CustomObject

Represents a custom object that stores data unique to your organization. Includes access to the associated CustomObject object and related fields in Salesforce Metadata API.

Version 

Introduced in API version 31.0.

Supported SOAP API Calls 

describeSObjects(), query(), retrieve(), search()

Supported REST API Methods 

GET, HEAD, Query

Fields 

CustomHelpId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The control that contains the help content if this custom object has customized help content.

• Relationship name: CustomHelpId

• Relationship type: polymorphic

Description 

• Type: textarea

• Required: No

• Properties: Filter, Nillable, Sort

• Description: The object’s description. This can be useful to describe the reason for creating the object or its intended use.

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The developer’s internal name for the custom object. For example, the internal name for the custom object CO__c is CO.

ExternalDataSourceId 

• Type: reference

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Relationship name: ExternalDataSource

• Relationship type: relationship

• Refers to: ExternalDataSource

ExternalName 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Maps to a table in the external data source. If you created the external object using Validate and Sync for the data source, this name is automatically created.

ExternalRepository 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Maps to a table in the external data source. If you created the external object using Validate and Sync for the data source, this name is automatically created; do not modify it.

Language 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Description: The language of the action. Valid values are:

• 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

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

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

SharingModel 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Description: The sharing model. Values are:

• Edit

• ControlledByparent

• None

• Read

• Possible values:

  • None — Private

  • Read — Read Only

  • Edit — Read/Write

  • ControlledByParent — Controlled By Parent