Skip to main content

Update task status by ID

PATCH 

/task-status/:id

experimental

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

    id stringrequired

    Task ID.

    Example: 00eebcf881994e419d72e757fd30dc0e

Header Parameters

    X-SailPoint-Experimental stringrequired

    Default value: true

    Use this header to enable this experimental API.

    Example: true

Body

array

required

The JSONPatch payload used to update the object.

  • Array [

  • op stringrequired

    Possible values: [add, remove, replace, move, copy, test]

    The operation to be performed

    path stringrequired

    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

  • ]

Responses

This response indicates the PATCH operation succeeded, and the API returns the updated task object.

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

Loading...