title | description | ms.date | ms.topic | author | ms.author | applies_to | ms.assetid | |
---|---|---|---|---|---|---|---|---|
msdyn_maskingrule Entity Reference | MicrosoftDocs |
Includes schema information and supported messages for the msdyn_maskingrule entity. |
03/23/2020 |
reference |
gandhamm |
mgandham |
|
3948cc48-07c8-7f60-0608-71c37158ad7c |
[!INCLUDEcc-use-with-omnichannel]
Masking Rules to apply to chat messages.
Added by: Omnichannel – Base Solution
Message | Web API Operation | SDK Assembly |
---|---|---|
Create | POST [org URI]/api/data/v9.1/msdyn_maskingrules See Create |
xref:Microsoft.Xrm.Sdk.Messages.CreateRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Create* |
Delete | DELETE [org URI]/api/data/v9.1/msdyn_maskingrules(msdyn_maskingruleid) See Delete |
xref:Microsoft.Xrm.Sdk.Messages.DeleteRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Delete* |
IsValidStateTransition | xref:Microsoft.Crm.Sdk.Messages.IsValidStateTransitionRequest | |
Retrieve | GET [org URI]/api/data/v9.1/msdyn_maskingrules(msdyn_maskingruleid) See Retrieve |
xref:Microsoft.Xrm.Sdk.Messages.RetrieveRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Retrieve* |
RetrieveMultiple | GET [org URI]/api/data/v9.1/msdyn_maskingrules See Query Data |
xref:Microsoft.Xrm.Sdk.Messages.RetrieveMultipleRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.RetrieveMultiple* |
SetState | PATCH [org URI]/api/data/v9.1/msdyn_maskingrules(msdyn_maskingruleid) Update statecode and statuscode properties. |
xref:Microsoft.Crm.Sdk.Messages.SetStateRequest |
Update | PATCH [org URI]/api/data/v9.1/msdyn_maskingrules(msdyn_maskingruleid) See Update |
xref:Microsoft.Xrm.Sdk.Messages.UpdateRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Update* |
Property | Value |
---|---|
CollectionSchemaName | msdyn_maskingrules |
DisplayCollectionName | Masking Rules |
DisplayName | Masking Rule |
EntitySetName | msdyn_maskingrules |
IsBPFEntity | False |
LogicalCollectionName | msdyn_maskingrules |
LogicalName | msdyn_maskingrule |
OwnershipType | OrganizationOwned |
PrimaryIdAttribute | msdyn_maskingruleid |
PrimaryNameAttribute | msdyn_name |
SchemaName | msdyn_maskingrule |
These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- ImportSequenceNumber
- msdyn_description
- msdyn_enter_test_data
- msdyn_masked_character
- msdyn_masked_test_data
- msdyn_maskingruleId
- msdyn_name
- msdyn_regular_expression
- OverriddenCreatedOn
- statecode
- statuscode
- TimeZoneRuleVersionNumber
- UTCConversionTimeZoneCode
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 |
Property | Value |
---|---|
Description | Description of the masking rule |
DisplayName | Description |
FormatName | TextArea |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | msdyn_description |
MaxLength | 500 |
RequiredLevel | None |
Type | String |
Property | Value |
---|---|
Description | Test data to evaluate a masking rule |
DisplayName | Enter Test Data |
FormatName | TextArea |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | msdyn_enter_test_data |
MaxLength | 4000 |
RequiredLevel | None |
Type | String |
Property | Value |
---|---|
Description | Character to be masked |
DisplayName | Masked Character |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | msdyn_masked_character |
MaxLength | 1 |
RequiredLevel | None |
Type | String |
Property | Value |
---|---|
Description | Test data evaluated by a masking rule |
DisplayName | Masked Test Data |
FormatName | TextArea |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | msdyn_masked_test_data |
MaxLength | 4000 |
RequiredLevel | None |
Type | String |
Property | Value |
---|---|
Description | Unique identifier for entity instances |
DisplayName | Masking Rule |
IsValidForForm | False |
IsValidForRead | True |
IsValidForUpdate | False |
LogicalName | msdyn_maskingruleid |
RequiredLevel | SystemRequired |
Type | Uniqueidentifier |
Property | Value |
---|---|
Description | The name of the custom entity. |
DisplayName | Name |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | msdyn_name |
MaxLength | 100 |
RequiredLevel | ApplicationRequired |
Type | String |
Property | Value |
---|---|
Description | Regular Expression in Javascript |
DisplayName | Regular Expression |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | msdyn_regular_expression |
MaxLength | 500 |
RequiredLevel | ApplicationRequired |
Type | String |
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 |
Property | Value |
---|---|
Description | Status of the Masking Rule |
DisplayName | Status |
IsValidForCreate | False |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | statecode |
RequiredLevel | SystemRequired |
Type | State |
Value | Label | DefaultStatus | InvariantName |
---|---|---|---|
0 | Active | 1 | Active |
1 | Inactive | 2 | Inactive |
Property | Value |
---|---|
Description | Reason for the status of the Masking Rule |
DisplayName | Status Reason |
IsValidForForm | True |
IsValidForRead | True |
LogicalName | statuscode |
RequiredLevel | None |
Type | Status |
Value | Label | State |
---|---|---|
1 | Active | 0 |
2 | Inactive | 1 |
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 |
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 |
These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
- CreatedBy
- CreatedByName
- CreatedByYomiName
- CreatedOn
- CreatedOnBehalfBy
- CreatedOnBehalfByName
- CreatedOnBehalfByYomiName
- ModifiedBy
- ModifiedByName
- ModifiedByYomiName
- ModifiedOn
- ModifiedOnBehalfBy
- ModifiedOnBehalfByName
- ModifiedOnBehalfByYomiName
- OrganizationId
- OrganizationIdName
- VersionNumber
Added by: Active Solution Solution
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 |
Added by: Active Solution Solution
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdbyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
Added by: Active Solution Solution
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdbyyominame |
MaxLength | 100 |
RequiredLevel | SystemRequired |
Type | String |
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 |
Added by: Active Solution Solution
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 |
Added by: Active Solution Solution
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdonbehalfbyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
Added by: Active Solution Solution
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | createdonbehalfbyyominame |
MaxLength | 100 |
RequiredLevel | SystemRequired |
Type | String |
Added by: Active Solution Solution
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 |
Added by: Active Solution Solution
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedbyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
Added by: Active Solution Solution
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedbyyominame |
MaxLength | 100 |
RequiredLevel | SystemRequired |
Type | String |
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 |
Added by: Active Solution Solution
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 |
Added by: Active Solution Solution
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedonbehalfbyname |
MaxLength | 100 |
RequiredLevel | None |
Type | String |
Added by: Active Solution Solution
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | modifiedonbehalfbyyominame |
MaxLength | 100 |
RequiredLevel | SystemRequired |
Type | String |
Added by: Active Solution Solution
Property | Value |
---|---|
Description | Unique identifier for the organization |
DisplayName | Organization Id |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | organizationid |
RequiredLevel | None |
Targets | organization |
Type | Lookup |
Added by: Active Solution Solution
Property | Value |
---|---|
Description | |
DisplayName | |
FormatName | Text |
IsLocalizable | False |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | organizationidname |
MaxLength | 100 |
RequiredLevel | SystemRequired |
Type | String |
Added by: Active Solution Solution
Property | Value |
---|---|
Description | Version Number |
DisplayName | Version Number |
IsValidForForm | False |
IsValidForRead | True |
LogicalName | versionnumber |
MaxValue | 9223372036854775807 |
MinValue | -9223372036854775808 |
RequiredLevel | None |
Type | BigInt |
Introduction to Omnichannel for Customer Service
Developer guide for Omnichannel for Customer Service
[!INCLUDEfooter-include]