ApprovalRequest

An instance of an approval request.

type ApprovalRequest {
  actionedComment: String
  correlationId: ID
  expiresAt: DateTime!
  id: ID!
  isApproved: Boolean
  presentation: Presentation
  presentationRequest: JSONObject!
  purpose: String!
  referenceUrl: String
  requestData: JSONObject
  requestType: String!
  requestedAt: DateTime!
  requestedBy: User!
  status: ApprovalRequestStatus!
  updatedAt: DateTime
  updatedBy: User
}

Fields

ApprovalRequest.actionedComment ● String scalar

Optional comment on approval or rejection of this request.

ApprovalRequest.correlationId ● ID scalar

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

ApprovalRequest.expiresAt ● DateTime! non-null scalar

When the approval expires; presentations cannot be made for an expired approval.

ApprovalRequest.id ● ID! non-null scalar

ApprovalRequest.isApproved ● Boolean scalar

Indicates whether the approval has been granted.

ApprovalRequest.presentation ● Presentation object

The presentation that was provided to satisfy approval requirement

ApprovalRequest.presentationRequest ● JSONObject! non-null scalar

The presentation request definition for this approval.

ApprovalRequest.purpose ● String! non-null scalar

Purpose for requesting approval.

ApprovalRequest.referenceUrl ● String scalar

Optional URL to the artifact for approval.

ApprovalRequest.requestData ● JSONObject scalar

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

ApprovalRequest.requestType ● String! non-null scalar

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

ApprovalRequest.requestedAt ● DateTime! non-null scalar

When the approval request was created.

ApprovalRequest.requestedBy ● User! non-null object

The platform user (application or person) that requested the approval.

ApprovalRequest.status ● ApprovalRequestStatus! non-null enum

The approval status.

ApprovalRequest.updatedAt ● DateTime scalar

When the approval request was last updated.

ApprovalRequest.updatedBy ● User object

The user who last updated the approval request.

Returned By

actionApprovalRequest mutation ● approvalRequest query ● findApprovalRequests query