SvcCatalogCategory

Represents the grouping of individual catalog items in Service Catalog.

Version 

Introduced in API version 53.0.

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 

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: Developer name for this category.

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 53.0

• Description: The full name of the category. 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

IsActive 

• Type: boolean

• Required: No

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

• Description: Indicates if a catalog category is active.

The default value is ‘false’.

• Default value: false

Language 

• Type: picklist

• Required: No

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

• Description: The language of the Service Catalog Category.

• 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 category 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, Sort

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

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Introduced: API version 53.0

• Description: The category’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 category.

ParentCategoryId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: If provided, the name of another SvcCatalogCategory that this category appears under. The parent category in this field can’t have its own parent category. Categories can’t have more than one level of nesting.

This is a relationship field.

• Relationship name: ParentCategory
• Relationship type: relationship
• Refers to: SvcCatalogCategory

SortOrder 

• Type: int

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Displays a set order for catalog category entities.