SOAP API 開発者ガイド
j記述用の API コール (describe)
API でサポートされている記述用の API コールのリストを表示します。
次の表は、API がサポートしている記述用の API コールをアルファベット順に表示し、それぞれの簡単な説明を示しています。コール名をクリックすると、構文、使用方法、各コールの詳細情報を確認できます。
| コール | 説明 |
|---|---|
| describeAllTabs() | ユーザーが [すべてのタブ] ([+]) タブカスタマイズ機能を使用して自分のユーザーインターフェースでタブを非表示にしているかどうかに関係なく、ログインユーザーが使用できるすべてのタブ (Lightning ページタブを含む) に関する情報を返します。 |
| describeAppMenu() | Salesforce モバイルアプリケーションナビゲーションメニューまたは Salesforce ドロップダウンアプリケーションメニューの項目に関するメタデータを取得します。 |
| describeApprovalLayout() | 指定されたオブジェクト種別の承認レイアウトに関するメタデータを取得します。 |
| describeAvailableQuickActions() | API バージョン 28.0 では、指定された親で使用できるアクションの詳細を記述します。API バージョン 29.0 以降では、指定されたコンテキストで使用可能なアクションの詳細を記述します。 |
| describeCompactLayouts() | 指定されたオブジェクト種別のコンパクトレイアウトに関するメタデータを取得します。 |
| describeDataCategoryGroups() | 要求で指定されたエンティティで使用できるカテゴリグループを取得します。 |
| describeDataCategoryGroupStructures() | 要求で指定されたエンティティで使用できるカテゴリグループとそのデータカテゴリ構造を返します。 |
| describeGlobal() | 組織のデータで利用可能なオブジェクトの一覧を取得します。 |
| describeGlobalTheme() | 現在のログインユーザーが使用できるオブジェクトとテーマの両方の情報を返します。 |
| describeKnowledge() | 組織のナレッジ言語設定を取得します。 |
| describeLayout() | 指定されたオブジェクト種別のページレイアウトに関するメタデータを取得します。 |
| describePrimaryCompactLayouts() | 指定されたオブジェクト種別ごとに主コンパクトレイアウトに関するメタデータを取得します。 |
| describeQuickActions() | 指定されたアクションの詳細を取得します。 |
| describeSearchScopeOrder() | ユーザーの検索結果ページの固定表示オブジェクトを含め、ログインユーザーのデフォルトのグローバル検索範囲内にあるオブジェクトの順序付きリストを取得します。 |
| describeSObject() | 指定されたオブジェクト種別のメタデータ (項目リストとオブジェクトプロパティ) を表します。describeSObjects() で置き換えられました。 |
| describeSObjects() | describeSObject の配列ベースのバージョン。 |
| describeSoftphoneLayout() | 組織のために作成された 1 つ以上のソフトフォンレイアウトの説明です。 |
| describeSoqlListViews() | リストビューに関する SOQL クエリおよびその他の情報を取得します。 |
| describeTabs() | ページ上部の Lightning プラットフォームアプリケーションメニューに表示される、ログインユーザーが使用できる標準アプリケーションおよびカスタムアプリケーションに関する情報を返します。 |
| describeTheme() | 現在のログインユーザーが使用できるテーマの情報を返します。 |
サンプル
このセクションのサンプルは、Enterprise WSDL ファイルに基づいてます。これらのサンプルでは、WSDL ファイルがインポート済みであり、接続が作成済みであることを前提としています。これを実行する方法の詳細については、「クイックスタート」のチュートリアルを参照してください。