Batch Operations

Sample Request

GET /v1/batch-operations/ed95fa34-8d8d-473f-921d-ae408c924875/status

Sample Response

(Success - 200 OK)

{
  "processorResult": "SuccessWithValidationErrors",
  "errorReason": "None",
  "validationErrorCount": 10,
  "batchRequestId": "ed95fa34-8d8d-473f-921d-ae408c924875",
  "taskId": "0620a281-57ea-4291-9121-ce0cd35f9764-BatchHost-07c3c1a-d272-453f",
  "status": "T",
  "controllerClass": "AttributeRelationBatch",
  "methodName": "CreateBatch",
  "description": "",
  "processedSize": 3405,
  "payloadSize": 3405,
  "processedPage": 1,
  "processedItems": 10,
  "lastUpdated": {
    "updatedAt": "2026-06-05T07:59:47.000",
    "updatedBy": "SYSEN"
  },
  "errorMessage": ""
}

Path Parameters

The following parameters are required in the URL path:

Limits & Notes

• Use this endpoint to quickly check whether your batch is still waiting, running, finished, failed, or cancelled.
• Query it every 10 to 30 seconds while the batch is in progress; once the status is final, you can stop checking.
• A batch with status T (Success) may still contain some validation issues, so always review validationErrorCount.
• If the batch ends with E (Error), check errorReason and errorMessage to understand the failure.
• If the batch ends with C (Cancelled), processing stopped before completion and only partial results may exist.
• The response is most useful for progress tracking, while detailed success or error records should be retrieved from the results endpoint.

Status Codes for This Endpoint

When you call this endpoint, the batch will be in one of these states:

• N (Pending) — your batch was submitted but has not started processing yet. The system is preparing it. Query again in a few seconds to see progress.
• W (Working) — your batch is actively being processed right now. Check processedItems (how many items done) and validationErrorCount (errors so far) to track progress. These numbers will increase with each query.
• T (Success) — processing is complete. Important: status = T does NOT mean zero errors. Always check validationErrorCount. If > 0, some items had validation issues but were still processed. Download error records via GET /v1/batch-operations/{batchRequestId}/results?type=error to see which items failed validation.
• E (Error) — processing failed. Check errorReason and errorMessage for the failure reason. This is a critical error, not individual item validation errors.
• C (Cancelled) — batch was cancelled (by you or the system). Processing stopped early. Partial results may be available via GET /results.
• K (Cancelling) — batch is in the process of being cancelled. This is temporary, status will change to C within seconds.

Validation Rules for GET Method (Status)

Sample Request

GET /v1/batch-operations/ed95fa34-8d8d-473f-921d-ae408c924875/results?type=success

Sample Response

(Success - 200 OK)

[
  {
    "index": 0,
    "item": {
      "attributeName": "MGA81",
      "attributeId": "M81",
      "attributeValue": "M81_004001",
      "companyId": "EN",
      "relationDateFrom": "0001-01-01T00:00:00",
      "relationDateTo": "0001-01-01T00:00:00",
      "percent": 100.0,
      "relatedAttributeName": "MGA82",
      "relatedAttributeId": "M82",
      "relationValue": "M82_004001",
      "relationValueStatus": "N",
      "notificationMessages": {
        "_objectMessages": [
          {
            "code": 3010,
            "message": "The entity of the following parameters [Company : EN, Attribute ID : M81, Attribute value : M81_004001] was not found."
          }
        ]
      }
    }
  }
]

Limits & Notes

• This endpoint is for final output retrieval, so call it after status becomes a final state (T, E, or C).
• Use type=error for failed or invalid records and type=success for successfully processed records.
• If the batch is still running, the API can return 202 Accepted; continue polling status and retry later.
• A successful response (200) confirms result availability, not business correctness of every record.

Validation Rules for GET Method (Results)

Sample Request

POST /v1/batch-operations/159f2879-c6b7-4cbc-b42a-c89d11d342f1/cancel

Sample Response

(Success - 200 OK)

{
  "batchRequestId": "159f2879-c6b7-4cbc-b42a-c89d11d342f1",
  "status": "C",
  "processorResult": "CANCELLED",
  "errorReason": "User Request",
  "errorMessage": ""
}

Limits & Notes

• Use this endpoint when you decide a running batch should stop, for example due to wrong input data or changed priorities.
• Cancellation is asynchronous: first response confirms the request, while final status may briefly show the status K before becoming C.
• Cancel works best for jobs in status N or W; already finished jobs (T, E, C) will not be reprocessed by cancel.
• Always verify final status through the status endpoint after requesting cancel.
• Keep the batchRequestId for audit and support tracking of who cancelled and when.

Validation Rules for POST Method (Cancel)