Manage

Get bulk process

Retrieves the bulk process identified by the bulk_id parameter.

Use this to poll a process after executing it, since execution is asynchronous. status reports where the run is: SUBMITTED before execution, RUNNING or PAUSED during it, and COMPLETED, PARTIALLY_COMPLETED, FAILED, or CANCELLED once it settles. The response also carries the counts of submitted, successful, and failed operations.

When a run ends PARTIALLY_COMPLETED or FAILED, use List bulk operations filtered on status to find the individual operations that failed.

get/bulks/{bulk_id}

Request

  • Base URL: https://sandbox.weavr.io/multi
  • URL: https://sandbox.weavr.io/multi/bulks/{bulk_id}
  • Auth: HTTP bearer and API key in header api-key

Path parameters

bulk_idstring required
Example:2468013579

The bulk id of the bulk process.

Response

Success

bulkIdstring

The bulk id of the bulk process

statusstring

SUBMITTED: the data for the bulk process operations has been persisted and bulk process is ready for execution. A bulk process in this status can be executed or submitted. This is the initial state for a bulk process

RUNNING : the bulk process is currently being executed by the system

COMPLETED : the execution of the bulk process is complete and all bulk operations of the bulk process were executed successfully. This is a final state for the bulk process

PARTIALLY_COMPLETED the execution of the bulk process is complete and some of the bulk operations of the bulk process failed. This is a final state for the bulk process

FAILED : none of the operations of the bulk process have executed. This is a final state for the bulk process

PAUSED : the execution of bulk process has been paused through the Pause bulk process operation Execution can be resumed through Resume bulk operation

CANCELLED : the execution of bulk process has been canceled through Cancel bulk operation. This is a final state for the bulk process

submittedItemsCountinteger

The number of bulk operations in the bulk process

executionStartinteger

Timestamp of when the execution of the Bulk Process started

executionFinishinteger

Timestamp of when the execution of the Bulk Process finished.

operationstring

The underlying operations contained within the Bulk; shown as the endpoint for the equivalent single operation.

mode'ON_FAILURE_STOP' | 'ON_FAILURE_CONTINUE'

ON_FAILURE_STOP : the execution of the bulk process stops after the first bulk operation that fails (operation returns a 4xx or 5xx response code). ON_FAILURE_CONTINUE: the execution of the bulk process resumes as normal even when any of the bulk operations fail.

Example response

{
  "bulkId": "123456789",
  "status": "COMPLETED",
  "submittedItemsCount": 100,
  "executionStart": 1786118400000,
  "executionFinish": 1786118405000,
  "operation": "/multi/managed_cards",
  "operationStatusCounts": [
    {
      "count": 25
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.