maskingrule EntityType
Masking Rules to apply to fields.
- Entity Set Path
- [organization URI]/api/data/v9.2/maskingrules
- Base Type
- crmbaseentity
- Display Name
- Masking Rule
- Primary Key
- maskingruleid
- 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 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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
|
||||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display Name: Created On Read Only
|
||||||||||
| description | Edm.String |
Description of the secured masking rule Display Name: Description |
||||||||||
| displayname | Edm.String |
The display name of the secured masking rule. Display Name: Display Name |
||||||||||
| 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
|
||||||||||
| maskedcharacter | Edm.String |
Character used to mask Display Name: Masked Character |
||||||||||
| maskedtestdata | Edm.String |
Test data evaluated by a secured masking rule Display Name: Masked Test Data |
||||||||||
| maskingruleid | Edm.Guid |
Unique identifier for entity instances Display Name: Masking Rule |
||||||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the record was modified. Display Name: Modified On Read Only
|
||||||||||
| name | Edm.String |
The unique name of the secured masking rule. Display Name: Name |
||||||||||
| overwritetime | Edm.DateTimeOffset |
For internal use only. Display Name: Record Overwrite Time Read Only
|
||||||||||
| regularexpression | Edm.String |
Regular Expression in C# Display Name: Regular Expression |
||||||||||
| solutionid | Edm.Guid |
Unique identifier of the associated solution. Display Name: Solution Read Only
|
||||||||||
| testdata | Edm.String |
Test data to evaluate a secured masking rule Display Name: Enter Test Data |
||||||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display Name: Time Zone Rule Version Number |
||||||||||
| 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 |
|---|---|---|
| _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 |
|---|---|---|
| organizationid | organization | organization_maskingrule |
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 |
|---|---|---|
| maskingrule_AsyncOperations | asyncoperation | regardingobjectid_maskingrule |
| maskingrule_attributemaskingrule | attributemaskingrule | MaskingRuleId |
| maskingrule_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_maskingrule |
| maskingrule_DuplicateBaseRecord | duplicaterecord | baserecordid_maskingrule |
| maskingrule_DuplicateMatchingRecord | duplicaterecord | duplicaterecordid_maskingrule |
| maskingrule_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_maskingrule |
| maskingrule_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_maskingrule |
| maskingrule_ProcessSession | processsession | regardingobjectid_maskingrule |
| maskingrule_SyncErrors | syncerror | regardingobjectid_maskingrule |
Operations
The following operations can be used with the maskingrule entity type.
| Name | Binding |
|---|---|
| BulkRetain | Not Bound |
| CreateMultiple | Not Bound |
| PurgeRetainedContent | Not Bound |
| Retain | Not Bound |
| RollbackRetain | Not Bound |
| UpdateMultiple | Not Bound |
| ValidateRetentionConfig | Not Bound |