DeleteResourceTag
HTTP Request Formats
DELETE api/ResourceTag
DELETE api/ResourceTag/{tagName}
To specify the schedule the command shall be sent to:
DELETE api/schedule/{scheduleName}/ResourceTag
DELETE api/schedule/{scheduleName}/ResourceTag/{tagName}
Description
The DeleteResourceTag REST API command deletes resource tags in a schedule. This command can be used to delete a single resource tag or multiple resource tags.
Parameters
Parameters are only used if the resource tag name is not specified in the HTTP request
| JSON Parameters | Body Format | Description |
|---|---|---|
| Id | "Id" : "ResTag1" | Parameter is a string of a single resource tag name. Wildcards are allowed |
| IdList | "IdList": ["ResTag1","ResTag2","ResTag3"] | Parameter is a string of a comma delimited list of resource tag names. Wildcards are allowed |
| All | "All : "TRUE" | Optional boolean will delete all resource tags within the schedule |
Examples
Deletes the Alpha, Beta, and Charlie resource tags in the active schedule.
DELETE api/ResourceTag
Body:
{
"IdList" : ["Alpha", "Beta","Charlie"]
}
Return Message
If activated, a standard response for a successful HTTP response shall appear.
Group Membership
This command belongs to the following group(s):
Version
12.3
