FlowOrchestrationStageInstance

Represents a run-time instance of a stage in a run-time instance of an orchestration.

Introduced in API version 53.0.

This read-only object is available in API version 53.0 and later.

create(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()

  • If sharing rules are defined for FlowOrchestrationStageInstance, they determine access to specific orchestration stage run records. Or the user must have the View All Data permission.
  • Type: string
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The label for the flow orchestration stage instance. This label helps users and administrators differentiate between step instances from the same orchestration.
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: The API name for the flow orchestration stage instance.
  • Type: reference

  • Properties: Create, Filter, Group, Sort, Update

  • Description:

    The ID of the FlowOrchestrationInstance associated with the orchestration stage instance.

    This field is a relationship field.

  • Relationship name: OrchestrationInstance

  • Relationship type: relationship

  • Refers to: FlowOrchestrationInstance

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 56.0
  • Description: The API name of flow orchestration stage instance.
  • Type: int
  • Properties: Create, Filter, Group, Sort, Update
  • Description: For internal use only.
  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: The run status of the orchestration stage instance.
  • Possible values:
    • Completed — Completed — The stage instance completed.
    • Discontinued — Discontinued — The stage was in progress or completed when the orchestration instance encountered an error.
    • Error — Error — The stage instance encountered an error, an instance of a background step within the stage encountered and error, or an autolaunched flow called by a background step within the stage encountered an error.
    • InProgress — InProgress — The stage instance is in progress.
    • Suspended — Suspended — The stage was in progress when the orchestration instance was manually suspended.

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.