ClickHelp User Manual

[API] Get Project Management Task Status

Returns a status of a project management task. Once the job finishes, the server will wait for you to retrieve the status, after which the task object is terminated — i.e., you'll get 404 for every subsequent requests for the same finished task.

GET tasks/{task-key}

Authentication

This request requires basic authentication.

Request Parameters

Path params

task-key	string	The key of the task to get the status of.

Samples

Request sample

Copy Code

Bash (Unix Shell)

curl --location -g --request GET 'https://{portal-url}/api/v1/tasks/651db92f08d64dbd86b48c92d2aaf668'

Response body sample

Copy Code

JSON

{
    "isSucceeded": true,
    "isWorking": false,
    "maxOverallProgress": 100,
    "overallProgress": 100,
    "statusText": "Export finished.",
    "taskName": "Exporting Publication"
}

Response fields

isSucceeded	Whether the task has been completed successfully or not. If the task is not yet completed, returns null.
isWorking	Whether or not the task is still in progress.
maxOverallProgress	The maximum value of task progress value.
overallProgress	The current task progress. Together with the maxOverallProgress, can be used to calculate the percentage of task completion.
statusText	The name of the current task status.
taskName	The task name.

[API] Export Publication [API] Create Project Backup