Skip Navigation

Newer Version Available

This content describes an older version of this product. View Latest

CleanRule

Represents a clean rule that controls how a data service adds and updates data for existing records in an org.

Supported SOAP Calls

This object is available in API version 38.0 and later.

query(),search()

Supported REST HTTP Methods

GET

Fields

Field	Details
CleanDataServiceId	Type reference Properties Filter, Group, Sort Description A foreign key reference to the CleanDataService that processes this CleanRule.
Description	Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description User-friendly text that describes the clean rule.
DeveloperName	Type string Properties Create, Filter, Group, Sort, Update Description This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This unique name prevents conflicts with rules from other packages that have the same MasterLabel.
IsBulkEnabled	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If this flag is set to `true`, the system automatically applies the rule to existing records whenever the rule is updated or saved. If the flag is set to `false`, the system doesn’t automatically apply the rule to existing records. You can always apply the rule manually.
IsSilentSaveEnabled	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If `false`, cleaning doesn’t modify LastModifiedDate and LastModifiedById when it applies this rule; otherwise, cleaning inserts the current date and the current user.
Language	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the clean rule. The following values are permitted: Chinese (Simplified): `zh_CN` Chinese (Traditional): `zh_TW` Danish: `da` Dutch: `nl_NL` English: `en_US` Finnish: `fi` French: `fr` German: `de` Italian: `it` Japanese: `ja` Korean: `ko` Norwegian: `no` Portuguese (Brazil): `pt_BR` Russian: `ru` Spanish: `es` Spanish (Mexico): `es_MX` Swedish: `sv` Thai: `th`
MasterLabel	Type string Properties Create, Filter, Group, Sort, Update Description Master label for this object. This display value is the internal label that is not translated.
MatchRule	Type string Properties Filter, Group, Nillable, Sort Description An internal label for the matching rule in the data service that’s associated with this CleanRule.
ShouldBypassTriggers	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If `true`, indicates that the system does not apply triggers when it applies this rule; otherwise, the system applies the triggers.
ShouldBypassWorkflow	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description If `true`, the system bypasses workflow rules when it applies the clean rule; otherwise, the system applies workflow rules.
SobjectType	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The standard or custom object in your org that’s acted on by this CleanRule. The possible values are: Account Contact Lead ResourceAbsence ServiceAppointment ServiceTerritory ServiceTerritoryMember WorkOrder WorkOrderLineItem In addition, custom objects with clean rules are possible. The standard objects are installed with default clean rules, but only the default rules for account, contact, and lead can be modified. Note
SourceSobjectType	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description A data service object associated with this CleanRule. The set of picklist values includes all the object types defined in the data service. However, if you specify a non-existent object, the API call returns an error. If you enable the Salesforce data services, the following values appear: `DataCloudAddress` Geolocation data service. To learn more about this service, see Compound Field Considerations and Limitations. `DatacloudDandBCompany` Data.com clean data service. This service is only available in the Professional, Enterprise, Unlimited, and Performance Editions, and only with a Premium Clean license. Your administrator must enable this data service by enabling the clean rules for account and lead. If you install Marketplace packages that contain data services, their object names also appear in the set of picklist values.
Status	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Status of the clean rule. Valid values are `Active` and `Inactive`.