SvcCatalogItemDef | メタデータ API 開発者ガイド

ファイルのサフィックスおよびディレクトリの場所

SvcCatalogItemDef コンポーネントのサフィックスは catalogItem で、svcCatalogItems フォルダーに保存されます。

バージョン

SvcCatalogItemDef コンポーネントは、API バージョン 53.0 以降で使用できます。

項目

項目名	説明
categories	項目の型 SvcCatalogCategoryItem[] 説明このカタログ項目を含むカタログカテゴリのリスト。
dataCategories	項目の型 SvcCatalogItemDefDataCategorySelection[] 説明このカタログ項目のデータカテゴリのリスト。この項目は、API バージョン 59.0 以降で利用できます。
description	項目の型 string 説明カタログ項目の自由テキストの説明。
flow	項目の型 string 説明カタログ項目に関連付けられた画面フロー。
image	項目の型 string 説明この項目のサービスカタログに表示するコンテンツドキュメントの API 参照名。
internalNotes	項目の型 string 説明カタログ項目で何を行うかとその実装について説明することを目的とします。この値は他のカタログビルダー向けの値です。
isActive	項目の型 boolean 説明カタログ項目が有効かどうかを確認します。この項目は、API バージョン 59.0 以降で利用できます。
isFeatured	項目の型 boolean 説明カタログ項目が主要カタログ項目に含まれるかどうかを決定します。
isProtected	項目の型 boolean 説明自動生成された値。現在、この値の影響はありません。
masterLabel	項目の型 string 説明必須。カタログ項目レコードの主表示ラベル。
Product	項目の型 string 説明カタログ項目に関連付けられた製品。この項目は、API バージョン 59.0 以降で利用できます。
sharedTo	項目の型 SharedTo 説明カタログ項目を複数のカタログカテゴリ間でどのように共有するかを説明します。SvcCatalogItemDef ではグループとの共有のみがサポートされます。
status	項目の型 PublishStatusType (string 型の列挙) 説明必須。カタログ項目の公開状況を表示します。値は次のとおりです。 `Deprecated` `Draft` `PendingChanges` `Published`

SvcCatalogCategoryItem

サービスカタログ内のカテゴリへのこのサービスの割り当てを表します。

項目名	説明
isPrimaryCategory	項目の型 boolean 説明カタログカテゴリ (svcCatalogCategory) がこのカタログ項目のプライマリカテゴリかどうかを決定します。SvcCatalogItemDef コンポーネントあたり 1 つのカテゴリでのみ、この属性を true に設定する必要があります。
sortOrder	項目の型 int 説明カタログカテゴリ内での他のカタログ項目に対するこのカタログ項目の相対的な位置。
svcCatalogCategory	項目の型 string 説明必須。カタログ項目が割り当てられているカタログカテゴリ。

SvcCatalogItemAttribute

カタログ項目バージョンの属性を表します。この属性には、カタログビルダーのユーザーが記入する静的な入力や、エンドユーザーに実行時に回答を求める追加の質問などがあります。

項目名	説明
BaseObjectApiName	項目の型 string 説明この属性の詳細を保存するベースオブジェクトの API 参照名。ServiceProcessAttribute メタデータ型の attributeType 項目が `Base` に設定されている場合に自動的に入力されます。この項目は、API バージョン 59.0 以降で利用できます。
field	項目の型 string 説明表示の種類がルックアップ/参照の場合に適用されます。
inputType	項目の型 SvcCatalogItemAttrDataType (string 型の列挙) 説明必須。値は次のとおりです。 `Attachment` `Checkbox` `Currency` `Date` `Datetime` `DisplayText` `Email` `IPAddress` `Integer` `ListOfBoolean` `ListOfDouble` `ListOfInteger` `ListOfMaps` `ListOfString` `Lookup` `Map` `MultilineText` `Number` `NumericScale` `Percentage` `Picklist` `Queue` `SingleCheckbox` (API バージョン 59.0 以降で使用可能) `SinglelineText` `Text` `Toggle` (API バージョン 59.0 以降で使用可能) `URL`
inputVariable	項目の型 string 説明属性値を転送する入力変数を参照します。
isAttrValueDerivAtRuntime	項目の型 boolean 説明この項目属性の値を実行時に取得するかどうかを指定します。この項目は、API バージョン 59.0 以降で利用できます。
isRequired	項目の型 boolean 説明この質問に回答が必要かどうかを判断します。
label	項目の型 string 説明ユーザーに属性を表示する翻訳可能な表示ラベル。
maxValue	項目の型 double 説明表示の種類がスライダーの場合に適用されます。
minValue	項目の型 double 説明表示の種類がスライダーの場合に適用されます。
name	項目の型 string 説明必須。表示の種類がルックアップ/参照の場合に適用されます。
object	項目の型 string 説明選択リストオブジェクトのカスタム API 参照名。inputType が `Picklist` に設定されている場合にのみ適用されます。
options	項目の型 SvcCatalogItemAttrDetail 説明項目バージョンの属性に付加する値。
ReferenceObjectApiName	項目の型 string 説明参照型属性の値を取得するオブジェクトの API 参照名。この項目は、API バージョン 59.0 以降で利用できます。次の場合に必須: ServiceProcessAttribute メタデータ型の attributeType 項目が `Extended` に設定されている。 ServiceProcessAttribute メタデータ型の attributeType 項目が `Base` に設定され、IsAttrValueDerivAtRuntime が `true` に設定されている。
type	項目の型 SvcCatalogItemAttrType (string 型の列挙) 説明必須。事前入力されているか、ユーザーに質問するかを判断するために使用する属性の種別。値は次のとおりです。 `FulfillmentInput` `UserQuestion`
value	項目の型 string 説明カタログビルダーで定義された属性値。

SvcCatalogItemAttrDetail

項目バージョンの属性の詳細を表します。選択リストまたはチェックボックスグループに表示されるオプションに使用します。

項目名	説明
isDefault	項目の型 boolean 説明必須。属性の詳細をデフォルトとしてマークする。入力表示タイプが選択リストまたはチェックボックスの場合に適用されます。
label	項目の型 string 説明必須。入力タイプが選択リストまたはチェックボックスである場合の、選択リストオプションの表示ラベル。
value	項目の型 string 説明カタログビルダーで定義された属性値。

SvcCatalogItemDefDataCategorySelection

このカタログ項目のデータカテゴリのリストを表します。このサブタイプは、API バージョン 59.0 以降で利用できます。

項目名	説明
category	項目の型 string 説明データカテゴリの API 参照名。
categoryGroup	項目の型 string 説明データカテゴリグループの API 参照名。

宣言的なメタデータの定義のサンプル

SvcCatalogItemDef コンポーネントの例を次に示します。

1<SvcCatalogItemDef xmlns="http://soap.sforce.com/2006/04/metadata">
2    <apiVersion>57.0</apiVersion>
3    <categories>
4        <isPrimaryCategory>true</isPrimaryCategory>
5        <sortOrder>3</sortOrder>
6        <svcCatalogCategory>Category1</svcCatalogCategory>
7    </categories>
8    <dataCategories>
9        <category>France</category>
10        <categoryGroup>World</categoryGroup>
11    </dataCategories>
12    <masterLabel>Item Draft Update</masterLabel>
13    <description>Item with a Draft state</description>
14    <fulfillmentFlow>TestQuestions</fulfillmentFlow>
15    <isFeatured>false</isFeatured>
16    <isProtected>false</isProtected>
17    <status>Published</status>
18    <inputs>
19        <name>Input1</name>
20        <type>FulfillmentInput</type>
21        <inputVariable>input1</inputVariable>
22        <label>Input Static</label>
23        <inputType>Text</inputType>
24        <isRequired>false</isRequired>
25    </inputs>
26    <inputs>
27        <type>UserQuestion</type>
28        <inputType>Picklist</inputType>
29        <isRequired>false</isRequired>
30        <label>My First Question</label>
31        <name>first_question</name>
32        <options>
33            <label>Option 1</label>
34            <value>option_1</value>
35            <isDefault>true</isDefault>
36        </options>
37        <options>
38            <label>Option 2</label>
39            <value>option_2</value>
40            <isDefault>false</isDefault>
41        </options>
42        <options>
43            <label>Option 3</label>
44            <value>option_3</value>
45            <isDefault>false</isDefault>
46        </options>
47    </inputs>
48</SvcCatalogItemDef>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。