Skip to content

Get all bulk processes

Request

Filter bulk processes.

Security
auth_token and api-key
Query
offsetinteger, (int32), >= 0

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, (int32), [ 1 .. 100 ]

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

statusstring(BulkProcessStatus)
Enum:"SUBMITTED""RUNNING""PARTIALLY_COMPLETED""COMPLETED""FAILED""PAUSED""CANCELLED"
curl -i -X GET \
  'https://sandbox.weavr.io/multi/bulks?offset=0&limit=1&status=SUBMITTED' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'api-key: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
countinteger, (int32)

Total number of records (excluding limit)

bulkProcessesArray of objects(BulkProcess)
responseCountinteger, (int32)

Total number of records returned in this response

Response
{ "count": 0, "bulkProcesses": [ {} ], "responseCount": 0 }