Task_executions

(By task) Lists all task executions.

get

API Key Scope: task_executions / index

Authorizations

Path parameters

task_idstringRequired

Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

sort_bystring[]Optional

Sort results by attribute.

Can sort on multiple attributes, separated by |. Order direction can be suffixing the attribute by either :asc (default) or :desc.

idstringOptional

Filter on id

namestringOptional

Filter on name

workflow_typestringOptional

Filter on task workflow type

workflow_actionstringOptional

Filter on task workflow action

source_typestringOptional

Filter on task source type

destination_typestringOptional

Filter on task destination type

statusstringOptional

Filter on status

log_timestringOptional

Filter on log time

job_startedstringOptional

Filter on job started

job_finishedstringOptional

Filter on job finished

to_process_sizestringOptional

Filter on to process size

processed_sizestringOptional

Filter on processed size

to_process_filesstringOptional

Filter on to process files

processed_filesstringOptional

Filter on processed files

finalized_filesstringOptional

Filter on finalized files

estimation_timestringOptional

Filter on estimation time

bandwidthstringOptional

Filter on bandwidth

Responses

200

List of task executions.

application/json

get

/tasks/{task_id}/task_executions

GET /api/v2/tasks/{task_id}/task_executions HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of task executions.

{
  "count": 1,
  "task_executions": [
    {
      "id": "1542797273225418555",
      "task_id": 1,
      "name": "text",
      "workflow_type": "active_archive",
      "workflow_action": "copy",
      "source_type": "container",
      "destination_type": "container",
      "status": "finished_with_warnings",
      "progress": 1,
      "log_time": "2018-11-21T09:48:09.000Z",
      "job_started": "2018-11-21T10:47:53.000Z",
      "job_finished": "2018-11-21T10:48:08.000Z",
      "to_process_size": 16515610,
      "processed_size": 12115125,
      "to_process_files": 126,
      "processed_files": 113,
      "finalized_files": 126,
      "estimation_time": 1,
      "bandwidth": 1
    }
  ]
}

Lists all task executions.

get

API Key Scope: task_executions / index

Authorizations

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

sort_bystring[]Optional

Sort results by attribute.

Can sort on multiple attributes, separated by |. Order direction can be suffixing the attribute by either :asc (default) or :desc.

complete_listbooleanOptional

If false, only includes the last correct execution of a task.

Default: true

idstringOptional

Filter on id

task_idstringOptional

Filter on task id

namestringOptional

Filter on name

workflow_typestringOptional

Filter on task workflow type

workflow_actionstringOptional

Filter on task workflow action

source_typestringOptional

Filter on task source type

destination_typestringOptional

Filter on task destination type

statusstringOptional

Filter on status

log_timestringOptional

Filter on log time

job_startedstringOptional

Filter on job started

job_finishedstringOptional

Filter on job finished

creation_datestringOptional

Filter on creation date

modification_datestringOptional

Filter on modification date

to_process_sizestringOptional

Filter on to process size

processed_sizestringOptional

Filter on processed size

to_process_filesstringOptional

Filter on to process files

processed_filesstringOptional

Filter on processed files

finalized_filesstringOptional

Filter on finalized files

estimation_timestringOptional

Filter on estimation time

bandwidthstringOptional

Filter on bandwidth

Responses

200

List of task executions.

application/json

get

/task_executions

GET /api/v2/task_executions HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of task executions.

{
  "count": 1,
  "task_executions": [
    {
      "id": "1542797273225418555",
      "task_id": 1,
      "name": "text",
      "workflow_type": "active_archive",
      "workflow_action": "copy",
      "source_type": "container",
      "destination_type": "container",
      "status": "finished_with_warnings",
      "progress": 1,
      "log_time": "2018-11-21T09:48:09.000Z",
      "job_started": "2018-11-21T10:47:53.000Z",
      "job_finished": "2018-11-21T10:48:08.000Z",
      "to_process_size": 16515610,
      "processed_size": 12115125,
      "to_process_files": 126,
      "processed_files": 113,
      "finalized_files": 126,
      "estimation_time": 1,
      "bandwidth": 1
    }
  ]
}

Displays a specific task execution.

get

API Key Scope: task_executions / show

Authorizations

Path parameters

task_execution_idstringRequired

Numeric ID of task execution.

Responses

200

A specific task execution.

application/json

404

The requested resource was not found. The detailed error will be of type not_found.

application/json

get

/task_executions/{task_execution_id}

GET /api/v2/task_executions/{task_execution_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

{
  "id": "1542797273225418555",
  "task_id": 1,
  "name": "text",
  "workflow_type": "active_archive",
  "workflow_action": "copy",
  "source_type": "container",
  "destination_type": "container",
  "status": "finished_with_warnings",
  "progress": 1,
  "log_time": "2018-11-21T09:48:09.000Z",
  "job_started": "2018-11-21T10:47:53.000Z",
  "job_finished": "2018-11-21T10:48:08.000Z",
  "to_process_size": 16515610,
  "processed_size": 12115125,
  "to_process_files": 126,
  "processed_files": 113,
  "finalized_files": 126,
  "estimation_time": 1,
  "bandwidth": 1
}

Last updated 1 day ago

Was this helpful?