OBJECT

StepChecklistEntity

link GraphQL Schema definition

  • type StepChecklistEntity {
  • # 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
  • # Appointment type that satisfies this checklist item. Set when activity_type_id
  • # resolves to an AppointmentType.
  • appointmentType: AppointmentTypeEntity
  • # Task type that satisfies this checklist item. Set when activity_type_id resolves
  • # to a TaskType.
  • taskType: TaskTypeEntity
  • # Cloud object template that the checklist item should fill and attach to the
  • # record.
  • cloudObjectTemplate: CloudObjectTemplateEntity
  • # Email sequence the item should enroll the record into.
  • emailSequence: EmailSequenceEntity
  • # Field whose value satisfies this checklist item. Set when item_type is
  • # FieldType.
  • field: FieldEntity
  • # Process the item should run. Set when item_type is ProcessType.
  • process: ProcessEntity
  • # Field that supplies the recipient email address when the checklist item triggers
  • # sending an email.
  • sendEmailField: FieldEntity
  • # Email template used when the checklist item triggers sending an email.
  • sendEmailTemplate: EmailTemplateEntity
  • # Pipeline or process step this checklist item belongs to.
  • step: StepEntity
  • # Id of the appointment or task type that satisfies the checklist item, or empty
  • # when the item is not activity-based.
  • activityTypeId: ID
  • # Field whose values are strictly defined with an enumeration of values.
  • cloudObjectFormat: StepChecklistDocumentFormatEnum
  • # Id of the cloud object template.
  • cloudObjectTemplateId: ID
  • # Free-text description shown alongside the checklist item.
  • description: String
  • # Id of the email sequence.
  • emailSequenceId: ID
  • # Id of the related field.
  • fieldId: ID
  • # Field whose values are strictly defined with an enumeration of values.
  • itemType: StepChecklistTypeEnum
  • # Field whose values are strictly defined with an enumeration of values.
  • itemValidation: StepChecklistValidationEnum
  • # Display label of the checklist item.
  • label: String
  • # When true, label is treated as a translation key and localized in the UI;
  • # otherwise the literal text is shown.
  • labelUseLang: Boolean
  • # Id of the related process.
  • processId: ID
  • # Id of the recipient field.
  • sendEmailFieldId: ID
  • # Id of the email template.
  • sendEmailTemplateId: ID
  • # Position of the checklist item within its step; lower values appear first.
  • sortOrder: Int!
  • # Id of the step.
  • stepId: ID!
  • # Filter expression that controls when the checklist item is shown. The item is
  • # visible only when the record matches this filter; defaults to a no-op filter
  • # matching all records.
  • visibilityCondition: StepChecklistVisibilityFilter!
  • # Field whose values are strictly defined with an enumeration of values.
  • visibilityType: StepChecklistVisibilityEnum
  • # Revision when entity was lastly changed.
  • revision: Int
  • # Sales roles the checklist item is shown to. Empty means the item is shown to all
  • # roles.
  • #
  • # Arguments
  • # filter: Filter SalesRole relations by target SalesRole
  • # attributes.
  • # filterEdge: Filter StepChecklistSalesRoleRelation relations by
  • # edge (relation) StepChecklistSalesRoleRelation attributes.
  • # orderBy: Order SalesRole relations by target SalesRole
  • # 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.
  • salesRoles(
  • filter: SalesRoleFilterInput,
  • filterEdge: StepChecklistSalesRoleRelationFilterInput,
  • orderBy: [SalesRoleOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): StepChecklistSalesRoleRelationEntityConnection
  • # Checks which permissions current user has on concrete entity instance.
  • #
  • # Arguments
  • # permissions: [Not documented]
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • }