ExternalStringLocalization

Represents the translation of custom labels for a UI component represented by the ExternalString object.

Version 

Introduced in API version 49.0.

Supported SOAP API Calls 

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

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules 

• • Your organization must be using Professional, Enterprise, Performance, Unlimited, or Developer edition.
  • Translation Workbench and data translation must be enabled in your org.
  • To view this object, you must have the “View Setup and Configuration” permission.

Limitations 

SOSL Limitations

Fields 

ExternalStringId 

• Type: reference

• Required: No

• Properties: Create, Filter, Group, Sort

• Description: The ID of the ExternalString associated with the custom label that is being translated.

• Relationship name: ExternalString

• Relationship type: relationship

• Refers to: ExternalString

Language 

• Type: picklist

• Required: No

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

• Introduced: API version 17.0

• Description: The language for this translated text.

• 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

  You can’t change the language of an existing ExternalString.

  Note

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

• Type: ManageableState enumerated list

• 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

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 13.0

• Description: The namespace of the package of which the custom label is a part.

Value 

• Type: string

• Required: No

• Properties: Create, Filter, Sort, Update

• Description: The translated string value, limited to 32,000 characters or 96,000 bytes of data, up to the length of the translated string.