DescribeGlobalResult
describeGlobal() コールが返す DescribeGlobalResult オブジェクトには次のプロパティがあります。
| 名前 | 型 | 説明 |
|---|---|---|
| encoding | string | UTF-8 や ISO-8859-1 など、組織データのエンコーディング方法を指定します。 |
| maxBatchSize | int | create()、update() または delete() コールで許容される最大レコード数。 |
| sobjects | DescribeGlobalSObjectResult[] | 組織に使用できるオブジェクトについての情報を返す結果オブジェクトの一覧。API バージョン 17.0 以降で利用できます。以前のバージョンの types プロパティで提供されていた情報を強化するものです。 |
| types | string[] | 組織で利用可能なオブジェクトの一覧。この一覧の内容を反復処理し、describeSObjects() に渡すオブジェクト文字列を取得します。 API バージョン 17.0 以降では、このプロパティはサポートされていません。代わりに、DescribeGlobalSObjectResult で name プロパティを使用します。 |
DescribeGlobalSObjectResult
組織で使用できるオブジェクトのいずれかのプロパティを示します。各オブジェクトには次のプロパティがあります。
| 名前 | 型 | 説明 |
|---|---|---|
| activateable | boolean | 将来の使用のために予約されています。 |
| createable | boolean | オブジェクトが create() コールで作成可能か (true)、否か (false) を示します。 |
| custom | boolean | カスタムオブジェクトであるかどうかを示します (カスタムオブジェクトの場合は true、そうでない場合は false)。 |
| customSetting | boolean | カスタム設定項目であるか (true)、否か (false) を示します。 |
| dataTranslationEnabled | boolean | オブジェクトでデータ翻訳が有効になっているか (true)、否か (false) を示します。API バージョン 49.0 以降で利用できます。 |
| deepCloneable | boolean | 将来の使用のために予約されています。 |
| deletable | boolean | オブジェクトが delete() コールで削除できるか (true)、否か (false) を示します。 |
| deprecatedAndHidden | boolean | 将来の使用のために予約されています。 |
| feedEnabled | boolean | オブジェクトで Chatter 項目が有効か (true)、否か (false) を示します。このプロパティは、API バージョン 19.0 以降で使用できます。 |
| isInterface | boolean | 将来の使用のために予約されています。 |
| keyPrefix | string | オブジェクト ID の 3 文字のプレフィックスコード。オブジェクト ID はオブジェクト型を示す 3 文字のコードが先頭に付けられます。たとえば、Account オブジェクトのプレフィックスは 001、Opportunity オブジェクトのプレフィックスは 006 です。主要なプレフィックスを複数のオブジェクトで共有する場合があるため、必ずしもオブジェクトを一意に識別するわけではありません。 子に 1 つ以上の親オブジェクトが存在する場合 (多態的な場合)、親のオブジェクト種別を確認するためにこの項目の値を使用します。たとえば、Task または Event の親の keyPrefix 値を取得しなければならない場合にこの値を使用します。 |
| label | string | 適用される場合は、ユーザインターフェースで名前が変更されたタブまたは項目のラベルテキスト。変更されていない場合はオブジェクト名。たとえば、医療分野の組織では「取引先」を Patient に変更する場合があります。タブや項目は Salesforce ユーザインターフェースで名前を変更できます。詳細は、Salesforce オンラインヘルプを参照してください。 |
| labelPlural | string | オブジェクト名の複数形を表すラベルテキストです。 |
| layoutable | boolean | オブジェクトが describeLayout() コールをサポートしているか (true)、否か (false) を示します。 |
| mergeable | boolean | オブジェクトが同じ型の他のオブジェクトとマージ可能か (true)、否か (false) を示します。リード、取引先責任者、および取引先の場合は true です。 |
| mruEnabled | boolean | 最後に使用 (MRU) リスト機能がオブジェクトで有効か (true)、否か (false) を示します。 |
| name | string | オブジェクトの名前。この name は、API バージョン 17.0 以降でサポートされなくなった types リストのエントリに相当します。 |
| queryable | boolean | オブジェクトが query() コールでクエリ可能か (true)、否か (false) を示します。 |
| replicateable | boolean | オブジェクトを getUpdated() および getDeleted() コールで複製可能か (true)、否か (false) を示します。 |
| retrieveable | boolean | オブジェクトが retrieve() コールで取得可能か (true)、否か (false) を示します。 |
| searchable | boolean | オブジェクトが search() コールで検索可能か (true)、否か (false) を示します。 |
| triggerable | boolean | オブジェクトが Apex トリガをサポートしているかどうかを示します。 |
| undeletable | boolean | オブジェクトが undelete() コールで復元可能か (true)、否か (false) を示します。 |
| updateable | boolean | オブジェクトが update() コールで更新可能か (true)、否か (false) を示します。 |