OBJECT

ApprovalEntity

link GraphQL Schema definition

  • type ApprovalEntity {
  • # Tells if the entity instance is protected against delete (Entities that need to
  • # be present in the system at any time). Delete action still may fail if entity is
  • # deletable, due some other additional validations.
  • 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
  • # Account the approval is requested on, when the trigger record is an Account.
  • account: AccountEntity
  • # User who triggered the approval, or empty when triggered automatically.
  • actor: ClientEntity
  • # Application context the approval was triggered in.
  • application: ApplicationEntity
  • # Approval process this approval was raised from.
  • approvalProcess: ApprovalProcessEntity
  • # Contact the approval is requested on, when the trigger record is a Contact.
  • contact: ContactEntity
  • # Lead the approval is requested on. Set when lead_oppty_id resolves to a Lead.
  • lead: LeadEntity
  • # Opportunity the approval is requested on. Set when lead_oppty_id resolves to an
  • # Opportunity.
  • oppty: OpportunityEntity
  • # Quote the approval is requested on, when the trigger record is a Quote.
  • quote: QuoteEntity
  • # Id of the linked account.
  • accountId: ID
  • # Id of the triggering user.
  • actorId: ID
  • # Id of the application.
  • applicationId: ID!
  • # Id of the approval process.
  • approvalProcessId: ID!
  • # Field whose values are strictly defined with an enumeration of values.
  • approvalStatus: ApprovalStatusEnum
  • # Comment the requester attached when raising the approval.
  • comment: String
  • # Id of the linked contact.
  • contactId: ID
  • # Timestamp the approval reached a final status (Approved/Rejected/Cancelled).
  • # Empty while the approval is still pending.
  • endTime: DateTime
  • # Id of the linked lead or opportunity, or empty when not linked.
  • leadOpptyId: ID
  • # Id of the linked quote.
  • quoteId: ID
  • # Snapshot of the approval process schema at the time the approval was raised.
  • # Frozen so subsequent changes to the parent approval process do not affect this
  • # run.
  • settings: JSONString!
  • # Field whose values are strictly defined with an enumeration of values.
  • status: ProcessStatusEnum
  • # Revision when entity was lastly changed.
  • revision: Int
  • # Users who must respond to the approval, with their individual responses.
  • #
  • # Arguments
  • # filter: Filter ApprovalApprover relations by target
  • # ApprovalApprover attributes.
  • # orderBy: Order ApprovalApprover relations by target
  • # ApprovalApprover 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.
  • approvers(
  • filter: ApprovalApproverFilterInput,
  • orderBy: [ApprovalApproverOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ApprovalApproverEntityConnection
  • # Activity log lines describing the steps taken on this approval (visible only).
  • #
  • # Arguments
  • # filter: Filter ApprovalProcessActivityLogLine relations by
  • # target ApprovalProcessActivityLogLine attributes.
  • # orderBy: Order ApprovalProcessActivityLogLine relations by
  • # target ApprovalProcessActivityLogLine 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.
  • lines(
  • filter: ApprovalProcessActivityLogLineFilterInput,
  • orderBy: [ApprovalProcessActivityLogLineOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ApprovalProcessActivityLogLineEntityConnection
  • # Display name of the approval, derived from the underlying record being approved
  • # (e.g. the quote name). Empty when the underlying record has been deleted.
  • name: String
  • # Id of the user who owns the record being approved (the record's owner, not the
  • # approver). Empty when the underlying record has been deleted.
  • ownerId: UUID
  • # Type identifier (e.g. account type, quote type) of the underlying record being
  • # approved. Empty when the underlying record has no type or has been deleted.
  • entityType: BaseEntityTypeEnum
  • # Timestamp the approval was raised (alias of created).
  • startTime: DateTime
  • # Checks which permissions current user has on concrete entity instance.
  • #
  • # Arguments
  • # permissions: [Not documented]
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • }