DeleteTaskGroup
HTTP Request Formats
DELETE api/TaskGroup
DELETE api/TaskGroup/{groupName}
To specify the schedule the command shall be sent to:
DELETE api/schedule/{scheduleName}/TaskGroup
DELETE api/schedule/{scheduleName}/TaskGroup/{groupName}
Description
The DeleteTaskGroup REST API command deletes task groups in the active schedule. This command can be used to delete a single task group or multiple task groups.
Parameters
Parameters are only used if the task group name is not specified in the HTTP request
| JSON Parameters | Body Format | Description |
|---|---|---|
| Id | "Id" : "TaskGroup1" | Parameter is a string of a single task group name. |
| IdList | "IdList": ["TaskGroup1","TaskGroup2","TaskGroup3"] | Parameter is a string of text in single quotes of a comma delimited list of task group names. |
| All | "All : "TRUE" | Optional boolean will delete all task groups within the schedule |
| Unassigned | "Unassigned" : "TRUE" | Optional boolean will remove all task groups where the minimum assigned constraint is not satisfied, excluding where the restraint is set to NA. |
Examples
Deletes the Alpha, Beta, and Charlie task groups in the active schedule.
DELETE api/TaskGroup
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
