Request New Timeseries

This endpoint is used to register one or more timeseries. Timeseries Id will be randomly generated. Timeseries Type will be always baseline. There is no need to provide any data in the POST request body. Depending on the number of timeseries to register it will generate some random baseline timeseries. Should this run successfully it will return the created timeseries. Only 50 new timeseries can be created from a single request.

When using this endpoint all timeseriesId will be generated with default Ids (GUID). No Custom Timeseries Ids are allowed.

Owner permissions will be automatically set to the requestor.

URL

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

Method

POST

Required IMS Scopes

  • read
  • write

Versions Supported

  • 2.0 (Default)
  • 2.1

URL Query Parameters

Name Description Example Type
v
optional
Version of the API to use v=2.0 string
n
optional
Number of timeseries IDs to register 10 integer(int32)
timeseriesType
optional
Type of timeseries 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 POST 
  'https://{{HOST}}/timeseries/timeseries/new?n=2' 
  -H 'Authorization: Bearer {access_token} 
  -H 'Content-Type: application/json' 

Response

[
    {
        "timeseriesId": "c91d59cb-f6f6-4b64-b176-0a0acb1d0e97",
        "orgId": "jci.com",
        "timeseriesType": "None",
        "dag": [
            {
                "metric": "Raw",
                "processingType": "raw",
                "dataType": "double",
                "validateInputData": false
            }
        ],
        "status": "active"
    },
    {
        "timeseriesId": "0992cbb0-e758-3bd8-5525-1c15103897c3",
        "orgId": "jci.com",
        "timeseriesType": "None",
        "dag": [
            {
                "metric": "Raw",
                "processingType": "raw",
                "dataType": "double",
                "validateInputData": false
            }
        ],
        "status": "active"
    }
]

Errors

Error Description
401 Unauthorized Invalid token

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