GET | /machines/{Id}/telemetries |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | string | No | |
Granularity | query | string | No | |
TelemetryType | query | string | No | |
ObservedAfter | query | DateTime | No | |
ObservedBefore | query | DateTime | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OrganisationId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Distinct | form | string | No | |
Limit | form | int? | No | |
Offset | form | int? | No | |
Sort | form | string | No | |
Filter | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Embed | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Granularity | form | string | No | |
Type | form | string | No | |
From | form | DateTime | No | |
To | form | DateTime | No | |
Telemetries | form | List<SummarisedTelemetry> | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Metadata | form | SearchMetadata | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Total | form | int | No | |
Limit | form | int | No | |
Offset | form | int | No | |
Sort | form | Sorting | No | |
Filter | form | Filtering | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
By | form | string | No | |
Direction | form | SortDirection | No |
Ascending | |
Descending |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Fields | form | List<string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Type | form | string | No | |
Value | form | string | No | |
ObservedAt | form | DateTime | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Granularity | form | string | No | |
Type | form | string | No | |
From | form | DateTime | No | |
To | form | DateTime | No | |
Telemetries | form | List<SummarisedTelemetry> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK Content-Type: text/csv 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"]}}}