Returns a TaskResult resource based on id.

GET 
http://localhost:8080/identityiq/scim/v2/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

idstring
Unique identifier of the TaskResult.
Example: c0a8019c80761c398180856488d2051d
namestring
Name of the TaskResult.
Example: Aggregate Composite Application
typestring
Type of the TaskResult.
Example: AccountAggregation
completionStatusstring
Completion Status of the TaskResult.
Possible values: [Success, Warning, Error, Terminated, TempError]
Example: Success
launcherstring
Launcher of the TaskResult.
Example: james.smith
hoststring
Host of the TaskResult.
Example: mandrake.testdomain.com
progressstring
Progress of the TaskResult.
Example: 3/5 tasks completed.
targetClassstring
Target Class of the TaskResult.
Example: Permission
targetNamestring
Target Name of the Task Result.
Example: Adam.Kennedy
terminatedboolean
Flag to indicate this TaskResult is terminated.
Example: false
partitionedboolean
Flag to indicate this TaskResult is partitioned.
Example: true
launcheddate-time
The launched DateTime of the TaskResult.
Example: 2022-05-02T10:30:00.014-05:00
completeddate-time
The completed DateTime of the TaskResult.
Example: 2022-05-02T10:30:00.035-05:00
expirationdate-time
The expiration DateTime of the TaskResult.
Example: 2022-05-03T16:40:34.271-05:00
verifieddate-time
The verification DateTime of the TaskResult.
Example: 2022-05-03T16:40:34.271-05:00
percentageCompleteinteger
The percentage completed of this TaskResult.
Example: 30
pendingSignOffsinteger
The number of pending signoffs of this TaskResult.
Example: 0
taskDefinitionstring
Name of the TaskDefinition of the TaskResult.
Example: Workflow Launcher
taskSchedulestring
Name of the TaskSchedule of the TaskResult.
Example: Perform Identity Request Maintenance
attributes undefined[]
A list of attributes of the TaskResult.
Array [
keystring
The attribute key.
Example: inactiveWorkItemsForwarded
valuestring
The attribute value.
Example: 0
]
messagesundefined[]
List of messages of the TaskResult.
meta object
createddate-time
DateTime when the TaskResult was created.
Example: 2022-05-02T10:30:00.018-05:00
locationstring
URL to the TaskResult.
Example: http://localhost:8080/identityiq/scim/v2/TaskResults/c0a8019c80761c398180856488d2051d
lastModifieddate-time
DateTime of TaskResult last modification.
Example: 2022-05-02T10:30:00.036-05:00
versionstring
TaskResult version.
Example: W"1651505400036"
resourceTypestring
Resource type of the metadata subject.
Example: TaskResult
schemasarray
Example: ["urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult"]

Example (auto)

{
  "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"
  ]
}

Authorization: http

name: basicAuthtype: httpscheme: basic

• go
• powershell
  SailPoint SDK
• python
  SailPoint SDK
• csharp
• curl
• dart
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• r
• ruby
• rust
• shell
• swift

• NATIVE

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "http://localhost:8080/identityiq/scim/v2/TaskResults/:taskResultId"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Accept", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

Request Collapse all

Base URL

http://localhost:8080/identityiq/scim/v2

Auth

Username

Password

Parameters

taskResultId — pathrequired

attributes — query

excludedAttributes — query

ResponseClear

Click the Send API Request button above and see the response here!