List Work Items

This gets a collection of work items belonging to either the specified user(admin required), or the current user.

Query Parameters

• limit int32

  Possible values: <= 250

  Default value: 250

  Max number of results to return. See V3 API Standard Collection Parameters for more information.

  Example: 250
• offset int32

  Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

• count boolean

  If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

  Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

  See V3 API Standard Collection Parameters for more information.

  Example: true
• ownerId string

  ID of the work item owner.

  Example: 1211bcaa32112bcef6122adb21cef1ac

Responses

• 200
• 401
• 403
• 404
• 429
• 500

---

List of work items

application/json

• Schema
• Example (from schema)

---

Schema array

• id string

  ID of the work item

• requesterId string

  ID of the requester

• requesterDisplayName string

  The displayname of the requester

• ownerId string

  The ID of the owner

• ownerName string

  The name of the owner

• created date-time

  Time when the work item was created

• modified date-time

  Time when the work item was last updated

• description string

  The description of the work item

• state string

  Possible values: [FINISHED, REJECTED, RETURNED, EXPIRED, PENDING, CANCELED]

  The state of a work item

• type 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

  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

  id string

  ID of the approval item

  account string

  The account referenced by the approval item

  application string

  The name the application/source

  attributeName string

  The name of the attribute

  attributeOperation string

  The operation of the attribute

  attributeValue string

  The value of the attribute

  state string

  Possible values: [FINISHED, REJECTED, RETURNED, EXPIRED, PENDING, CANCELED]

  The state of a work item

• name string

  The work item name

• completed date-time

  The time at which the work item completed

• numItems int32

  The number of items in the work item

• form object

  id string

  ID of the form

  name string

  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

  name string

  Name of the FormItem

  label string

  Label of the section

  formItems object[]

  List of FormItems. FormItems can be SectionDetails and/or FieldDetails

• errors string[]

  An array of errors that ocurred during the work item

[
  {
    "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": "FINISHED",
    "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",
      "attributeName": "emailAddress",
      "attributeOperation": "update",
      "attributeValue": "a@b.com",
      "state": "FINISHED"
    },
    "name": "Account Create",
    "completed": "2018-10-19T13:49:37.385Z",
    "numItems": 19,
    "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": []
      }
    },
    "errors": [
      "The work item ID that was specified was not found."
    ]
  }
]

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

• Schema
• Example (from schema)

---

Schema

• error

  A message describing the error

{
  "error": "JWT validation failed: JWT is expired"
}

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

application/json

• Schema
• Example (from schema)
• 403

---

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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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.

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

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

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

application/json

• Schema
• Example (from schema)
• 404

---

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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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.

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

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

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

• Schema
• Example (from schema)

---

Schema

• message

  A message describing the error

{
  "message": " Rate Limit Exceeded "
}

Internal Server Error - Returned if there is an unexpected error.

application/json

• Schema
• Example (from schema)
• 500

---

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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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.

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

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Loading...