Skip to main content

Task

The Task API allows the user to access task information.

Security

jwt-bearer-token

apiKey

API Key

Name

Authorization

In

header

Endpoint

GET /task/{id}

Summary

Get the task information by task_id.

Request Parameters

In

Field Name

Type

Required

Description

header

X-COMPANY-ID

string

Yes

The identifier (ID) of the company that owns the document

path

id

string

Yes

The task ID

Responses

Code

Description

Schema

200

Success

task_get_response_1

400

Bad request, for more information look at body error

401

Unauthorized error

403

Forbidden error

404

Not Found

422

Unprocessable error

500

Internal Server Error

Data Model

task_get_response_1

Field Name

Type

Description

_id

string

objectId, the task's identifier (ID)

company_id

string

objectId, the company's ID

type

string

The transfer-dm-sync type

status

string

The transfer-dm-sync status including pending, running, failed, and completed

error_message

string

The transfer-dm-sync error message

value

string

The current transfer information including transfer_id and is_acknowledge

sub_tasks

array object

The subtasks of the current task