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

FlowDefinitionView

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

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

query()、retrieve()

項目

項目 詳細
ActiveVersionId
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
有効なフローバージョンの ID。
ApiName
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
フロー定義の API 参照名。
ビルダー
型
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。
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 以降で使用できます。

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
説明
フロー定義と関連付けられた名前空間プレフィックス。
ProcessType
型
picklist
プロパティ
Filter、Group、Nillable、Restricted picklist、Sort
説明
フローの種別。有効な値は、次のとおりです。
  • Appointments — Lightning Scheduler のフロー。この値は API バージョン 44.0 以降で使用できます。
  • AutoLaunchedFlow — ユーザ操作を必要としないフロー。
  • ContactRequestFlow — 顧客がカスタマーサポートに折り返し連絡を要求できるようにするフロー。このフローは、連絡要求レコードを作成するために使用します。この値は API バージョン 45.0 以降で使用できます。
  • CustomEvent — プラットフォームイベントメッセージを受信すると呼び出されるプロセス。UI では、これはイベントプロセスです。この値は API バージョン 41.0 以降で使用できます。
  • FieldServiceMobile — Field Service Lightning モバイルアプリケーションのフロー。この値は API バージョン 39.0 以降で使用できます。
  • FieldServiceWeb — 組み込みの予定の予約のフロー。UI 表示ラベルは [Field Service 組み込みフロー] です。この値は API バージョン 41.0 以降で使用できます。
  • Flow — 1 つ以上の画面、ローカルアクション、選択肢、または動的選択肢が含まれるため、ユーザ操作を必要とするフロー。UI および Salesforce ヘルプでは、これは画面フローです。画面フローは、UI (フローアクションを含む UI など)、Lightning ページ、または Web タブから起動できます。
  • InvocableProcess — 別のプロセスまたは REST API の Invocable Actions リソースから呼び出すことができるプロセス。この値は API バージョン 38.0 以降で使用できます。
  • Survey — Salesforce アンケートのフロー。UI から、この種別のフローはアンケートビルダーで作成します。この値は API バージョン 42.0 以降で使用できます。
  • Workflow — レコードを作成または編集するときに呼び出されるプロセス。UI および Salesforce ヘルプでは、これはレコード変更プロセスです。

これらの値は、今後の使用のために予約されています。

  • ActionCadenceFlow
  • ActionPlan
  • CartAsyncFlow
  • CheckoutFlow
  • DecisionStudio
  • DigitalForm
  • Journey
  • JourneyBuilderIntegration
  • LoginFlow
  • ManagedContentFlow
  • OrchestrationFlow
  • SalesEntryExperienceFlow
  • SurveyEnrich
  • TransactionSecurityFlow
  • UserProvisioningFlow

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

メモ

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

TriggerType
型
picklist
プロパティ
Filter、Group、Nillable、Restricted picklist、Sort
説明
フローを実行するトリガを指定します。この項目を除外すると、フローのトリガがなくなり、ユーザまたはアプリケーションがこのフローを起動した場合にしか開始されなくなります。有効な値は次のとおりです。
  • Scheduled — スケジュールされた時刻にフローが開始されます。

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

使用方法

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