Tasks
Task execution management
All endpoints require a bearer token (oh_... API key or user JWT) and are served under https://api.orderly-hub.com. Use the Try it consoles to run a request against the Preview (test) server.
Execute a task asynchronously
/api/v1/tasks/executeRequest body
| Field | Type | Description |
|---|---|---|
bridgeId | string | |
taskName | string | |
input | object |
{
"bridgeId": "550e8400-e29b-41d4-a716-446655440000",
"taskName": "string",
"input": {}
}
Responses
202 Task queued
/api/v1/tasks/executeExecute a task asynchronously
https://api-test.orderly-hub.com/api/v1/tasks/executeExecute a task synchronously
/api/v1/tasks/execute-syncRequest body
| Field | Type | Description |
|---|---|---|
bridgeId | string | |
taskName | string | |
input | object |
{
"bridgeId": "550e8400-e29b-41d4-a716-446655440000",
"taskName": "string",
"input": {}
}
Responses
200 Task result
/api/v1/tasks/execute-syncExecute a task synchronously
https://api-test.orderly-hub.com/api/v1/tasks/execute-syncList task executions
/api/v1/tasks/executionsRequires scope bridges:read. Secret fields in input, output and error (API keys, tokens, passwords, client secrets and similar) are returned as "••••••••", and a credentials object as {"masked": true}.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
page | query | no | integer | |
limit | query | no | integer | |
bridgeId | query | no | string | |
status | query | no | string | |
taskName | query | no | string |
Responses
200 Paginated execution list
403 The caller lacks bridges:read
/api/v1/tasks/executionsList task executions
https://api-test.orderly-hub.com/api/v1/tasks/executionsGet task execution details
/api/v1/tasks/executions/{id}Requires scope bridges:read. Secret fields in input, output and error are masked as in listTaskExecutions.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string |
Responses
200 Execution details
403 The caller lacks bridges:read
404 Execution not found
/api/v1/tasks/executions/{id}Get task execution details
https://api-test.orderly-hub.com/api/v1/tasks/executions/Cancel a running task execution
/api/v1/tasks/executions/{id}/cancelParameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string |
Responses
200 Execution cancelled
/api/v1/tasks/executions/{id}/cancelCancel a running task execution
https://api-test.orderly-hub.com/api/v1/tasks/executions//cancelRetry a failed task execution
/api/v1/tasks/executions/{id}/retryParameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string |
Responses
202 Retry queued
/api/v1/tasks/executions/{id}/retryRetry a failed task execution
https://api-test.orderly-hub.com/api/v1/tasks/executions//retry