--- id: get-work-items sidebar_label: Get a Work Item hide_title: true hide_table_of_contents: true api: {"operationId":"getWorkItems","tags":["Work Items"],"description":"This gets the details of a Work Item belonging to either the specified user(admin required), or the current user.","parameters":[{"in":"query","name":"ownerId","schema":{"type":"string"},"description":"ID of the work item owner.","required":false},{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"ID of the work item."}],"responses":{"200":{"description":"The work item with the given ID.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the work item","example":"2c9180835d2e5168015d32f890ca1581"},"requesterId":{"type":"string","description":"ID of the requester","example":"2c9180835d2e5168015d32f890ca1581"},"requesterDisplayName":{"type":"string","description":"The displayname of the requester","example":"John Smith"},"ownerId":{"type":"string","description":"The ID of the owner","example":"2c9180835d2e5168015d32f890ca1581"},"ownerName":{"type":"string","description":"The name of the owner","example":"Jason Smith"},"created":{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"},"modified":{"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z"},"description":{"type":"string","description":"The description of the work item","example":"Create account on source 'AD'"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"]},"type":{"type":"string","enum":["UNKNOWN","GENERIC","CERTIFICATION","REMEDIATION","DELEGATION","APPROVAL","VIOLATIONREVIEW","FORM","POLICYVIOLATION","CHALLENGE","IMPACTANALYSIS","SIGNOFF","EVENT","MANUALACTION","TEST"]},"remediationItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the certification","example":"2c9180835d2e5168015d32f890ca1581"},"targetId":{"type":"string","description":"The ID of the certification target","example":"2c9180835d2e5168015d32f890ca1581"},"targetName":{"type":"string","description":"The name of the certification target","example":"john.smith"},"targetDisplayName":{"type":"string","description":"The display name of the certification target","example":"emailAddress"},"applicationName":{"type":"string","description":"The name of the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute being certified","example":"phoneNumber"},"attributeOperation":{"type":"string","description":"The operation of the certification on the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute being certified","example":"512-555-1212"},"nativeIdentity":{"type":"string","description":"The native identity of the target","example":"jason.smith2"}}},"approvalItems":{"type":"object","properties":{"id":{"type":"string","description":"ID of the approval item","example":"2c9180835d2e5168015d32f890ca1581"},"account":{"type":"string","description":"The account referenced by the approval item","example":"john.smith"},"application":{"type":"string","description":"The name the application/source","example":"Active Directory"},"attributeName":{"type":"string","description":"The name of the attribute","example":"emailAddress"},"attributeOperation":{"type":"string","description":"The operation of the attribute","example":"update"},"attributeValue":{"type":"string","description":"The value of the attribute","example":"a@b.com"},"state":{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED"]}}},"name":{"type":"string","description":"The work item name","example":"Account Create"},"completed":{"type":"string","format":"date-time","example":"2018-10-19T13:49:37.385Z"},"numItems":{"type":"integer","description":"The number of items in the work item","example":19},"errors":{"type":"array","items":{"type":"string"},"example":["The work item ID that was specified was not found."]}}}}}}},"400":{"description":"Client Error - Returned if the request body is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}}}}},"403":{"description":"Forbidden - Returned if the user you are running as, doesn't have access to this end-point.","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"403":{"summary":"An example of a 403 response object","value":{"detailCode":"403 Forbidden","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server understood the request but refuses to authorize it."}]}}}}}},"404":{"description":"Not Found - returned if the request URL refers to a resource or object that does not exist","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"},"trackingId":{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"},"messages":{"type":"array","description":"Generic localized reason for error","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}},"causes":{"type":"array","description":"Plain-text descriptive reasons to provide additional detail to the text provided in the messages field","items":{"type":"object","properties":{"locale":{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US"},"localeOrigin":{"type":"string","enum":["DEFAULT","REQUEST"],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT"},"text":{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}}}}},"examples":{"404":{"summary":"An example of a 404 response object","value":{"detailCode":"404 Not found","trackingId":"b21b1f7ce4da4d639f2c62a57171b427","messages":[{"locale":"en-US","localeOrigin":"DEFAULT","text":"The server did not find a current representation for the target resource."}]}}}}}}},"method":"get","path":"/work-items/{id}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"security":[{"oauth2":[]}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/docs/authentication.html) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/docs/authentication.html#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/docs/authentication.html#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/docs/authentication.html#authorization-code-grant-flow)\n\nWhich authentication method should I choose? See our [guide](https://developer.sailpoint.com/docs/authentication.html#which-oauth-2-0-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/docs/authentication.html#finding-your-tenant-s-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"contact":{"email":"developers@sailpoint.com","name":"Developer Relations","url":"https://developer.sailpoint.com/discuss"},"description":"These are the public, beta APIs for SailPoint's SaaS services and are subject to change.","title":"SailPoint - Beta SaaS API","version":"3.1.0-beta"},"postman":{"name":"Get a Work Item","description":{"content":"This gets the details of a Work Item belonging to either the specified user(admin required), or the current user.","type":"text/plain"},"url":{"path":["work-items",":id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"ID of the work item owner.","type":"text/plain"},"key":"ownerId","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the work item.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: docs/sailpoint-api-beta/sail-point-beta-saa-s-api --- 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"; ## Get a Work Item This gets the details of a Work Item belonging to either the specified user(admin required), or the current user.
Path Parameters
Query Parameters
The work item with the given ID.
Schema array
    remediationItems object
    approvalItems object
Client Error - Returned if the request body is invalid.
Schema
    messages object[]
    Generic localized reason for error
    causes object[]
    Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
Schema
    messages object[]
    Generic localized reason for error
    causes object[]
    Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Not Found - returned if the request URL refers to a resource or object that does not exist
Schema
    messages object[]
    Generic localized reason for error
    causes object[]
    Plain-text descriptive reasons to provide additional detail to the text provided in the messages field