RecreatePossibilities
HTTP Request Format
POST api/RecreatePossibilities
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/RecreatePossibilities
Description
The RecreatePossibilities REST API command will make Astro Scheduler Engine recalculate all possibilities for all tasks in a schedule. Note that by default (and if no additional attributes are included), the resource usage settings (such as capacity, setup time, etc.) will also be reset to their default values based on the resources used for that possibility. Including additional attributes will allow you to retain certain resource usage settings, or allow you to only recreate possibilities for a certain set of tasks.
Parameters
All parameters are optional
| JSON Parameters | Body Format | Description |
|---|---|---|
| RetainAll | "RetainSettings" : "TRUE" | If the RetainSettings parameter is TRUE (or not included with command), then all tasks' possibilities
will attempt to re-create their resource usage attributes while retaining their current settings as they
existed immediately prior to this command.
If the RetainSettings parameter is FALSE, then all tasks' possibilities will re-create their resource usage attributes from their related resource object values. To partially retain resource usage settings, see other options |
| RetainCapacity | "RetainCapacity" : "TRUE" | All tasks' possibilities will attempt to re-create their resource usage attributes while retaining their current Capacity settings as they existed immediately prior to this command. This parameter cannot be used if "RetainAll" is also being used |
| RetainBreakdownTimes | "RetainBreakdownTimes" : "TRUE" | All tasks' possibilities will attempt to re-create their resource usage attributes while retaining their current Setup/Breakdown settings as they existed immediately prior to this command. This parameter cannot be used if "RetainAll" is also being used |
| RetainCost | "RetainCost" : "TRUE" | All tasks' possibilities will attempt to re-create their resource usage attributes while retaining their current Cost settings as they existed immediately prior to this command. This parameter cannot be used if "RetainAll" is also being used |
| RetainPriority | "RetainPriority" : "TRUE" | All tasks' possibilities will attempt to re-create their resource usage attributes while retaining their current Priority settings as they existed immediately prior to this command. This parameter cannot be used if "RetainAll" is also being used |
| RetainSTKReports | "RetainSTKReports" : "TRUE" | All tasks' possibilities will attempt to re-create their resource usage attributes while retaining their current STK Reports as they existed immediately prior to this command. This parameter cannot be used if "RetainAll" is also being used |
| RetainTimeReports | "RetainTimeReports" : "TRUE" | All tasks' possibilities will attempt to re-create their resource usage attributes while retaining their current time window files. This parameter cannot be used if "RetainAll" is also being used |
| RetainOther | "RetainOther" : "TRUE" | All tasks' possibilities will attempt to re-create their resource usage attributes while retaining their current Animation, Report Definition, Is Accommodation Applicable, and Override Task Duration settings as they existed immediately prior to this command. This parameter cannot be used if "RetainAll" is also being used |
| IdList | "IdList": ["Task1","Task2","Task3"] | An optional comma delimited list of tasks that will have their possibilities re-created. If not present, then all task possibilities will re-created. This value must be in single quotes. |
| RetainAssignments | "RetainAssignments" : "TRUE" | If the RetainAssignments parameter is TRUE, then tasks will attempt to keep their current assignments after possibilities are recreated. This may result in violations if these assignments are no longer valid. Recurring tasks may have their assignments reassigned to different children, or may not be able to retain all assignments if there are not enough child tasks after recreating possibilities. If the RetainAssignments parameter is FALSE, then all assignments will be unassigned from tasks when their possibilities are recreated. This is the default behavior. If the RetainAssignments parameter is ADJUST, it will be treated as TRUE, but additionally this command will attempt to adjust task assignments to fit within any altered timeslots. This may result in violations if altering these assignments causes resources to be utilized in an invalid manner. |
| RetainChildSettings | "RetainChildSettings": "TRUE" | If the RetainChildSettings parameter is TRUE, then child tasks will attempt to keep their saved changes. If it's FALSE, all changes made to child tasks will be overwritten, which is the default behavior |
Examples
Re-creates possibilities for DemoTask1 and DemoTask2 while retaining resource usage settings
POST api/RecreatePossibilities
Body:
{
"RetainSettings" : "TRUE"
"IdList" : ["DemoTask1", "DemoTask2"],
}
Re-creates possibilities for all tasks while retaining resource usage settings only for capacity and resource priority
POST api/RecreatePossibilities
Body:
{
"RetainCapacity" : "TRUE"
"RetainPriority" : "TRUE"
"IdList" : ["DemoTask1", "DemoTask2"],
}
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
