sObject CompactLayouts を使用したコンパクトレイアウトの取得

特定のオブジェクトのコンパクトレイアウトのリストを取得します。このリソースは REST API バージョン 29.0 以降で使用できます。

構文

URI

特定のオブジェクトのコンパクトレイアウトの説明については、/services/data/vXX.X/sobjects/sObject/describe/compactLayouts/ を使用します。

形式

JSON、XML

HTTP のメソッド

GET

認証

Authorization: Bearer token

要求のパラメータ

不要

例

コンパクトレイアウトの取得

JSON レスポンスボディの例

このサンプルの JSON 応答は、Account オブジェクトに対して作成されたコンパクトレイアウト用です。この例では、Account に対してカスタムコンパクトレイアウトが 1 つのみ作成されます。カスタムコンパクトレイアウトは、オブジェクトの主コンパクトレイアウトとして割り当てられ、[取引先名] と [電話] の 2 つの項目が含まれます。

オブジェクトのコンパクトレイアウトを定義していない場合は、compactLayoutId が Null として返されます。