Manage

List bulk processes

Returns a paginated list of bulk processes for the logged-in identity. Use the status query parameter to inspect processes at a particular stage of execution.

Read The bulk process for the bulk lifecycle and the operations available in each state.

get/bulks

Request

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

Query parameters

offsetinteger

The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results.

limitinteger
Example:25

The limit of the results for paging, starting at the offset. Limit is always capped at 100.

status'SUBMITTED' | 'RUNNING' | 'PARTIALLY_COMPLETED' | 'COMPLETED' | 'FAILED' | 'PAUSED' | 'CANCELLED'

The current status of the bulk process:

  • SUBMITTED: The bulk process data has been persisted and is ready for execution. This is the initial state.
  • RUNNING: The bulk process is currently being executed.
  • PARTIALLY_COMPLETED: Execution is complete, but some bulk operations failed. This is a final state.
  • COMPLETED: Execution is complete, and all bulk operations succeeded. This is a final state.
  • FAILED: No operations in the bulk process were executed. This is a final state.
  • PAUSED: Execution has been paused and can be resumed.
  • CANCELLED: Execution has been canceled. This is a final state.

Filter by the bulk process status.

Response

Success

countinteger

Total number of records (excluding limit)

responseCountinteger

Total number of records returned in this response

Example response

{
  "count": 42,
  "bulkProcesses": [
    {
      "bulkId": "123456789",
      "status": "COMPLETED",
      "submittedItemsCount": 100,
      "executionStart": 1786118400000,
      "executionFinish": 1786118405000,
      "operation": "/multi/managed_cards"
    }
  ],
  "responseCount": 10
}

Changes

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