OBJECT

ApprovalProcessEntity

Approval rule that raises approval requests for records of an entity when its trigger conditions are met, and defines who approves them.

link GraphQL Schema definition

  • type ApprovalProcessEntity {
  • # True when the record is protected against deletion because it must always exist
  • # in the space. Deleting a record that is not protected can still fail on other
  • # checks. Read-only.
  • isDeleteProtected: Boolean!
  • # Unique identifier of entity.
  • id: ID!
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • # User who owns the approval process.
  • owner: ClientEntity
  • # Free-text description shown alongside the approval process.
  • description: String
  • # Entity whose records the approval process is raised for, taken from the trigger
  • # in settings. Read-only.
  • entityType: BaseEntityTypeEnum
  • # When true, the approval process actively raises approvals on matching record
  • # events; when false, the process is paused.
  • isEnabled: Boolean!
  • # Timestamp of the most recent change to settings.
  • lastSchemaChange: DateTime
  • # Timestamp of the most recent change to isEnabled.
  • lastStatusChange: DateTime
  • # Name of the entity and its default text representation.
  • name: String!
  • # Id of the owning user.
  • ownerId: ID!
  • # Position of this process among approval processes for the same record-trigger
  • # entity type; lower values are evaluated first. Read-only; managed via
  • # update_priority. Null for manual-trigger approval processes.
  • priority: Int
  • # Approval process schema as a JSON object conforming to the ApprovalProcessSchema
  • # type — trigger, filter, approver settings, and approve/reject nodes. Validated
  • # on write. Full structure:
  • # https://api-doc.coevera.com/latest/graphql/space/approvalprocessschema.doc.html
  • # This payload conforms to the `ApprovalProcessSchema` JSON Schema:
  • # https://api-doc.coevera.com/schemas/ApprovalProcessSchema.json
  • settings: ApprovalProcessSchema
  • # Files attached to the approval process (e.g. process documentation).
  • documents: [CloudObjectRelationEntity!]
  • # Approvals (one per process run) raised by this approval process.
  • #
  • # Arguments
  • # filter: Filter Approval relations by target Approval
  • # attributes.
  • # orderBy: Order Approval relations by target Approval
  • # attributes.
  • # includeDeleted: Returns deleted target records as well. Default
  • # is true.
  • # before: Cursor until which to take entities to result set.
  • # after: Cursor after which to start taking entities to result
  • # set.
  • # first: Number of entities to return from beginning of the
  • # result set.
  • # last: Return only the "last" number of entities from result
  • # set.
  • activityLogs(
  • filter: ApprovalFilterInput,
  • orderBy: [ApprovalOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ApprovalEntityConnection
  • # For record-change triggers, the entity whose records can raise an approval (e.g.
  • # "Quote"). Empty for manual triggers.
  • triggerEntityName: EntityNameEnum
  • # Overall status of the approval process, derived from the approvals it raised
  • # since it was last enabled or its settings changed: Ok, Warning or Error. Ok when
  • # there are none.
  • status: ProcessStatusEnum
  • # How approvals are raised: Manual (a user must initiate) or RecordChange
  • # (automatically when a record matching the trigger condition is created or
  • # updated).
  • triggerType: ApprovalProcessTriggerTypeEnum
  • # Permissions the current user has on this record, out of the requested ones.
  • #
  • # Arguments
  • # permissions: Permissions to check; the result lists those the
  • # current user has.
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • }