SvcCatalogItemDef

Represents the grouping of individual catalog items in Service Catalog.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Version 

Introduced in API version 53.0.

Supported SOAP API Calls 

create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), search(), update(), upsert()

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules 

• Available to customers with Employee Productivity Plus or IT Service Center add-ons.

Fields 

Description 

• Type: textarea

• Required: No

• Properties: Nillable

• Description: Free-text description of the catalog item.

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: Developer name for this catalog item.

FlowId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The screen flow associated with the catalog item.

This is a relationship field.

• Relationship name: Flow
• Relationship type: relationship
• Refers to: FlowDefinition

FulfillmentFlowId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 56.0

• Description: This field is a relationship field.

• Relationship name: FulfillmentFlow

• Relationship type: relationship

• Refers to: SvcCatalogFulfillmentFlow

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 53.0

• Description: The full name of the catalog item. This name has the following requirements:

• It must be unique across the org.

• It must contain only alphanumeric characters and underscores.

• It must begin with a letter.

• It must not include spaces.

• It must not end with an underscore.

• It must not contain two consecutive underscores.

Query this field only if the query result contains up to one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

ImageId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Relationship name: Image

• Relationship type: relationship

• Refers to: ContentAsset

ImageReference 

• Type: string
• Required: No
• Properties: Filter, Group, Nillable, Sort
• Introduced: API version 61.0

InternalNotes 

• Type: textarea

• Required: No

• Properties: Nillable

• Description: Describes what the catalog item does and its implementation. This value is meant for other catalog builders.

IsActive 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Introduced: API version 59.0

• Default value: false

IsAvailableToAllCustomers 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Introduced: API version 61.0

• Default value: false

IsFeatured 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Description: Determines if the catalog item is part of the featured catalog items.

The default value is ‘false’.

• Default value: false

IsGuestAccessible 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Introduced: API version 61.0

• Default value: false

IsOutOfSync 

• Type: boolean

• Required: No

• Properties: Defaulted on create, Filter, Group, Sort

• Introduced: API version 58.0

• Default value: false

Language 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Description: Possible values are:

• da - Danish

• de - German

• en_US - English

• es - Spanish

• es_MX - Spanish (Mexico)

• fi - Finnish

• fr - French

• it - Italian

• ja - Japanese

• ko - Korean

• nl_NL - Dutch

• no - Norwegian

• pt_BR - Portuguese (Brazil)

• ru - Russian

• sv - Swedish

• th - Thai

• zh_CN - Chinese (Simplified)

• zh_TW - Chinese (Traditional)

• Possible values:

  • en_US — English

  • de — German

  • es — Spanish

  • fr — French

  • it — Italian

  • ja — Japanese

  • sv — Swedish

  • ko — Korean

  • zh_TW — Chinese (Traditional)

  • zh_CN — Chinese (Simplified)

  • pt_BR — Portuguese (Brazil)

  • nl_NL — Dutch

  • da — Danish

  • th — Thai

  • fi — Finnish

  • ru — Russian

  • es_MX — Spanish (Mexico)

  • no — Norwegian

ManageableState 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: Describes the manageable state of a catalog item that is contained in a package.

• Possible values:

  • beta — beta — Managed-Beta

  • deleted — deleted — Managed-Proposed-Deleted

  • deprecated — deprecated — Managed-Proposed-Deprecated

  • deprecatedEditable — deprecatedEditable — SecondGen-Installed-Deprecated

  • installed — installed — Managed-Installed

  • installedEditable — installedEditable — SecondGen-Installed-Editable

  • released — released — Managed-Released

  • unmanaged — unmanaged

MasterLabel 

• Type: string

• Required: No

• Properties: Filter, Group, idLookup, Sort

• Description: The primary label for the catalog item record.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Introduced: API version 53.0

• Description: The catalog item’s metadata. Query this field only if the query result contains up to one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The namespace associated with this catalog item.

Product 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Introduced: API version 59.0

• Possible values:

  • ServiceCatalog — ServiceCatalog (default)

  • FinancialServices — FinancialServices

• Default value: ServiceCatalog

Status 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort

• Description: Displays the publishing status of a catalog item.

The default value is ‘Draft’.

• Possible values:

  • Draft — Draft (default)

  • Published — Published

  • PendingChanges — PendingChanges

  • Deprecated — Deprecated

• Default value: Draft

UsageType 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Introduced: API version 57.0

• Possible values:

  • Employee — Employee (default)

  • CustomerService — CustomerService

  • Industry — Industry

  • FinancialServices — FinancialServices

• Default value: Employee