INPUT_OBJECT

StepChecklistFilterInput

Filter conditions for StepChecklist records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

link GraphQL Schema definition

  • input StepChecklistFilterInput {
  • # Matches records that meet at least one of the listed filters.
  • OR: [StepChecklistFilterInput!]
  • # Matches records that meet all of the listed filters.
  • AND: [StepChecklistFilterInput!]
  • # Matches records that do not meet this filter.
  • NOT: StepChecklistFilterInput
  • # Search term matched against the fields that the global search covers for this
  • # entity.
  • globalSearchQuery: String
  • # Unique identifier of entity.
  • id: EntityFilterStringField
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: EntityFilterDateTimeField
  • # Creation time.
  • created: EntityFilterDateTimeField
  • # Id of the appointment or task type that satisfies the checklist item, or empty
  • # when the item is not activity-based.
  • activityTypeId: EntityFilterStringField
  • # File format of the document generated from cloudObjectTemplate when itemType is
  • # UseDocumentTemplate: the template's own format or PDF.
  • cloudObjectFormat: StepChecklistDocumentFormatEnumFilterInput
  • # Id of the document template the checklist item fills and attaches to the record.
  • # Set when itemType is UseDocumentTemplate.
  • cloudObjectTemplateId: EntityFilterStringField
  • # Free-text description shown alongside the checklist item.
  • description: EntityFilterStringField
  • # Id of the email sequence the record must be enrolled in to complete the item.
  • # Set when itemType is EnrollToEmailSequence.
  • emailSequenceId: EntityFilterStringField
  • # Id of the related field.
  • fieldId: EntityFilterStringField
  • # Kind of checklist item, which determines what completes it, such as checking it
  • # off, filling in field, logging an activity of activityTypeId or running process.
  • itemType: StepChecklistTypeEnumFilterInput
  • # Condition the item must meet before the record can move past the step; empty
  • # when the item is optional. RelatedActivityCompleted is allowed only when
  • # itemType is ActivityType.
  • itemValidation: StepChecklistValidationEnumFilterInput
  • # Display label of the checklist item.
  • label: EntityFilterStringField
  • # 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: EntityFilterStringField
  • # Id of the recipient field.
  • sendEmailFieldId: EntityFilterStringField
  • # Id of the Contact or Account lookup field whose primary record supplies the
  • # recipient; empty when the recipient comes from the Primary Contact or Primary
  • # Account.
  • sendEmailLookupFieldId: EntityFilterStringField
  • # Id of the email template the email is pre-filled with when the item is completed
  • # by sending an email. Set when itemType is SendEmail; empty when no template is
  • # preset.
  • sendEmailTemplateId: EntityFilterStringField
  • # Position of the checklist item within its step; lower values appear first.
  • sortOrder: EntityFilterNumberField
  • # Id of the pipeline or process step this checklist item belongs to.
  • stepId: EntityFilterStringField
  • # Whether the item is always shown on the record or only when the record matches
  • # visibilityCondition.
  • visibilityType: StepChecklistVisibilityEnumFilterInput
  • # Revision when entity was lastly changed.
  • revision: EntityFilterNumberField
  • # Appointment type that satisfies this checklist item. Set when activityTypeId
  • # resolves to an AppointmentType. Matches records where a related record meets
  • # these conditions.
  • appointmentType: AppointmentTypeFilterInput
  • # Task type that satisfies this checklist item. Set when activityTypeId resolves
  • # to a TaskType. Matches records where a related record meets these conditions.
  • taskType: TaskTypeFilterInput
  • # Document template the checklist item fills and attaches to the record. Set when
  • # itemType is UseDocumentTemplate. Matches records where a related record meets
  • # these conditions.
  • cloudObjectTemplate: CloudObjectTemplateFilterInput
  • # Email sequence the item should enroll the record into. Matches records where a
  • # related record meets these conditions.
  • emailSequence: EmailSequenceFilterInput
  • # Field whose value satisfies this checklist item. Set when itemType is FieldType.
  • # Matches records where a related record meets these conditions.
  • field: FieldFilterInput
  • # Automatizer process that completes the item once it has run for the record. Set
  • # when itemType is RunProcess. Matches records where a related record meets these
  • # conditions.
  • process: ProcessFilterInput
  • # Field that supplies the recipient email address when the checklist item triggers
  • # sending an email. Matches records where a related record meets these conditions.
  • sendEmailField: FieldFilterInput
  • # Contact or Account lookup field whose primary record supplies the recipient.
  • # When set, sendEmailField is read from that record instead of the Primary Contact
  • # or Primary Account. Only lookup fields with a primary record are valid. Matches
  • # records where a related record meets these conditions.
  • sendEmailLookupField: FieldFilterInput
  • # Email template the email is pre-filled with when the item is completed by
  • # sending an email. Set when itemType is SendEmail. Matches records where a
  • # related record meets these conditions.
  • sendEmailTemplate: EmailTemplateFilterInput
  • # Pipeline or process step this checklist item belongs to. Matches records where a
  • # related record meets these conditions.
  • step: StepFilterInput
  • # Sales roles the checklist item is shown to. Empty means the item is shown to all
  • # roles. Matches records where a related record meets these conditions.
  • salesRoles: StepChecklistSalesRoleRelationFilterInput
  • }