Get Approval

GET 
/generic-approvals/:id

Get a single approval for a given approval ID. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and doesn't include access-request-approvals.

Request

Path Parameters

id stringrequired
ID of the approval that to be returned.
Example: 38453251-6be2-5f8f-df93-5ce19e295837

Responses

200

Approval object

application/json

Schema

Schema

approvalId string

The Approval ID

approvers

object[]

Object representation of an approver of an approval

Array [

id string

The identity ID

type string

Possible values: [IDENTITY]

Indication of what group the identity belongs to. Ie, IDENTITY, GOVERNANCE_GROUP, etc

name string

Name of the identity

]

createdDate string

Date the approval was created

type string

Type of approval

name

object[]

The name of the approval for a given locale

Array [

value string

Name of the approval

locale string

What locale the name of the approval is using

]

batchRequest

object

The name of the approval for a given locale

batchId string

ID of the batch

batchSize int64

How many approvals are going to be in this batch. Defaults to 1 if not provided.

description

object[]

The description of the approval for a given locale

Array [

value string

The description of what the approval is asking for

locale string

What locale the description of the approval is using

]

priority string

Possible values: [HIGH, MEDIUM, LOW]

The priority of the approval

requester

object

Identity Object

id string

The identity ID

type string

Possible values: [IDENTITY]

Indication of what group the identity belongs to. Ie, IDENTITY, GOVERNANCE_GROUP, etc

name string

Name of the identity

comments

object[]

Object representation of a comment on the approval

Array [

author

object

Identity Object

id string

The identity ID

type string

Possible values: [IDENTITY]

Indication of what group the identity belongs to. Ie, IDENTITY, GOVERNANCE_GROUP, etc

name string

Name of the identity

comment string

Comment to be left on an approval

createdDate string

Date the comment was created

]

approvedBy

object[]

Array of approvers who have approved the approval

Array [

id string

The identity ID

type string

Possible values: [IDENTITY]

Indication of what group the identity belongs to. Ie, IDENTITY, GOVERNANCE_GROUP, etc

name string

Name of the identity

]

rejectedBy

object[]

Array of approvers who have rejected the approval

Array [

id string

The identity ID

type string

Possible values: [IDENTITY]

Indication of what group the identity belongs to. Ie, IDENTITY, GOVERNANCE_GROUP, etc

name string

Name of the identity

]

completedDate string

Date the approval was completed

approvalCriteria string

Possible values: [SINGLE, DOUBLE, TRIPLE, QUARTER, HALF, ALL]

Criteria that needs to be met for an approval to be marked as approved

status string

Possible values: [PENDING, APPROVED, REJECTED]

The current status of the approval

additionalAttributes string

Json string representing additional attributes known about the object to be approved.

referenceData

object[]

Reference data related to the approval

Array [

id string

Id of the reference object

type string

What reference object does this ID correspond to

]

Example (from schema)

{
  "approvalId": "38453251-6be2-5f8f-df93-5ce19e295837",
  "approvers": [
    {
      "id": "85d173e7d57e496569df763231d6deb6a",
      "type": "IDENTITY",
      "name": "John Doe"
    }
  ],
  "createdDate": "2023-04-12T23:20:50.52Z",
  "type": "ENTITLEMENT_DESCRIPTIONS",
  "name": [
    {
      "value": "Audit DB Access",
      "locale": "en_US"
    }
  ],
  "batchRequest": {
    "batchId": "38453251-6be2-5f8f-df93-5ce19e295837",
    "batchSize": 100
  },
  "description": [
    {
      "value": "This access allows viewing and editing of workflow resource",
      "locale": "en_US"
    }
  ],
  "priority": "HIGH",
  "requester": {
    "id": "85d173e7d57e496569df763231d6deb6a",
    "type": "IDENTITY",
    "name": "John Doe"
  },
  "comments": [
    {
      "author": {
        "id": "85d173e7d57e496569df763231d6deb6a",
        "type": "IDENTITY",
        "name": "John Doe"
      },
      "comment": "Looks good",
      "createdDate": "2023-04-12T23:20:50.52Z"
    }
  ],
  "approvedBy": [
    {
      "id": "85d173e7d57e496569df763231d6deb6a",
      "type": "IDENTITY",
      "name": "John Doe"
    }
  ],
  "rejectedBy": [
    {
      "id": "85d173e7d57e496569df763231d6deb6a",
      "type": "IDENTITY",
      "name": "John Doe"
    }
  ],
  "completedDate": "2023-04-12T23:20:50.52Z",
  "approvalCriteria": "SINGLE",
  "status": "PENDING",
  "additionalAttributes": "{ \"llm_description\": \"generated description\" }",
  "referenceData": [
    {
      "id": "64012350-8fd9-4f6c-a170-1fe123683899",
      "type": "AccessRequestId"
    }
  ]
}

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

401

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

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

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

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

429

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

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

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

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

500

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...