category EntityType
Entity for categorizing records to make it easier for your customers to find them on portals and through search.
- Entity set path:
- [organization URI]/api/data/v9.2/categories
- Base type:
- crmbaseentity
- Table type:
- Standard
- Display name:
- Category
- Primary key:
- categoryid
- Primary name column:
- title
- Operations supported:
- POST GET PATCH DELETE
Properties
Properties represent fields of data stored in the entity. Some properties are read-only.
| Name | Type | Details |
|---|---|---|
| categoryid | Edm.Guid |
Shows the category. Display name: Category ID |
| categorynumber | Edm.String |
Shows the category number for customer reference. Display name: Category Number |
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display name: Record Created On Read only
|
| description | Edm.String |
Type a detailed description of the category Display name: Description |
| exchangerate | Edm.Decimal |
Shows the conversion rate of the record's currency. The exchange rate is used to convert all money fields in the record from the local currency to the system's default currency. Display name: Exchange Rate Read only
|
| importsequencenumber | Edm.Int32 |
Unique identifier of the data import or data migration that created this record. Display name: Import Sequence Number |
| modifiedon | Edm.DateTimeOffset |
Date and time when the record was modified. Display name: Modified On Read only
|
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display name: Record Created On |
| sequencenumber | Edm.Int32 |
Enter a number to define the display position of the category in the hierarchy. Display name: Display Order |
| title | Edm.String |
Type a title for the Category. Display name: Title |
| versionnumber | Edm.Int64 |
Read only
|
Lookup properties
Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.
| Name | Single-valued navigation property | Description |
|---|---|---|
| _createdby_value | lk_category_createdby |
Unique identifier of the user who created the record. |
| _createdonbehalfby_value | lk_category_createdonbehalfby |
Unique identifier of the delegate user who created the record. |
| _modifiedby_value | lk_category_modifiedby |
Unique identifier of the user who modified the record. |
| _modifiedonbehalfby_value | lk_category_modifiedonbehalfby |
Unique identifier of the delegate user who modified the record. |
| _ownerid_value | ownerid |
Enter the user or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user. |
| _owningbusinessunit_value | owningbusinessunit |
Shows the business unit that the record owner belongs to. |
| _parentcategoryid_value | parentcategoryid |
Select an existing category article for the category. |
| _transactioncurrencyid_value | transactioncurrencyid |
Choose the local currency for the record to make sure budgets are reported in the correct currency. |
Single-valued navigation properties
Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.
| Name | Type | Partner |
|---|---|---|
| lk_category_createdby | systemuser | lk_category_createdby |
| lk_category_createdonbehalfby | systemuser | lk_category_createdonbehalfby |
| lk_category_modifiedby | systemuser | lk_category_modifiedby |
| lk_category_modifiedonbehalfby | systemuser | lk_category_modifiedonbehalfby |
| ownerid | principal | owner_categories |
| owningbusinessunit | businessunit | business_unit_category |
| parentcategoryid | category | category_parent_category |
| transactioncurrencyid | transactioncurrency | transactioncurrency_category |
Collection-valued navigation properties
Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.
| Name | Type | Partner |
|---|---|---|
| category_parent_category | category | parentcategoryid |
| Category_SyncErrors | syncerror | regardingobjectid_category_syncerror |
| knowledgearticle_category | knowledgearticle | knowledgearticle_category |
Operations
The following operations can be used with the category entity type.
| Name | Binding |
|---|---|
| GrantAccess | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RevokeAccess | Not Bound |