Weavr
Powered by Redocly

Manage

Get all bulk processes

Filter bulk processes.

Request
query Parameters
offset
integer <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.

limit
integer <int32> [ 1 .. 100 ]

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

status
string (BulkProcessStatus)
Enum: "SUBMITTED" "RUNNING" "PARTIALLY_COMPLETED" "COMPLETED" "FAILED" "PAUSED" "CANCELLED"
Responses
200

Success

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

404

Not found - The requested resource couldn't be found.

409

BulkProcessorConflict - bulk processor conflict.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

get/bulks
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "bulk_processes": [
    ],
  • "responseCount": 0
}
Get bulk process
Retrieves details on the bulk process identified by the bulk_id parameter.


Securityauth_token and api_key 
Request 
path Parameters
bulk_id
required
string (BulkId) ^[0-9]+$
The bulk id of the bulk process.


 
Responses 
200
Success


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


403
Forbidden - Access to the requested resource or action is forbidden.


404
Not found - The requested resource couldn't be found.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


get/bulks/{bulk_id}
Request samples 
Response samples 
application/json
{
  • "bulkId": "string",
  • "status": "string",
  • "submittedItemsCount": 0
}
Get all operations in a bulk
Retrieves the bulk process operations that match the query parameters.


Securityauth_token and api_key 
Request 
path Parameters
bulk_id
required
string (BulkId) ^[0-9]+$
The bulk id of the bulk process.


 
query Parameters
offset
integer <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.


 
limit
integer <int32>   [ 1 .. 100 ] 
The limit of the results for paging, starting at the offset. Limit is always capped at 100.


 
sequence
integer <int64> 
 
status
string (BulkProcessOperationStatus) 
 Enum: "SUBMITTED" "RUNNING" "COMPLETED" "FAILED" "CANCELLED"  
Responses 
200
Success


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


403
Forbidden - Access to the requested resource or action is forbidden.


404
Not found - The requested resource couldn't be found.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


get/bulks/{bulk_id}/operations
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "operations": [
    ],
  • "responseCount": 0
}
Execute bulk process
Launches execution of operations of any bulk process identified by the bulk_id  parameter.


The status of the bulk process has to be in a ‘SUBMITTED’ state and after execution initiates, the bulk process state is set to ‘RUNNING’.


The final state of execution can be any of


COMPLETED: the execution of the bulk process is complete and all bulk operations of the bulk process were executed successfully


FAILED:  none of the operations of the bulk process have executed.


PARTIALLY_COMPLETED: the execution of the bulk process is complete and some of the bulk operations of the bulk process failed.


This operation is asynchronous and will return immediately. You can track the status of the execution of the bulk process through Get bulk process. You can also pause execution through bulkIdPause


Securityauth_token and api_key 
Request 
path Parameters
bulk_id
required
string (BulkId) ^[0-9]+$
The bulk id of the bulk process.


 
Request Body schema: application/json
required
mode
string (BulkProcessMode) 
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.


 Enum: "ON_FAILURE_STOP" "ON_FAILURE_CONTINUE"  
Responses 
204
Success - No Content.


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


403
Forbidden - Access to the requested resource or action is forbidden.


404
Not found - The requested resource couldn't be found.


409
BulkProcessorConflict - bulk processor conflict.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


post/bulks/{bulk_id}/execute
Request samples 
application/json
{
  • "mode": "ON_FAILURE_STOP"
}
Response samples 
application/json
{
  • "message": "string",
  • "syntaxErrors": {
    }
}
Pause bulk process
Pauses the execution of operations of the bulk process that is in state ‘RUNNING’ as identified by the bulk_id  parameter.


The status of the bulk process after execution of this operation is set to ‘PAUSED’


The execution can be resumed through bulkIdResume


Securityauth_token and api_key 
Request 
path Parameters
bulk_id
required
string (BulkId) ^[0-9]+$
The bulk id of the bulk process.


 
Responses 
204
Success - No Content.


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


403
Forbidden - Access to the requested resource or action is forbidden.


404
Not found - The requested resource couldn't be found.


409
BulkProcessorConflict - bulk processor conflict.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


post/bulks/{bulk_id}/pause
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "syntaxErrors": {
    }
}
Resume bulk process
Resumes the execution of operations of the bulk process that is in state ' PAUSED' as identified by the bulk_id parameter.


The status of the bulk process after execution of this operation is set back to ‘RUNNING’


Securityauth_token and api_key 
Request 
path Parameters
bulk_id
required
string (BulkId) ^[0-9]+$
The bulk id of the bulk process.


 
Responses 
204
Success - No Content.


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


403
Forbidden - Access to the requested resource or action is forbidden.


404
Not found - The requested resource couldn't be found.


409
BulkProcessorConflict - bulk processor conflict.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


post/bulks/{bulk_id}/resume
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "syntaxErrors": {
    }
}
Cancel bulk process
Cancels the execution of operations of a bulk process that is in state ‘PAUSED’ or ‘RUNNING’ as identified by the bulk_id parameter.


The status of the bulk process after execution of this operation is set  to ‘CANCELLED’. This is a final state and a cancelled bulk process cannot be resumed.


Securityauth_token and api_key 
Request 
path Parameters
bulk_id
required
string (BulkId) ^[0-9]+$
The bulk id of the bulk process.


 
Responses 
204
Success - No Content.


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


403
Forbidden - Access to the requested resource or action is forbidden.


404
Not found - The requested resource couldn't be found.


409
BulkProcessorConflict - bulk processor conflict.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


post/bulks/{bulk_id}/cancel
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "syntaxErrors": {
    }
}