Skip to main content

ApprovalRequestInput

The input for creating a new approval request.

input ApprovalRequestInput {
  callback: Callback
  correlationId: ID
  expiresAt: DateTime
  presentationRequestInput: ApprovalRequestPresentationInput!
  purpose: String!
  referenceUrl: String
  requestData: JSONObject
  requestType: String!
}

Fields​

ApprovalRequestInput.callback ● Callback input​

Callback will be invoked when the approval request is actioned (i.e. approved, rejected, or cancelled).

ApprovalRequestInput.correlationId ● ID scalar​

The optional originating source entity ID of the artifact requiring approval.

ApprovalRequestInput.expiresAt ● DateTime scalar​

When the approval expires; presentations cannot be made for an expired approval. Defaults to 7 days from the current date.

ApprovalRequestInput.presentationRequestInput ● ApprovalRequestPresentationInput! non-null input​

The presentation request definition for this approval.

ApprovalRequestInput.purpose ● String! non-null scalar​

Purpose for requesting approval. Markdown is supported.

ApprovalRequestInput.referenceUrl ● String scalar​

Optional URL to the artifact for approval.

ApprovalRequestInput.requestData ● JSONObject scalar​

Optional additional data that is useful for / relevant to the approval; the schema of which would vary by type.

ApprovalRequestInput.requestType ● String! non-null scalar​

The type of approval request, useful for partitioning and filtering different types of approval requests.

Member Of​

createApprovalRequest mutation