Get Batch Job Summaries

Retrieves a list of all batch job summaries

GET /platform/data/batchJob/actions/summaries

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    {
      "code": "<string>",
      "dateStarted": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "resources": [
        {
          "counts": [
            {
              "count": 123
            }
          ],
          "resourceType": "<string>"
        }
      ],
      "scheduledDate": "2023-11-07T05:31:56Z"
    }
  ],
  "pageCount": 123,
  "pageSize": 123,
  "startIndex": 123,
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

domain · string

pageSize · integer<int32>

startIndex · integer<int32>

status · string

includeCount · boolean

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

Success

items · object[] | null

Show child attributes

pageCount · integer<int32>

pageSize · integer<int32>

startIndex · integer<int32>

totalCount · integer<int32>