SvcCatalogItemDef | Metadata API Developer Guide

File Suffix and Directory Location

SvcCatalogItemDef components have the suffix catalogItem and are stored in the svcCatalogItems folder.

Version

SvcCatalogItemDef components are available in API version 53.0 and later.

Fields

Field Name	Description
categories	Field Type SvcCatalogCategoryItem[] Description A list of catalog categories that contain this catalog item.
dataCategories	Field Type SvcCatalogItemDefDataCategorySelection[] Description A list of data categories for this catalog item. This field is available in API version 59.0 and later.
description	Field Type string Description Free-text description of the catalog item.
flow	Field Type string Description The screen flow associated with the catalog item.
image	Field Type string Description The developer name of a content document to be displayed in the Service Catalog for this item.
internalNotes	Field Type string Description Intended to describe what the catalog item does and its implementation. That value is meant for other catalog builders.
isActive	Field Type boolean Description Determines if the catalog item is active. This field is available in API version 59.0 and later.
isFeatured	Field Type boolean Description Determines if the catalog item is part of the featured catalog items.
isProtected	Field Type boolean Description An auto-generated value. This value currently has no impact.
masterLabel	Field Type string Description Required. The primary label for the catalog item record.
Product	Field Type string Description The product associated with the catalog item. This field is available in API version 59.0 and later.
sharedTo	Field Type SharedTo Description Describes how the catalog item is shared across multiple catalog categories. SvcCatalogItemDef only supports sharing with groups.
status	Field Type PublishStatusType (enumeration of type string) Description Required. Displays the publishing status of a catalog item. Values are: `Deprecated` `Draft` `PendingChanges` `Published`

SvcCatalogCategoryItem

Represents the assignment of this service to a category within the Service Catalog.

Field Name	Description
isPrimaryCategory	Field Type boolean Description Determines if the catalog category (svcCatalogCategory) is the primary category for this catalog item. Exactly one category per SvcCatalogItemDef component must set this attribute to true.
sortOrder	Field Type int Description The position of the catalog item relative to other catalog items in the catalog category.
svcCatalogCategory	Field Type string Description Required. The catalog category the catalog item is assigned to.

SvcCatalogItemAttribute

Represents an attribute of a catalog item version. It can be a static input filled by the catalog builder user or additional questions that end users answer at runtime.

Field Name	Description
BaseObjectApiName	Field Type string Description The API Name of the base object that stores the details of this attribute. Automatically populated when the attributeType field of the ServiceProcessAttribute metadata type is set to `Base`. This field is available in API version 59.0 and later.
field	Field Type string Description Applicable when the display type is Lookup/Reference.
inputType	Field Type SvcCatalogItemAttrDataType (enumeration of type string) Description Required. Values are: `Attachment` `Checkbox` `Currency` `Date` `Datetime` `DisplayText` `Email` `IPAddress` `Integer` `ListOfBoolean` `ListOfDouble` `ListOfInteger` `ListOfMaps` `ListOfString` `Lookup` `Map` `MultilineText` `Number` `NumericScale` `Percentage` `Picklist` `Queue` `SingleCheckbox` (available in API version 59.0 and later) `SinglelineText` `Text` `Toggle` (available in API version 59.0 and later) `URL`
inputVariable	Field Type string Description References the input variable to which the attribute value is forwarded.
isAttrValueDerivAtRuntime	Field Type boolean Description Specifies whether the value of this item attribute is derived at runtime. This field is available in API version 59.0 and later.
isRequired	Field Type boolean Description Determines if an answer is required for this question.
label	Field Type string Description A translatable label for rendering the attribute to users.
maxValue	Field Type double Description Applicable when the display type is slider.
minValue	Field Type double Description Applicable when the display type is slider.
name	Field Type string Description Required. Applicable when the display type is Lookup/Reference.
object	Field Type string Description A picklist object’s custom API Name. Applies when inputType is set to `Picklist`.
options	Field Type SvcCatalogItemAttrDetail Description The values attached to an attribute of an item version.
ReferenceObjectApiName	Field Type string Description The API name of the object from which to derive the value of the lookup-type attribute. This field is available in API version 59.0 and later. Required if: The attributeType field of the ServiceProcessAttribute metadata type is set to `Extended`. The attributeType field of the ServiceProcessAttribute metadata type is set to `Base` and IsAttrValueDerivAtRuntime is set to `true`.
type	Field Type SvcCatalogItemAttrType (enumeration of type string) Description Required. Type of the attribute; used to determine if it's a pre-filled input or questions to ask users. Values are: `FulfillmentInput` `UserQuestion`
value	Field Type string Description Attribute value defined by the catalog builder.

SvcCatalogItemAttrDetail

Represents the details for an attribute of an item version. Used for options displayed in picklist or checkbox groups.

Field Name	Description
isDefault	Field Type boolean Description Required. Marks the attribute detail as the default. Applicable when the input display type is picklist or checkbox.
label	Field Type string Description Required. Picklist option label when the input type is picklist or checkbox.
value	Field Type string Description Attribute value defined by the catalog builder.

SvcCatalogItemDefDataCategorySelection

Represents a list of data categories for this catalog item. This subtype is available in API version 59.0 and later.

Field Name	Description
category	Field Type string Description API Name of a data category.
categoryGroup	Field Type string Description API Name of a data category group.

Declarative Metadata Sample Definition

The following is an example of a SvcCatalogItemDef component.

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>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.