メタデータ API 開発者ガイド
jGlobalValueSet
グローバル選択リスト値セット (カスタム選択リスト項目で使用できる共有値のセット) のメタデータを表します。グローバル値セットは項目ではありません。これに対し、グローバル選択リストに基づくカスタム選択リスト項目は ValueSet 型になります。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよ��ディレクトリの場所
GlobalValueSet コンポーネントのサフィックスは .globalValueSet で、globalValueSets フォルダに保存されます。
バージョン
GlobalValueSet コンポーネントは、API バージョン 38.0 以降で使用できます。API バージョン 37.0 では、GlobalPicklist 型です。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| customValue | CustomValue[] | 少なくとも 1 つの値が必要です。グローバル選択リストで定義された値のリスト (「グローバル値セット」)。グローバル値セットは、グローバル値セットを使用するすべてのカスタム選択リスト項目で継承されます。各値は customValue 型です。グローバル値セットには、合計 1,000 個までの値を設定できます (無効な値を含む)。 |
| description | string | これは、グローバル値セットの目的や対象オブジェクトを記述する場合に役立ちます。最大 255 文字です。 |
| masterLabel | string | 必須。グローバル値セットの作成時に定義されるグローバル値セットの名前。ユーザインターフェースに表示ラベルとして表示されます。 |
| sorted | boolean | 必須。グローバル値セットがアルファベット順に並び替えられるかどうかを示します。デフォルトでは、この値は false です。 |
宣言的なメタデータの定義のサンプル
次の Territories.globalValueSet は GlobalValueSet コンポーネントの例です。
1<?xml version="1.0" encoding="UTF-8"?>
2<GlobalValueSet xmlns="http://soap.sforce.com/2006/04/metadata">
3 <description>Updated:This is a basic global value set.</description>
4 <masterLabel>Territories</masterLabel>
5 <customValue>
6 <fullName>North</fullName>
7 <default>true</default>
8 </customValue>
9 <customValue>
10 <fullName>South</fullName>
11 </customValue>
12 <customValue>
13 <fullName>East</fullName>
14 </customValue>
15 <customValue>
16 <fullName>West</fullName>
17 </customValue>
18 <sorted>true</sorted>
19</GlobalValueSet>
20
21 前の定義を参照する package.xml の例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>Territories</members>
5 <name>GlobalValueSet</name>
6 </types>
7 <version>38.0</version>
8</Package>