RecordFilter table/entity reference
Note
Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.
Record Access Filter
Added by: AuthorizationCore Solution
Messages
| Message | Web API Operation | SDK class or method |
|---|---|---|
| Create | POST /recordfilters See Create |
CreateRequest or Create |
| CreateMultiple | CreateMultiple | CreateMultipleRequest |
| Delete | DELETE /recordfilters(recordfilterid) See Delete |
DeleteRequest or Delete |
| IsValidStateTransition | IsValidStateTransition | IsValidStateTransitionRequest |
| Retrieve | GET /recordfilters(recordfilterid) See Retrieve |
RetrieveRequest or Retrieve |
| RetrieveMultiple | GET /recordfilters See Query Data |
RetrieveMultipleRequest or RetrieveMultiple |
| SetState | PATCH /recordfilters(recordfilterid) Update statecode and statuscode properties. |
SetStateRequest |
| Update | PATCH /recordfilters(recordfilterid) See Update |
UpdateRequest or Update |
| UpdateMultiple | UpdateMultiple | UpdateMultipleRequest |
Properties
| Property | Value |
|---|---|
| CollectionSchemaName | RecordFilters |
| DisplayCollectionName | Record Filters |
| DisplayName | Record Filter |
| EntitySetName | recordfilters |
| IsBPFEntity | False |
| LogicalCollectionName | recordfilters |
| LogicalName | recordfilter |
| OwnershipType | OrganizationOwned |
| PrimaryIdAttribute | recordfilterid |
| PrimaryNameAttribute | displayname |
| SchemaName | RecordFilter |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- DisplayName
- FetchXml
- ImportSequenceNumber
- IsCustomizable
- OverriddenCreatedOn
- RecordFilterId
- statecode
- statuscode
- TimeZoneRuleVersionNumber
- UniqueName
- UTCConversionTimeZoneCode
DisplayName
| Property | Value |
|---|---|
| Description | The display name of the record. |
| DisplayName | Display Name |
| FormatName | Text |
| IsLocalizable | True |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | displayname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
FetchXml
| Property | Value |
|---|---|
| Description | FetchXml used by Filter Query |
| DisplayName | Filter Query (Fetch Xml) |
| Format | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | fetchxml |
| MaxLength | 4000 |
| RequiredLevel | None |
| Type | Memo |
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 |
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 |
RecordFilterId
| Property | Value |
|---|---|
| Description | Unique identifier for record |
| DisplayName | Record Filter Id |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | recordfilterid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
statecode
| Property | Value |
|---|---|
| Description | Status of the Record Filter |
| 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 Record Filter |
| 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 record. |
| 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
- IsRoleBusinessUnitQuery
- ModifiedBy
- ModifiedByName
- ModifiedByYomiName
- ModifiedOn
- ModifiedOnBehalfBy
- ModifiedOnBehalfByName
- ModifiedOnBehalfByYomiName
- OrganizationId
- OrganizationIdName
- OverwriteTime
- 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
| 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 | 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 |
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: 0
IsRoleBusinessUnitQuery
| Property | Value |
|---|---|
| Description | Is Record Filter Query using Role's Business Unit |
| DisplayName | Is Role BusinessUnit Query |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | isrolebusinessunitquery |
| RequiredLevel | None |
| Type | Boolean |
IsRoleBusinessUnitQuery Choices/Options
| Value | Label | Description |
|---|---|---|
| 1 | Yes | |
| 0 | No |
DefaultValue: 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 |
| 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 |
OrganizationId
| Property | Value |
|---|---|
| Description | Unique identifier for the organization |
| DisplayName | Organization Id |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | organizationid |
| RequiredLevel | None |
| Targets | organization |
| Type | Lookup |
OrganizationIdName
| 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 |
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
| 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.
- recordfilter_SyncErrors
- recordfilter_DuplicateMatchingRecord
- recordfilter_DuplicateBaseRecord
- recordfilter_AsyncOperations
- recordfilter_MailboxTrackingFolders
- recordfilter_ProcessSession
- recordfilter_BulkDeleteFailures
- recordfilter_PrincipalObjectAttributeAccesses
- recordfilter_entityrecordfilter
recordfilter_SyncErrors
Added by: System Solution Solution
Same as the recordfilter_SyncErrors many-to-one relationship for the syncerror table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | syncerror |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | recordfilter_SyncErrors |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
recordfilter_DuplicateMatchingRecord
Added by: System Solution Solution
Same as the recordfilter_DuplicateMatchingRecord many-to-one relationship for the duplicaterecord table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | duplicaterecord |
| ReferencingAttribute | duplicaterecordid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | recordfilter_DuplicateMatchingRecord |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
recordfilter_DuplicateBaseRecord
Added by: System Solution Solution
Same as the recordfilter_DuplicateBaseRecord many-to-one relationship for the duplicaterecord table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | duplicaterecord |
| ReferencingAttribute | baserecordid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | recordfilter_DuplicateBaseRecord |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
recordfilter_AsyncOperations
Added by: System Solution Solution
Same as the recordfilter_AsyncOperations many-to-one relationship for the asyncoperation table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | asyncoperation |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | recordfilter_AsyncOperations |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
recordfilter_MailboxTrackingFolders
Added by: System Solution Solution
Same as the recordfilter_MailboxTrackingFolders many-to-one relationship for the mailboxtrackingfolder table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | mailboxtrackingfolder |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | recordfilter_MailboxTrackingFolders |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
recordfilter_ProcessSession
Added by: System Solution Solution
Same as the recordfilter_ProcessSession many-to-one relationship for the processsession table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | processsession |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | recordfilter_ProcessSession |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: NoCascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
recordfilter_BulkDeleteFailures
Added by: System Solution Solution
Same as the recordfilter_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | bulkdeletefailure |
| ReferencingAttribute | regardingobjectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | recordfilter_BulkDeleteFailures |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
recordfilter_PrincipalObjectAttributeAccesses
Added by: System Solution Solution
Same as the recordfilter_PrincipalObjectAttributeAccesses many-to-one relationship for the principalobjectattributeaccess table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | principalobjectattributeaccess |
| ReferencingAttribute | objectid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | recordfilter_PrincipalObjectAttributeAccesses |
| AssociatedMenuConfiguration | Behavior: DoNotDisplay Group: Details Label: Order: |
| CascadeConfiguration | Assign: NoCascade Delete: Cascade Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
recordfilter_entityrecordfilter
Same as the recordfilter_entityrecordfilter many-to-one relationship for the entityrecordfilter table/entity.
| Property | Value |
|---|---|
| ReferencingEntity | entityrecordfilter |
| ReferencingAttribute | recordfilterid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | recordfilter_entityrecordfilter |
| 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_recordfilter_createdby
- lk_recordfilter_createdonbehalfby
- lk_recordfilter_modifiedby
- lk_recordfilter_modifiedonbehalfby
- organization_recordfilter
lk_recordfilter_createdby
Added by: System Solution Solution
See the lk_recordfilter_createdby one-to-many relationship for the systemuser table/entity.
lk_recordfilter_createdonbehalfby
Added by: System Solution Solution
See the lk_recordfilter_createdonbehalfby one-to-many relationship for the systemuser table/entity.
lk_recordfilter_modifiedby
Added by: System Solution Solution
See the lk_recordfilter_modifiedby one-to-many relationship for the systemuser table/entity.
lk_recordfilter_modifiedonbehalfby
Added by: System Solution Solution
See the lk_recordfilter_modifiedonbehalfby one-to-many relationship for the systemuser table/entity.
organization_recordfilter
Added by: System Solution Solution
See the organization_recordfilter one-to-many relationship for the organization table/entity.
See also
Dataverse table/entity reference
Web API Reference
recordfilter EntityType
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for