EditResourceTag
HTTP Request Formats
PATCH api/ResourceTag
PATCH api/ResourceTag/{tagName}
To specify the schedule the command shall be sent to:
PATCH api/schedule/{scheduleName}/ResourceTag
PATCH api/schedule/{scheduleName}/ResourceTag/{tagName}
Description
The EditResourceTag REST API command edits the attributes of a resource tag in Astro Scheduler Engine. This command can be used to edit the ResourceTag to consist of the resources provided with ResourceIds. If the resource tag does not exist, this command will create one (effectively doubling as the non-existent commands CreateResourceTag).
Parameters
"ResourceIDs" is required for all requests. Additional ones are only needed if the Resource Tag was not specified in 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 text in single quotes 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 |
| includedResourceIDs | "includedResourceIDs" : ["Res1","Res2","Res3"] | List of strings of resource ids that will be included in the ResourceTag. |
Examples
Sets ResourceTag TagA to contain the Alpha, Beta resources in the active schedule.
PATCH api/ResourceTag
Body:
{
"Id" : "TagA",
"includedResourceIDs" : ["Alpha","Beta"]
}
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.5
