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.
- : Boolean!
- # Unique identifier of entity.
- : ID!
- # Specifies if the entity is considered deleted.
- : Boolean
- # Last modification time.
- : DateTime
- # Creation time.
- : DateTime
- # User who owns the approval process.
- : ClientEntity
- # Free-text description shown alongside the approval process.
- : String
- # Entity whose records the approval process is raised for, taken from the trigger
- # in settings. Read-only.
- : BaseEntityTypeEnum
- # When true, the approval process actively raises approvals on matching record
- # events; when false, the process is paused.
- : Boolean!
- # Timestamp of the most recent change to settings.
- : DateTime
- # Timestamp of the most recent change to isEnabled.
- : DateTime
- # Name of the entity and its default text representation.
- : String!
- # Id of the owning user.
- : 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.
- : 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
- : ApprovalProcessSchema
- # Files attached to the approval process (e.g. process documentation).
- : [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.
- (
- : ApprovalFilterInput,
- : [ApprovalOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): ApprovalEntityConnection
- # For record-change triggers, the entity whose records can raise an approval (e.g.
- # "Quote"). Empty for manual triggers.
- : 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.
- : ProcessStatusEnum
- # How approvals are raised: Manual (a user must initiate) or RecordChange
- # (automatically when a record matching the trigger condition is created or
- # updated).
- : 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.
- (: [EntityPermsEnum!]!): [EntityPermsEnum!]!
- }
link Require by
- ApprovalEntityApproval request that an approval process raised for a record, such as a quote or an opportunity, waiting for the decision of its approvers.
- ApprovalProcessEntityEdgeA Relay edge containing a `ApprovalProcessEntity` and its cursor.
- ApprovalProcessRepositoryRead operations for ApprovalProcess records.
- CloudObjectRelationEntityAttachment of a file to a record, such as an account, contact, opportunity, activity or email template, optionally in a folder of that record.
- CreateApprovalProcessPayloadResult of the createApprovalProcess mutation.
- DeleteApprovalProcessPayloadResult of the deleteApprovalProcess mutation.
- UpdateApprovalProcessPayloadResult of the updateApprovalProcess mutation.