| GET | /machines/{Id}/telemetries |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
TResponse = TypeVar('TResponse')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetOperationUnTenanted(Generic[TResponse], IReturn[TResponse], IHasGetOptions, IGet):
embed: Optional[str] = None
@staticmethod
def response_type(): return TResponse
TResponse = TypeVar('TResponse')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchOperationUnTenanted(Generic[TResponse], GetOperationUnTenanted[TResponse], IHasSearchOptions):
distinct: Optional[str] = None
limit: Optional[int] = None
offset: Optional[int] = None
sort: Optional[str] = None
filter: Optional[str] = None
TResponse = TypeVar('TResponse')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchOperationTenanted(Generic[TResponse], SearchOperationUnTenanted[TResponse], ITenantedRequest):
organisation_id: Optional[str] = None
class SortDirection(str, Enum):
ASCENDING = 'Ascending'
DESCENDING = 'Descending'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Sorting:
by: Optional[str] = None
direction: Optional[SortDirection] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Filtering:
fields: Optional[List[str]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchMetadata:
total: Optional[int] = None
limit: Optional[int] = None
offset: Optional[int] = None
sort: Optional[Sorting] = None
filter: Optional[Filtering] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchOperationResponse:
metadata: Optional[SearchMetadata] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SummarisedTelemetry:
type: Optional[str] = None
value: Optional[str] = None
observed_at: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchTelemetriesResponse(SearchOperationResponse):
granularity: Optional[str] = None
type: Optional[str] = None
from_: Optional[datetime.datetime] = field(metadata=config(field_name='from'), default=None)
to: Optional[datetime.datetime] = None
telemetries: Optional[List[SummarisedTelemetry]] = None
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchTelemetriesRequest(SearchOperationTenanted[SearchTelemetriesResponse]):
id: Optional[str] = None
granularity: Optional[str] = None
telemetry_type: Optional[str] = None
observed_after: Optional[datetime.datetime] = None
observed_before: Optional[datetime.datetime] = None
Python SearchTelemetriesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /machines/{Id}/telemetries HTTP/1.1
Host: foundrystage-api-app.azurewebsites.net
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
granularity: String,
type: String,
telemetries:
[
{
type: String,
value: String
}
],
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
metadata:
{
total: 0,
limit: 0,
offset: 0,
sort:
{
by: String,
direction: Ascending
},
filter:
{
fields:
[
String
]
}
}
}