メタデータ API 開発者ガイド
jDescribeValueTypeResult
宣言的なメタデータを使用する開発者に役立つ、値の型に関する情報が含まれます。
describeValueType() コールは DescribeValueTypeResult オブジェクトを返します。
各 DescribeValueTypeResult オブジェクトには次のプロパティがあります。
| 名前 | 型 | 説明 |
|---|---|---|
| apiCreatable | boolean | この値の型を createMetadata() コールで作成できるか (true)、否か (false) を示します。 |
| apiDeletable | boolean |
この値の型を deleteMetadata() コールで作成できるか (true)、否か (false) を示します。 この項目は、API バージョン 36.0 以降で使用できます。 |
| apiReadable | boolean |
この値の型を readMetadata() コールで作成できるか (true)、否か (false) を示します。 この項目は、API バージョン 36.0 以降で使用できます。 |
| apiUpdatable | boolean |
この値の型を updateMetadata() コールで作成できるか (true)、否か (false) を示します。 この項目は、API バージョン 36.0 以降で使用できます。 |
| parentField | ValueTypeField |
この値の型の親に関する情報。親項目情報は、カスタム項目、メールテンプレート、ワークフロールール、レポートなど、親に名前で指定されているメタデータ型で便利です。たとえば、カスタム項目の完全名には、その項目が格納されている sObject が含まれます (例: Account.field1__c)。同様に、メールテンプレートの完全名には、テンプレートが保存されているフォルダが含まれます (例: MyFolder/EmailTemplate1)。 値の型に親がない場合、この項目は null になります。 この項目は、API バージョン 36.0 以降で使用できます。 |
| valueTypeFields | ValueTypeField[] | 1 つ以上のメタデータコンポーネントおよびその属性。 |
ValueTypeField
このオブジェクトは DescribeValueTypeResult の一環として返され、1 つの項目のメタデータを表します。各 ValueTypeField には次のプロパティがあります。
| 名前 | 型 | 説明 |
|---|---|---|
| fields | ValueTypeField | 次の項目の ValueTypeField オブジェクト (存在する場合)。 |
| foreignKeyDomain | string | isForeignKey が True の場合、foreignKeyDomain は、取引先や商談などのオブジェクト種別になります。 |
| isForeignKey | boolean | 項目が外部キーの場合は True。つまり、この項目は別のデータベーステーブルの主キーになります。 |
| isNameField | boolean | この値の型の項目が fullName 項目の場合は True、そうでない場合は False。 |
| minOccurs | int | この項目が必須の場合は 1、そうでない場合は 0。 |
| name | string | この値の型の項目の名前。親項目の名前は null です。 |
| picklistValues | PicklistEntry | 項目が選択リストの場合は個々の選択リスト値。 |
| soapType | string | boolean または double などの項目のデータ型。 |
| valueRequired | boolean | 必須。この値の型の項目に値が必要か (true)、null にできるか (false) を示します。 |