catalog EntityType

Entity for cataloging records to make it easier for your customers to find them on portals and through search.

Entity Set Path
[organization URI]/api/data/v9.0/catalogs
Base Type
crmbaseentity
Display Name
Catalog
Primary Key
catalogid
Primary Key Attribute
name
Operations Supported
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
catalogid Edm.Guid

Unique identifier for catalog instances

Display Name: Catalog

componentidunique Edm.Guid

For internal use only.

Display Name: Row id unique

Read Only
componentstate Edm.Int32

For internal use only.

Display Name: Component State

Read Only
Default Options
Value Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
description Edm.String

Localized description for catalog instances

Display Name: Description

displayname Edm.String

Localized display name for catalog instances

Display Name: Display Name

importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

iscustomizable BooleanManagedProperty

For internal use only.

Display Name: Is Customizable

ismanaged Edm.Boolean

Indicates whether the solution component is part of a managed solution.

Display Name: Is Managed

Read Only
Default Options
Value Label
1 Managed
0 Unmanaged
modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
name Edm.String

The primary name of the catalog

Display Name: Name

overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

overwritetime Edm.DateTimeOffset

For internal use only.

Display Name: Record Overwrite Time

Read Only
solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
statecode Edm.Int32

Status of the Catalog

Display Name: Status

Default Options
Value Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the Catalog

Display Name: Status Reason

Default Options
Value Label
1 Active
2 Inactive
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

uniquename Edm.String

Unique name for the catalog

Display Name: Unique Name

utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version Number

Display Name: Version Number

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 Retrieve data about lookup properties.

Name Single-valued navigation property Description
_createdby_value createdby

Unique identifier of the user who created the record.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the record.

_modifiedby_value modifiedby

Unique identifier of the user who modified the record.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who modified the record.

_organizationid_value organizationid

Unique identifier for the organization

_parentcatalogid_value ParentCatalogId

Unique identifier for the Parent Catalog

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
createdby systemuser lk_catalog_createdby
createdonbehalfby systemuser lk_catalog_createdonbehalfby
modifiedby systemuser lk_catalog_modifiedby
modifiedonbehalfby systemuser lk_catalog_modifiedonbehalfby
organizationid organization organization_catalog
ParentCatalogId catalog SubCatalogs

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
catalog_AsyncOperations asyncoperation regardingobjectid_catalog
catalog_BulkDeleteFailures bulkdeletefailure regardingobjectid_catalog
Catalog_CatalogAssignment catalogassignment CatalogId
catalog_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_catalog
catalog_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_catalog
catalog_ProcessSession processsession regardingobjectid_catalog
catalog_SyncErrors syncerror regardingobjectid_catalog
SubCatalogs catalog ParentCatalogId

Operations

The following operations can be used with the catalog entity type.

Name Binding
IsValidStateTransition Not Bound

Solutions

The following solutions include the catalog entity type.

Name Description
CatalogFramework

See also