SetTimescaleOptions
Format
POST api/schedule/TimescaleOptions
Description
The SetTimescaleOptions REST API command sets the timescale properties in the Astro Scheduler Engine Gantt view and resource chart windows.
Parameters
All parameters are optional
| JSON Parameters | Body Format | Description |
|---|---|---|
| ViewScale | "ViewScale" : "thirty_seconds" | Possible values are "one_millisecond"," ten_milliseconds"," hunder_milliseconds"," five_hundred_milliseconds", "one_second", "five_seconds", "ten_seconds", "fifteen_seconds"," thirty_seconds", "one_minute", "five_minutes"," ten_minutes"," fifteen_minutes", "thirty_minutes", "one_hour", "three_hours"," six_hours"," twelve_hours", "one_day"," one_week" |
| ShowDateGrids | "ShowDateGrids": "TRUE" | Boolean to determine if Date Grids will be displayed |
| AutoDisplay | "AutoDisplay" : "TRUE" | Optional boolean to determine if Display will automatically update |
| DisplayStartTime | "DisplayStartTime" : "<StartTime>" | <StartTime> can use any of the date formats listed on the DateFormats page. |
| DisplayStopTime | "DisplayStopTime" : "<StopTime>" | <StopTime> can use any of the date formats listed on the DateFormats page. |
Examples
Sets the timescale to Minutes, hide date grids, and set display times.
POST api/schedule/TimescaleOptions
Body:
{
"ViewScale" : "one_minute",
"ShowDateGrids" : "FALSE",
"DisplayStartTime" : "2004/08/11_03:00:00.526"
"DisplayStopTime" : "2004/08/12_12:30:45"
}
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
