describeFlexiPages() | SOAP API 開発者ガイド

一連の Lightning ページに関するメタデータ詳細を取得します。

Lightning ページは、いくつかの場所で使用されます。

Salesforce1 では、Lightning ページはナビゲーションメニューに表示されるアプリケーションのホームページです。
Lightning Experienceでは、Lightning ページはアプリケーションのホームページとして使用したり、レコードページやホームページのレイアウトをカスタマイズするために使用したりできます。

これらのページは、API では FlexiPage と呼ばれますが、それ以外の Salesforce ドキュメントおよび UI では Lightning ページと呼ばれます。

メモ

構文

このコールを使用して、指定された Lightning ページに関する情報を取得します。このコールは、各 Lightning ページのレイアウトや関連付けられた QuickAction など、一連の Lightning ページに関するメタデータを返します。

flexiPageNames に対して空のリストを指定すると、Lightning ページは返されません。

このコールは高度な API コールであり、通常は、モバイルデバイスで出力を生成するためのカスタムページ表示コードを記述してから出力結果を表示する前に Lightning ページのレイアウト詳細を確認する必要のあるパートナーが使用します。

メモ

このサンプルでは、Lightning ページの取得方法を示します。記述する Lightning ページの名前を使用して、describeFlexiPage() をコールします。Lightning ページ��取得すると、範囲、コンポーネント、およびプロパティが出力されます。

名前	型	説明
flexiPages	string[]	取得する Lightning ページの配列。
contexts	FlexipageContext[]	Account や Contact など、FlexiPage のコンテキストの配列。この引数は、種別が `AppPage` または `HomePage` のページには必要ありません。 API バージョン 35.0 以降で使用できます。

Account や Contact など、FlexiPage のコンテキストを表します。種別が AppPage または HomePage のページには適用されません。API バージョン 35.0 以降で使用できます。

名前	型	説明
type	string 型の FlexipageContextTypeEnum 列挙	FlexipageContext の種別。有効な値は、次のとおりです。 `ENTITYNAME`
value	string	FlexipageContext の値。