Update multiple executions in a single request
request
POST
/v1/executions/batch-update
Batch update multiple executions
Batch update multiple executions. Allows updating custom labels for multiple executions in a single API call.
Security
API Key
Header parameter name
The API key to use for authentication.
orby-api-key
Header parameters
orby-org-id string Required
The organization id to handle execution requests for.
Body parameters
Expand All
object
executions Array of object Required
List of executions to update
List of executions to update. Limited to 100 executions per request.
object
id string
The unique identifier of the execution
customLabels Array of string
The custom labels to update
The custom labels to update. Maximum 255 characters per label.
string
updateMask string Required
Fields to update for all executions
The custom labels to update. Maximum 255 characters per label.
Responses
200
A successful response.
Expand All
object
results Array of object (v1BatchUpdateResult)
Results for each execution update attempt.
object
execution object (v1Execution)
id string
Unique identifier of the execution.
name string
Name of the execution.
workflowId string
Unique identifier of the workflow
Unique identifier of the workflow associated with the execution.
workflowName string
Name of the workflow
Name of the workflow associated with the execution.
status string
Output only.
VALID VALUE S | [ "\"STATUS_UNSPECIFIED\"", "\"SCHEDULED\"", "\"BLOCKED\"", "\"EXECUTING\"", "\"PENDING_REVIEW\"", "\"COMPLETED\"", "\"FAILED\"", "\"CANCELLED\"" ] | ||
|---|---|---|---|
DEFAULT | "STATUS_UNSPECIFIED" |
error object (v1ExecutionError)
type string
Type of error
Type of the error, e.g. 'LOW_DOCUMENT_CLASSIFICATION_SCORE', 'LARGE_DOCUMENT_SIZE', 'FAILED_AFTER_ACCEPTED', 'UNMATCHED_CLASSIFICATION', 'FAILED_EXECUTION_ENGINE', 'INVALID_DOCUMENT_MIME_TYPE', 'NO_AVAILABLE_USERS', 'MAX_WORKFLOW_LIMIT_REACHED', 'FAILED_TO_CREATE_TASK', 'FILE_DECRYPTION_FAILED', 'WRONG_FILE_FORMAT', 'USER_CANCELLED_EXECUTION'.
details string
Details of the error.
sourceExecutionId string
The unique identifier of the source execution that triggers the current execution.
followingUpExecutionIds Array of string
The unique identifiers of the following up executions from the current execution.
string
warnings Array of object (v1ExecutionWarning)
The warnings generated during the execution of few shot workflow
object
type string
Type of the warning, e.g. 'WARNING_LLM_OUTPUT_TOKEN_LIMIT_EXCEEDED'.
details string
The detailed description of the warning.
customLabels Array of string
Custom labels for the execution. Max 255 characters per label. Label can only contain alphanumeric characters, underscores, and hyphens.
string
error string
Error message if the update failed for this execution.
Bad Request. The request is invalid. Please check the request body and try again.
400
{ "code": 0, "message": "string" }
EXAMPLE
Unauthorized. Please check if your API key and organization id are correct.
401
{ "code": 0, "message": "string" }
EXAMPLE
Not Found. The resource you are trying to access does not exist.
404
{ "code": 0, "message": "string" }
EXAMPLE
Rate Limit Exceeded. Please try again later.
429
Internal Server Error. Please try again later or contact Orby support if the issue persists.
500
{ "code": 0, "message": "string" }
EXAMPLE