Update task status by ID
PATCH/task-status/:id
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true
to use this endpoint.
Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.
Request
Path Parameters
Task ID.
Header Parameters
Default value: true
Use this header to enable this experimental API.
- application/json-patch+json
Body
array
required
The JSONPatch payload used to update the object.
Array [
- string
- boolean
- integer
- object
- array
Array [
- MOD1
- MOD2
- MOD3
]
]
Possible values: [add
, remove
, replace
, move
, copy
, test
]
The operation to be performed
A string JSON Pointer representing the target path to an element to be affected by the operation
value
object
The value to be used for the operation, required for "add" and "replace" operations
oneOf
string
boolean
integer
object
anyOf
string
integer
object
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 500
This response indicates the PATCH operation succeeded, and the API returns the updated task object.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
System-generated unique ID of the task this TaskStatus represents
Possible values: [QUARTZ
, QPOC
, QUEUED_TASK
]
Type of task this TaskStatus represents
Name of the task this TaskStatus represents
Description of the task this TaskStatus represents
Name of the parent of the task this TaskStatus represents
Service to execute the task this TaskStatus represents
target
object
nullable
Target ID
Possible values: [APPLICATION
, IDENTITY
, null
]
Target type
Target name
Creation date of the task this TaskStatus represents
Last modification date of the task this TaskStatus represents
Launch date of the task this TaskStatus represents
Completion date of the task this TaskStatus represents
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
Possible values: [INFO
, WARN
, ERROR
]
Type of the message
localizedText
object
nullable
required
Localized form of the message
Message locale
Message text
Key of the message
Message parameters for internationalization
returns
object[]
required
Return values from the task this TaskStatus represents
Display name of the TaskReturnDetails
Attribute the TaskReturnDetails is for
attributes
object
required
Attributes of the task this TaskStatus represents
Attributes of the task this TaskStatus represents
Current progress of the task this TaskStatus represents
Current percentage completion of the task this TaskStatus represents
taskDefinitionSummary
object
Definition of a type of task, used to invoke tasks
System-generated unique ID of the TaskDefinition
Name of the TaskDefinition
Description of the TaskDefinition
Name of the parent of the TaskDefinition
Executor of the TaskDefinition
arguments
object
required
Formal parameters of the TaskDefinition, without values
Formal parameters of the TaskDefinition, without values
{
"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": {}
}
}
Client Error - Returned if the request body is invalid.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
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.
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
The locale for the message text, a BCP 47 language tag.
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.
Actual text of the error message in the indicated locale.
{
"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."
}
]
}
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
{
"error": "JWT validation failed: JWT is expired"
}
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
- application/json
- Schema
- Example (from schema)
- 403
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
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.
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
The locale for the message text, a BCP 47 language tag.
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.
Actual text of the error message in the indicated locale.
{
"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."
}
]
}
An example of a 403 response object
{
"detailCode": "403 Forbidden",
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The server understood the request but refuses to authorize it."
}
]
}
Not Found - returned if the request URL refers to a resource or object that does not exist
- application/json
- Schema
- Example (from schema)
- 404
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
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.
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
The locale for the message text, a BCP 47 language tag.
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.
Actual text of the error message in the indicated locale.
{
"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."
}
]
}
An example of a 404 response object
{
"detailCode": "404 Not found",
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The server did not find a current representation for the target resource."
}
]
}
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
- Example (from schema)
Schema
A message describing the error
{
"message": " Rate Limit Exceeded "
}
Internal Server Error - Returned if there is an unexpected error.
- application/json
- Schema
- Example (from schema)
- 500
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
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.
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
The locale for the message text, a BCP 47 language tag.
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.
Actual text of the error message in the indicated locale.
{
"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."
}
]
}
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."
}
]
}