{ "sections": [ "title", "description", "fields", "special_access_rules", "associated_objects", "wsdl_segment", "field_reference" ], "title": "FlowOrchestrationInstance - Data API", "description": "Represents a run-time instance of an orchestration. This object is available in API version 53.0 and later.", "fields_columns": [ "type", "properties", "description", "relationship_name", "relationship_type", "refers_to" ], "fields": { "AuxiliaryTriggeringRecord": { "type": "string", "properties": "Create, Filter, Group, Nillable, Sort, Update", "description": "The related object ID or service appointment ID. This fields isn’t used by flow approval processes or orchestrations. This field is available in API version 65.0 and later." }, "CurrentStage": { "type": "string", "properties": "Filter, Group, Nillable, Sort", "description": "The API name of the stage that was running when the orchestration run was paused or failed because of an error in an action called by a step. This field is available in API version 62.0 and later." }, "Duration": { "type": "long", "properties": "Filter, Group, Nillable, Sort", "description": "The duration of the orchestration instance in seconds. Durations are incremented until the orchestration is completed, canceled, or ends in an error. This field is available in API version 62.0 and later." }, "FlowDefinitionVersionName": { "type": "picklist", "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update", "description": "The fully qualified API name of the underlying orchestration. Possible values are active flow approval processes and orchestrations in the org. This field is available in API version 62.0 and later." }, "FlowType": { "type": "picklist", "properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update", "description": "The flow type of the orchestration that created the orchestration work item. Valid values are: ApprovalOrchAutolnch—Autolaunched Flow Approval Process ApprovalOrchRecTrigAftSave—Record-Triggered After Save Flow Approval Process ExtSysChgFlowAppvl—External System Change-Triggered Flow Approval Process ExtSysChgOrch—External System Change-Triggered Orchestration OrchAutolnch—Autolaunched No Trigger Orchestration OrchRecTrigAftSave—Record-Triggered After Save Orchestration This field is available in API version 62.0 and later." }, "InterviewId": { "type": "reference", "properties": "Create, Filter, Group, Nillable, Sort, Update", "description": "The globally unique flow interview ID associated with the orchestration instance. This field is a relationship field.", "relationship_name": "Interview", "relationship_type": "Lookup", "refers_to": "FlowInterview" }, "IsDebugRun": { "type": "boolean", "properties": "Create, Defaulted on create, Filter, Group, Sort, Update", "description": "Indicates whether the instance was executed from a debug run. The default value is false. This field is available in API version 65.0 and later." }, "LastReferencedDate": { "type": "dateTime", "properties": "Filter, Nillable, Sort", "description": "The most recent time a user viewed a record related to the orchestration run. This field is available in API version 55.0 and later." }, "LastViewedDate": { "type": "dateTime", "properties": "Filter, Nillable, Sort", "description": "The most recent time a user viewed the orchestration run. This field is available in API version 55.0 and later." }, "Name": { "type": "string", "properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort", "description": "The name for the orchestration instance." }, "OrchestrationDeveloperName": { "type": "string", "properties": "Filter, Group, Nillable, Sort", "description": "The developer name of the flow definition associated with the orchestration run. This field is available in API version 55.0 and later." }, "OrchestrationLabel": { "type": "string", "properties": "Filter, Group, Nillable, Sort", "description": "The label of the orchestration. This field is available in API version 63.0 and later." }, "OwnerId": { "type": "reference", "properties": "Filter, Group, Sort", "description": "The ID of the automated process user. This field is available in API version 56.0 and later.", "relationship_name": "Owner", "relationship_type": "Lookup", "refers_to": "User" }, "Status": { "type": "picklist", "properties": "Filter, Group, Restricted picklist, Sort, Update", "description": "The status of the orchestration run. Valid values are: Canceled—The orchestration instance was canceled. Completed—The orchestration instance completed. Error—The orchestration instance, or a stage or step within the orchestration instance, encountered an error. InProgress—The orchestration instance is in progress. Suspended—The orchestration instance was suspended." }, "TriggeringRecord": { "type": "string", "properties": "Create, Filter, Group, Nillable, Sort, Update", "description": "The ID of the record that triggered the record-triggered orchestration. This field is available in API version 62.0 and later." }, "TriggeringRecordType": { "type": "string", "properties": "Create, Filter, Group, Nillable, Sort, Update", "description": "The name of the Salesforce object configured to trigger the orchestration. This field is available in API version 64.0 and later." } }, "special_access_rules": "If sharing rules are defined for FlowOrchestrationInstance, they determine access to specific orchestration run records. Or the user must have the View All Data permission.", "associated_objects": "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 and later.\n\n- **FlowOrchestrationInstanceFeed**: Feed tracking is available for the object.\n- **FlowOrchestrationInstanceHistory**: History is available for tracked fields of the object.\n- **FlowOrchestrationInstanceOwnerSharingRule**: Sharing rules are available for the object. This object is available in API version 56.0 and later.\n- **FlowOrchestrationInstanceShare**: Sharing is available for the object. This object is available in API version 56.0 and later.", "wsdl_segment": "```xml\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n\n\n \n\n\n \n \n \n \n \n \n\n```", "field_reference": { "AuxiliaryTriggeringRecord": { "field_label": "Auxiliary Triggering Record", "type": "string", "length": "40" }, "CreatedById": { "field_label": "Created By ID", "type": "reference", "length": "18" }, "CreatedDate": { "field_label": "Created Date", "type": "datetime" }, "CurrencyIsoCode": { "field_label": "Currency ISO Code", "type": "picklist", "length": "3" }, "CurrentStage": { "field_label": "Current Stage", "type": "string", "length": "100" }, "Duration": { "field_label": "Duration", "type": "long", "digits": "18" }, "FlowDefinitionVersionName": { "field_label": "Flow Definition Version Name", "type": "picklist", "length": "255" }, "FlowType": { "field_label": "Flow Type", "type": "picklist", "length": "255" }, "Id": { "field_label": "Orchestration Run ID", "type": "id", "length": "18" }, "InterviewId": { "field_label": "Interview ID", "type": "reference", "length": "18" }, "IsDebugRun": { "field_label": "Debug Run", "type": "boolean" }, "IsDeleted": { "field_label": "Deleted", "type": "boolean" }, "LastModifiedById": { "field_label": "Last Modified By ID", "type": "reference", "length": "18" }, "LastModifiedDate": { "field_label": "Last Modified Date", "type": "datetime" }, "LastReferencedDate": { "field_label": "Last Referenced Date", "type": "datetime" }, "LastViewedDate": { "field_label": "Last Viewed Date", "type": "datetime" }, "Name": { "field_label": "Name", "type": "string", "length": "255" }, "OrchestrationDeveloperName": { "field_label": "Orchestration Developer Name", "type": "string", "length": "80" }, "OrchestrationLabel": { "field_label": "Orchestration Name", "type": "string", "length": "255" }, "OrchestrationName": { "field_label": "Orchestration Developer Name", "type": "string", "length": "80" }, "OwnerId": { "field_label": "Owner ID", "type": "reference", "length": "18" }, "Status": { "field_label": "Status", "type": "picklist", "length": "255" }, "SystemModstamp": { "field_label": "System Modstamp", "type": "datetime" }, "TriggeringRecord": { "field_label": "Triggering Record ID", "type": "string", "length": "40" }, "TriggeringRecordType": { "field_label": "Triggering Record Type", "type": "string", "length": "40" } }, "field_reference_columns": [ "field_label", "type", "length", "digits" ] }