メタデータ API 開発者ガイド
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Picklist (連動選択リストを含む)
カスタムオブジェクトのカスタム項目、または取引先などの標準オブジェクトのカスタム項目または標準項目の選択リスト (または連動選択リスト) の定義を表します。
バージョン
カスタムオブジェクトのカスタム項目の選択リストは、API バージョン 12.0 以降で使用できます。取引先などの標準オブジェクトのカスタム項目または標準項目の選択リストは、API バージョン 16.0 以降で使用できます。API バージョン 27.0 以降では、カスタム項目のリリースに必要な場合は、選択リストの値が削除されます。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
選択リストの定義は、カスタムオブジェクトと選択リストの定義が関連付けられた項目に含まれます。
項目
選択リストには次の項目が含まれます。
| 項目名 | データ型 | 説明 |
|---|---|---|
| controllingField | string | これが連動選択リストである場合、制御項目の fullName。連動選択リストは、制御選択リストまたはチェックボックスと連動して動作し、使用可能なオプションに検索条件を適用します。制御項目で選択した値は、連動項目に使用できる値に影響します。この項目は API バージョン 14.0 以降で使用できます。 |
| picklistValues | PicklistValue[] | 必須。選択リストの値のセットを表します。 |
| sorted | boolean | 必須。値を並び替えるか (true)、否か (false) を示します。 |
PicklistValue
このメタデータ型では選択リストの値を定義し、この値がデフォルト値であるかどうかを指定します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。選択リストの値を使用する場合は、次の点に注意してください。
- 標準オブジェクトを取得する場合、カスタマイズされた選択リスト値のみでなく、すべての選択リスト値が取得されます。
- 標準選択リスト項目への変更をリリースする場合、必要に応じて選択リストの値を追加、更新、削除することができます。
- 選択リストの値を無効として設定することはできませんが、選択リストの値が欠落しているときに update() コールを呼び出すと、欠落している値が無効になります。
| 項目名 | データ型 | 説明 |
|---|---|---|
| allowEmail | boolean | この値によりユーザが見積 PDF をメール送信できるか (true)、否か (false) を示します。この項目は見積の Status 項目にのみ関連します。この項目は API バージョン 18.0 以降で使用できます。 |
| closed | boolean | この値が完了の状況に関連付けられるか (true)、否か (false) を示します。この項目はケースおよび ToDo の標準項目の Status にのみ関連します。この項目は API バージョン 16.0 以降で使用できます。 |
| color | string | レポートおよびダッシュボードのグラフで色が使用されている場合、選択リスト値に割り当てられている色を示します。色は、16 進形式で表記されます (#FF6600 など)。色が指定されていない場合、グラフ作成時に動的に割り当てられます。この項目は API バージョン 17.0 以降で使用できます。 |
| controllingFieldValues | string[] | この選択リスト値にリンクしている制御項目の値のリスト。制御項目は、チェックボックスまたは選択リストにすることができます。この項目は API バージョン 14.0 以降で使用できます。リストの値は項目のデータ型によって異なります。
|
| converted | boolean | この値が取引開始済みの状況に関連付けられるか (true)、否か (false) を示します。この項目はリードの標準項目の [リード状況] にのみ関連します。詳細は、Salesforce オンラインヘルプの「取引の開始」を参照してください。この項目は、API バージョン 16.0 以降で使用できます。 |
| cssExposed | boolean | この値がセルフサービスポータルで使用可能か (true)、否か (false) を示します。この項目はケースの標準項目の [原因] にのみ関連します。 セルフサービスは、顧客にオンラインサポートチャネルを提供します。これにより、顧客は、カスタマサービス担当者に連絡しなくても各自の疑問を解消できます。セルフサービスについての詳細は、Salesforce オンラインヘルプの「セルフサービスの設定」を参照してください。 この項目は API バージョン 16.0 以降で使用できます。 |
| default | boolean | 必須。この値が指定されている選択リストのデフォルトの選択リスト値であるか (true)、否か (false) を示します。 |
| description | string | カスタム選択リスト値の説明。この項目は商談の標準項目の Stage にのみ関連します。カスタマイズされている選択リスト値に関する説明を記載すると、これを作成した理由の履歴を追跡できるので便利です。この項目は API バージョン 16.0 以降で使用できます。 |
| forecastCategory | ForecastCategories (string 型の列挙) | この値が売上予測分類に関連付けられるか (true)、否か (false) を示します。この項目は商談の標準項目の Stage にのみ関連します。以下に示した有効な文字列値を含む、売上予測分類についての詳細は、Salesforce オンラインヘルプの「売上予測分類の使用」を参照してください。
この項目は API バージョン 16.0 以降で使用できます。 |
| fullName | string | API アクセスの一意の識別子として使用される名前。fullName には、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。 |
| highPriority | boolean | この値が優先度が高い項目であるか (true)、否か (false) を示します。この項目は ToDo の標準項目の Priority にのみ関連します。ToDo についての詳細は、Salesforce オンラインヘルプの「ToDo の使用についての考慮事項」を参照してください。この項目は、API バージョン 16.0 以降で使用できます。 |
| probability | int | この値が確度割合であるか (true)、否か (false) を示します。この項目は商談の標準項目の Stage にのみ関連します。商談についての詳細は、Salesforce オンラインヘルプの「商談の概要」を参照してください。この項目は、API バージョン 16.0 以降で使用できます。 |
| reverseRole | string | パートナーの相手側から見たロールの名前に対応する選択リスト値。ロールが「下請け」の場合、相手側から見たロールは「元請け」となります。Salesforce でパートナーロールを取引先に割り当てると、相手側から見たパートナーとの関係が作成され、両方の取引先で他方をパートナーとして表示できます。この項目は、パートナーロールにのみ関連します。 詳細は、Salesforce オンラインヘルプの「パートナーの項目」を参照してください。 この項目は、API バージョン 18.0 以降で使用できます。 |
| reviewed | boolean | この値がレビュー済み状況に関連付けられるか (true)、否か (false) を示します。この項目はソリューションの標準項目の Status にのみ関連します。商談についての詳細は、Salesforce オンラインヘルプの「ソリューションの作成」を参照してください。この項目は、API バージョン 16.0 以降で使用できます。 |
| won | boolean | この値が完了または成立の状況に関連付けられるか (true)、否か (false) を示します。この項目は商談の標準項目の Stage にのみ関連します。この項目は API バージョン 16.0 以降で使用できます。 |