OBJECT
StepEntity
link GraphQL Schema definition
- type StepEntity {
- # 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.
- : Boolean!
- # Unique identifier of entity.
- : ID!
- # Specifies if the entity is considered deleted.
- : Boolean
- # Last modification time.
- : DateTime
- # Creation time.
- : DateTime
- # Lead process this step belongs to. Set when the step is part of a lead process.
- : LeadProcessEntity
- # Opportunity pipeline this step belongs to. Set when the step is part of an
- # opportunity pipeline.
- : PipelineEntity
- # Quote process this step belongs to. Set when the step is part of a quote
- # process.
- : QuoteProcessEntity
- # Free-text description shown in the step UI.
- : String
- # When true, the record form is read-only while a record is in this step.
- : Boolean
- # When true, transitioning a record into this step bumps its version counter.
- : Boolean
- # Id of the lead process.
- : ID
- # Name of the entity and its default text representation.
- : String!
- # Probability percent associated with the step (0-100). Required for opportunity
- # pipeline steps; null for lead/quote process steps.
- : Int
- # Id of the opportunity pipeline.
- : ID
- # Id of the quote process.
- : ID
- # Position of the step within its pipeline or process; lower values appear first.
- : Int
- # Expected number of days a record should spend in this step. Used to flag overdue
- # records.
- : Int
- # Revision when entity was lastly changed.
- : Int
- # Files attached to the step (e.g. step-specific documentation or templates).
- #
- # Arguments
- # filter: Filter CloudObject relations by target CloudObject
- # attributes.
- # filterEdge: Filter CloudObjectStepRelation relations by edge
- # (relation) CloudObjectStepRelation attributes.
- # orderBy: Order CloudObject relations by target CloudObject
- # 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.
- (
- : CloudObjectFilterInput,
- : CloudObjectStepRelationFilterInput,
- : [CloudObjectOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): CloudObjectStepRelationEntityConnection
- # Checklist items the user must complete before moving a record out of this step.
- #
- # Arguments
- # filter: Filter StepChecklist relations by target StepChecklist
- # attributes.
- # orderBy: Order StepChecklist relations by target StepChecklist
- # 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.
- (
- : StepChecklistFilterInput,
- : [StepChecklistOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): StepChecklistEntityConnection
- # Checks which permissions current user has on concrete entity instance.
- #
- # Arguments
- # permissions: [Not documented]
- (: [EntityPermsEnum!]!): [EntityPermsEnum!]!
- }
link Require by
- CloudObjectStepRelationEntitynull
- CreateStepPayloadnull
- LeadEntitynull
- LeadProcessEntitynull
- OpportunityEntitynull
- OpptyRecurrenceEntitynull
- PipelineEntityPipeline entity.
- QuoteEntitynull
- QuoteProcessEntitynull
- StepChecklistEntitynull
- StepEntityEdgeA Relay edge containing a `StepEntity` and its cursor.
- StepRepositorynull
- TimeframeEntitynull
- UpdateStepPayloadnull