The API Change Log shows structural changes to API resources for each version. Each major release and current version patch release changes are shown starting with v15.0.
RESOURCE | METHOD | VERB | ROUTE | CHANGE | VERSION | DESCRIPTION | CONTRACT | OLD | NEW |
---|---|---|---|---|---|---|---|---|---|
AnalyticsReports | Create | Post | Reporting/AnalyticsReports/ | Resource Added | 15.0.0 | New resource added. | AnalyticsReports | ||
AnalyticsReports | Delete | Delete | Reporting/AnalyticsReports/{analyticsReportId} | Resource Added | 15.0.0 | New resource added. | AnalyticsReports | ||
AnalyticsReports | Get | Get | Reporting/AnalyticsReports/{analyticsReportId} | Resource Added | 15.0.0 | New resource added. | AnalyticsReports | ||
AnalyticsReports | GetAll | Get | Reporting/AnalyticsReports/ | Resource Added | 15.0.0 | New resource added. | AnalyticsReports | ||
AnalyticsReports | Update | Put | Reporting/AnalyticsReports/{analyticsReportId} | Resource Added | 15.0.0 | New resource added. | AnalyticsReports | ||
AuditLogs | Get | Get | Reporting/AuditLogs/{auditLog} | Parameter Changed | 15.0.0 | auditLog has been marked as required. | Required | ||
Lists | Results | Post | Reporting/Lists/{listId}/Results | Property Added | 15.0.0 | FormatDate has been added to OutputResultRequest | OutputResultRequest | OutputResultRequest.FormatDate | |
QueryElementFilters | Delete | Delete | Reporting/QueryElementFilters/{queryElementFilterId} | Parameter Changed | 15.0.0 | queryElementFilterId has been marked as required. | Required | ||
QueryElementFilters | Get | Get | Reporting/QueryElementFilters/{queryElementFilterId} | Parameter Changed | 15.0.0 | queryElementFilterId has been marked as required. | Required | ||
QueryElementFilters | Update | Put | Reporting/QueryElementFilters/{queryElementFilterId} | Parameter Changed | 15.0.0 | queryElementFilterId has been marked as required. | Required | ||
QueryElementGroups | Delete | Delete | Reporting/QueryElementGroups/{queryElementGroupId} | Parameter Changed | 15.0.0 | queryElementGroupId has been marked as required. | Required | ||
QueryElementGroups | Get | Get | Reporting/QueryElementGroups/{queryElementGroupId} | Parameter Changed | 15.0.0 | queryElementGroupId has been marked as required. | Required | ||
QueryElementGroups | Update | Put | Reporting/QueryElementGroups/{queryElementGroupId} | Parameter Changed | 15.0.0 | queryElementGroupId has been marked as required. | Required | ||
QueryElements | Delete | Delete | Reporting/QueryElements/{id} | Parameter Changed | 15.0.0 | id has been marked as required. | Required | ||
QueryElements | Get | Get | Reporting/QueryElements/{id} | Parameter Changed | 15.0.0 | id has been marked as required. | Required | ||
QueryElements | GetAll | Get | Reporting/QueryElements/ | Parameter Added | 15.0.0 | New parameter added activeOnly | activeOnly | ||
QueryElements | GetSummaries | Get | Reporting/QueryElements/Summary | Parameter Added | 15.0.0 | New parameter added activeOnly | activeOnly | ||
QueryElements | Update | Put | Reporting/QueryElements/{id} | Parameter Changed | 15.0.0 | id has been marked as required. | Required | ||
ReportRequests | Create | Post | Reporting/ReportRequests/ | Property Added | 15.1.0 | ReportType has been added to ReportRequest | ReportRequest | ReportRequest.ReportType | |
ReportRequests | Create | Post | Reporting/ReportRequests/ | Property Added | 15.1.0 | ReportType has been added to ReportRequest | ReportRequest | ReportRequest.ReportType | |
ReportRequests | DeleteAllExpired | Delete | Reporting/ReportRequests/Expired | Operation Added | 15.0.0 | DeleteAllExpired has been added. | DeleteAllExpired | ||
ReportRequests | FlushIncomplete | Put | Reporting/ReportRequests/FlushIncomplete | Operation Added | 15.0.0 | FlushIncomplete has been added. | FlushIncomplete | ||
ReportRequests | GenerateScheduled | Post | Reporting/ReportRequests/GenerateScheduled | Operation Added | 15.0.0 | GenerateScheduled has been added. | GenerateScheduled | ||
ReportRequests | Get | Get | Reporting/ReportRequests/{id} | Property Added | 15.1.0 | ReportType has been added to ReportRequest | ReportRequest | ReportRequest.ReportType | |
ReportRequests | Get | Get | Reporting/ReportRequests/{id} | Property Removed | 15.0.0 | DeletedFlag has been removed from ReportRequest | ReportRequest | DeletedFlag | |
ReportRequests | Get | Get | Reporting/ReportRequests/{id} | Property Removed | 15.0.0 | FormName has been removed from ReportRequest | ReportRequest | FormName | |
ReportRequests | Get | Get | Reporting/ReportRequests/{id} | Property Removed | 15.0.0 | PrintedInd has been removed from ReportRequest | ReportRequest | PrintedInd | |
ReportRequests | Get | Get | Reporting/ReportRequests/{id} | Property Removed | 15.0.0 | PrinterName has been removed from ReportRequest | ReportRequest | PrinterName | |
ReportRequests | Get | Get | Reporting/ReportRequests/{id} | Property Removed | 15.0.0 | PublicFlag has been removed from ReportRequest | ReportRequest | PublicFlag | |
ReportRequests | Get | Get | Reporting/ReportRequests/{id} | Property Added | 15.0.0 | CreatedBy has been added to ReportRequest | ReportRequest | ReportRequest.CreatedBy | |
ReportRequests | Get | Get | Reporting/ReportRequests/{id} | Property Added | 15.0.0 | CreatedDateTime has been added to ReportRequest | ReportRequest | ReportRequest.CreatedDateTime | |
ReportRequests | Get | Get | Reporting/ReportRequests/{id} | Property Added | 15.0.0 | CreateLocation has been added to ReportRequest | ReportRequest | ReportRequest.CreateLocation | |
ReportRequests | Get | Get | Reporting/ReportRequests/{id} | Property Added | 15.0.0 | DeletedIndicator has been added to ReportRequest | ReportRequest | ReportRequest.DeletedIndicator | |
ReportRequests | Get | Get | Reporting/ReportRequests/{id} | Property Added | 15.0.0 | OutputOption has been added to ReportRequest | ReportRequest | ReportRequest.OutputOption | |
ReportRequests | Get | Get | Reporting/ReportRequests/{id} | Property Added | 15.0.0 | Parameters has been added to ReportRequest | ReportRequest | ReportRequest.Parameters | |
ReportRequests | Get | Get | Reporting/ReportRequests/{id} | Property Added | 15.0.0 | PublicIndicator has been added to ReportRequest | ReportRequest | ReportRequest.PublicIndicator | |
ReportRequests | Get | Get | Reporting/ReportRequests/{id} | Property Added | 15.0.0 | QueueStatus has been added to ReportRequest | ReportRequest | ReportRequest.QueueStatus | |
ReportRequests | Get | Get | Reporting/ReportRequests/{id} | Property Added | 15.0.0 | ScheduleId has been added to ReportRequest | ReportRequest | ReportRequest.ScheduleId | |
ReportRequests | Get | Get | Reporting/ReportRequests/{id} | Property Added | 15.0.0 | UpdatedBy has been added to ReportRequest | ReportRequest | ReportRequest.UpdatedBy | |
ReportRequests | Get | Get | Reporting/ReportRequests/{id} | Property Added | 15.0.0 | UpdatedDateTime has been added to ReportRequest | ReportRequest | ReportRequest.UpdatedDateTime | |
ReportRequests | Get | Get | Reporting/ReportRequests/{id} | Parameter Changed | 15.0.0 | id has been marked as required. | Required | ||
ReportRequests | GetAll | Get | Reporting/ReportRequests/ | Property Added | 15.1.0 | ReportType has been added to ReportRequest | ReportRequest | ReportRequest.ReportType | |
ReportRequests | GetAll | Get | Reporting/ReportRequests/ | Property Removed | 15.0.0 | DeletedFlag has been removed from ReportRequest | ReportRequest | DeletedFlag | |
ReportRequests | GetAll | Get | Reporting/ReportRequests/ | Property Removed | 15.0.0 | FormName has been removed from ReportRequest | ReportRequest | FormName | |
ReportRequests | GetAll | Get | Reporting/ReportRequests/ | Property Removed | 15.0.0 | PrintedInd has been removed from ReportRequest | ReportRequest | PrintedInd | |
ReportRequests | GetAll | Get | Reporting/ReportRequests/ | Property Removed | 15.0.0 | PrinterName has been removed from ReportRequest | ReportRequest | PrinterName | |
ReportRequests | GetAll | Get | Reporting/ReportRequests/ | Property Removed | 15.0.0 | PublicFlag has been removed from ReportRequest | ReportRequest | PublicFlag | |
ReportRequests | GetAll | Get | Reporting/ReportRequests/ | Property Added | 15.0.0 | CreatedBy has been added to ReportRequest | ReportRequest | ReportRequest.CreatedBy | |
ReportRequests | GetAll | Get | Reporting/ReportRequests/ | Property Added | 15.0.0 | CreatedDateTime has been added to ReportRequest | ReportRequest | ReportRequest.CreatedDateTime | |
ReportRequests | GetAll | Get | Reporting/ReportRequests/ | Property Added | 15.0.0 | CreateLocation has been added to ReportRequest | ReportRequest | ReportRequest.CreateLocation | |
ReportRequests | GetAll | Get | Reporting/ReportRequests/ | Property Added | 15.0.0 | DeletedIndicator has been added to ReportRequest | ReportRequest | ReportRequest.DeletedIndicator | |
ReportRequests | GetAll | Get | Reporting/ReportRequests/ | Property Added | 15.0.0 | OutputOption has been added to ReportRequest | ReportRequest | ReportRequest.OutputOption | |
ReportRequests | GetAll | Get | Reporting/ReportRequests/ | Property Added | 15.0.0 | Parameters has been added to ReportRequest | ReportRequest | ReportRequest.Parameters | |
ReportRequests | GetAll | Get | Reporting/ReportRequests/ | Property Added | 15.0.0 | PublicIndicator has been added to ReportRequest | ReportRequest | ReportRequest.PublicIndicator | |
ReportRequests | GetAll | Get | Reporting/ReportRequests/ | Property Added | 15.0.0 | QueueStatus has been added to ReportRequest | ReportRequest | ReportRequest.QueueStatus | |
ReportRequests | GetAll | Get | Reporting/ReportRequests/ | Property Added | 15.0.0 | ScheduleId has been added to ReportRequest | ReportRequest | ReportRequest.ScheduleId | |
ReportRequests | GetAll | Get | Reporting/ReportRequests/ | Property Added | 15.0.0 | UpdatedBy has been added to ReportRequest | ReportRequest | ReportRequest.UpdatedBy | |
ReportRequests | GetAll | Get | Reporting/ReportRequests/ | Property Added | 15.0.0 | UpdatedDateTime has been added to ReportRequest | ReportRequest | ReportRequest.UpdatedDateTime | |
ReportRequests | GetAllExpired | Get | Reporting/ReportRequests/Expired | Operation Added | 15.0.0 | GetAllExpired has been added. | GetAllExpired | ||
ReportRequests | GetQueued | Get | Reporting/ReportRequests/Queued | Property Added | 15.1.0 | ReportType has been added to ReportRequest | ReportRequest | ReportRequest.ReportType | |
ReportRequests | GetQueued | Get | Reporting/ReportRequests/Queued | Operation Added | 15.0.0 | GetQueued has been added. | GetQueued | ||
ReportRequests | Update | Put | Reporting/ReportRequests/{id} | Property Added | 15.1.0 | ReportType has been added to ReportRequest | ReportRequest | ReportRequest.ReportType | |
ReportRequests | Update | Put | Reporting/ReportRequests/{id} | Property Added | 15.1.0 | ReportType has been added to ReportRequest | ReportRequest | ReportRequest.ReportType | |
Reports | Get | Get | Reporting/Reports/{reportId} | Property Removed | 15.0.0 | AllowQuery has been removed from Report | Report | AllowQuery | |
Reports | Get | Get | Reporting/Reports/{reportId} | Property Changed | 15.0.0 | AllowSchedule has changed from String to Boolean | Report | String | Boolean |
Reports | Get | Get | Reporting/Reports/{reportId} | Property Removed | 15.0.0 | ApplicationId has been removed from Report | Report | ApplicationId | |
Reports | Get | Get | Reporting/Reports/{reportId} | Property Removed | 15.0.0 | ImpWinInd has been removed from Report | Report | ImpWinInd | |
Reports | Get | Get | Reporting/Reports/{reportId} | Property Removed | 15.0.0 | ImpWinName has been removed from Report | Report | ImpWinName | |
Reports | Get | Get | Reporting/Reports/{reportId} | Property Removed | 15.0.0 | PsrFile has been removed from Report | Report | PsrFile | |
Reports | Get | Get | Reporting/Reports/{reportId} | Property Removed | 15.0.0 | PublicFlag has been removed from Report | Report | PublicFlag | |
Reports | Get | Get | Reporting/Reports/{reportId} | Property Removed | 15.0.0 | QuerystringAppend has been removed from Report | Report | QuerystringAppend | |
Reports | Get | Get | Reporting/Reports/{reportId} | Property Removed | 15.0.0 | UtilityInd has been removed from Report | Report | UtilityInd | |
Reports | Get | Get | Reporting/Reports/{reportId} | Property Removed | 15.0.0 | WarningInd has been removed from Report | Report | WarningInd | |
Reports | Get | Get | Reporting/Reports/{reportId} | Property Added | 15.0.0 | ParameterWindow has been added to Report | Report | Report.ParameterWindow | |
Reports | Get | Get | Reporting/Reports/{reportId} | Property Added | 15.0.0 | ParameterWindowIndicator has been added to Report | Report | Report.ParameterWindowIndicator | |
Reports | Get | Get | Reporting/Reports/{reportId} | Property Added | 15.0.0 | PublicIndicator has been added to Report | Report | Report.PublicIndicator | |
Reports | Get | Get | Reporting/Reports/{reportId} | Property Added | 15.0.0 | ReportPath has been added to Report | Report | Report.ReportPath | |
Reports | Get | Get | Reporting/Reports/{reportId} | Property Added | 15.0.0 | UtilityIndicator has been added to Report | Report | Report.UtilityIndicator | |
Reports | Get | Get | Reporting/Reports/{reportId} | Property Added | 15.0.0 | WarningIndicator has been added to Report | Report | Report.WarningIndicator | |
Reports | GetAll | Get | Reporting/Reports/ | Property Removed | 15.0.0 | AllowQuery has been removed from Report | Report | AllowQuery | |
Reports | GetAll | Get | Reporting/Reports/ | Property Changed | 15.0.0 | AllowSchedule has changed from String to Boolean | Report | String | Boolean |
Reports | GetAll | Get | Reporting/Reports/ | Property Removed | 15.0.0 | ApplicationId has been removed from Report | Report | ApplicationId | |
Reports | GetAll | Get | Reporting/Reports/ | Property Removed | 15.0.0 | ImpWinInd has been removed from Report | Report | ImpWinInd | |
Reports | GetAll | Get | Reporting/Reports/ | Property Removed | 15.0.0 | ImpWinName has been removed from Report | Report | ImpWinName | |
Reports | GetAll | Get | Reporting/Reports/ | Property Removed | 15.0.0 | PsrFile has been removed from Report | Report | PsrFile | |
Reports | GetAll | Get | Reporting/Reports/ | Property Removed | 15.0.0 | PublicFlag has been removed from Report | Report | PublicFlag | |
Reports | GetAll | Get | Reporting/Reports/ | Property Removed | 15.0.0 | QuerystringAppend has been removed from Report | Report | QuerystringAppend | |
Reports | GetAll | Get | Reporting/Reports/ | Property Removed | 15.0.0 | UtilityInd has been removed from Report | Report | UtilityInd | |
Reports | GetAll | Get | Reporting/Reports/ | Property Removed | 15.0.0 | WarningInd has been removed from Report | Report | WarningInd | |
Reports | GetAll | Get | Reporting/Reports/ | Property Added | 15.0.0 | ParameterWindow has been added to Report | Report | Report.ParameterWindow | |
Reports | GetAll | Get | Reporting/Reports/ | Property Added | 15.0.0 | ParameterWindowIndicator has been added to Report | Report | Report.ParameterWindowIndicator | |
Reports | GetAll | Get | Reporting/Reports/ | Property Added | 15.0.0 | PublicIndicator has been added to Report | Report | Report.PublicIndicator | |
Reports | GetAll | Get | Reporting/Reports/ | Property Added | 15.0.0 | ReportPath has been added to Report | Report | Report.ReportPath | |
Reports | GetAll | Get | Reporting/Reports/ | Property Added | 15.0.0 | UtilityIndicator has been added to Report | Report | Report.UtilityIndicator | |
Reports | GetAll | Get | Reporting/Reports/ | Property Added | 15.0.0 | WarningIndicator has been added to Report | Report | Report.WarningIndicator | |
Reports | GetCustomData | Get | Reporting/Reports/CustomData | Operation Added | 15.0.0 | GetCustomData has been added. | GetCustomData | ||
Reports | GetParameterValues | Post | Reporting/Reports/ParameterValues | Operation Added | 15.0.0 | GetParameterValues has been added. | GetParameterValues | ||
Reports | GetReportParameters | Get | Reporting/Reports/Parameters | Property Changed | 15.0.0 | EndOfDay has changed from String to Boolean | ReportParameter | String | Boolean |
Reports | GetReportParameters | Get | Reporting/Reports/Parameters | Property Added | 15.0.0 | IsDependentOnOtherParameters has been added to ReportParameter | ReportParameter | ReportParameter.IsDependentOnOtherParameters | |
ReportSchedules | CalculateNextRun | Post | Reporting/ReportSchedules/CalculateNextRun | Resource Added | 15.0.0 | New resource added. | ReportSchedules | ||
ReportSchedules | Get | Get | Reporting/ReportSchedules/{id} | Property Added | 15.1.0 | AsOfDateTime has been added to ReportSchedule | ReportSchedule | ReportSchedule.AsOfDateTime | |
ReportSchedules | Get | Get | Reporting/ReportSchedules/{id} | Resource Added | 15.0.0 | New resource added. | ReportSchedules | ||
ReportSchedules | GetAll | Get | Reporting/ReportSchedules/ | Property Added | 15.1.0 | AsOfDateTime has been added to ReportSchedule | ReportSchedule | ReportSchedule.AsOfDateTime | |
ReportSchedules | GetAll | Get | Reporting/ReportSchedules/ | Resource Added | 15.0.0 | New resource added. | ReportSchedules | ||
ReportSchedules | Save | Post | Reporting/ReportSchedules/ | Property Added | 15.1.0 | AsOfDateTime has been added to ReportSchedule | ReportSchedule | ReportSchedule.AsOfDateTime | |
ReportSchedules | Save | Post | Reporting/ReportSchedules/ | Property Added | 15.1.0 | AsOfDateTime has been added to ReportSchedule | ReportSchedule | ReportSchedule.AsOfDateTime | |
ReportSchedules | Save | Post | Reporting/ReportSchedules/ | Resource Added | 15.0.0 | New resource added. | ReportSchedules | ||
ReportSchedules | Update | Put | Reporting/ReportSchedules/{id} | Property Added | 15.1.0 | AsOfDateTime has been added to ReportSchedule | ReportSchedule | ReportSchedule.AsOfDateTime | |
ReportSchedules | Update | Put | Reporting/ReportSchedules/{id} | Property Added | 15.1.0 | AsOfDateTime has been added to ReportSchedule | ReportSchedule | ReportSchedule.AsOfDateTime | |
ReportSchedules | Update | Put | Reporting/ReportSchedules/{id} | Resource Added | 15.0.0 | New resource added. | ReportSchedules |