Update task status by ID

PATCH {{baseUrl}}/task-status/:id

Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes.

Request Body

{"0"=>{"op"=>"replace", "path"=>"/completionStatus", "value"=>"Error"}, "1"=>{"op"=>"replace", "path"=>"/completed", "value"=>"2024-05-17T19:33:16.470Z"}}

HEADERS

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":{"sunt_8":"esse dolor Duis nisi enim"},"description":"Aggregates from the specified application.","executor":"sailpoint.task.ServiceTaskExecutor","id":"2c91808475b4334b0175e1dff64b63c5","uniqueName":"Cloud Account Aggregation","parentName":"Cloud Account Aggregation"}}