Retrieve a task status list.
GET {{baseUrl}}/task-status
Use this endpoint to get a list of completed tasks. To get a list of tasks in-progress, please use the get pending tasks endpoint.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
limit | number | Max number of results to return. | |
| See V3 API Standard Collection Parameters for more information. | |||
offset | number | Offset into the full result set. Usually specified with limit to paginate through the results. | |
| See V3 API Standard Collection Parameters for more information. | |||
count | boolean | If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. |
Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.
See V3 API Standard Collection Parameters for more information. |
| filters | string | | Filter results using the standard syntax described in V3 API Standard Collection Parameters
Filtering is supported for the following fields and operators:
id: eq, in
sourceId: eq, in
completionStatus: eq, in
type: eq, in |
| sorters | string | | Sort results using the standard syntax described in V3 API Standard Collection Parameters
Sorting is supported for the following fields: created |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-SailPoint-Experimental | boolean | (Required) Use this header to enable this experimental API. | |
Accept | string |
RESPONSES
status: OK
[{"id":"id12345","type":"QUARTZ","uniqueName":"Big Task","description":"A Really Big Task","parentName":"Parent Task","attributes":{"identityCount":0},"created":"2020-07-11T21:23:15.000Z","modified":"2020-07-11T21:23:15.000Z","launched":"2020-07-11T21:23:15.000Z","launcher":"sweep","completed":"2020-07-11T21:23:15.000Z","completionStatus":"SUCCESS","messages":[{"key":"akey","localizedText":{"locale":"An error has occurred!","message":"Error has occurred!"},"type":"INFO","parameters":[{"name":"value"}]},{"key":"akey","localizedText":{"locale":"An error has occurred!","message":"Error has occurred!"},"type":"INFO","parameters":[{"name":"value"}]}],"progress":"Started","percentComplete":100,"returns":[{"name":"label","attributeName":"identityCount"},{"name":"label","attributeName":"identityCount"}],"target":{"id":"c6dc37bf508149b28ce5b7d90ca4bbf9","type":"APPLICATION","name":"Active Directory [source]"},"taskDefinitionSummary":{"arguments":{"ea__d":6170661},"description":"Aggregates from the specified application.","executor":"sailpoint.task.ServiceTaskExecutor","id":"2c91808475b4334b0175e1dff64b63c5","uniqueName":"Cloud Account Aggregation","parentName":"Cloud Account Aggregation"}},{"id":"id12345","type":"QUARTZ","uniqueName":"Big Task","description":"A Really Big Task","parentName":"Parent Task","attributes":{"identityCount":0},"created":"2020-07-11T21:23:15.000Z","modified":"2020-07-11T21:23:15.000Z","launched":"2020-07-11T21:23:15.000Z","launcher":"sweep","completed":"2020-07-11T21:23:15.000Z","completionStatus":"SUCCESS","messages":[{"key":"akey","localizedText":{"locale":"An error has occurred!","message":"Error has occurred!"},"type":"INFO","parameters":[{"name":"value"}]},{"key":"akey","localizedText":{"locale":"An error has occurred!","message":"Error has occurred!"},"type":"INFO","parameters":[{"name":"value"}]}],"progress":"Started","percentComplete":100,"returns":[{"name":"label","attributeName":"identityCount"},{"name":"label","attributeName":"identityCount"}],"target":{"id":"c6dc37bf508149b28ce5b7d90ca4bbf9","type":"APPLICATION","name":"Active Directory [source]"},"taskDefinitionSummary":{"arguments":{"culpa9e":-98221090,"sint_16c":true},"description":"Aggregates from the specified application.","executor":"sailpoint.task.ServiceTaskExecutor","id":"2c91808475b4334b0175e1dff64b63c5","uniqueName":"Cloud Account Aggregation","parentName":"Cloud Account Aggregation"}}]