Get batch job task

get https://{host}/platform/batch/v1/jobs/{jobId}/tasks/{taskId}

Gets the specified task by batch job.

Every batch job may consist of multiple tasks that are linked together into a user-defined workflow. These tasks are performed in order according to rules specified in request body of the batch job. Each task in the user-defined workflow is identified by a system-defined task ID.

Responses

Response body

object

taskId

string

ID of task.

guid

string

Unique ID of task.

jobId

string

ID of batch job.

status

string

Status of batch task.

submittedAt

string

Date task was submitted in ISO 8601 format, e.g. 2020-01-01T00:00:00.000Z

createdAt

string

Date task was created in ISO 8601 format, e.g. 2020-01-01T00:00:00.000Z

name

string

Name of task.

percentComplete

int32

Percent of task completed.

priorTaskGuids

array of strings

List of tasks to perform prior to this task.

priorTaskGuids

output

object

Has additional fields

subTasks

array of objects

subTasks

object

subTaskId

string

ID of task.

guid

string

Unique ID of task.

jobId

string

ID of batch job.

status

string

Status of batch task.

submittedAt

string

Date task was submitted in ISO 8601 format, e.g. 2020-01-01T00:00:00.000Z

createdAt

string

Date task was created in ISO 8601 format, e.g. 2020-01-01T00:00:00.000Z

name

string

Name of task.

percentComplete

int32

Percent of task completed.

priorTaskGuids

array of strings

List of tasks to perform prior to this task.

priorTaskGuids

output

object

Has additional fields

Language

Credentials

URL

Request


xxxxxxxxxx
1
No JSON body


xxxxxxxxxx
30
}
1
{
2
  "taskId": "string",
3
  "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4
  "jobId": 67,
5
  "status": "string",
6
  "submittedAt": "string",
7
  "createdAt": "string",
8
  "name": "string",
9
  "percentComplete": 0,
10
  "priorTaskGuids": [
11
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
12
  ],
13
  "output": {},
14
  "subTasks": [
15
    {
16
      "subTaskId": "string",
17
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
18
      "jobId": 67,
19
      "status": "string",
20
      "submittedAt": "string",
21
      "createdAt": "string",
22
      "name": "string",
23
      "percentComplete": 0,
24
      "priorTaskGuids": [
25
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"

200Success

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error