OBJECT

ProcessEntity

link GraphQL Schema definition

  • type ProcessEntity {
  • # 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
  • # User who owns the process.
  • owner: ClientEntity
  • # AI assistant conversation associated with the process (e.g. records of AI-driven
  • # schema generation).
  • aiConversation: [AiConversationItem!]
  • # Field whose values are strictly defined with an enumeration of values.
  • deactivationReason: ProcessDeactivationReasonEnum
  • # Free-text description shown alongside the process.
  • description: String
  • # When true, the process actively responds to its trigger; when false, the process
  • # is paused. Toggle via enable/disable mutations.
  • isEnabled: Boolean
  • # Timestamp of the most recent change to settings.
  • lastSchemaChange: DateTime
  • # Timestamp of the most recent change to is_enabled.
  • lastStatusChange: DateTime
  • # Name of the entity and its default text representation.
  • name: String!
  • # Id of the owning user.
  • ownerId: ID!
  • settings: ProcessSchema
  • # Field whose values are strictly defined with an enumeration of values.
  • type: ProcessTypeEnum!
  • # Activity log runs (one per process execution) recorded for this process.
  • #
  • # Arguments
  • # filter: Filter ProcessActivityLog relations by target
  • # ProcessActivityLog attributes.
  • # orderBy: Order ProcessActivityLog relations by target
  • # ProcessActivityLog 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: ProcessActivityLogFilterInput,
  • orderBy: [ProcessActivityLogOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ProcessActivityLogEntityConnection
  • # Tags attached to the process for organisation/filtering.
  • #
  • # Arguments
  • # filter: Filter Tag relations by target Tag attributes.
  • # filterEdge: Filter TagRelation relations by edge (relation)
  • # TagRelation attributes.
  • # orderBy: Order Tag relations by target Tag 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.
  • tags(
  • filter: TagFilterInput,
  • filterEdge: TagRelationFilterInput,
  • orderBy: [TagOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): TagRelationEntityConnection
  • # Timestamp of the most recent execution of this process. Empty when never run.
  • lastProcessRun: DateTime
  • # Activity timeline for the last 24 hours showing per-hour counts of successful,
  • # warning, and error process runs.
  • activity: ProcessTimelineResult!
  • # Aggregate status derived from the most recent runs in the last 24 hours:
  • # NoActivity, Running, Success, Warning, or Error.
  • status: ProcessStatusEnum
  • # For record-based triggers, which record-lifecycle event fires the process
  • # (Create, Update, Delete). Empty for non-record triggers (schedule, webhook,
  • # ...).
  • recordTriggerEvent: ProcessRecordTriggerEventEnum
  • # Kind of trigger configured for the process (RecordTrigger, ScheduleTrigger,
  • # WebhookTrigger, ...). Determines which other trigger_* fields apply.
  • triggerType: ProcessTriggerTypeEnum
  • # For record-based triggers, the entity whose records fire the process (e.g.
  • # "Lead"). Empty for non-record triggers.
  • triggerEntityName: EntityNameEnum
  • # API name of the trigger entity (useful for custom entities where this differs
  • # from trigger_entity_name). Empty for non-record triggers.
  • triggerEntityApiName: String
  • # Files attached to the process (e.g. process documentation).
  • documents: [CloudObjectRelationEntity!]
  • # Checks which permissions current user has on concrete entity instance.
  • #
  • # Arguments
  • # permissions: [Not documented]
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • }