CleanDataService

Represents a data service that adds and updates data in existing records in an org.

Version 

Introduced in API version 38.0.

Supported SOAP API Calls 

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Fields 

Description 

• Type: textarea

• Required: No

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Description: User-friendly text that describes the data service.

DeveloperName 

• Type: string

• Required: No

• Properties: Create, Filter, Group, Sort, Update

• Description: A unique name for this data service. 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. Provides a globally unique identifier for the data service, which prevents conflicts with other data services that have the same MasterLabel.

  Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.

  Note

Language 

• Type: picklist

• Required: No

• Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

• Description: The language of the data service. The following values are supported:

• 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 Spanish (Mexico) defaults to Spanish for customer-defined translations.

• Swedish: sv

• Thai: th The Salesforce user interface is fully translated to Thai, but Help is in English.

• Possible values:

  • en_US — English

  • de — German

  • es — Spanish

  • fr — French

  • it — Italian

  • ja — Japanese

  • sv — Swedish

  • ko — Korean

  • zh_TW — Chinese (Traditional)

  • zh_CN — Chinese (Simplified)

  • pt_BR — Portuguese (Brazil)

  • nl_NL — Dutch

  • da — Danish

  • th — Thai

  • fi — Finnish

  • ru — Russian

  • es_MX — Spanish (Mexico)

  • no — Norwegian

ManageableState 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: Indicates the manageable state of the specified component that is contained in a package:

• beta

• deleted

• deprecated

• deprecatedEditable

• installed

• installedEditable

• released

• unmanaged

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

MasterLabel 

• Type: string

• Required: No

• Properties: Create, Filter, Group, Sort, Update

• Description: Master label for this object. This display value is the internal label that is not translated.

MatchEngine 

• Type: string

• Required: No

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Description: A key that maps to the internal data service identifier.

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The namespace prefix associated with the data service, which is assigned to the Lightning Platform AppExchange package. 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. The namespace helps differentiate custom objects and fields from those in use by other data services.