attributemaskingrule EntityType

Defines masking rule of attribute

Entity Set Path
[organization URI]/api/data/v9.2/attributemaskingrules
Base Type
crmbaseentity
Display Name
Attribute Masking Rule
Primary Key
attributemaskingruleid
Primary Key Attribute
uniquename
Operations Supported
POST GET PATCH DELETE

Properties

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

Name Type Details
attributelogicalname Edm.String

Logical name of the attribute for which masking rule is used

Display Name: Attribute

attributemaskingruleid Edm.Guid

Unique identifier for entity instances

Display Name: AttributeMaskingRuleId

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
entityname Edm.String

Name of the Entity for attribute

Display Name: Entity

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
modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
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
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

uniquename Edm.String

The unique name of the masking rule for attribute.

Display Name: UniqueName

utcconversiontimezonecode Edm.Int32

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

Display Name: UTC Conversion Time Zone Code

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
_maskingruleid_value MaskingRuleId

Masking Rule of Attribute

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
MaskingRuleId maskingrule maskingrule_attributemaskingrule

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
attributemaskingrule_AsyncOperations asyncoperation regardingobjectid_attributemaskingrule
attributemaskingrule_BulkDeleteFailures bulkdeletefailure regardingobjectid_attributemaskingrule
attributemaskingrule_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_attributemaskingrule
attributemaskingrule_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_attributemaskingrule
attributemaskingrule_ProcessSession processsession regardingobjectid_attributemaskingrule
attributemaskingrule_SyncErrors syncerror regardingobjectid_attributemaskingrule

Operations

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

Name Binding
BulkRetain Not Bound
PurgeRetainedContent Not Bound
Retain Not Bound
RollbackRetain Not Bound
ValidateRetentionConfig Not Bound

See also