{
  "sections": [
    "title",
    "description",
    "fields",
    "associated_objects",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "FlowOrchestration - Data API",
  "description": "Represents the details of an orchestration definition. This object is available in API version 62.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "refers_to"
  ],
  "fields": {
    "ActiveVersionId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The ID of the active orchestration version. This field is a relationship field. This field is a relationship field.",
      "relationship_name": "ActiveVersion",
      "refers_to": "FlowOrchestrationVersion"
    },
    "ApiName": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The API name of the the orchestration."
    },
    "ApiVersion": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The API version of the active orchestration or the last saved orchestration."
    },
    "AverageRunTime": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The average duration of an orchestration run that has completed without error."
    },
    "CompletionRate": {
      "type": "percent",
      "properties": "Filter, Nillable, Sort",
      "description": "The percentage of the total number of orchestration runs that have completed without error."
    },
    "Description": {
      "type": "textarea",
      "properties": "Nillable, Update",
      "description": "The description of the flow orchestration."
    },
    "FailedRunCount": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of orchestration runs that have failed."
    },
    "InstalledPackageName": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The API name of the installed package that the orchestration is a part of."
    },
    "IsCitizenEnabled": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "Indicates whether the orchestration can be modified by non-admins. Valid value is False. The default value is false."
    },
    "IsOverridable": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "Indicates whether the orchestration that's part of a managed package is overridable. The default value is false."
    },
    "IsTemplate": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "Indicates whether the orchestration record is a template. The default value is false."
    },
    "LastReferencedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The timestamp for when the current user last viewed a record related to this record."
    },
    "LastViewedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The timestamp for when the current user last viewed this record."
    },
    "ManageableState": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Specifies the managable state of the orchestration that's contained in a package. Valid values are: beta—Managed-Beta deleted—Managed-Proposed-Deleted deprecated—Managed-Proposed-Deprecated deprecatedEditable—SecondGen-Installed-Deprecated installed—Managed-Installed installedEditable—SecondGen-Installed-Editable released—Managed-Released unmanaged—Unmanaged"
    },
    "Name": {
      "type": "string",
      "properties": "Filter, Group, idLookup, Sort, Update",
      "description": "The label of the orchestration."
    },
    "NamespacePrefix": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The namespace prefix associated with the orchestration record."
    },
    "OrchestrationDefinition": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "Represents the orchestration definition."
    },
    "OrchestrationLabel": {
      "type": "string",
      "properties": "Filter, Group, Nillable, Sort, Update",
      "description": "The label of the orchestration."
    },
    "OrchestrationType": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The orchestration's flow type. FlowType consolidates ProcessType and TriggerType into one field. FlowType is used with permissions, so admins can control access to each flow type. Valid values are: OrchAutolnch—Autolaunched No Trigger Orchestration: Launches when invoked by Apex, REST API, custom buttons, or custom links. An orchestration lets you create a multi-step, multi-user process. OrchRecTrigAftSave—Record-Triggered After Save Orchestration: Launches when a record is created or updated. An orchestration lets you create a multi-step, multi-user process. This type of flow runs in the background without user interaction. CmsOrchAutolnch —CMS Workflow Orchestration Autolaunched: Launches when invoked from the Workflows component in a CMS workspace. This type of orchestration lets you create a multi-step, multi-user process to create, edit, organize, and manage digital content from a centralized location"
    },
    "OverriddenById": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The ID of the orchestration that's overriding the current orchestration. This field is a relationship field.",
      "relationship_name": "OverriddenBy",
      "refers_to": "FlowOrchestration"
    },
    "OverriddenOrchestrationId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The ID of the orchestration that the current orchestration is overriding. This field is a relationship field.",
      "relationship_name": "OverriddenOrchestration",
      "refers_to": "FlowOrchestration"
    },
    "RunCount": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The number of orchestration runs that have been started across all orchestration versions."
    },
    "SourceTemplateId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The ID of the template that the orchestration was created from. This field is a relationship field.",
      "relationship_name": "SourceTemplate",
      "refers_to": "FlowOrchestration"
    },
    "Status": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "The status of the record. Valid values are: Active—Active Draft—Inactive InvalidDraft—Draft Obsolete—Inactive UnderReview—Under Review"
    },
    "TriggerType": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Specifies the trigger type for a record-triggered orchestration. Valid values are: RecordAfterSave—Record—Run After Save"
    }
  },
  "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- **FlowOrchestrationChangeEvent**: Change events are available for the object.",
  "wsdl_segment": "```xml\n<complexType name=\"FlowOrchestration\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"ActiveVersion\" nillable=\"true\" minOccurs=\"0\" type=\"ens:FlowOrchestrationVersion\"/>\n        <element name=\"ActiveVersionId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"ApiName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ApiVersion\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"AverageRunTime\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"CompletionRate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"Description\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"FailedRunCount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"FlowOrchestrationRuns\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"FlowOrchestrationVersions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"InstalledPackageName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"IsCitizenEnabled\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsOverridable\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsTemplate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"ManageableState\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"NamespacePrefix\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"OrchestrationDefinition\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"OrchestrationLabel\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"OrchestrationType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"OverriddenBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:FlowOrchestration\"/>\n        <element name=\"OverriddenById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"OverriddenOrchestration\" nillable=\"true\" minOccurs=\"0\" type=\"ens:FlowOrchestration\"/>\n        <element name=\"OverriddenOrchestrationId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"RunCount\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"SourceTemplate\" nillable=\"true\" minOccurs=\"0\" type=\"ens:FlowOrchestration\"/>\n        <element name=\"SourceTemplateId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"Status\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"TriggerType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n<simpleType name=\"QueryLocator\">\n  <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n  <sequence>\n    <element name=\"done\" type=\"xsd:boolean\"/>\n    <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n    <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n    <element name=\"size\" type=\"xsd:int\"/>\n  </sequence>\n</complexType>\n```",
  "field_reference": {
    "ActiveVersionId": {
      "field_label": "Orchestration Version ID",
      "type": "reference",
      "length": "18"
    },
    "ApiName": {
      "field_label": "API Name",
      "type": "string",
      "length": "255"
    },
    "ApiVersion": {
      "field_label": "API Version",
      "type": "int",
      "digits": "9"
    },
    "AverageRunTime": {
      "field_label": "Average Run Time",
      "type": "int",
      "digits": "9"
    },
    "CompletionRate": {
      "field_label": "Completion Rate",
      "type": "percent",
      "precision": "3",
      "scale": "0"
    },
    "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"
    },
    "Description": {
      "field_label": "Description",
      "type": "textarea",
      "length": "65535"
    },
    "FailedRunCount": {
      "field_label": "Failed Run Count",
      "type": "int",
      "digits": "9"
    },
    "Id": {
      "field_label": "Orchestration ID",
      "type": "id",
      "length": "18"
    },
    "InstalledPackageName": {
      "field_label": "Package Name",
      "type": "string",
      "length": "255"
    },
    "IsCitizenEnabled": {
      "field_label": "Citizen Enabled",
      "type": "boolean"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "IsOverridable": {
      "field_label": "Overridable",
      "type": "boolean"
    },
    "IsTemplate": {
      "field_label": "Template",
      "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"
    },
    "ManageableState": {
      "field_label": "Package State",
      "type": "picklist",
      "length": "255"
    },
    "Name": {
      "field_label": "Orchestration Label",
      "type": "string",
      "length": "255"
    },
    "NamespacePrefix": {
      "field_label": "Orchestration Namespace",
      "type": "string",
      "length": "40"
    },
    "OrchestrationDefinition": {
      "field_label": "Orchestration Definition",
      "type": "string",
      "length": "15"
    },
    "OrchestrationLabel": {
      "field_label": "Orchestration Label",
      "type": "string",
      "length": "255"
    },
    "OrchestrationType": {
      "field_label": "Orchestration Type",
      "type": "picklist",
      "length": "255"
    },
    "OverriddenById": {
      "field_label": "Orchestration ID",
      "type": "reference",
      "length": "18"
    },
    "OverriddenOrchestrationId": {
      "field_label": "Orchestration ID",
      "type": "reference",
      "length": "18"
    },
    "RunCount": {
      "field_label": "Run Count",
      "type": "int",
      "digits": "9"
    },
    "SourceTemplateId": {
      "field_label": "Orchestration ID",
      "type": "reference",
      "length": "18"
    },
    "Status": {
      "field_label": "Status",
      "type": "picklist",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "TriggerType": {
      "field_label": "Trigger Type",
      "type": "picklist",
      "length": "255"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "digits",
    "precision",
    "scale"
  ]
}