GetScheduleComparisonReport
HTTP Request Formats
POST api/report/comparison/plain
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/report/comparison/plain
Description
The GetScheduleComparisonReport REST API command returns a report that compares the specified schedule with the current schedule.
Parameters
Both parameters are required
| JSON Parameters | Body Format | Description |
|---|---|---|
| Path | "Path" :"C\MyFiles\Schedules" | Parameter is a string of text in single quotes of the file path of a schedule, which will be compared to the currently-selected schedule. More information on the acceptable file path formats can be found here. |
Examples
Generates a report listing the differences between the currently-active schedule
POST api/report/comparison/plain
Body:
{
"Path" : "C:\Schedules\model.ssc" ,
}
Return Message
Returns a message that contains all of the report data. See Schedule Comparison Report Details for more information.
Group Membership
This command belongs to the following group(s):
Version
12.3
