Secured Masking Column (AttributeMaskingRule) table/entity reference

Defines secured masking rule for column

Messages

The following table lists the messages for the Secured Masking Column (AttributeMaskingRule) 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
Create
Event: True
POST /attributemaskingrules
See Create
Create records
Delete
Event: True
DELETE /attributemaskingrules(attributemaskingruleid)
See Delete
Delete records
Retrieve
Event: True
GET /attributemaskingrules(attributemaskingruleid)
See Retrieve
Retrieve records
RetrieveMultiple
Event: True
GET /attributemaskingrules
See Query data
Query data
Update
Event: True
PATCH /attributemaskingrules(attributemaskingruleid)
See Update
Update records
Upsert
Event: False
PATCH /attributemaskingrules(attributemaskingruleid)
See Upsert a table row
UpsertRequest

Events

The following table lists the events for the Secured Masking Column (AttributeMaskingRule) table. Events are messages that exist so that you can subscribe to them. Unless you added the event, you shouldn't invoke the message, only subscribe to it.

Name Web API Operation SDK for .NET
BulkRetain BulkRetain Learn to use messages with the SDK for .NET
PurgeRetainedContent PurgeRetainedContent Learn to use messages with the SDK for .NET
Retain Retain Learn to use messages with the SDK for .NET
RollbackRetain RollbackRetain Learn to use messages with the SDK for .NET
ValidateRetentionConfig ValidateRetentionConfig Learn to use messages with the SDK for .NET

Properties

The following table lists selected properties for the Secured Masking Column (AttributeMaskingRule) table.

Property Value
DisplayName Secured Masking Column
DisplayCollectionName Secured Masking Columns
SchemaName AttributeMaskingRule
CollectionSchemaName attributemaskingrules
EntitySetName attributemaskingrules
LogicalName attributemaskingrule
LogicalCollectionName attributemaskingrules
PrimaryIdAttribute attributemaskingruleid
PrimaryNameAttribute uniquename
TableType Standard
OwnershipType None

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

AttributeLogicalName

Property Value
Description Logical name of the column for which the secured masking rule is used
DisplayName Attribute
IsValidForForm False
IsValidForRead True
LogicalName attributelogicalname
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 128

AttributeMaskingRuleId

Property Value
Description Unique identifier for entity instances
DisplayName AttributeMaskingRuleId
IsValidForForm False
IsValidForRead True
LogicalName attributemaskingruleid
RequiredLevel SystemRequired
Type Uniqueidentifier

EntityName

Property Value
Description Name of the Entity for attribute
DisplayName Entity
IsValidForForm False
IsValidForRead True
LogicalName entityname
RequiredLevel SystemRequired
Type EntityName

IsCustomizable

Property Value
Description For internal use only.
DisplayName Is Customizable
IsValidForForm False
IsValidForRead True
LogicalName iscustomizable
RequiredLevel SystemRequired
Type ManagedProperty

MaskingRuleId

Property Value
Description Masking Rule of Attribute
DisplayName Masking Rule
IsValidForForm True
IsValidForRead True
LogicalName maskingruleid
RequiredLevel None
Type Lookup
Targets maskingrule

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -1

UniqueName

Property Value
Description The unique name of the masking rule for attribute.
DisplayName UniqueName
IsValidForForm True
IsValidForRead True
LogicalName uniquename
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -1

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

ComponentIdUnique

Property Value
Description For internal use only.
DisplayName Row id unique
IsValidForForm False
IsValidForRead True
LogicalName componentidunique
RequiredLevel SystemRequired
Type Uniqueidentifier

ComponentState

Property Value
Description For internal use only.
DisplayName Component State
IsValidForForm False
IsValidForRead True
LogicalName componentstate
RequiredLevel SystemRequired
Type Picklist
DefaultFormValue
GlobalChoiceName componentstate

ComponentState Choices/Options

Value Label
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
Type Lookup
Targets systemuser

CreatedOn

Property Value
Description Date and time when the record was created.
DisplayName 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

IsManaged

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
GlobalChoiceName ismanaged
DefaultValue False
True Label Managed
False Label Unmanaged

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

OrganizationId

Property Value
Description Unique identifier for the organization
DisplayName Organization Id
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel None
Type Lookup
Targets

OverwriteTime

Property Value
Description For internal use only.
DisplayName Record Overwrite Time
IsValidForForm False
IsValidForRead True
LogicalName overwritetime
RequiredLevel SystemRequired
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

SolutionId

Property Value
Description Unique identifier of the associated solution.
DisplayName Solution
IsValidForForm False
IsValidForRead True
LogicalName solutionid
RequiredLevel SystemRequired
Type Uniqueidentifier

SupportingSolutionId

Property Value
Description For internal use only.
DisplayName Solution
IsValidForForm False
IsValidForRead False
LogicalName supportingsolutionid
RequiredLevel None
Type Uniqueidentifier

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

maskingrule_attributemaskingrule

One-To-Many Relationship: maskingrule maskingrule_attributemaskingrule

Property Value
ReferencedEntity maskingrule
ReferencedAttribute maskingruleid
ReferencingAttribute maskingruleid
ReferencingEntityNavigationPropertyName MaskingRuleId
IsHierarchical
CascadeConfiguration Archive: Cascade
Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

attributemaskingrule_AsyncOperations

Many-To-One Relationship: asyncoperation attributemaskingrule_AsyncOperations

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName attributemaskingrule_AsyncOperations
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

attributemaskingrule_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure attributemaskingrule_BulkDeleteFailures

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName attributemaskingrule_BulkDeleteFailures
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

attributemaskingrule_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder attributemaskingrule_MailboxTrackingFolders

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName attributemaskingrule_MailboxTrackingFolders
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

attributemaskingrule_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess attributemaskingrule_PrincipalObjectAttributeAccesses

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
ReferencedEntityNavigationPropertyName attributemaskingrule_PrincipalObjectAttributeAccesses
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

attributemaskingrule_ProcessSession

Many-To-One Relationship: processsession attributemaskingrule_ProcessSession

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName attributemaskingrule_ProcessSession
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

attributemaskingrule_SyncErrors

Many-To-One Relationship: syncerror attributemaskingrule_SyncErrors

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName attributemaskingrule_SyncErrors
IsCustomizable True
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
attributemaskingrule