Get task status by ID.

GET 
/task-status/:id

Get a TaskStatus for a task by task ID.

Request

Path Parameters

id stringrequired
Task ID.
Example: 00eebcf881994e419d72e757fd30dc0e

Responses

200

Responds with a TaskStatus for the task with the given task ID.

application/json

Schema

Schema

id stringrequired

System-generated unique ID of the task this TaskStatus represents

type stringrequired

Possible values: [QUARTZ, QPOC, QUEUED_TASK]

Type of task this TaskStatus represents

uniqueName stringrequired

Name of the task this TaskStatus represents

description stringrequired

Description of the task this TaskStatus represents

parentName stringnullablerequired

Name of the parent of the task this TaskStatus represents

launcher stringrequired

Service to execute the task this TaskStatus represents

target

object

nullable

id string

Target ID

type stringnullable

Possible values: [APPLICATION, IDENTITY, null]

Target type

name string

Target name

created date-timerequired

Creation date of the task this TaskStatus represents

modified date-timerequired

Last modification date of the task this TaskStatus represents

launched date-timenullablerequired

Launch date of the task this TaskStatus represents

completed date-timenullablerequired

Completion date of the task this TaskStatus represents

completionStatus stringnullablerequired

Possible values: [SUCCESS, WARNING, ERROR, TERMINATED, TEMPERROR, null]

Completion status of the task this TaskStatus represents

messages

object[]

required

Messages associated with the task this TaskStatus represents

Array [

type stringrequired

Possible values: [INFO, WARN, ERROR]

Type of the message

localizedText

object

nullable

required

Localized form of the message

locale stringrequired

Message locale

message stringrequired

Message text

key stringrequired

Key of the message

parameters object[]nullablerequired

Message parameters for internationalization

]

returns

object[]

required

Return values from the task this TaskStatus represents

Array [

name stringrequired

Display name of the TaskReturnDetails

attributeName stringrequired

Attribute the TaskReturnDetails is for

]

attributes

object

required

Attributes of the task this TaskStatus represents

property name* any

Attributes of the task this TaskStatus represents

progress stringnullablerequired

Current progress of the task this TaskStatus represents

percentComplete integerrequired

Current percentage completion of the task this TaskStatus represents

taskDefinitionSummary

object

Definition of a type of task, used to invoke tasks

id stringrequired

System-generated unique ID of the TaskDefinition

uniqueName stringrequired

Name of the TaskDefinition

description stringrequired

Description of the TaskDefinition

parentName stringrequired

Name of the parent of the TaskDefinition

executor stringnullablerequired

Executor of the TaskDefinition

arguments

object

required

Formal parameters of the TaskDefinition, without values

property name* any

Formal parameters of the TaskDefinition, without values

Example (from schema)

{
  "id": "id12345",
  "type": "QUARTZ",
  "uniqueName": "Big Task",
  "description": "A Really Big Task",
  "parentName": "Parent Task",
  "launcher": "sweep",
  "target": {
    "id": "c6dc37bf508149b28ce5b7d90ca4bbf9",
    "type": "APPLICATION",
    "name": "Active Directory [source]"
  },
  "created": "2020-07-11T21:23:15.000Z",
  "modified": "2020-07-11T21:23:15.000Z",
  "launched": "2020-07-11T21:23:15.000Z",
  "completed": "2020-07-11T21:23:15.000Z",
  "completionStatus": "SUCCESS",
  "messages": [
    {
      "type": "INFO",
      "localizedText": {
        "locale": "An error has occurred!",
        "message": "Error has occurred!"
      },
      "key": "akey",
      "parameters": [
        {
          "name": "value"
        }
      ]
    }
  ],
  "returns": [
    {
      "name": "label",
      "attributeName": "identityCount"
    }
  ],
  "attributes": {
    "identityCount": 0
  },
  "progress": "Started",
  "percentComplete": 100,
  "taskDefinitionSummary": {
    "id": "2c91808475b4334b0175e1dff64b63c5",
    "uniqueName": "Cloud Account Aggregation",
    "description": "Aggregates from the specified application.",
    "parentName": "Cloud Account Aggregation",
    "executor": "sailpoint.task.ServiceTaskExecutor",
    "arguments": {}
  }
}

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden, generally due to a lack of security rights

404

TaskStatus with the given id was not found.

429

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

Schema

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

500

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Loading...