| DeveloperName |
- Type
- string
- Properties
- Filter, Group, Sort
- Description
- Developer name for this category.
|
| FullName |
- Type
- string
- Properties
- Create, Group, Nillable
- 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.
|
| IsActive |
- Type
- boolean
- Properties
- Defaulted on create, Filter, Group, Sort
- Description
- Indicates if a catalog category is active.
- The default value is 'false'.
|
| ManageableState |
- Type
- picklist
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- Description
- Describes the manageable state of a category 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 category record.
|
| Metadata |
- Type
- complexvalue
- Properties
- Create, Nillable, Update
- 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
- Properties
- Filter, Group, Nillable, Sort
- Description
- The namespace associated with this category.
|
| ParentCategoryId |
- Type
- reference
- 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
- Lookup
- Refers To
- SvcCatalogCategory
|
| SortOrder |
- Type
- int
- Properties
- Filter, Group, Nillable, Sort
- Description
- Displays a set order for catalog category entities.
|