---
id: get-task-result-by-id
sidebar_label: Returns a TaskResult resource based on id.
hide_title: true
hide_table_of_contents: true
api: {"operationId":"getTaskResultById","tags":["TaskResults"],"description":"The TaskResult resource with matching id is returned.<br /><br />\nAttributes to include in the response can be specified with the attributes query parameter. <br /><br />\nAttributes to exclude from the response can be specified with the excludedAttributes query parameter. <br /><br />\nThe schema related to TaskResult is:\n- **urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult**\n","parameters":[{"name":"taskResultId","in":"path","schema":{"type":"string","example":"c0a8019c802d1e5a81802eb2b57e020f"},"description":"id of TaskResult resource.","required":true},{"in":"query","name":"attributes","schema":{"type":"string","example":"host"},"description":"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."},{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"name, messages"},"description":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**"}],"responses":{"200":{"description":"Returns a single TaskResult resource based on the id.","content":{"application/json":{"schema":{"properties":{"id":{"description":"Unique identifier of the TaskResult.","type":"string","example":"c0a8019c80761c398180856488d2051d"},"name":{"description":"Name of the TaskResult.","type":"string","example":"Aggregate Composite Application"},"type":{"description":"Type of the TaskResult.","type":"string","example":"AccountAggregation"},"completionStatus":{"type":"string","description":"Completion Status of the TaskResult.","enum":["Success","Warning","Error","Terminated","TempError"],"example":"Success"},"launcher":{"description":"Launcher of the TaskResult.","type":"string","example":"james.smith"},"host":{"description":"Host of the TaskResult.","type":"string","example":"mandrake.testdomain.com"},"progress":{"description":"Progress of the TaskResult.","type":"string","example":"3/5 tasks completed."},"targetClass":{"description":"Target Class of the TaskResult.","type":"string","example":"Permission"},"targetName":{"description":"Target Name of the Task Result.","type":"string","example":"Adam.Kennedy"},"terminated":{"description":"Flag to indicate this TaskResult is terminated.","type":"boolean","example":false},"partitioned":{"description":"Flag to indicate this TaskResult is partitioned.","type":"boolean","example":true},"launched":{"type":"string","format":"date-time","description":"The launched DateTime of the TaskResult.","example":"2022-05-02T10:30:00.014-05:00"},"completed":{"type":"string","format":"date-time","description":"The completed DateTime of the TaskResult.","example":"2022-05-02T10:30:00.035-05:00"},"expiration":{"type":"string","format":"date-time","description":"The expiration DateTime of the TaskResult.","example":"2022-05-03T16:40:34.271-05:00"},"verified":{"type":"string","format":"date-time","description":"The verification DateTime of the TaskResult.","example":"2022-05-03T16:40:34.271-05:00"},"percentageComplete":{"type":"integer","description":"The percentage completed of this TaskResult.","example":30},"pendingSignOffs":{"description":"The number of pending signoffs of this TaskResult.","type":"integer","example":0},"taskDefinition":{"type":"string","description":"Name of the TaskDefinition of the TaskResult.","example":"Workflow Launcher"},"taskSchedule":{"description":"Name of the TaskSchedule of the TaskResult.","type":"string","example":"Perform Identity Request Maintenance"},"attributes":{"description":"A list of attributes of the TaskResult.","type":"array","items":{"properties":{"key":{"description":"The attribute key.","type":"string","example":"inactiveWorkItemsForwarded"},"value":{"description":"The attribute value.","type":"string","example":"0"}}}},"messages":{"description":"List of messages of the TaskResult.","type":"array","items":{"example":["Partition 2 is pending."]}},"meta":{"type":"object","properties":{"created":{"description":"DateTime when the TaskResult was created.","type":"string","format":"date-time","example":"2022-05-02T10:30:00.018-05:00"},"location":{"description":"URL to the TaskResult.","type":"string","example":"http://localhost:8080/identityiq/scim/v2/TaskResults/c0a8019c80761c398180856488d2051d"},"lastModified":{"description":"DateTime of TaskResult last modification.","type":"string","format":"date-time","example":"2022-05-02T10:30:00.036-05:00"},"version":{"description":"TaskResult version.","type":"string","example":"W\"1651505400036\""},"resourceType":{"description":"Resource type of the metadata subject.","type":"string","example":"TaskResult"}}},"schemas":{"type":"array","example":["urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult"]}}}}}}},"method":"get","path":"/TaskResults/{taskResultId}","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns a TaskResult resource based on id.","description":{"content":"The TaskResult resource with matching id is returned.<br /><br />\nAttributes to include in the response can be specified with the attributes query parameter. <br /><br />\nAttributes to exclude from the response can be specified with the excludedAttributes query parameter. <br /><br />\nThe schema related to TaskResult is:\n- **urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult**\n","type":"text/plain"},"url":{"path":["TaskResults",":taskResultId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"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.","type":"text/plain"},"key":"attributes","value":""},{"disabled":false,"description":{"content":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**","type":"text/plain"},"key":"excludedAttributes","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) id of TaskResult resource.","type":"text/plain"},"type":"any","value":"","key":"taskResultId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}}
sidebar_class_name: "get api-method"
info_path: iiq/api/identityiq-scim-rest-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns a TaskResult resource based on id.' (get-task-result-by-id)"
---

import ApiTabs from "@theme/ApiTabs";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import TabItem from "@theme/TabItem";

## Returns a TaskResult resource based on id.



The TaskResult resource with matching id is returned.<br /><br />
Attributes to include in the response can be specified with the attributes query parameter. <br /><br />
Attributes to exclude from the response can be specified with the excludedAttributes query parameter. <br /><br />
The schema related to TaskResult is:
- **urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult**


<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Path Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"taskResultId","in":"path","schema":{"type":"string","example":"c0a8019c802d1e5a81802eb2b57e020f"},"description":"id of TaskResult resource.","required":true}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Query Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"attributes","schema":{"type":"string","example":"host"},"description":"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."}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"excludedAttributes","schema":{"type":"string","example":"name, messages"},"description":"A comma-separated list of attributes to exclude from the response. **Some attributes cannot be excluded.**"}}></ParamsItem></ul></div></details><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Returns a single TaskResult resource based on the id.

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={"Unique identifier of the TaskResult."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={"Name of the TaskResult."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"Type of the TaskResult."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"completionStatus"} required={false} deprecated={undefined} schemaDescription={"Completion Status of the TaskResult."} schemaName={"string"} qualifierMessage={"**Possible values:** [`Success`, `Warning`, `Error`, `Terminated`, `TempError`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"launcher"} required={false} deprecated={undefined} schemaDescription={"Launcher of the TaskResult."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"host"} required={false} deprecated={undefined} schemaDescription={"Host of the TaskResult."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"progress"} required={false} deprecated={undefined} schemaDescription={"Progress of the TaskResult."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"targetClass"} required={false} deprecated={undefined} schemaDescription={"Target Class of the TaskResult."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"targetName"} required={false} deprecated={undefined} schemaDescription={"Target Name of the Task Result."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"terminated"} required={false} deprecated={undefined} schemaDescription={"Flag to indicate this TaskResult is terminated."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"partitioned"} required={false} deprecated={undefined} schemaDescription={"Flag to indicate this TaskResult is partitioned."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"launched"} required={false} deprecated={undefined} schemaDescription={"The launched DateTime of the TaskResult."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"completed"} required={false} deprecated={undefined} schemaDescription={"The completed DateTime of the TaskResult."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"expiration"} required={false} deprecated={undefined} schemaDescription={"The expiration DateTime of the TaskResult."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"verified"} required={false} deprecated={undefined} schemaDescription={"The verification DateTime of the TaskResult."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"percentageComplete"} required={false} deprecated={undefined} schemaDescription={"The percentage completed of this TaskResult."} schemaName={"integer"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"pendingSignOffs"} required={false} deprecated={undefined} schemaDescription={"The number of pending signoffs of this TaskResult."} schemaName={"integer"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"taskDefinition"} required={false} deprecated={undefined} schemaDescription={"Name of the TaskDefinition of the TaskResult."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"taskSchedule"} required={false} deprecated={undefined} schemaDescription={"Name of the TaskSchedule of the TaskResult."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>attributes</strong><span style={{"opacity":"0.6"}}> undefined[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A list of attributes of the TaskResult.

</div><SchemaItem collapsible={false} name={"key"} required={false} deprecated={undefined} schemaDescription={"The attribute key."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} deprecated={undefined} schemaDescription={"The attribute value."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"messages"} required={false} deprecated={undefined} schemaDescription={"List of messages of the TaskResult."} schemaName={"undefined[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>meta</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"created"} required={false} deprecated={undefined} schemaDescription={"DateTime when the TaskResult was created."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"location"} required={false} deprecated={undefined} schemaDescription={"URL to the TaskResult."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"lastModified"} required={false} deprecated={undefined} schemaDescription={"DateTime of TaskResult last modification."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} deprecated={undefined} schemaDescription={"TaskResult version."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"resourceType"} required={false} deprecated={undefined} schemaDescription={"Resource type of the metadata subject."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"schemas"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"array"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"c0a8019c80761c398180856488d2051d\",\n  \"name\": \"Aggregate Composite Application\",\n  \"type\": \"AccountAggregation\",\n  \"completionStatus\": \"Success\",\n  \"launcher\": \"james.smith\",\n  \"host\": \"mandrake.testdomain.com\",\n  \"progress\": \"3/5 tasks completed.\",\n  \"targetClass\": \"Permission\",\n  \"targetName\": \"Adam.Kennedy\",\n  \"terminated\": false,\n  \"partitioned\": true,\n  \"launched\": \"2022-05-02T10:30:00.014-05:00\",\n  \"completed\": \"2022-05-02T10:30:00.035-05:00\",\n  \"expiration\": \"2022-05-03T16:40:34.271-05:00\",\n  \"verified\": \"2022-05-03T16:40:34.271-05:00\",\n  \"percentageComplete\": 30,\n  \"pendingSignOffs\": 0,\n  \"taskDefinition\": \"Workflow Launcher\",\n  \"taskSchedule\": \"Perform Identity Request Maintenance\",\n  \"attributes\": [\n    {\n      \"key\": \"inactiveWorkItemsForwarded\",\n      \"value\": \"0\"\n    }\n  ],\n  \"messages\": [\n    [\n      \"Partition 2 is pending.\"\n    ]\n  ],\n  \"meta\": {\n    \"created\": \"2022-05-02T10:30:00.018-05:00\",\n    \"location\": \"http://localhost:8080/identityiq/scim/v2/TaskResults/c0a8019c80761c398180856488d2051d\",\n    \"lastModified\": \"2022-05-02T10:30:00.036-05:00\",\n    \"version\": \"W\\\"1651505400036\\\"\",\n    \"resourceType\": \"TaskResult\"\n  },\n  \"schemas\": [\n    \"urn:ietf:params:scim:schemas:sailpoint:1.0:TaskResult\"\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>