SvcCatalogItemDef
Represents the entity associated with a specific, individual service available in the Service Catalog.
This type extends Metadata and inherits its fields.
SvcCatalogItemDef components have the suffix catalogItem and are stored in the svcCatalogItems folder.
Introduced in API version 53.0.
- Type: double
- Required: No
- Description: The API version in which this catalog item was created. The value for this field updates based on the value of
fulfillmentFlow. For catalog items created before version 57.0, the value for this field isnull. Available in version 57.0 and later.
- Type: SvcCatalogItemDefFiltrCrit[]
- Required: No
- Introduced: API version 59.0
- Description: The eligibility rule associated with a catalog item. Eligibility rules customize access to catalog items for different audiences, based on the User object.
- Type: SvcCatalogCategoryItem[]
- Required: No
- Description: A list of catalog categories that contain this catalog item.
- Type: SvcCatalogItemDefDataCategorySelection[]
- Required: No
- Introduced: API version 59.0
- Description: A list of data categories for this catalog item.
- Type: string
- Required: No
- Description: Description of the catalog item.
- Type: string
- Required: No
- Version: Available in API version 53.0 to 58.0.
- Description: The screen flow associated with the catalog item.
- Type: string
- Required: No
- Introduced: API version 56.0
- Description: Name of the related
SvcCatalogFulfillmentFlow, which represents the flow associated with a specific catalog item in the Service Catalog.
- Type: string
- Required: No
- Description: The developer name of a content document to be displayed in the Service Catalog for this item.
- Type: SvcCatalogItemAttribute[]
- Required: No
- Introduced: API version 57.0
- Description: Represents attributes of a catalog item version.
- Type: string
- Required: No
- Description: Intended to describe what the catalog item does and its implementation. That value is meant for other catalog builders.
- Type: boolean
- Required: Yes
- Introduced: API version 61.0
- Description: Required. Controls catalog item access for internal users. To share with all internal users, set the value to
True. This value corresponds to the Allow Access for All Users option for Internal Access in the Catalog Item Builder.
- Type: boolean
- Required: No
- Description: Determines if the catalog item is part of the featured catalog items.
- Type: boolean
- Required: Yes
- Introduced: API version 61.0
- Description: Required. Controls catalog item access for guest users. To share with guests, set the value to
True. This value corresponds to Guest Visibility option for External Access in the Catalog Item Builder.
- Type: boolean
- Required: No
- Description: An auto-generated value. This value has no impact.
- Type: string
- Required: Yes
- Description: Required. The primary label for the catalog item record.
- Type: SharedTo
- Required: No
- Description: Describes how the catalog item is shared across multiple catalog categories. SvcCatalogItemDef only supports sharing with groups.
-
Type: PublishStatusType (enumeration of type string)
-
Required: Yes
-
Description: Required. Displays the publishing status of a catalog item.
Values are:
-
Possible values:
- Deprecated
- Draft
- PendingChanges
- Published
Represents the assignment of this service to a category within the Service Catalog.
- Type: boolean
- Required: No
- 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.
- Type: int
- Required: No
- Description: The position of the catalog item relative to other catalog items in the catalog category.
- Type: string
- Required: Yes
- Description: Required. The catalog category the catalog item is assigned to.
Represents the details for an attribute of an item version. Used for options displayed in picklist or checkbox groups.
- Type: boolean
- Required: Yes
- Description: Required. Marks the attribute detail as the default. Applicable when the input display type is picklist or checkbox.
- Type: string
- Required: Yes
- Description: Required. Picklist option label when the input type is picklist or checkbox.
- Type: string
- Required: Yes
- Description: Attribute value defined by the catalog builder.
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.
Introduced in API version 57.0.
- Type: string
- Required: No
- Description: Applicable when the display type is Lookup/Reference.
-
Type: SvcCatalogItemAttrDataType (enumeration of type string)
-
Required: Yes
-
Description: Required.
Values are:
-
Possible values:
- Attachment
- Checkbox
- Currency
- Date
- Datetime
- DisplayText
- IPAddress
- Integer
- ListOfAttachment — (available in API version 65.0 and later)
- ListOfBoolean
- ListOfDouble
- ListOfInteger
- ListOfMaps
- ListOfString
- Lookup
- Map
- MultilineText
- MultiSelectPicklist — (available in API version 65.0 and later)
- Number
- NumericScale
- Password — (available in API version 65.0 and later)
- Percentage
- Picklist
- Queue
- RadioButton — (available in API version 65.0 and later)
- SingleCheckbox — (available in API version 59.0 and later)
- SinglelineText
- Text
- Toggle — (available in API version 59.0 and later)
- Url
- Type: string
- Required: No
- Description: References the input variable to which the attribute value is forwarded.
- Type: boolean
- Required: Yes
- Description: Determines if an answer is required for this question.
- Type: string
- Required: Yes
- Description: A translatable label for rendering the attribute to users.
- Type: double
- Required: No
- Description: Applicable when the display type is slider.
- Type: double
- Required: No
- Description: Applicable when the display type is slider.
- Type: string
- Required: Yes
- Description: Required. Applicable when the display type is Lookup/Reference.
- Type: string
- Required: No
- Description: A picklist object’s custom API Name. Applies when
inputTypeis set toPicklist.
- Type: SvcCatalogItemAttrDetail[]
- Required: No
- Description: The values attached to an attribute of an item version.
-
Type: SvcCatalogItemAttrType (enumeration of type string)
-
Required: Yes
-
Description: Required. Type of the attribute; used to determine if it’s a pre-filled input or questions to ask users.
Values are:
-
Possible values:
- FulfillmentInput
- UserQuestion
- Type: string
- Required: No
- Description: Attribute value defined by the catalog builder.
Represents a list of data categories for this catalog item. This subtype is available in API version 59.0 and later.
- Type: string
- Required: Yes
- Description: API name of a data category.
- Type: string
- Required: Yes
- Description: API Name of a data category group.
Represents the association of an eligibility rule with a catalog item. Eligibility rules customize access to catalog items for different audiences, based on the User object. Available in version 59.0 and later.
- Type: string
- Required: Yes
- Description: The name of the associated
catalogFilerCriteriaeligibility filter.
The following is an example of a SvcCatalogItemDef component.
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.