Read Timeseries

This endpoint is used to request the definition of a timeseries.

URL

https://{{HOST}}/timeseries/timeseries/{timeseries_id}

Method

POST

Required IMS Scopes

  • Read
  • Write

Required ACL Permissions

  • owner
  • admin
  • readwrite
  • readonly

Versions Supported

  • 2.0 (Default)
  • 2.1

URL Path Parameters

Name Description Example Type
timeseries_id
required		 timeseries IDs to get the definition from 27830711-3763-4663-80b6-7d4e71207760 string

URL Query Parameters

Name Description Example Type
v
optional		 Version of the API to use v=2.0 string

Request Header Parameters

Type Value Description
Authentication Bearer {access_token}
required		 Retrieve access token
Content-Type application/json
required		 Description

Example

Request

curl -X GET 
  'https://{{HOST}}/timeseries/timeseries/8cb3e647-3632-4693-b604-7d22fde00659' 
  -H 'Authorization: Bearer {access_token}'

Response

{
    "timeseriesId": "8cb3e647-3632-4693-b604-7d22fde00659",
    "orgId": "jci.com",
    "timeseriesType": "None",
    "dag": [
        {
            "metric": "Raw",
            "processingType": "raw",
            "dataType": "double",
            "validateInputData": false
        }
    ],
    "status": "active",
    "customData": 
    {
        "exampleProperty": "exampleValue"
    }
}

Errors

Error Description
403 Forbidden

Response Body Parameters

Name Description Schema
timeseriesId ID of timeseries string
timeseriesType Type of timeseries string
dag.metric Metric name string
dag.processingType Procesing type of metric string
dag.dataType Data type of metric string
dag.validateInputData Flags data to be validated boolean
status Status of timeseries string
customData Application specific data can be stored here Dictionary<string,object>
orgId
deprecated		 Deprecated string