GetScheduleComparisonReportJson
HTTP Request Formats
POST api/report/comparison
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/report/comparison
Description
The GetScheduleComparisonReportJson REST API command returns a report that compares the specified schedule with the current schedule in JSON format.
GetScheduleComparisonReportJson vs. GetScheduleComparisonReport
The choice of command will depend on use case.
GetScheduleComparisonReportJson provides output in a commonly used format that is easy to parse. This command is preferred if schedule comparison information will be further processed.
GetScheduleComparisonReport provides output that is difficult to parse but easy to understand. This command is preferred if no further processing is required.
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 and the schedule saved as
"ScheduleComparisonB.ssc"
POST api/report/comparison
Body:
{
"Path" : "C:\Schedules\ScheduleComparisonB.ssc" ,
}
Return Message
Returns a message that contains all of the schedule comparison report data in JSON format. See Schedule Comparison Report Details for more information.
The following JSON file contains sample output of the above command.
Group Membership
This command belongs to the following group(s):
Version
12.3
