OBJECT

ProcessTemplateEntity

link GraphQL Schema definition

  • type ProcessTemplateEntity {
  • # 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
  • # Free-text description of what the template does.
  • description: String
  • # True when the platform recommends this template (highlighted in the template
  • # gallery).
  • isRecommended: Boolean
  • # Name of the entity and its default text representation.
  • name: String!
  • settings: ProcessSchema
  • # Files attached to the template (e.g. reference documents, screenshots).
  • documents: [CloudObjectRelationEntity!]
  • # Kind of trigger pre-configured in the template (RecordTrigger, ScheduleTrigger,
  • # WebhookTrigger, ...). Applied to any Process spawned from this template.
  • triggerType: ProcessTriggerTypeEnum
  • # For record-based triggers in the template, the entity whose records would fire a
  • # spawned process (e.g. "Lead"). Empty for non-record triggers.
  • triggerEntityName: EntityNameEnum
  • # Action-type icons present in the template schema, used for filtering templates
  • # by capability (e.g. SendEmail, CreateRecord, Webhook).
  • actionTypes: [ProcessActionTypeIconEnum!]
  • # Checks which permissions current user has on concrete entity instance.
  • #
  • # Arguments
  • # permissions: [Not documented]
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • }