ControlApprovalRequest

A request raised by a control that needs approval.

type ControlApprovalRequest {
  actions: [ControlApprovalAction!]!
  aiAgent: Boolean!
  appliedAt: DateTime
  appliedBy: String
  appliedByName: String
  canApply: Boolean!
  canDecide: Boolean!
  canRecall: Boolean!
  channel: String!
  checkpoint: String!
  controlId: String!
  controlSnapshot: JSON!
  controlTitle: String!
  controlVersion: Int!
  createdAt: DateTime!
  decisionConditions: [ControlTestConditionType!]
  decisionId: String!
  documentId: String!
  documentNumber: String
  documentType: String!
  expiresAt: DateTime
  id: ID!
  onBehalfOfName: String
  onBehalfOfUserId: String
  permission: String!
  requesterName: String!
  requesterPrincipal: String!
  requesterUserId: String!
  resolvedAt: DateTime
  resolvedBy: String
  resolvedByName: String
  state: ControlApprovalState!
  stateReason: String
  viewerIsRequester: Boolean!
}

Fields

ControlApprovalRequest.actions ● [ControlApprovalAction!]! non-null object

Signatures and recalls, oldest first.

ControlApprovalRequest.aiAgent ● Boolean! non-null scalar

True when an AI agent raised it for the requester.

ControlApprovalRequest.appliedAt ● DateTime scalar

When the approved action ran.

ControlApprovalRequest.appliedBy ● String scalar

Who ran it.

ControlApprovalRequest.appliedByName ● String scalar

That person's name.

ControlApprovalRequest.canApply ● Boolean! non-null scalar

True when you hold the permission to run its action; checked again when you do.

ControlApprovalRequest.canDecide ● Boolean! non-null scalar

True when you may approve, reject or return it now.

ControlApprovalRequest.canRecall ● Boolean! non-null scalar

True when you may recall it now.

ControlApprovalRequest.channel ● String! non-null scalar

Where it came from, e.g. admin or sales_app.

ControlApprovalRequest.checkpoint ● String! non-null scalar

The checkpoint it was raised at, e.g. order.confirm.

ControlApprovalRequest.controlId ● String! non-null scalar

The control that raised it.

ControlApprovalRequest.controlSnapshot ● JSON! non-null scalar

The control's rule at that version.

ControlApprovalRequest.controlTitle ● String! non-null scalar

The control's name at that version.

ControlApprovalRequest.controlVersion ● Int! non-null scalar

The control's version when it was raised.

ControlApprovalRequest.createdAt ● DateTime! non-null scalar

When it was raised.

ControlApprovalRequest.decisionConditions ● [ControlTestConditionType!] list object

The values the control saw when the request was raised; only on a single request read, null when not recorded.

ControlApprovalRequest.decisionId ● String! non-null scalar

The control decision that raised it.

ControlApprovalRequest.documentId ● String! non-null scalar

The document's ID.

ControlApprovalRequest.documentNumber ● String scalar

The document's number, when known.

ControlApprovalRequest.documentType ● String! non-null scalar

The document's type, e.g. SalesOrder.

ControlApprovalRequest.expiresAt ● DateTime scalar

When it expires.

ControlApprovalRequest.id ● ID! non-null scalar

The request's ID.

ControlApprovalRequest.onBehalfOfName ● String scalar

That person's name.

ControlApprovalRequest.onBehalfOfUserId ● String scalar

Whom the requester acted for.

ControlApprovalRequest.permission ● String! non-null scalar

The approval permission that may sign it.

ControlApprovalRequest.requesterName ● String! non-null scalar

The requester's name.

ControlApprovalRequest.requesterPrincipal ● String! non-null scalar

staff, customer or system.

ControlApprovalRequest.requesterUserId ● String! non-null scalar

Who raised it.

ControlApprovalRequest.resolvedAt ● DateTime scalar

When it was decided, recalled or expired.

ControlApprovalRequest.resolvedBy ● String scalar

Who decided or recalled it.

ControlApprovalRequest.resolvedByName ● String scalar

That person's name.

ControlApprovalRequest.state ● ControlApprovalState! non-null enum

Where the request stands.

ControlApprovalRequest.stateReason ● String scalar

Why it is in that state.

ControlApprovalRequest.viewerIsRequester ● Boolean! non-null scalar

True when you raised it.

Returned By

approveControlRequest mutation ● controlApprovalRequest query ● recallControlRequest mutation ● rejectControlRequest mutation ● returnControlRequest mutation

Member Of

ControlApprovalApplyResult object ● ControlApprovalRequestConnection object ● DocumentControlStatus object