Get Batch Job Items

Retrieve a list of all batch job items. Query for items of a specific processing status and/or resource by appending ?processingStatus=&resourceType=. Resource type can be Products, ProductProperty, or Pricelistentries.

POST /platform/data/batchJob/actions/{code}/items

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    {
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "batchJobCode": "<string>",
      "catalogId": 123,
      "correlationId": "<string>",
      "currencyCode": "<string>",
      "errors": [
        {
          "code": "<string>",
          "field": "<string>",
          "itemKeys": [
            {
              "key": "<string>",
              "value": "<string>"
            }
          ],
          "longMessage": "<string>",
          "message": "<string>",
          "subErrors": "<array>"
        }
      ],
      "httpMethod": "<string>",
      "itemKey": "<string>",
      "localeCode": "<string>",
      "masterCatalog": 123,
      "query": "<string>",
      "resourceType": "<string>",
      "retryCount": 123,
      "siteId": 123,
      "status": 123,
      "uri": "<string>"
    }
  ],
  "pageCount": 123,
  "pageSize": 123,
  "startIndex": 123,
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

code · string · required

Query Parameters

pageSize · integer<int32>

startIndex · integer<int32>

includeCount · boolean

processingStatus · string

resourceType · string

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>