SetViewOptions
HTTP Request Formats
POST api/ViewOptions
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/ViewOptions
Description
The SetViewOptions REST API command edits GUI display settings for the active schedule.
Parameters
All parameters are optional
| JSON Parameters | Body Format | Description |
|---|---|---|
| View | "View" : "Gantt" | Indicates what schedule view is displayed. Options are "Gantt" or "Table" |
| Sort | "Sort" : "Name" | Indicates how tasks will be sorted. Options are "Name" or "Time" |
| Group | "Group" : "grouped" | Indicates how tasks will be grouped. Options are "ungrouped", "grouped", "stkAircraft", "stkAreaTarget", "stkChain", "stkFacility", "stkGroundVehicle", "stkLaunhcVehicle", "stkMissile", "stkRadar", "stkReceiver", "stkPlace", "stkPlanet", "stkSatellite", "stkSensor", "stkShip", "stkStar", "stkTarget", "stkTransmitter", "byResource" |
| Rollup | "Rollup" : "rollupRecurr" | Indicates how recurring tasks will be rolled up. Options are "rollupNone", "rollupRecurr", "rollupGroups", "showPossibilities" |
| ShowLabels | "ShowLabels" : "TRUE" | Boolean indicating if task labels are shown |
| ShowParents | "ShowParents" : "TRUE" | Boolean indicating if parent tasks are shown |
| ShowResources | "ShowResources" : "TRUE" | Boolean indicating if resources are shown |
| ShowTimeslots | "ShowTimeslots" : "TRUE" | Boolean indicating if timeslots are shown |
| ShowUnassigned | "ShowUnassigned" : "TRUE" | Boolean indicating if unassigned tasks are shown |
| TaskIdFontSize | "TaskIdFontSize" : "10" | New font size for the Task IDs in the Gantt chart; whole number or decimal between 6 and 16, inclusive, and rounded to the nearest quarter of a point. The default size is 10 point. |
| AssignedColor | "AssignedColor" : "255,0,0,255" | Four ARGB (Red Green Blue Alpha) values that are bytes (0-255) to represent Assigned Tasks in the Gantt and Table |
| LockedColor | "LockedColor" : "255,0,0,255" | Four ARGB (Red Green Blue Alpha) values that are bytes (0-255) to represent Locked Tasks in the Gantt and Table |
| DeferredColor | "DeferredColor" : "255,0,0,255" | Four ARGB (Red Green Blue Alpha) values that are bytes (0-255) to represent Deferred Tasks in the Gantt and Table |
| ViolationColor | "ViolationColor" : "255,0,0,255" | Four ARGB (Red Green Blue Alpha) values that are bytes (0-255) to represent Violations in the Gantt and Table |
Examples
Sets the display to the Gantt view, does not show parent tasks or labels, shows resources, and rollup recurring tasks
POST api/ViewOptions
Body:
{
"View" : "Gantt",
"ShowParents" : "FALSE",
"ShowLabels" : "FALSE",
"ShowResources" : "TRUE",
"Rollup" : "rollupRecurr"
}
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
