INPUT_OBJECT

StepFilterInput

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

link GraphQL Schema definition

  • input StepFilterInput {
  • # Matches records that meet at least one of the listed filters.
  • OR: [StepFilterInput!]
  • # Matches records that meet all of the listed filters.
  • AND: [StepFilterInput!]
  • # Matches records that do not meet this filter.
  • NOT: StepFilterInput
  • # 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
  • # Free-text description shown in the step UI.
  • description: EntityFilterStringField
  • # When true, the record form is read-only while a record is in this step.
  • hasReadonlyForm: Boolean
  • # When true, transitioning a record into this step bumps its version counter.
  • hasVersionIncrement: Boolean
  • # Id of the lead process this step belongs to, or empty when the step is not part
  • # of a lead process.
  • leadProcessId: EntityFilterStringField
  • # Name of the entity and its default text representation.
  • name: EntityFilterStringField
  • # Probability percent associated with the step (0-100). Required for opportunity
  • # pipeline steps; null for lead/quote process steps.
  • percent: EntityFilterNumberField
  • # Id of the opportunity pipeline.
  • pipelineId: EntityFilterStringField
  • # Id of the quote process this step belongs to, or empty when the step is not part
  • # of a quote process.
  • quoteProcessId: EntityFilterStringField
  • # Position of the step within its pipeline or process; lower values appear first.
  • sortOrder: EntityFilterNumberField
  • # Expected number of days a record should spend in this step. Used to flag overdue
  • # records.
  • timeframe: EntityFilterNumberField
  • # Revision when entity was lastly changed.
  • revision: EntityFilterNumberField
  • # Lead process this step belongs to. Set when the step is part of a lead process.
  • # Matches records where a related record meets these conditions.
  • leadProcess: LeadProcessFilterInput
  • # Opportunity pipeline this step belongs to. Set when the step is part of an
  • # opportunity pipeline. Matches records where a related record meets these
  • # conditions.
  • pipeline: PipelineFilterInput
  • # Quote process this step belongs to. Set when the step is part of a quote
  • # process. Matches records where a related record meets these conditions.
  • quoteProcess: QuoteProcessFilterInput
  • # Files attached to the step (e.g. step-specific documentation or templates).
  • # Matches records where a related record meets these conditions.
  • documents: CloudObjectStepRelationFilterInput
  • # Checklist items the user must complete before moving a record out of this step.
  • # Matches records where a related record meets these conditions.
  • stepChecklists: StepChecklistFilterInput
  • }

link Require by