afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/FlowDefinitionView.json

368 lines
27 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"sections": [
"title",
"description",
"fields",
"usage",
"wsdl_segment",
"field_reference"
],
"title": "FlowDefinitionView - Data API",
"description": "Represents the description of a flow definition. This object is available in API version 46.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"ActiveVersionId": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The ID of the active flow version."
},
"ApiName": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The API name of the flow definition."
},
"ApiVersion": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The API version of the flow definition. Available in API version 59.0 and later."
},
"AreMetricsLoggedToDataCloud": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "Indicates whether this flows metrics are logged in Data Cloud. The default value is false. This field is available in API version 63.0 and later."
},
"Builder": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The name of the tool that created this flow. Possible values are: Cloud Flow Designer Flow Builder Swing Designer"
},
"CapacityCategory": {
"type": "picklist",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "The category that determines the usage limits of the flow. Possible values are: Marketing Cloud Flow"
},
"Description": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "Flow definition information, specified by the orgs admin."
},
"DurableId": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The ID of the flow definition."
},
"Environments": {
"type": "multipicklist",
"properties": "Filter, Nillable",
"description": "The environment in which the flow can run. Valid values are: Default—The flow can run from a Visualforce component, Lightning page, flow action, or custom Aura component. Offline—The flow can run only offline. Flow types that support offline flows must set this value. This value is available in API version 62.0 and later. Slack—The flow can run in Slack and the default environment. You specify the Slack flow environment when you save the flow. This field is available in API version 55.0 to 62.0. This field is deprecated in API version 63.0 and later."
},
"HasAsyncAfterCommitPath": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "Indicates whether the scheduled path runs asynchronously after a save. The default value is false. This field is available in API version 54.0 and later."
},
"InstalledPackageName": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The name of the installed package that includes this flow definition."
},
"IsActive": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "Indicates whether the latest version of the flow definition is the active flow version."
},
"IsOutOfDate": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "Indicates whether the active flow version is the latest version of the flow definition."
},
"IsOverridable": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "Indicates whether the flow is overridable. The default value is false. This field is available in API version 53.0 and later."
},
"IsSwingFlow": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "Indicates whether the flow is built with Desktop Flow Designer."
},
"IsTemplate": {
"type": "boolean",
"properties": "Defaulted on create, Filter, Group, Sort",
"description": "Indicates whether the process or flow is a template. The default value is false. When installed from managed packages, subscribers cant view or clone processes or flows because of intellectual property (IP) protection. But when those processes and flows are templates, subscribers can open them in a builder, clone them, and customize the clones."
},
"Label": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The label of the flow definition."
},
"LastModifiedBy": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "Name of the user who last updated this flow definition."
},
"LatestVersionId": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The ID of the latest flow version, regardless of the flows status."
},
"ManageableState": {
"type": "picklist",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "Indicates the manageable state of the flow that is contained in a package. Possible values are: beta deleted deprecated deprecatedEditable installed installedEditable released unmanaged"
},
"NamespacePrefix": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The namespace prefix associated with the flow definition."
},
"OverriddenById": {
"type": "string",
"properties": "Filter, Nillable, Sort",
"description": "The flow thats overriding the current flow. This is a relationship field. This field is available in API version 53.0 and later.",
"relationship_name": "OverriddenBy",
"relationship_type": "Lookup",
"refers_to": "FlowDefinitionView"
},
"OverriddenFlowId": {
"type": "string",
"properties": "Filter, Nillable, Sort",
"description": "The flow that the current flow is overriding. This is a relationship field. This field is available in API version 53.0 and later.",
"relationship_name": "OverriddenFlow",
"relationship_type": "Lookup",
"refers_to": "FlowDefinitionView"
},
"ProcessType": {
"type": "picklist",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "The type of the flow. Valid values are: ActionableEventManagementFlow—A flow that triggers an actionable event orchestration process in the background and automatically executes different types of actions based on the event type. This value is available in API version 62.0 and later. ActionCadenceAutolaunchedFlow—A flow thats executed when a user completes a cadence step. This value is available in API version 56.0 and later. ActionCadenceStepFlow—A screen flow used as a cadence step. This value is available in API version 56.0 and later. ActivityObjectMatchingFlow—A flow that launches when Einstein Activity Capture detects and captures a new activity, such as an email. This type of flow runs in the background without user interaction. This value is available with Sync Email as Salesforce Activity in API version 64.0 and later. Appointments—A flow for Lightning Scheduler. This value is available in API version 44.0 and later. ApprovalWorkflow—An orchestration thats used for an approval process. This value is available in API version 63.0 and later. AutoLaunchedFlow—A flow that doesnt require user interaction. CheckoutFlow—A flow used in Lightning B2B Commerce to create a checkout in a store. This value is available in API version 48.0 and later. ContactRequestFlow—A flow that lets customers request to be contacted by customer support. This flow is used to create contact request records. This value is available in API version 45.0 and later. CustomerLifecycle—A Salesforce Surveys flow that lets you associate survey questions with different stages in customer lifecycles. This value is available in API version 49.0 and later and only when the Customer Lifecycle Designer license is enabled. CustomEvent—A process that is invoked when it receives a platform event message. In the UI, its an event process. This value is available in API version 41.0 and later. DataCaptureFlow— In the UI, Data Capture flows configure the Form tab in the Field Service mobile app. When the Data Capture flow is launched, its Flow metadata is publicly available in JavaScript format. This value is available in API version 62.0 and later. DcvrFrameworkDataCaptureFlow—A screen flow that presents assessment questions from Discovery Framework. Launches when invoked by a user on a mobile device. This type of flow collects or displays information, requires user interaction, and works offline or online. This value is available in API version 62.0 and later. EvaluationFlow—A flow for evaluating custom entry and exit conditions in an orchestration. Uses the isOrchestrationConditionMet output variable and discards values from any other output variables. This value is available in API version 54.0 and later. FieldServiceMobile—A flow for the Field Service mobile app. This value is available in API version 39.0 and later. FieldServiceWeb—A flow for embedded Appointment Booking. Its UI label is Field Service Embedded Flow. This value is available in API version 41.0 and later. Flow—A flow that requires user interaction because it contains one or more screens or local actions, choices, or dynamic choices. In the UI and Salesforce Help, its a screen flow. Screen flows can be launched from the UI, such as with a flow action, Lightning page, or web tab. FSCLending—A flow for Financial Services Cloud Mortgage. This value is available in API version 46.0 and later. IdentityUserRegistrationFlow—A flow to handle user registration and updates for single sign-on with the authentication provider framework. Available in API version 64.0 and later. IndicatorResultFlow—A flow for Outcome Management that calculates and creates indicator results for a selected indicator performance period. This value is available with the Outcome Management license in API version 60.0 and later. IndividualObjectLinkingFlow—A flow that associates individuals with interactions such as voice calls, messaging sessions, or case-related emails. This value is available in API version 58.0 and later. InvocableProcess—A process that another process or the Invocable Actions resource in REST API invokes. This value is available in API version 38.0 and later. Journey—An audience-driven flow for Marketing Cloud. This value is available in API version 57.0 and later. LoginFlow—A flow for login. This value is available in API version 51.0 and later. LoyaltyManagementFlow—A flow for the Loyalty Management app thats invokable by loyalty program processes. This value is available in API version 54.0 and later. Orchestrator—An orchestration that organizes flows into groups of steps contained in a series of stages. This value is available in API version 53.0 and later. PromptFlow—A flow for Prompt Builder. Pass data between Prompt Builder and the flow. This value is available in API version 60.0 and later. RecommendationStrategy—Build recommendations for your users. A recommendation launches its assigned flow. This value is available in API version 54.0 and later. See Flow Builder Strategies. RoutingFlow—A flow for Salesforce Omni-Channel routing and other business logic. This value is available in API version 52.0 and later. Survey—A flow for Salesforce Surveys. From the UI, this type of flow is created in Survey Builder. This value is available in API version 42.0 and later. SurveyEnrich—A Salesforce Surveys flow that uses the Survey Data Mapper. From the UI, this type of flow is created in the Survey Builder and requires an associated survey flow type. This value is available in API version 49.0 or later and only when the Customer Lifecycle Designer license is enabled. Workflow—A process that is invoked when a record is created or edited. In the UI and Salesforce Help, its a record change process. These values are reserved for future use: ActionPlan AppProcess ApprovalWorkflow CartAsyncFlow DigitalForm JourneyBuilderIntegration LoginFlow ManagedContentFlow OrchestrationFlow SalesEntryExperienceFlow TransactionSecurityFlow UserProvisioningFlow This value has significant impact on validation when saving the flow and on the flows runtime behavior. Dont change this value unless you understand the flow properties of the specified type."
},
"RecordTriggerType": {
"type": "picklist",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "Specifies what type of record changes can start the flow. Possible values are: Create CreateAndUpdate Delete None Update Available only when triggerType is RecordBeforeSave. This field is available in API version 54.0 and later."
},
"SourceTemplateId": {
"type": "string",
"properties": "Filter, Nillable, Sort",
"description": "The template that the current flow was created from. This is a relationship field. This field is available in API version 53.0 and later.",
"relationship_name": "SourceTemplate",
"relationship_type": "Lookup",
"refers_to": "FlowDefinitionView"
},
"SupportedEnvironments": {
"type": "string",
"properties": "Filter, Nillable",
"description": "The environment in which the flow can run. Valid values are: Default—The flow can run from a Visualforce component, Lightning page, flow action, or custom Aura component. Offline—The flow can run only offline. Flow types that support offline flows must set this value. Slack—The flow can run in Slack and the default environment. You specify the Slack flow environment when you save the flow. This field is available in API version 63.0 and later."
},
"TriggerObjectOrEventId": {
"type": "string",
"properties": "Filter, Nillable, Sort",
"description": "ID of the object or platform event that triggers this flow. This field is available in API version 53.0 and later.This is a relationship field.",
"relationship_name": "TriggerObjectOrEvent",
"relationship_type": "Lookup",
"refers_to": "EntityDefinition"
},
"TriggerObjectOrEventLabel": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The label of the object or platform event that triggers this flow. This field is available in API version 53.0 and later."
},
"TriggerOrder": {
"type": "int",
"properties": "Filter, Group, Nillable, Sort",
"description": "The run order of a record-triggered flow, from 1 to 2,000. See \"Guidelines for Defining the Run Order of Record-Triggered Flows for an Object\" in Salesforce Help. Available in API version 54.0 and later."
},
"TriggerType": {
"type": "picklist",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "Specifies what causes the flow to run. If you exclude this field, the flow has no trigger and starts only when a user or app launches the flow. Valid values are: AutomationEvent—The flow starts when an automation event such as an SMS subscription occurs. This value is available in API version 62.0 and later. CampaignMember—t the scheduled time, the flow performs actions on or sends messages to individuals from the selected campaign. This value is available in API version 67.0 and later. Capability—The flow starts when the specified capability that the flow integrates with is invoked. This value is available in API version 60.0 and later. CrmRecordQuery—At the scheduled time, the flow performs actions on or sends messages to individuals from the queried customer relationship management record. This value is available in API version 67.0 and later. DataCloudDataChange—The flow starts when data model object (DMO) or calculated insight object (CIO) conditions are met. This value is available in API version 59.0 and later. DataGraphDataChange—The flow starts when conditions are met in the specified data graph field. This value is available in API version 63.0 and later. EnterpriseScaleExternalSystemChange—The flow runs when triggered by MuleSoft. This value is available in API version 67.0 and later. EventDrivenJourney—Reserved for internal use. ExternalSystemChange—The flow starts when an external system change event is received. This value is available in API version 61.0 and later. FormSubmissionEvent—The flow runs when a user submits data via a webform. In Flow Builder, this value corresponds to Form. This value is available in API version 60.0 and later. IndivRelatedRecord—The flow starts when an object or an object with fields related to an individual is created or updated. This value is available in API version 66.0 and later. List—At the scheduled time, the flow performs actions on or sends messages to individuals from the selected list. This value is available in API version 67.0 and later. PlatformEvent—The flow starts when a platform event message is received. This value is available in API version 49.0 and later. RecordAfterSave—The flow starts after a record is saved. This value is available in API version 49.0 and later. RecordBeforeDelete—Deleting a record triggers an autolaunched flow before the record is deleted from the database. This value is available in API version 50.0 and later. RecordBeforeSave—Creating and/or updating a record triggers an autolaunched flow to make additional updates to that record before it's saved to the database. This value is available in API version 48.0 and later. Scheduled—The flow starts at the scheduled time. This value is available in API version 47.0 and later. Segment— At the scheduled time, the flow performs actions on or sends messages to individuals from the selected segment. This value is available in API version 56.0 and later."
},
"VersionNumber": {
"type": "int",
"properties": "Filter, Group, Nillable, Sort",
"description": "The flows version number. This field is available in API version 54.0 and later."
}
},
"usage": "Use this object to query information about flow definitions.",
"wsdl_segment": "```xml\n<complexType name=\"FlowDefinitionView\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"ActiveVersionId\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\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=\"AreMetricsLoggedToDataCloud\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"Builder\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"CapacityCategory\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Description\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"DurableId\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Environments\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"FlowTestResults\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"FlowTestViews\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"HasAsyncAfterCommitPath\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"InstalledPackageName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"IsActive\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsOutOfDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsOverridable\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsSwingFlow\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"IsTemplate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"Label\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LatestVersionId\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"ManageableState\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"NamespacePrefix\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"OverriddenBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:FlowDefinitionView\"/>\n <element name=\"OverriddenById\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"OverriddenFlow\" nillable=\"true\" minOccurs=\"0\" type=\"ens:FlowDefinitionView\"/>\n <element name=\"OverriddenFlowId\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"ProcessType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"RecordTriggerType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"SourceTemplate\" nillable=\"true\" minOccurs=\"0\" type=\"ens:FlowDefinitionView\"/>\n <element name=\"SourceTemplateId\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"SupportedEnvironments\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"TriggerObjectOrEvent\" nillable=\"true\" minOccurs=\"0\" type=\"ens:EntityDefinition\"/>\n <element name=\"TriggerObjectOrEventId\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"TriggerObjectOrEventLabel\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"TriggerOrder\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n <element name=\"TriggerType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"VersionNumber\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n <element name=\"Versions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\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": "Active Flow Version API Name or ID",
"type": "string",
"length": "255"
},
"ApiName": {
"field_label": "Flow API Name",
"type": "string",
"length": "255"
},
"ApiVersion": {
"field_label": "API Version",
"type": "int",
"digits": "9"
},
"AreMetricsLoggedToDataCloud": {
"field_label": "Log Metrics to Data Cloud",
"type": "boolean"
},
"Builder": {
"field_label": "Built with",
"type": "string",
"length": "255"
},
"CapacityCategory": {
"field_label": "Capacity Category",
"type": "picklist",
"length": "255"
},
"Description": {
"field_label": "Flow Description",
"type": "string",
"length": "255"
},
"DurableId": {
"field_label": "Durable ID",
"type": "string",
"length": "255"
},
"Environments": {
"field_label": "Environments",
"type": "multipicklist",
"length": "4099",
"precision": "0"
},
"HasAsyncAfterCommitPath": {
"field_label": "Has Asynchronous After Commit Path",
"type": "boolean"
},
"Id": {
"field_label": "Flow Definition View ID",
"type": "id",
"length": "18"
},
"InstalledPackageName": {
"field_label": "Package Name",
"type": "string",
"length": "240"
},
"IsActive": {
"field_label": "Active",
"type": "boolean"
},
"IsOutOfDate": {
"field_label": "Is Using an Older Version",
"type": "boolean"
},
"IsOverridable": {
"field_label": "Overridable",
"type": "boolean"
},
"IsSwingFlow": {
"field_label": "Is Swing Flow",
"type": "boolean"
},
"IsTemplate": {
"field_label": "Template",
"type": "boolean"
},
"Label": {
"field_label": "Flow Label",
"type": "string",
"length": "255"
},
"LastModifiedBy": {
"field_label": "Last Modified By",
"type": "string",
"length": "255"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"LatestVersionId": {
"field_label": "Latest Flow Version API Name or ID",
"type": "string",
"length": "255"
},
"ManageableState": {
"field_label": "Package State",
"type": "picklist",
"length": "255"
},
"NamespacePrefix": {
"field_label": "Flow Namespace",
"type": "string",
"length": "255"
},
"OverriddenById": {
"field_label": "Flow Definition View ID",
"type": "string",
"length": "512"
},
"OverriddenFlowId": {
"field_label": "Flow Definition View ID",
"type": "string",
"length": "512"
},
"ProcessType": {
"field_label": "Process Type",
"type": "picklist",
"length": "255"
},
"RecordTriggerType": {
"field_label": "Record Trigger Type",
"type": "picklist",
"length": "255"
},
"SourceTemplateId": {
"field_label": "Flow Definition View ID",
"type": "string",
"length": "512"
},
"SupportedEnvironments": {
"field_label": "Supported Environments",
"type": "string",
"length": "255"
},
"TriggerObjectOrEventId": {
"field_label": "Entity Definition ID",
"type": "string",
"length": "512"
},
"TriggerObjectOrEventLabel": {
"field_label": "Triggering Object or Platform Event Label",
"type": "string",
"length": "255"
},
"TriggerOrder": {
"field_label": "Trigger Order",
"type": "int",
"digits": "9"
},
"TriggerType": {
"field_label": "Trigger",
"type": "picklist",
"length": "255"
},
"VersionNumber": {
"field_label": "Version Number",
"type": "int",
"digits": "9"
}
},
"field_reference_columns": [
"field_label",
"type",
"length",
"digits",
"precision"
]
}