Category table/entity reference
Entity for categorizing records to make it easier for your customers to find them on portals and through search.
Messages
The following table lists the messages for the Category table. Messages represent operations that can be performed on the table. They may also be events.
Name Is Event? |
Web API Operation | SDK for .NET |
---|---|---|
Assign Event: True |
PATCH /categories(categoryid)Update the ownerid property. |
AssignRequest |
Create Event: True |
POST /categoriesSee Create |
Create records |
Delete Event: True |
DELETE /categories(categoryid)See Delete |
Delete records |
GrantAccess Event: True |
GrantAccess | GrantAccessRequest |
Retrieve Event: True |
GET /categories(categoryid)See Retrieve |
Retrieve records |
RetrieveMultiple Event: True |
GET /categoriesSee Query data |
Query data |
RetrievePrincipalAccess Event: True |
RetrievePrincipalAccess | RetrievePrincipalAccessRequest |
RetrieveSharedPrincipalsAndAccess Event: True |
RetrieveSharedPrincipalsAndAccess | RetrieveSharedPrincipalsAndAccessRequest |
RevokeAccess Event: True |
RevokeAccess | RevokeAccessRequest |
Update Event: True |
PATCH /categories(categoryid)See Update |
Update records |
Upsert Event: False |
PATCH /categories(categoryid)See Upsert a table row |
UpsertRequest |
Properties
The following table lists selected properties for the Category table.
Property | Value |
---|---|
DisplayName | Category |
DisplayCollectionName | Categories |
SchemaName | Category |
CollectionSchemaName | Categories |
EntitySetName | categories |
LogicalName | category |
LogicalCollectionName | categories |
PrimaryIdAttribute | categoryid |
PrimaryNameAttribute | title |
TableType | Standard |
OwnershipType | UserOwned |
Writable columns/attributes
These columns/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 |
LogicalName | categoryid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
CategoryNumber
Property | Value |
---|---|
Description | Shows the category number for customer reference. |
DisplayName | Category Number |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | categorynumber |
RequiredLevel | SystemRequired |
Type | String |
Format | Text |
FormatName | Text |
ImeMode | Auto |
IsLocalizable | False |
MaxLength | 4000 |
Description
Property | Value |
---|---|
Description | Type a detailed description of the category |
DisplayName | Description |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | description |
RequiredLevel | None |
Type | Memo |
Format | Text |
FormatName | Text |
ImeMode | Auto |
IsLocalizable | False |
MaxLength | 2000 |
ImportSequenceNumber
Property | Value |
---|---|
Description | Unique identifier of the data import or data migration that created this record. |
DisplayName | Import Sequence Number |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | importsequencenumber |
RequiredLevel | None |
Type | Integer |
MaxValue | 2147483647 |
MinValue | -2147483648 |
OverriddenCreatedOn
Property | Value |
---|---|
Description | Date and time that the record was migrated. |
DisplayName | Record Created On |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | overriddencreatedon |
RequiredLevel | None |
Type | DateTime |
CanChangeDateTimeBehavior | False |
DateTimeBehavior | UserLocal |
Format | DateOnly |
ImeMode | Inactive |
SourceTypeMask | 0 |
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 |
Type | Owner |
Targets | systemuser, team |
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 |
Type | Lookup |
Targets | category |
SequenceNumber
Property | Value |
---|---|
Description | Enter a number to define the display position of the category in the hierarchy. |
DisplayName | Display Order |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | sequencenumber |
RequiredLevel | None |
Type | Integer |
MaxValue | 2147483647 |
MinValue | 0 |
Title
Property | Value |
---|---|
Description | Type a title for the Category. |
DisplayName | Title |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | title |
RequiredLevel | SystemRequired |
Type | String |
Format | Text |
FormatName | Text |
ImeMode | Auto |
IsLocalizable | True |
MaxLength | 155 |
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 |
Type | Lookup |
Targets | transactioncurrency |
Read-only columns/attributes
These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.
- CreatedBy
- CreatedOn
- CreatedOnBehalfBy
- ExchangeRate
- ModifiedBy
- ModifiedOn
- ModifiedOnBehalfBy
- OwnerIdName
- OwningBusinessUnit
- OwningTeam
- OwningUser
- 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 |
Type | Lookup |
Targets | systemuser |
CreatedOn
Property | Value |
---|---|
Description | Date and time when the record was created. |
DisplayName | Record Created On |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | createdon |
RequiredLevel | None |
Type | DateTime |
CanChangeDateTimeBehavior | False |
DateTimeBehavior | UserLocal |
Format | DateAndTime |
ImeMode | Inactive |
SourceTypeMask | 0 |
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 |
Type | Lookup |
Targets | systemuser |
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 |
RequiredLevel | None |
Type | Decimal |
ImeMode | Disabled |
MaxValue | 100000000000 |
MinValue | 1E-12 |
Precision | 12 |
SourceTypeMask | 0 |
ModifiedBy
Property | Value |
---|---|
Description | Unique identifier of the user who modified the record. |
DisplayName | Modified By |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | modifiedby |
RequiredLevel | None |
Type | Lookup |
Targets | systemuser |
ModifiedOn
Property | Value |
---|---|
Description | Date and time when the record was modified. |
DisplayName | Modified On |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | modifiedon |
RequiredLevel | None |
Type | DateTime |
CanChangeDateTimeBehavior | False |
DateTimeBehavior | UserLocal |
Format | DateAndTime |
ImeMode | Inactive |
SourceTypeMask | 0 |
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 |
Type | Lookup |
Targets | systemuser |
OwnerIdName
Property | Value |
---|---|
Description | |
DisplayName | |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | owneridname |
RequiredLevel | SystemRequired |
Type | String |
Format | Text |
FormatName | Text |
ImeMode | Auto |
IsLocalizable | False |
MaxLength | 100 |
OwningBusinessUnit
Property | Value |
---|---|
Description | Shows the business unit that the record owner belongs to. |
DisplayName | Owning Business Unit |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | owningbusinessunit |
RequiredLevel | None |
Type | Lookup |
Targets | businessunit |
OwningTeam
Property | Value |
---|---|
Description | Unique identifier of the team who owns the category. |
DisplayName | Owning Team |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | owningteam |
RequiredLevel | None |
Type | Lookup |
Targets | team |
OwningUser
Property | Value |
---|---|
Description | Unique identifier of the user who owns this category. |
DisplayName | Owning User |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | owninguser |
RequiredLevel | None |
Type | Lookup |
Targets | systemuser |
VersionNumber
Property | Value |
---|---|
Description | |
DisplayName | |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | versionnumber |
RequiredLevel | None |
Type | BigInt |
MaxValue | 9223372036854775807 |
MinValue | -9223372036854775808 |
Many-to-One relationships
These relationships are many-to-one. Listed by SchemaName.
- business_unit_category
- category_parent_category
- lk_category_createdby
- lk_category_createdonbehalfby
- lk_category_modifiedby
- lk_category_modifiedonbehalfby
- owner_categories
- transactioncurrency_category
business_unit_category
One-To-Many Relationship: businessunit business_unit_category
Property | Value |
---|---|
ReferencedEntity | businessunit |
ReferencedAttribute | businessunitid |
ReferencingAttribute | owningbusinessunit |
ReferencingEntityNavigationPropertyName | owningbusinessunit |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
category_parent_category
One-To-Many Relationship: category category_parent_category
Property | Value |
---|---|
ReferencedEntity | category |
ReferencedAttribute | categoryid |
ReferencingAttribute | parentcategoryid |
ReferencingEntityNavigationPropertyName | parentcategoryid |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
lk_category_createdby
One-To-Many Relationship: systemuser lk_category_createdby
Property | Value |
---|---|
ReferencedEntity | systemuser |
ReferencedAttribute | systemuserid |
ReferencingAttribute | createdby |
ReferencingEntityNavigationPropertyName | lk_category_createdby |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
lk_category_createdonbehalfby
One-To-Many Relationship: systemuser lk_category_createdonbehalfby
Property | Value |
---|---|
ReferencedEntity | systemuser |
ReferencedAttribute | systemuserid |
ReferencingAttribute | createdonbehalfby |
ReferencingEntityNavigationPropertyName | lk_category_createdonbehalfby |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
lk_category_modifiedby
One-To-Many Relationship: systemuser lk_category_modifiedby
Property | Value |
---|---|
ReferencedEntity | systemuser |
ReferencedAttribute | systemuserid |
ReferencingAttribute | modifiedby |
ReferencingEntityNavigationPropertyName | lk_category_modifiedby |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
lk_category_modifiedonbehalfby
One-To-Many Relationship: systemuser lk_category_modifiedonbehalfby
Property | Value |
---|---|
ReferencedEntity | systemuser |
ReferencedAttribute | systemuserid |
ReferencingAttribute | modifiedonbehalfby |
ReferencingEntityNavigationPropertyName | lk_category_modifiedonbehalfby |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
owner_categories
One-To-Many Relationship: owner owner_categories
Property | Value |
---|---|
ReferencedEntity | owner |
ReferencedAttribute | ownerid |
ReferencingAttribute | ownerid |
ReferencingEntityNavigationPropertyName | ownerid |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
transactioncurrency_category
One-To-Many Relationship: transactioncurrency transactioncurrency_category
Property | Value |
---|---|
ReferencedEntity | transactioncurrency |
ReferencedAttribute | transactioncurrencyid |
ReferencingAttribute | transactioncurrencyid |
ReferencingEntityNavigationPropertyName | transactioncurrencyid |
IsHierarchical | |
CascadeConfiguration | Archive: NoCascade Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade |
One-to-Many relationships
These relationships are one-to-many. Listed by SchemaName.
category_parent_category
Many-To-One Relationship: category category_parent_category
Property | Value |
---|---|
ReferencingEntity | category |
ReferencingAttribute | parentcategoryid |
ReferencedEntityNavigationPropertyName | category_parent_category |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: UseCollectionName Group: Details Label: MenuId: null Order: 10 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
Category_SyncErrors
Many-To-One Relationship: syncerror Category_SyncErrors
Property | Value |
---|---|
ReferencingEntity | syncerror |
ReferencingAttribute | regardingobjectid |
ReferencedEntityNavigationPropertyName | Category_SyncErrors |
IsCustomizable | True |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
Many-to-Many relationships
These relationships are many-to-many. Listed by SchemaName.
knowledgearticle_category
See knowledgearticle knowledgearticle_category Many-To-Many Relationship
Property | Value |
---|---|
IntersectEntityName | knowledgearticlescategories |
IsCustomizable | False |
SchemaName | knowledgearticle_category |
IntersectAttribute | categoryid |
NavigationPropertyName | knowledgearticle_category |
AssociatedMenuConfiguration | AvailableOffline: True Behavior: DoNotDisplay Group: Details Label: MenuId: null Order: QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000 |
See also
Dataverse table/entity reference
Dataverse Web API Reference
category