Register New Timeseries Definition

This endpoint is used to register one or more timeseries defintions with or without metrics.

Owner permissions will be automatically set to the requestor.

URL

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

Method

POST

Required IMS Scopes

  • Read
  • Write

Versions Supported

  • 2.0 (Default)
  • 2.1

URL Path Parameters

Name Description Example Type
id
optional		 Id of Needed for the Endpoint /endpoint/id 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		 Description
Content-Type application/json
required		 Description

Request Body Parameters

Name Description Schema
timeseriesId
required		 Timeseries the TSElement belogs to string
dag
optional		 Metric of the sample Metric

Example

Request

curl -X POST 
  'https://{{HOST}}/timeseries/timeseries' 
  -H 'Authorization: Bearer {access_token}' 
  -H 'Cache-Control: no-cache' 
  -H 'Content-Type: application/json' 
  -d '[
    {
    "timeseriesId": "be37e78e-359f-3f40-362a-47d02287bc1d",
    "dag": [
        {
            "metric": "QuarterHourlyAverage",
            "operations": [
                {
                    "operation": "Aggregate",
                    "input": [
                        {
                            "timeseriesId": "be37e78e-359f-3f40-362a-47d02287bc1d",
                            "metric": "Raw"
                        }
                    ],
                    "output": [
                        {
                            "timeseriesId": "be37e78e-359f-3f40-362a-47d02287bc1d",
                            "metric": "QuarterHourlyAverage"
                        }
                    ],
                    "parameters": {
                        "function": "Average",
                        "interval": "QuarterHourly"
                    }
                }
            ],
            "processingType": "stream",
            "dataType": "double",
            "validateInputData": false
        }
    ]
}
]'

Errors

Error Description
Error Name Description of Error