TelemetryResource
A REST Web Service for retrieving Telemetry entries.
The following resources are applicable:
- /telemetry/records
- /telemetry/records/interval/{start}/{end}
- /telemetry/records/interval/{start}/{end}/{domain}
- /telemetry/records/name/{name}
/telemetry/records
Mount Point: /telemetry/records
GET
Retrieves all telemetry records.
Response Body
element: | telemetrys |
media types: | application/xml text/xml application/json |
A Telemetrys object containing all the relevant records
/telemetry/records/interval/{start}/{end}
Mount Point: /telemetry/records/interval/{start}/{end}
GET
Retrieves all records started in a given interval. An example API path: '/api/telemetry/records/interval/2015-06-22T22:03:32Z/2015-06-23T22:03:32Z'
Parameters
name | description | type | default |
---|---|---|---|
start | The start time of the interval in ISODateTimeFormat without millis, for example, 2015-06-22T22:03:32Z | path | |
end | The end time of the interval in ISODateTimeFormat without millis, for example, 2015-06-23T22:03:32Z | path |
Response Body
element: | telemetrys |
media types: | application/xml text/xml application/json |
A Telemetry object containing all the relevant records
/telemetry/records/interval/{start}/{end}/{domain}
Mount Point: /telemetry/records/interval/{start}/{end}/{domain}
GET
Retrieves all records started in a given interval for a given domain.
Parameters
name | description | type | default |
---|---|---|---|
start | The start time of the interval in ISODateTimeFormat without millis, for example, 2015-06-22T22:03:32Z | path | |
end | The end time of the interval in ISODateTimeFormat without millis, for example, 2015-06-23T22:03:32Z | path | |
domain | The domain to filter on, ie scf_testing_domain | path |
Response Body
element: | telemetrys |
media types: | application/xml text/xml application/json |
A Telemetry object containing all the relevant records
/telemetry/records/name/{name}
Mount Point: /telemetry/records/name/{name}
GET
Retrieves all telemetry records of a given name.
Parameters
name | description | type | default |
---|---|---|---|
name | The definition name | path |
Response Body
element: | telemetrys |
media types: | application/xml text/xml application/json |
A Telemetry object containing all the relevant records