DeleteResourceLogicalGroup
HTTP Request Formats
DELETE api/ResourceConstraintGroup
DELETE api/ResourceConstraintGroup/{groupName}
To specify the schedule the command shall be sent to:
DELETE api/schedule/{scheduleName}/ResourceConstraintGroup
DELETE api/schedule/{scheduleName}/ResourceConstraintGroup/{groupName}
Description
The DeleteResourceLogicalGroup REST API command deletes resource constraint and template groups in a schedule. This command can be used to delete a single resource logical group or multiple resource logical groups.
Parameters
Parameters are only used if the resource logical group name is not specified in the HTTP request
| JSON Parameters | Body Format | Description |
|---|---|---|
| Id | "Id" : "ResLogicalGroup1" | Parameter is a string of a single resource logical group name. Wildcards are allowed |
| IdList | "IdList": ["ResLogicalGroup1","ResLogicalGroup2","Res3LogicalGroup"] | Parameter is a string of text in single quotes of a comma delimited list of resource logical group names. Wildcards are allowed |
| All | "All : "TRUE" | Optional boolean will delete all resource logical groups within the schedule |
Examples
Deletes the Alpha, Beta, and Charlie resource constraint groups in the active schedule.
DELETE api/ResourceConstraintGroup
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
