GetScheduleInfo
HTTP Request Formats
POST api/report/schedule/plain
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/report/schedule/plain
Description
The GetScheduleInfo REST API command returns all of the option settings.
GetScheduleInfoJson vs. GetScheduleInfo
The choice of command will depend on use case.
GetScheduleInfoJson provides output in a commonly used format that is easy to parse. This command is preferred if schedule value information will be further processed.
GetScheduleInfo provides output that is difficult to parse but easy to understand. This command is preferred if no further processing is required.
Parameters
| JSON Parameters | Body Format | Description |
|---|---|---|
| FieldList | "FieldList" : ["<ReportField1>","<ReportField2>"] | <ReportField> are specific report fields that are desired. If this parameter is used, the report produced will only contain these fields (if not used the report will contain all fields). A list of fields can be found on the Schedule Reports page. |
Examples
Finds the values of all the option settings for the active schedule
POST api/report/schedule/plain
Return Message
Returns a message that contains all of the option setting values for the specified schedule file. The report matches the format specified on the Schedule Report page.
Group Membership
This command belongs to the following group(s):
Version
12.3
