Partager via


maskingrule EntityType

Secured Masking Rules to apply to fields.

Entity set path: 
[organization URI]/api/data/v9.2/maskingrules
Base type: 
crmbaseentity
Table type: 
Standard
Display name: 
Secured Masking Rule
Primary key: 
maskingruleid
Primary name column: 
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
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
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
Values Label
1 Managed
0 Unmanaged
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
DeleteMultiple Not Bound
PurgeRetainedContent Not Bound
Retain Not Bound
RollbackRetain Not Bound
UpdateMultiple Not Bound
ValidateRetentionConfig Not Bound

See also