SOAP API 開発者ガイド
jDescribeSearchLayoutResult
describeSearchLayouts() コールは、DescribeSearchLayoutResult オブジェクトの配列を返します。各 DescribeSearchLayoutResult オブジェクトは、クエリ対象の各オブジェクトの検索レイアウト設定を表します。DescribeSearchLayoutResult オブジェクトには次のプロパティがあります。
| 名前 | 型 | 説明 |
|---|---|---|
| label | string | 検索結果ページに使用するブラウザタイトル。 |
| limitRows | int | 検索結果の最初のページに表示する最大行数。この数値は、システム管理者が変更できます。 |
| searchColumns | DescribeColumn[] | このオブジェクトの検索結果に関連付けられた列。 |
DescribeColumn
describeSearchLayouts() コールで返された各 DescribeSearchLayoutResult オブジェクトの検索レイアウト設定内の列を表します。
| 名前 | 型 | 説明 |
| field | string | 属するオブジェクトに対する項目参照。たとえば、「Lead.Phone」などです。 |
| format | string | 項目のデータ形式。たとえば、「date」などです。この値は null にできます。 |
| label | string | ユーザインターフェースでのこの項目の表示テキスト。たとえば、「会社電話」または「電話」などです。 |
| name | string | 項目名。SOQL クエリまたはコードで使用します。たとえば、「Name」などです。 |