ChangeSummaryListReportResponse

Used to encapsulate a response for any of the reports.
See the Introduction Guide for Reports for more details

Name / Description Type / Format Example
type
The content-type, this would usually be the same as the accept header you provided when you requested the report
string "string"
content
This could contain a link to a PDF file, HTML content or other content, depending on the Type value.
string "string"
model
If the type is application.json then this will contain a JSON representation of the relevant model
ChangeSummary[] {ChangeSummary}
stream
byte array
string byte "string"
{
  "type": "string",
  "content": "string",
  "model": [
    {
      "id": "string",
      "auditId": "string",
      "previousAuditId": "string",
      "date": "2024-12-05",
      "name": "string",
      "actionPerformed": "Added",
      "entityType": "None",
      "entityId": "string",
      "employeeUniqueId": "string",
      "employerUniqueId": "string",
      "actionPerformedBy": "string",
      "actionPerformedOn": "string",
      "employeeFirstName": "string",
      "employeeLastName": "string",
      "uniqueId": "string",
      "parentEventType": "string",
      "displayName": "string",
      "payRunPeriod": 0,
      "changeType": "string",
      "modifications": [
        {
          "fieldName": "string",
          "isSignificant": true,
          "oldValue": "string",
          "newValue": "string"
        }
      ]
    }
  ],
  "stream": "string"
}
Contained in Models

- none -

Consumed by Operations

- none -