INPUT_OBJECT

StepChecklistOrderByInput

Sorting of StepChecklist records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

link GraphQL Schema definition

  • input StepChecklistOrderByInput {
  • # Unique identifier of entity.
  • id: OrderByEnum
  • # Specifies if the entity is considered deleted.
  • isDeleted: OrderByEnum
  • # Last modification time.
  • modified: OrderByEnum
  • # Creation time.
  • created: OrderByEnum
  • # Appointment type that satisfies this checklist item. Set when activityTypeId
  • # resolves to an AppointmentType. Sorts by fields of the related record, listed in
  • # order of priority.
  • appointmentType: [AppointmentTypeOrderByNestedInput!]
  • # Task type that satisfies this checklist item. Set when activityTypeId resolves
  • # to a TaskType. Sorts by fields of the related record, listed in order of
  • # priority.
  • taskType: [TaskTypeOrderByNestedInput!]
  • # Document template the checklist item fills and attaches to the record. Set when
  • # itemType is UseDocumentTemplate. Sorts by fields of the related record, listed
  • # in order of priority.
  • cloudObjectTemplate: [CloudObjectTemplateOrderByNestedInput!]
  • # Email sequence the item should enroll the record into. Sorts by fields of the
  • # related record, listed in order of priority.
  • emailSequence: [EmailSequenceOrderByNestedInput!]
  • # Field whose value satisfies this checklist item. Set when itemType is FieldType.
  • # Sorts by fields of the related record, listed in order of priority.
  • field: [FieldOrderByNestedInput!]
  • # Automatizer process that completes the item once it has run for the record. Set
  • # when itemType is RunProcess. Sorts by fields of the related record, listed in
  • # order of priority.
  • process: [ProcessOrderByNestedInput!]
  • # Field that supplies the recipient email address when the checklist item triggers
  • # sending an email. Sorts by fields of the related record, listed in order of
  • # priority.
  • sendEmailField: [FieldOrderByNestedInput!]
  • # 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. Sorts by
  • # fields of the related record, listed in order of priority.
  • sendEmailLookupField: [FieldOrderByNestedInput!]
  • # Email template the email is pre-filled with when the item is completed by
  • # sending an email. Set when itemType is SendEmail. Sorts by fields of the related
  • # record, listed in order of priority.
  • sendEmailTemplate: [EmailTemplateOrderByNestedInput!]
  • # Pipeline or process step this checklist item belongs to. Sorts by fields of the
  • # related record, listed in order of priority.
  • step: [StepOrderByNestedInput!]
  • # Id of the appointment or task type that satisfies the checklist item, or empty
  • # when the item is not activity-based.
  • activityTypeId: OrderByEnum
  • # File format of the document generated from cloudObjectTemplate when itemType is
  • # UseDocumentTemplate: the template's own format or PDF.
  • cloudObjectFormat: OrderByEnum
  • # Id of the document template the checklist item fills and attaches to the record.
  • # Set when itemType is UseDocumentTemplate.
  • cloudObjectTemplateId: OrderByEnum
  • # Free-text description shown alongside the checklist item.
  • description: OrderByEnum
  • # Id of the email sequence the record must be enrolled in to complete the item.
  • # Set when itemType is EnrollToEmailSequence.
  • emailSequenceId: OrderByEnum
  • # Id of the related field.
  • fieldId: OrderByEnum
  • # 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: OrderByEnum
  • # 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: OrderByEnum
  • # Display label of the checklist item.
  • label: OrderByEnum
  • # When true, label is treated as a translation key and localized in the UI;
  • # otherwise the literal text is shown.
  • labelUseLang: OrderByEnum
  • # Id of the related process.
  • processId: OrderByEnum
  • # Id of the recipient field.
  • sendEmailFieldId: OrderByEnum
  • # 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: OrderByEnum
  • # 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: OrderByEnum
  • # Position of the checklist item within its step; lower values appear first.
  • sortOrder: OrderByEnum
  • # Id of the pipeline or process step this checklist item belongs to.
  • stepId: OrderByEnum
  • # Whether the item is always shown on the record or only when the record matches
  • # visibilityCondition.
  • visibilityType: OrderByEnum
  • # Revision when entity was lastly changed.
  • revision: OrderByEnum
  • }