recordfilter EntityType

Record Access Filter

Entity Set Path
[organization URI]/api/data/v9.2/recordfilters
Base Type
crmbaseentity
Display Name
Record Filter
Primary Key
recordfilterid
Primary Key Attribute
displayname
Operations Supported
POST GET PATCH DELETE

Properties

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

Name Type Details
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
Values 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
displayname Edm.String

The display name of the record.

Display Name: Display Name

fetchxml Edm.String

FetchXml used by Filter Query

Display Name: Filter Query (Fetch Xml)

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
Values Label
1 Managed
0 Unmanaged
isrolebusinessunitquery Edm.Boolean

Is Record Filter Query using Role's Business Unit

Display Name: Is Role BusinessUnit Query

Read Only
Default Options
Values Label
1 Yes
0 No
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

overwritetime Edm.DateTimeOffset

For internal use only.

Display Name: Record Overwrite Time

Read Only
recordfilterid Edm.Guid

Unique identifier for record

Display Name: Record Filter Id

solutionid Edm.Guid

Unique identifier of the associated solution.

Display Name: Solution

Read Only
statecode Edm.Int32

Status of the Record Filter

Display Name: Status

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

Reason for the status of the Record Filter

Display Name: Status Reason

Default Options
Values 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 record.

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 Lookup property data.

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

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_recordfilter_createdby
createdonbehalfby systemuser lk_recordfilter_createdonbehalfby
modifiedby systemuser lk_recordfilter_modifiedby
modifiedonbehalfby systemuser lk_recordfilter_modifiedonbehalfby
organizationid organization organization_recordfilter

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
recordfilter_AsyncOperations asyncoperation regardingobjectid_recordfilter
recordfilter_BulkDeleteFailures bulkdeletefailure regardingobjectid_recordfilter
recordfilter_DuplicateBaseRecord duplicaterecord baserecordid_recordfilter
recordfilter_DuplicateMatchingRecord duplicaterecord duplicaterecordid_recordfilter
recordfilter_entityrecordfilter entityrecordfilter RecordFilterId
recordfilter_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_recordfilter
recordfilter_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_recordfilter
recordfilter_ProcessSession processsession regardingobjectid_recordfilter
recordfilter_roleprivileges roleprivileges RecordFilterId
recordfilter_SyncErrors syncerror regardingobjectid_recordfilter

Operations

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

Name Binding
CreateMultiple Not Bound
IsValidStateTransition Not Bound
UpdateMultiple Not Bound

See also