Returns a TaskResult resource based on id.

GET 
/TaskResults/:taskResultId

The TaskResult resource with matching id is returned.

Attributes to include in the response can be specified with the attributes query parameter.

Attributes to exclude from the response can be specified with the excludedAttributes query parameter.

The schema related to TaskResult is:

• urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult

Request

Path Parameters

taskResultId stringrequired

id of TaskResult resource.

Query Parameters

attributes string

A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.

excludedAttributes string

A comma-separated list of attributes to exclude from the response. Some attributes cannot be excluded.

Responses

200

Returns a single TaskResult resource based on the id.

application/json

Schema

Schema

id string

Unique identifier of the TaskResult.

name string

Name of the TaskResult.

type string

Type of the TaskResult.

completionStatus string

Possible values: [Success, Warning, Error, Terminated, TempError]

Completion Status of the TaskResult.

launcher string

Launcher of the TaskResult.

host string

Host of the TaskResult.

progress string

Progress of the TaskResult.

targetClass string

Target Class of the TaskResult.

targetName string

Target Name of the Task Result.

terminated boolean

Flag to indicate this TaskResult is terminated.

partitioned boolean

Flag to indicate this TaskResult is partitioned.

launched date-time

The launched DateTime of the TaskResult.

completed date-time

The completed DateTime of the TaskResult.

expiration date-time

The expiration DateTime of the TaskResult.

verified date-time

The verification DateTime of the TaskResult.

percentageComplete integer

The percentage completed of this TaskResult.

pendingSignOffs integer

The number of pending signoffs of this TaskResult.

taskDefinition string

Name of the TaskDefinition of the TaskResult.

taskSchedule string

Name of the TaskSchedule of the TaskResult.

attributes

undefined[]

A list of attributes of the TaskResult.

Array [

key string

The attribute key.

value string

The attribute value.

]

messages undefined[]

List of messages of the TaskResult.

meta

object

created date-time

DateTime when the TaskResult was created.

location string

URL to the TaskResult.

lastModified date-time

DateTime of TaskResult last modification.

version string

TaskResult version.

resourceType string

Resource type of the metadata subject.

schemas array

Example (from schema)

{
  "id": "c0a8019c80761c398180856488d2051d",
  "name": "Aggregate Composite Application",
  "type": "AccountAggregation",
  "completionStatus": "Success",
  "launcher": "james.smith",
  "host": "mandrake.testdomain.com",
  "progress": "3/5 tasks completed.",
  "targetClass": "Permission",
  "targetName": "Adam.Kennedy",
  "terminated": false,
  "partitioned": true,
  "launched": "2022-05-02T10:30:00.014-05:00",
  "completed": "2022-05-02T10:30:00.035-05:00",
  "expiration": "2022-05-03T16:40:34.271-05:00",
  "verified": "2022-05-03T16:40:34.271-05:00",
  "percentageComplete": 30,
  "pendingSignOffs": 0,
  "taskDefinition": "Workflow Launcher",
  "taskSchedule": "Perform Identity Request Maintenance",
  "attributes": [
    {
      "key": "inactiveWorkItemsForwarded",
      "value": "0"
    }
  ],
  "messages": [
    [
      "Partition 2 is pending."
    ]
  ],
  "meta": {
    "created": "2022-05-02T10:30:00.018-05:00",
    "location": "http://localhost:8080/identityiq/scim/v2/TaskResults/c0a8019c80761c398180856488d2051d",
    "lastModified": "2022-05-02T10:30:00.036-05:00",
    "version": "W\"1651505400036\"",
    "resourceType": "TaskResult"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult"
  ]
}

Loading...