Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /config/extension_management/extensions_task_status/{status_id}

Retrieves the tasks status based on the status_id.

Retrieves the tasks status based on the status_id.

Table 1: GET /config/extension_management/extensions_task_status/{status_id} Resource Details

MIME Type

application/json

Table 2: GET /config/extension_management/extensions_task_status/{status_id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

status_id

path

Required

Number (Integer)

text/plain

Required - the id of the task status.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3: GET /config/extension_management/extensions_task_status/{status_id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The requested task status has been retrieved.

404

22604

The task status for status_id cannot be found.

422

22606

A supplied numeric parameter was not positive.

500

22602

An error has occurred while trying to retrieve the task status.

Response Description

A task status containing the following fields:

  • id - Number - The ID of the task status.

  • name - String - The name of the task status.

  • status - String - A string that represents the current state of the task status.

  • message - String - A message regarding the current state of the task.

  • progress - Number - The current progress of the task

  • minimum - Number - The minimum progress of the task.

  • maximum - Number - The maximum progress of the task.

  • created_by - String - The username of the user who created the task.

  • cancelled_by - String - The username of the user who cancelled the task.

  • created - Number - The date/time at which this task was created, represented as number of milliseconds since Unix epoch.

  • started - Number - The date/time at which this task was started, represented as number of milliseconds since Unix epoch.

  • modified - Number - The date/time at which this task was last modified, represented as number of milliseconds since Unix epoch.

  • completed - Number - The date/time at which this task was completed, represented as number of milliseconds since Unix epoch.

  • result_url - String - The url where the result can be viewed.

  • cancel_requested - Boolean - True if cancel has been requested.

  • child_tasks - Array - Array of child task id's that are executed asynchronously from this task.

  • task_components - Array - Array of task components that are executed sequentially.

Response Sample