Skip to main content
GET
/
sources
/
{sourceKey}
/
v1
/
tasks
/
{taskId}
Get a task from the registry
curl --request GET \
  --url https://{workspaceId}.clinia.cloud/sources/{sourceKey}/v1/tasks/{taskId} \
  --header 'X-Clinia-API-Key: <api-key>'
{
  "status": "SUCCESS",
  "taskId": "<string>",
  "receipts": [
    {
      "receivedAt": "2023-11-07T05:31:56Z",
      "taskId": "<string>",
      "action": "CREATE",
      "status": "SUCCESS",
      "targetType": "RELATIONSHIP",
      "id": "<string>",
      "type": "<string>",
      "completedAt": "2023-11-07T05:31:56Z",
      "error": {
        "code": 400,
        "message": "<string>",
        "type": "ALREADY_EXISTS",
        "details": "<array>"
      },
      "pipelineExecution": {
        "id": "<string>",
        "pipelineDefinitionId": "<string>",
        "status": "SUCCESSFUL"
      }
    }
  ]
}

Authorizations

​
X-Clinia-API-Key
string
header
required

Path Parameters

​
sourceKey
string
required

The source key.

​
taskId
string
required

The task id. The task identifier. Used to track an async task in the system. Use the task ID to poll for completion status. The taskId holds different prefix to represent different tasks.

  • oneOf task: s_<id>.
  • bulk task: bk_<id> (deprecated: <id> only).
  • bundle task: bd_<id> (deprecated: <id> only).
  • purge task: pg_<id> (deprecated: purge:<id>).

Query Parameters

​
withReceipts
boolean
default:false

If set to true, the operation receipts of the task will be included in the response. Else only the status of the task will be returned.

Response

The task with the given id.

​
status
enum<string>
required

Status of the task.

  • SUCCESS: All the operations of the task completed successfully.
  • PENDING: At least one operation in the task is still pending.
  • CANCELLED: All the operations in the task were cancelled.
  • FAILURE: At least one operations failed or was cancelled.
Available options:
SUCCESS,
PENDING,
CANCELLED,
FAILURE
​
taskId
string
required

The task identifier. Used to track an async task in the system. Use the task ID to poll for completion status. The taskId holds different prefix to represent different tasks.

  • oneOf task: s_<id>.
  • bulk task: bk_<id> (deprecated: <id> only).
  • bundle task: bd_<id> (deprecated: <id> only).
  • purge task: pg_<id> (deprecated: purge:<id>).
​
receipts
object[]
  • Option 1
  • Option 2
  • Option 3