DeleteResource
HTTP Request Formats
DELETE api/resource
DELETE api/resource/{resourceName}
To specify the schedule the command shall be sent to:
DELETE api/schedule/{scheduleName}/resource
DELETE api/schedule/{scheduleName}/resource/{resourceName}
Description
The DeleteResource REST API command deletes resources in a schedule.
Parameters
JSON Parameters | Body Format | Description |
---|---|---|
Id | "Id" : "Res1" | Parameter is a string of a single resource name. Wildcards are allowed |
IdList | "IdList": ["Res1","Res2","Res3"] | Parameter is a list of strings of resource names. Wildcards are allowed |
All | "All : "TRUE" | Optional boolean will delete all resources within the schedule |
Examples
Deletes the resource DemoResource from the active schedule
DELETE api/resource
Body:
{
"Id" : "DemoResource"
}
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