Set Timeseries Status

Sets the status to ‘active’ or ‘inactive’

URL

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

Method

POST

Required IMS Scopes

  • Read
  • Write

Required ACL Permissions

  • owner
  • admin

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
status
required		 Status of the timeseries ( ‘active’ or ‘inactive’) inactive 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/status/inactive' 
  -H 'Authorization: Bearer {access_token}'

Errors

Error Description
403 Forbidden