Catalog table/entity reference
Note
Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.
Entity for cataloging records to make it easier for your customers to find them on portals and through search.
Added by: CatalogFramework Solution
Messages
| Message | Web API Operation | SDK Assembly |
|---|---|---|
| Create | POST [org URI]/api/data/v9.0/catalogs See Create |
CreateRequest or Create |
| Delete | DELETE [org URI]/api/data/v9.0/catalogs(catalogid) See Delete |
DeleteRequest or Delete |
| IsValidStateTransition | IsValidStateTransition Function | IsValidStateTransitionRequest |
| Retrieve | GET [org URI]/api/data/v9.0/catalogs(catalogid) See Retrieve |
RetrieveRequest or Retrieve |
| RetrieveMultiple | GET [org URI]/api/data/v9.0/catalogs See Query Data |
RetrieveMultipleRequest or RetrieveMultiple |
| SetState | PATCH [org URI]/api/data/v9.0/catalogs(catalogid) Update statecode and statuscode properties. |
SetStateRequest |
| Update | PATCH [org URI]/api/data/v9.0/catalogs(catalogid) See Update |
UpdateRequest or Update |
Properties
| Property | Value |
|---|---|
| CollectionSchemaName | Catalogs |
| DisplayCollectionName | Catalogs |
| DisplayName | Catalog |
| EntitySetName | catalogs |
| IsBPFEntity | False |
| LogicalCollectionName | catalogs |
| LogicalName | catalog |
| OwnershipType | OrganizationOwned |
| PrimaryIdAttribute | catalogid |
| PrimaryNameAttribute | name |
| SchemaName | Catalog |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- CatalogId
- Description
- DisplayName
- ImportSequenceNumber
- IsCustomizable
- Name
- OverriddenCreatedOn
- ParentCatalogId
- statecode
- statuscode
- TimeZoneRuleVersionNumber
- UniqueName
- UTCConversionTimeZoneCode
CatalogId
| Property | Value |
|---|---|
| Description | Unique identifier for catalog instances |
| DisplayName | Catalog |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | catalogid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
Description
| Property | Value |
|---|---|
| Description | Localized description for catalog instances |
| DisplayName | Description |
| FormatName | Text |
| IsLocalizable | True |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | description |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
DisplayName
| Property | Value |
|---|---|
| Description | Localized display name for catalog instances |
| DisplayName | Display Name |
| FormatName | Text |
| IsLocalizable | True |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | displayname |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
ImportSequenceNumber
Added by: Basic Solution Solution
| Property | Value |
|---|---|
| Description | Sequence number of the import 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 |
IsCustomizable
Added by: Basic Solution Solution
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Is Customizable |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | iscustomizable |
| RequiredLevel | SystemRequired |
| Type | ManagedProperty |
Name
| Property | Value |
|---|---|
| Description | The primary name of the catalog |
| DisplayName | Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | name |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
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 |
ParentCatalogId
| Property | Value |
|---|---|
| Description | Unique identifier for the Parent Catalog |
| DisplayName | Parent Catalog |
| IsValidForForm | True |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | parentcatalogid |
| RequiredLevel | None |
| Targets | catalog |
| Type | Lookup |
statecode
| Property | Value |
|---|---|
| Description | Status of the Catalog |
| DisplayName | Status |
| IsValidForCreate | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statecode |
| RequiredLevel | SystemRequired |
| Type | State |
statecode Choices/Options
| Value | Label | DefaultStatus | InvariantName |
|---|---|---|---|
| 0 | Active | 1 | Active |
| 1 | Inactive | 2 | Inactive |
statuscode
| Property | Value |
|---|---|
| Description | Reason for the status of the Catalog |
| DisplayName | Status Reason |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | statuscode |
| RequiredLevel | None |
| Type | Status |
statuscode Choices/Options
| Value | Label | State |
|---|---|---|
| 1 | Active | 0 |
| 2 | Inactive | 1 |
TimeZoneRuleVersionNumber
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Time Zone Rule Version Number |
| Format | None |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | timezoneruleversionnumber |
| MaxValue | 2147483647 |
| MinValue | -1 |
| RequiredLevel | None |
| Type | Integer |
UniqueName
| Property | Value |
|---|---|
| Description | Unique name for the catalog |
| DisplayName | Unique Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | uniquename |
| MaxLength | 128 |
| RequiredLevel | SystemRequired |
| Type | String |
UTCConversionTimeZoneCode
| Property | Value |
|---|---|
| Description | Time zone code that was in use when the record was created. |
| DisplayName | UTC Conversion Time Zone Code |
| Format | None |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | utcconversiontimezonecode |
| MaxValue | 2147483647 |
| MinValue | -1 |
| RequiredLevel | None |
| Type | Integer |
Read-only columns/attributes
These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
- ComponentIdUnique
- ComponentState
- CreatedBy
- CreatedByName
- CreatedByYomiName
- CreatedOn
- CreatedOnBehalfBy
- CreatedOnBehalfByName
- CreatedOnBehalfByYomiName
- IsManaged
- ModifiedBy
- ModifiedByName
- ModifiedByYomiName
- ModifiedOn
- ModifiedOnBehalfBy
- ModifiedOnBehalfByName
- ModifiedOnBehalfByYomiName
- OrganizationId
- OrganizationIdName
- OverwriteTime
- ParentCatalogIdName
- SolutionId
- SupportingSolutionId
- VersionNumber
ComponentIdUnique
Added by: Basic Solution Solution
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Row id unique |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | componentidunique |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
ComponentState
Added by: Basic Solution Solution
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Component State |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | componentstate |
| RequiredLevel | SystemRequired |
| Type | Picklist |
ComponentState Choices/Options
| Value | Label | Description |
|---|---|---|
| 0 | Published | |
| 1 | Unpublished | |
| 2 | Deleted | |
| 3 | Deleted Unpublished |
CreatedBy
Added by: Active Solution Solution
| 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
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
CreatedByYomiName
Added by: Active Solution Solution
| 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 | Created On |
| Format | DateAndTime |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | createdon |
| RequiredLevel | None |
| Type | DateTime |
CreatedOnBehalfBy
Added by: Active Solution Solution
| 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
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdonbehalfbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
CreatedOnBehalfByYomiName
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | createdonbehalfbyyominame |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
IsManaged
Added by: Basic Solution Solution
| Property | Value |
|---|---|
| Description | Indicates whether the solution component is part of a managed solution. |
| DisplayName | Is Managed |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | ismanaged |
| RequiredLevel | SystemRequired |
| Type | Boolean |
IsManaged Choices/Options
| Value | Label | Description |
|---|---|---|
| 1 | Managed | |
| 0 | Unmanaged |
DefaultValue: False
ModifiedBy
Added by: Active Solution Solution
| 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
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
ModifiedByYomiName
Added by: Active Solution Solution
| 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
Added by: Active Solution Solution
| 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
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedonbehalfbyname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
ModifiedOnBehalfByYomiName
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | modifiedonbehalfbyyominame |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
OrganizationId
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | Unique identifier for the organization |
| DisplayName | Organization Id |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | organizationid |
| RequiredLevel | None |
| Targets | organization |
| Type | Lookup |
OrganizationIdName
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | organizationidname |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
OverwriteTime
Added by: Basic Solution Solution
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | For internal use only. |
| DisplayName | Record Overwrite Time |
| Format | DateAndTime |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | overwritetime |
| RequiredLevel | SystemRequired |
| Type | DateTime |
ParentCatalogIdName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | parentcatalogidname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
SolutionId
Added by: Basic Solution Solution
| Property | Value |
|---|---|
| Description | Unique identifier of the associated solution. |
| DisplayName | Solution |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | solutionid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
SupportingSolutionId
Added by: Basic Solution Solution
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Solution |
| IsValidForForm | False |
| IsValidForRead | False |
| LogicalName | supportingsolutionid |
| RequiredLevel | None |
| Type | Uniqueidentifier |
VersionNumber
Added by: Active Solution Solution
| Property | Value |
|---|---|
| Description | Version Number |
| DisplayName | Version Number |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | versionnumber |
| MaxValue | 9223372036854775807 |
| MinValue | -9223372036854775808 |
| RequiredLevel | None |
| Type | BigInt |
One-To-Many Relationships
Listed by SchemaName.
- catalog_SyncErrors
- catalog_AsyncOperations
- catalog_MailboxTrackingFolders
- catalog_ProcessSession
- catalog_BulkDeleteFailures
- catalog_PrincipalObjectAttributeAccesses
- catalog_catalogassignment
- parentcatalog_catalog
catalog_SyncErrors
Added by: System Solution Solution
Same as syncerror table catalog_SyncErrors Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | syncerror |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | catalog_SyncErrors |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
catalog_AsyncOperations
Added by: System Solution Solution
Same as asyncoperation table catalog_AsyncOperations Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | asyncoperation |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | catalog_AsyncOperations |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
catalog_MailboxTrackingFolders
Added by: System Solution Solution
Same as mailboxtrackingfolder table catalog_MailboxTrackingFolders Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | mailboxtrackingfolder |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | catalog_MailboxTrackingFolders |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
catalog_ProcessSession
Added by: System Solution Solution
Same as processsession table catalog_ProcessSession Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | processsession |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | catalog_ProcessSession |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
catalog_BulkDeleteFailures
Added by: System Solution Solution
Same as bulkdeletefailure table catalog_BulkDeleteFailures Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | bulkdeletefailure |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | catalog_BulkDeleteFailures |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
catalog_PrincipalObjectAttributeAccesses
Added by: System Solution Solution
Same as principalobjectattributeaccess table catalog_PrincipalObjectAttributeAccesses Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | principalobjectattributeaccess |
| ReferencingAttribute | objectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | catalog_PrincipalObjectAttributeAccesses |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
catalog_catalogassignment
Same as catalogassignment table catalog_catalogassignment Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | catalogassignment |
| ReferencingAttribute | catalogid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | Catalog_CatalogAssignment |
| AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
| CascadeConfiguration | Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
parentcatalog_catalog
Same as catalog table parentcatalog_catalog Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | catalog |
| ReferencingAttribute | parentcatalogid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | SubCatalogs |
| AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
| CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: NoCascade 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 table. Listed by SchemaName.
- lk_catalog_createdby
- lk_catalog_createdonbehalfby
- lk_catalog_modifiedby
- lk_catalog_modifiedonbehalfby
- organization_catalog
- parentcatalog_catalog
lk_catalog_createdby
Added by: System Solution Solution
See systemuser Table lk_catalog_createdby One-To-Many relationship.
lk_catalog_createdonbehalfby
Added by: System Solution Solution
See systemuser Table lk_catalog_createdonbehalfby One-To-Many relationship.
lk_catalog_modifiedby
Added by: System Solution Solution
See systemuser Table lk_catalog_modifiedby One-To-Many relationship.
lk_catalog_modifiedonbehalfby
Added by: System Solution Solution
See systemuser Table lk_catalog_modifiedonbehalfby One-To-Many relationship.
organization_catalog
Added by: System Solution Solution
See organization Table organization_catalog One-To-Many relationship.
parentcatalog_catalog
See catalog Table parentcatalog_catalog One-To-Many relationship.
See also
About the table reference
Web API Reference
catalog EntityType