EditTaskGroup
HTTP Request Formats
PATCH api/TaskGroup/{groupName}
To specify the schedule the command shall be sent to:
PATCH api/schedule/{scheduleName}/TaskGroup/{groupName}
Description
The EditTaskGroup REST API command edits the attributes of a task group in Astro Scheduler Engine. This command can be used to edit a single task group attribute or multiple attributes of a single task group. If the task group does not exist, this command will create one (effectively doubling as the non-existent commands CreateTaskGroup or NewTaskGroup).
| JSON Parameters | Body Format | Description |
|---|---|---|
| IncludedTasks | "IncludedTasks" : ["Task1","Task2"] | Text string of tasks in group. |
| MinAssignmentsType | "MinAssignmentsType" : "<MinAssignmentsType>" | <MinAssignmentsType> options are "ALL", "NOf", or "NA". "ALL" specifies that all tasks in the group must be included otherwise none will be. "NOf" specifies how many tasks associated with the group must be included in order for any to be included. Astro Scheduler Engine will not schedule any tasks beyond the integer specified. "NA" specifies that there is no scheduling requirements between tasks in the task group. |
| MinAssignments | "MinAssignments" : "10" | Integer value. Integer must be a positive non-zero number. Only required if "NOf" was selected. Specifies how many tasks associated with the group must be included in order for any to be included. Astro Scheduler Engine will not schedule any tasks beyond the integer specified |
| Show | "Show" : "TRUE" | Options are "TRUE" or "FALSE" indicating whether or not the task group will be shown in the Gantt when you roll up the gantt by task groups. |
Examples
Changes the values of the IncludedTasks and MinAssignments attributes of the Alpha task group in the active schedule to Launch1 Launch2 and Launch3, and 2, respectively.
PATCH api/TaskGroup/Alpha
Body:
{
"IncludedTasks" : ["Launch1","Launch2","Launch3"],
"MinAssignmentsType" : "NOf",
"MinAssignments" : "2"
}
Group Membership
This command belongs to the following group(s):
Version
12.3
Version
4.3.1 and 5.0
