この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

FlowDefinitionView

フロー定義の説明を表します。このオブジェクトは、API バージョン 46.0 以降で使用できます。

サポートされているコール

describeSObjects()query()

項目

項目 詳細
ActiveVersionId
string
プロパティ
Filter、Group、Nillable、Sort
説明
有効なフローバージョンの ID。
ApiName
string
プロパティ
Filter、Group、Nillable、Sort
説明
フロー定義の API 参照名。
Builder
string
プロパティ
Filter、Group、Nillable、Sort
説明
このフローを作成したツールの名前。可能な値は次のとおりです。
  • Cloud Flow Designer
  • Flow Builder
  • Swing Designer

この項目は、API バージョン 47.0 以降で使用できます。

Description
string
プロパティ
Filter、Group、Nillable、Sort
説明
組織のシステム管理者によって指定されるフロー定義情報。
DurableId
string
プロパティ
Filter、Group、Nillable、Sort
説明
フロー定義の ID。
Environments
multipicklist
プロパティ
Filter、Nillable
説明
フローを実行できる環境。有効な値は、次のとおりです。
  • Default — フローは、オフラインで実行するか、または Visualforce コンポーネント、Lightning ページ、フローアクション、カスタム Aura コンポーネントから実行できます。
  • Slack — フローは Slack およびデフォルトの環境で実行できます。フローを保存するときに、Slack フロー環境を指定します。
この項目は、API バージョン 55.0 以降で使用できます。
HasAsyncAfterCommitPath
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
スケジュール済みパスが保存後に非同期で実行されるかどうかを示します。デフォルト値は false です。この項目は、API バージョン 54.0 以降で使用できます。
InstalledPackageName
string
プロパティ
Filter、Group、Nillable、Sort
説明
このフロー定義を含むインストール済みパッケージの名前。

この項目は、API バージョン 47.0 以降で使用できます。

IsActive
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
最新バージョンのフロー定義が有効なフローバージョンであるかどうかを示します。

この項目は、API バージョン 47.0 以降で使用できます。

IsOutOfDate
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
有効なフローバージョンが最新バージョンのフロー定義であるかどうかを示します。

この項目は、API バージョン 47.0 以降で使用できます。

IsOverridable
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
フローが上書き可能かどうかを示します。デフォルト値は false です。この項目は、API バージョン 53.0 以降で使用できます。
IsSwingFlow
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
フローがデスクトップ Flow Designer で作成されているかどうかを示します。

この項目は、API バージョン 49.0 以降で使用できます。

IsTemplate
boolean
プロパティ
Defaulted on create、Filter、Group、Sort
説明
プロセスまたはフローがテンプレートであるかどうかを示します。管理パッケージからインストールされた場合、知的財産 (IP) の保護により、サブスクライバーはプロセスとフローの参照やコピーを行うことができません。ただし、プロセスやフローがテンプレートの場合、サブスクライバーはそれをビルダーで開いたり、コピーしたり、カスタマイズしたりできます。

この項目は、API バージョン 47.0 以降で使用できます。

Label
string
プロパティ
Filter、Group、Nillable、Sort
説明
フロー定義の表示ラベル。
LastModifiedBy
string
プロパティ
Filter、Group、Nillable、Sort
説明
このフロー定義を最後に更新したユーザの名前。

この項目は、API バージョン 47.0 以降で使用できます。

LatestVersionId
string
プロパティ
Filter、Group、Nillable、Sort
説明
フローの状況に関係なく、最新のフローバージョンの ID。
ManageableState
picklist
プロパティ
Filter、Group、Nillable、Restricted picklist、Sort
説明
パッケージに含まれているフローの管理可能な状態を示します。可能な値は次のとおりです。
  • beta
  • deleted
  • deprecated
  • deprecatedEditable
  • installed
  • installedEditable
  • released
  • unmanaged

この項目は、API バージョン 47.0 以降で使用できます。

NamespacePrefix
string
プロパティ
Filter、Group、Nillable、Sort
説明
フロー定義と関連付けられた名前空間プレフィックス。
OverriddenById
string
プロパティ
Filter、Nillable、Sort
説明
現在のフローを上書きしているフロー。これはリレー���ョン項目です。この項目は、API バージョン 53.0 以降で使用できます。
リレーション名
OverriddenBy
リレーション種別
Lookup
参照先
FlowDefinitionView
OverriddenFlowId
string
プロパティ
Filter、Nillable、Sort
説明
現在のフローが上書きしているフロー。これはリレーション項目です。この項目は、API バージョン 53.0 以降で使用できます。
リレーション名
OverriddenFlow
リレーション種別
Lookup
参照先
FlowDefinitionView
ProcessType
picklist
プロパティ
Filter、Group、Nillable、Restricted picklist、Sort
説明
フローの種別。有効な値は、次のとおりです。
  • ActionCadenceAutolaunchedFlow — ユーザがケイデンスステップを完了したときに実行されるフロー。この値は、API バージョン 56.0 以降で使用できます。
  • ActionCadenceStepFlow — ケイデンスステップとして使用される画面フロー。この値は、API バージョン 56.0 以降で使用できます。
  • Appointments — Lightning Scheduler のフロー。この値は API バージョン 44.0 以降で使用できます。
  • AutoLaunchedFlow — ユーザ操作を必要としないフロー。
  • CheckoutFlow — ストアのチェックアウトを作成するために Lightning B2B Commerce で使用されるフロー。この値は API バージョン 48.0 以降で使用できます。
  • ContactRequestFlow — 顧客がカスタマーサポートに折り返し連絡を要求できるようにするフロー。このフローは、連絡要求レコードを作成するために使用します。この値は API バージョン 45.0 以降で使用できます。
  • CustomerLifecycle — アンケートの質問を顧客ライフサイクルのさまざまなフェーズに関連付けることができる Salesforce Surveys フロー。この値は API バージョン 49.0 以降で、Customer Lifecycle Designer ライセンスが有効な場合にのみ使用できます。
  • CustomEvent — プラットフォームイベントメッセージを受信すると呼び出されるプロセス。UI では、これはイベントプロセスです。この値は API バージョン 41.0 以降で使用できます。
  • EvaluationFlow — オーケストレーションにおけるカスタムのエントリ条件および終了条件を評価するフロー。isOrchestrationConditionMet 出力変数を使用し、他の出力変数から値を破棄します。API バージョン 54.0 以降で利用できます。
  • FieldServiceMobile — Field Service モバイルアプリケーションのフロー。この値は API バージョン 39.0 以降で使用できます。
  • FieldServiceWeb — 組み込みの予定の予約のフロー。UI 表示ラベルは [Field Service 組み込みフロー] です。この値は API バージョン 41.0 以降で使用できます。
  • Flow — 1 つ以上の画面、ローカルアクション、選択肢、または動的選択肢が含まれるため、ユーザ操作を必要とするフロー。UI および Salesforce ヘルプでは、これは画面フローです。画面フローは、UI (フローアクションを含む UI など)、Lightning ページ、または Web タブから起動できます。
  • FSCLending — Financial Services Cloud 住宅ローン向けフロー。この値は API バージョン 46.0 以降で使用できます。
  • InvocableProcess — 別のプロセスまたは REST API の Invocable Actions リソースから呼び出すことができるプロセス。この値は API バージョン 38.0 以降で使用できます。
  • LoginFlow — ログインのフロー。API バージョン 51.0 以降で利用できます。
  • LoyaltyManagementFlow — ロイヤルティ管理アプリケーションのフローであり、ロイヤルティプログラムプロセスから呼び出すことができます。この値は、API バージョン 54.0 以降で使用できます。
  • ManagedContentAuthoringWorkflow (Beta) — Salesforce CMS で、管理コンテンツの作成ワークフローの生成に使用されるオーケストレーション。mContentVariantId および mContentSpaceId 入力変数を使用します。この値は、API バージョン 57.0 以降で使用できます。詳細は、「CMS ワークフローと承認」を参照してください。
  • Orchestrator — フローを一連のフェーズに含まれるステップのグループに整理するオーケストレーション。API バージョン 53.0 以降で利用できます。
  • RoutingFlow — Salesforce オムニチャネルルーティングなどのビジネスロジックのフロー。この値は API バージョン 52.0 以降で使用できます。
  • Survey — Salesforce アンケートのフロー。UI から、この種別のフローはアンケートビルダーで作成します。この値は API バージョン 42.0 以降で使用できます。
  • SurveyEnrich — アンケートデータマッパーを使用する Salesforce Surveys フロー。この種別のフローは、UI のアンケートビルダーで作成し、関連付けられたアンケートフロー種別が必要です。この値は API バージョン 49.0 以降で、Customer Lifecycle Designer ライセンスが有効な場合にのみ使用できます。
  • Workflow — レコードを作成または編集するときに呼び出されるプロセス。UI および Salesforce ヘルプでは、これはレコード変更プロセスです。

以下の値は、将来の使用のために予約されています。

  • ActionCadenceFlow
  • ActionPlan
  • AppProcess
  • CartAsyncFlow
  • DigitalForm
  • Journey
  • JourneyBuilderIntegration
  • LoginFlow
  • ManagedContentFlow
  • OrchestrationFlow
  • RecommendationStrategy
  • SalesEntryExperienceFlow
  • TransactionSecurityFlow
  • UserProvisioningFlow

この値は、フローを保存するときの検証およびフローの実行時の動作に大きな影響を与えます。指定された種別のフロープロパティを理解している場合を除き、この値は変更しないでください。

メモ

フローバージョン間では、種別を Flow から AutoLaunchedFlow (またはその逆) にのみ変更できます。フロー種別を変更する前に、新規フロー種別でサポートされる要素、リソース、機能のみがフローに含まれていることを確認します。

RecordTriggerType
picklist
プロパティ
Filter、Group、Nillable、Restricted picklist、Sort
説明
フローを開始できるレコード変更の種別を指定します。可能な値は次のとおりです。
  • Create
  • CreateAndUpdate
  • Delete
  • None
  • Update
triggerTypeRecordBeforeSave の場合にのみ使用できます。この項目は、API バージョン 54.0 以降で使用できます。
SourceTemplateId
string
プロパティ
Filter、Nillable、Sort
説明
現在のフローの作成元のテンプレート。これはリレーション項目です。この項目は、API バージョン 53.0 以降で使用できます。
リレーション名
SourceTemplate
リレーション種別
Lookup
参照先
FlowDefinitionView
TriggerObjectOrEventId
string
プロパティ
Filter、Nillable、Sort
説明
このフローをトリガするオブジェクトまたはプラットフォームイベントの ID。この項目は、API バージョン 53.0 以降で使用できます。

これはリレーション項目です。

リレーション名
TriggerObjectOrEvent
リレーション種別
Lookup
参照先
EntityDefinition
TriggerObjectOrEventLabel
string
プロパティ
Filter、Group、Nillable、Sort
説明
このフローをトリガするオブジェクトまたはプラットフォームイベントの表示ラベル。この項目は、API バージョン 53.0 以降で使用できます。
TriggerOrder
int
プロパティ
Filter、Group、Nillable、Sort
説明
レコードトリガフローの実行順序 (1 ~ 2000)。Salesforce ヘルプの「オブジェクトのレコードトリガフローの実行順序の定義に関するガイドライン」を参照してください。API バージョン 54.0 以降で利用できます。
TriggerType
picklist
プロパティ
Filter、Group、Nillable、Restricted picklist、Sort
説明
フローを実行するトリガを指定します。この項目を除外すると、フローのトリガがなくなり、ユーザまたはアプリケーションがこのフローを起動した場合にしか開始されなくなります。有効な値は、次のとおりです。
  • EventDrivenJourney — 内部使用のために予約されています。
  • PlatformEvent — フローは、プラットフォームイベントメッセージを受信すると開始されます。この値は API バージョン 49.0 以降で使用できます。
  • RecordAfterSave — フローは、レコードの保存後に開始されます。この値は API バージョン 49.0 以降で使用できます。
  • RecordBeforeSave — レコードの作成または更新により自動起動フローをトリガし、追加の更新をレコードに加えてからレコードをデータベースに保存します。この値は API バージョン 48.0 以降で使用できます。
  • Scheduled — スケジュールされた時刻にフローが開始されます。この値は API バージョン 47.0 以降で使用できます。

processTypeAutoLaunchedFlow の場合にのみ使用できます。この項目は、API バージョン 47.0 以降で使用できます。

VersionNumber
int
プロパティ
Filter、Group、Nillable、Sort
説明
フローのバージョン番号。この項目は、API バージョン 54.0 以降で使用できます。

使用方法

このオブジェクトを使用して、フロー定義に関する情報を照会します。