Category entity reference
Entity for categorizing records to make it easier for your customers to find them on portals and through search.
Messages
| Message | SDK class or method |
|---|---|
| Assign | AssignRequest |
| Create | CreateRequest or Create |
| Delete | DeleteRequest or Delete |
| GrantAccess | GrantAccessRequest |
| Retrieve | RetrieveRequest or Retrieve |
| RetrieveMultiple | RetrieveMultipleRequest or RetrieveMultiple |
| RetrievePrincipalAccess | RetrievePrincipalAccessRequest |
| RetrieveSharedPrincipalsAndAccess | RetrieveSharedPrincipalsAndAccessRequest |
| RevokeAccess | RevokeAccessRequest |
| Update | UpdateRequest or Update |
Properties
| Property | Value |
|---|---|
| CollectionSchemaName | Categories |
| DisplayCollectionName | Categories |
| DisplayName | Category |
| EntitySetName | categories |
| IsBPFEntity | False |
| LogicalCollectionName | categories |
| LogicalName | category |
| OwnershipType | UserOwned |
| PrimaryIdAttribute | categoryid |
| PrimaryNameAttribute | title |
| SchemaName | Category |
Writable attributes
These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- CategoryId
- CategoryNumber
- Description
- ImportSequenceNumber
- OverriddenCreatedOn
- OwnerId
- OwnerIdType
- ParentCategoryId
- SequenceNumber
- Title
- TransactionCurrencyId
CategoryId
| Property | Value |
|---|---|
| Description | Shows the category. |
| DisplayName | Category ID |
| IsValidForForm | True |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | categoryid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
CategoryNumber
| Property | Value |
|---|---|
| Description | Shows the category number for customer reference. |
| DisplayName | Category Number |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | categorynumber |
| MaxLength | 4000 |
| RequiredLevel | SystemRequired |
| Type | String |
Description
| Property | Value |
|---|---|
| Description | Type a detailed description of the category |
| DisplayName | Description |
| Format | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | description |
| MaxLength | 2000 |
| RequiredLevel | None |
| Type | Memo |
ImportSequenceNumber
| Property | Value |
|---|---|
| Description | Unique identifier of the data import or data migration that created this record. |
| DisplayName | Import Sequence Number |
| Format | None |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | importsequencenumber |
| MaxValue | 2147483647 |
| MinValue | -2147483648 |
| RequiredLevel | None |
| Type | Integer |
OverriddenCreatedOn
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Date and time that the record was migrated. |
| DisplayName | Record Created On |
| Format | DateOnly |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | overriddencreatedon |
| RequiredLevel | None |
| Type | DateTime |
OwnerId
| Property | Value |
|---|---|
| Description | 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. |
| DisplayName | Owner |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | ownerid |
| RequiredLevel | SystemRequired |
| Targets | systemuser,team |
| Type | Owner |
OwnerIdType
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridtype |
| RequiredLevel | SystemRequired |
| Type | EntityName |
ParentCategoryId
| Property | Value |
|---|---|
| Description | Select an existing category article for the category. |
| DisplayName | Parent Category |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | parentcategoryid |
| RequiredLevel | None |
| Targets | category |
| Type | Lookup |
SequenceNumber
| Property | Value |
|---|---|
| Description | Enter a number to define the display position of the category in the hierarchy. |
| DisplayName | Display Order |
| Format | None |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | sequencenumber |
| MaxValue | 2147483647 |
| MinValue | 0 |
| RequiredLevel | None |
| Type | Integer |
Title
| Property | Value |
|---|---|
| Description | Type a title for the Category. |
| DisplayName | Title |
| FormatName | Text |
| IsLocalizable | True |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | title |
| MaxLength | 155 |
| RequiredLevel | SystemRequired |
| Type | String |
TransactionCurrencyId
| Property | Value |
|---|---|
| Description | Choose the local currency for the record to make sure budgets are reported in the correct currency. |
| DisplayName | Currency |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | transactioncurrencyid |
| RequiredLevel | None |
| Targets | transactioncurrency |
| Type | Lookup |
Read-only attributes
These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
- CreatedBy
- CreatedByName
- CreatedByYomiName
- CreatedOn
- CreatedOnBehalfBy
- CreatedOnBehalfByName
- CreatedOnBehalfByYomiName
- ExchangeRate
- ModifiedBy
- ModifiedByName
- ModifiedByYomiName
- ModifiedOn
- ModifiedOnBehalfBy
- ModifiedOnBehalfByName
- ModifiedOnBehalfByYomiName
- OwnerIdName
- OwningBusinessUnit
- OwningTeam
- OwningUser
- ParentCategoryIdName
- TransactionCurrencyIdName
- VersionNumber
CreatedBy
| Property | Value |
|---|---|
| Description | Unique identifier of the user who created the record. |
| DisplayName | Created By |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | createdby |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
CreatedByName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
CreatedByYomiName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdbyyominame |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
CreatedOn
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Date and time when the record was created. |
| DisplayName | Record Created On |
| Format | DateAndTime |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | createdon |
| RequiredLevel | None |
| Type | DateTime |
CreatedOnBehalfBy
| Property | Value |
|---|---|
| Description | Unique identifier of the delegate user who created the record. |
| DisplayName | Created By (Delegate) |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | createdonbehalfby |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
CreatedOnBehalfByName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdonbehalfbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
CreatedOnBehalfByYomiName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdonbehalfbyyominame |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
ExchangeRate
| Property | Value |
|---|---|
| Description | 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. |
| DisplayName | Exchange Rate |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | exchangerate |
| MaxValue | 100000000000 |
| MinValue | 0.0000000001 |
| Precision | 10 |
| RequiredLevel | None |
| Type | Decimal |
ModifiedBy
| Property | Value |
|---|---|
| Description | Unique identifier of the user who modified the record. |
| DisplayName | Modified By |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | modifiedby |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
ModifiedByName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
ModifiedByYomiName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedbyyominame |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
ModifiedOn
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | Date and time when the record was modified. |
| DisplayName | Modified On |
| Format | DateAndTime |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | modifiedon |
| RequiredLevel | None |
| Type | DateTime |
ModifiedOnBehalfBy
| Property | Value |
|---|---|
| Description | Unique identifier of the delegate user who modified the record. |
| DisplayName | Modified By (Delegate) |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | modifiedonbehalfby |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
ModifiedOnBehalfByName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedonbehalfbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
ModifiedOnBehalfByYomiName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedonbehalfbyyominame |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
OwnerIdName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owneridname |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
OwningBusinessUnit
| Property | Value |
|---|---|
| Description | Shows the business unit that the record owner belongs to. |
| DisplayName | Owning Business Unit |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owningbusinessunit |
| RequiredLevel | None |
| Targets | businessunit |
| Type | Lookup |
OwningTeam
| Property | Value |
|---|---|
| Description | Unique identifier of the team who owns the category. |
| DisplayName | Owning Team |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owningteam |
| RequiredLevel | None |
| Targets | team |
| Type | Lookup |
OwningUser
| Property | Value |
|---|---|
| Description | Unique identifier of the user who owns this category. |
| DisplayName | Owning User |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | owninguser |
| RequiredLevel | None |
| Targets | systemuser |
| Type | Lookup |
ParentCategoryIdName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | parentcategoryidname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
TransactionCurrencyIdName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | transactioncurrencyidname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
VersionNumber
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | versionnumber |
| MaxValue | 9223372036854775807 |
| MinValue | -9223372036854775808 |
| RequiredLevel | None |
| Type | BigInt |
One-To-Many Relationships
Listed by SchemaName.
category_parent_category
Same as the category_parent_category many-to-one relationship for the category entity.
| Property | Value |
|---|---|
| ReferencingEntity | category |
| ReferencingAttribute | parentcategoryid |
| IsHierarchical | True |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | category_parent_category |
| AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10 |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Category_SyncErrors
Same as the Category_SyncErrors many-to-one relationship for the syncerror entity.
| Property | Value |
|---|---|
| ReferencingEntity | syncerror |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | Category_SyncErrors |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: Cascade Reparent: Cascade Share: Cascade Unshare: Cascade |
Many-To-One Relationships
Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.
- category_parent_category
- lk_category_createdonbehalfby
- transactioncurrency_category
- lk_category_createdby
- lk_category_modifiedonbehalfby
- lk_category_modifiedby
- business_unit_category
category_parent_category
See the category_parent_category one-to-many relationship for the category entity.
lk_category_createdonbehalfby
See the lk_category_createdonbehalfby one-to-many relationship for the systemuser entity.
transactioncurrency_category
See the transactioncurrency_category one-to-many relationship for the transactioncurrency entity.
lk_category_createdby
See the lk_category_createdby one-to-many relationship for the systemuser entity.
lk_category_modifiedonbehalfby
See the lk_category_modifiedonbehalfby one-to-many relationship for the systemuser entity.
lk_category_modifiedby
See the lk_category_modifiedby one-to-many relationship for the systemuser entity.
business_unit_category
See the business_unit_category one-to-many relationship for the businessunit entity.
Many-To-Many Relationships
Relationship details provided where the Category entity is the first entity in the relationship. Listed by SchemaName.
knowledgearticle_category
See the knowledgearticle_category many-to-many relationship for the knowledgearticle entity.