SvcCatalogItemDef

Represents the grouping of individual catalog items in Service Catalog. This object is available in API version 53.0 and later.

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

Supported SOAP API Calls

create(), delete(), describeSObjects(), query(), retrieve(), 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

Field Details
Description
Type
textarea
Properties
Nillable
Description
Free-text description of the catalog item.
DeveloperName
Type
string
Properties
Filter, Group, Sort
Description
Developer name for this catalog item.
FlowId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The screen flow associated with the catalog item.
This is a relationship field.
Relationship Name
Flow
Relationship Type
Lookup
Refers To
FlowDefinition
FulfillmentFlowId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
This field is a relationship field.
Relationship Name
FulfillmentFlow
Relationship Type
Lookup
Refers To
SvcCatalogFulfillmentFlow
FullName
Type
string
Properties
Create, Group, Nillable
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.
InternalNotes
Type
textarea
Properties
Nillable
Description
Describes what the catalog item does and its implementation. This value is meant for other catalog builders.
IsFeatured
Type
boolean
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'.
Language
Type
picklist
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)
ManageableState
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Describes the manageable state of a catalog item that is contained in a package.
Possible values are:
  • beta—Managed-Beta
  • deleted—Managed-Proposed-Deleted
  • deprecated—Managed-Proposed-Deprecated
  • deprecatedEditable—SecondGen-Installed-Deprecated
  • installed—Managed-Installed
  • installedEditable—SecondGen-Installed-Editable
  • released—Managed-Released
  • unmanaged—Unmanaged
MasterLabel
Type
string
Properties
Filter, Group, Sort
Description
The primary label for the catalog item record.
Metadata
Type
complexvalue
Properties
Create, Nillable, Update
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
Properties
Filter, Group, Nillable, Sort
Description
The namespace associated with this catalog item.
Status
Type
picklist
Properties
Defaulted on create, Filter, Group, Restricted picklist, Sort
Description
Displays the publishing status of a catalog item.
Possible values are:
  • Deprecated
  • Draft
  • PendingChanges
  • Published
The default value is 'Draft'.