Get a Work Item

GET 
/work-items/:id

This gets the details of a Work Item belonging to either the specified user(admin required), or the current user.

Request

Path Parameters

id stringrequired

ID of the work item.

Query Parameters

ownerId string

ID of the work item owner.

Responses

200

The work item with the given ID.

application/json

Schema

Schema

• Array [

id string

ID of the work item

requesterId stringnullable

ID of the requester

requesterDisplayName stringnullable

The displayname of the requester

ownerId stringnullable

The ID of the owner

ownerName string

The name of the owner

created date-time
modified date-timenullable
description string

The description of the work item

state WorkItemState (string)nullable

Possible values: [Finished, Rejected, Returned, Expired, Pending, Canceled, null]

The state of a work item

type WorkItemType (string)

Possible values: [Unknown, Generic, Certification, Remediation, Delegation, Approval, ViolationReview, Form, PolicyViolation, Challenge, ImpactAnalysis, Signoff, Event, ManualAction, Test]

The type of the work item

remediationItems

object[]

nullable

Array [

id string

The ID of the certification

targetId string

The ID of the certification target

targetName string

The name of the certification target

targetDisplayName string

The display name of the certification target

applicationName string

The name of the application/source

attributeName string

The name of the attribute being certified

attributeOperation string

The operation of the certification on the attribute

attributeValue string

The value of the attribute being certified

nativeIdentity string

The native identity of the target

]

approvalItems

object[]

nullable

Array [

id string

The approval item's ID

account stringnullable

The account referenced by the approval item

application string

The name of the application/source

name stringnullable

The attribute's name

operation string

The attribute's operation

value stringnullable

The attribute's value

state WorkItemState (string)nullable

Possible values: [Finished, Rejected, Returned, Expired, Pending, Canceled, null]

The state of a work item

]

name stringnullable

The work item name

completed date-timenullable
numItems integernullable

The number of items in the work item

errors string[]

form

object

nullable

id stringnullable

ID of the form

name stringnullable

Name of the form

title string

The form title

subtitle string

The form subtitle.

targetUser string

The name of the user that should be shown this form

sections object[]

• ]

Example (from schema)

[
  {
    "id": "2c9180835d2e5168015d32f890ca1581",
    "requesterId": "2c9180835d2e5168015d32f890ca1581",
    "requesterDisplayName": "John Smith",
    "ownerId": "2c9180835d2e5168015d32f890ca1581",
    "ownerName": "Jason Smith",
    "created": "2017-07-11T18:45:37.098Z",
    "modified": "2018-06-25T20:22:28.104Z",
    "description": "Create account on source 'AD'",
    "state": "Pending",
    "type": "Generic",
    "remediationItems": [
      {
        "id": "2c9180835d2e5168015d32f890ca1581",
        "targetId": "2c9180835d2e5168015d32f890ca1581",
        "targetName": "john.smith",
        "targetDisplayName": "emailAddress",
        "applicationName": "Active Directory",
        "attributeName": "phoneNumber",
        "attributeOperation": "update",
        "attributeValue": "512-555-1212",
        "nativeIdentity": "jason.smith2"
      }
    ],
    "approvalItems": [
      {
        "id": "2c9180835d2e5168015d32f890ca1581",
        "account": "john.smith",
        "application": "Active Directory",
        "name": "emailAddress",
        "operation": "update",
        "value": "[email protected]",
        "state": "Pending"
      }
    ],
    "name": "Account Create",
    "completed": "2018-10-19T13:49:37.385Z",
    "numItems": 19,
    "errors": [
      "The work item ID that was specified was not found."
    ],
    "form": {
      "id": "2c9180835d2e5168015d32f890ca1581",
      "name": "AccountSelection Form",
      "title": "Account Selection for John.Doe",
      "subtitle": "Please select from the following",
      "targetUser": "Jane.Doe",
      "sections": [
        {
          "name": "Field1",
          "label": "Section 1",
          "formItems": []
        }
      ]
    }
  }
]

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

404

Not Found - returned if the request URL refers to a resource or object that does not exist

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

404

An example of a 404 response object

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

Loading...