Delete Metrics from a Timeseries Definition

Use this endpoint to delete metrics. Supply the list of metric names in the DELETE request body.

This method also removes the timeseriesId from the corresponding batch period list if there is no batch metric left in the timeseries definition after removing a batch metric.

Consumes

  • application/json
  • text/json
  • application/json-patch+json

URL

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

Method

DELETE

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 ID from which to delete the metrics GUID 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 DELETE 
  'https://{{HOST}}/timeseries/timeseries/920de700-8a84-4306-aef7-2676df222c6f/metrics' 
  -H 'Authorization: Bearer {access_token}' 
  -H 'Cache-Control: no-cache' 
  -H 'Content-Type: application/json' 
  -d '[
  {"timeseriesId":"920de700-8a84-4306-aef7-2676df222c6f", "metric":"QuarterHourlyAverage"},
  {"timeseriesId":"920de700-8a84-4306-aef7-2676df222c6f", "metric":"HourlyAverage"},
  {"timeseriesId":"920de700-8a84-4306-aef7-2676df222c6f", "metric":"QuaterHourlyCount"},
  {"timeseriesId":"920de700-8a84-4306-aef7-2676df222c6f", "metric":"QuaterHourlyMin"},
  {"timeseriesId":"920de700-8a84-4306-aef7-2676df222c6f", "metric":"QuaterHourlyMax"}
]
'

Errors

Error Description
403 Forbidden