sforce logo

DescribeSObjectResult


The describeSObject call returns a DescribeSObjectResult object, which has the following properties. Note that, while the boolean properties indicate whether certain API calls can be used for an object, other factors (such as security settings in the user's personal profile) also affect whether such operations can be performed on the object.

Name
Type
Description
activateable
boolean
Reserved for future use.
createable
boolean
Indicates whether the object can be created via the create call (True) or not (False).
custom
boolean
Indicates whether the object is a custom object (True) or not (False).
deletable
boolean
Indicates whether the object can be deleted via the delete call (True) or not (False).
fields
Field[]
Array of fields associated with the object. The mechanism for retrieving information from this list varies among development tools.
keyPrefix
string
Three character code prefix in the object ID. Object IDs are prefixed with three character codes that specify the type of the object (for example, Account objects have a prefix of "001" and Opportunity objects have a prefix of "006". The describeSObject call returns a value for objects that have a stable prefix. For objects types that do not have a stable or predictable prefix, this field is blank. Therefore, client applications that rely on these codes should use this way of determining object types to ensure forward compatibility.
label
string
Label text for a renamed tab (for example, "Patient" in a medical vertical) in the user interface, if applicable, or the object name, if not.
layoutable
boolean
Indicates whether the object supports the describeLayout call (True) or not (False).
name
string
Name of the object. This is the same string that was passed in as the sObjectType parameter.
queryable
boolean
Indicates whether the object can be queried via the query call (True) or not (False).
replicateable
boolean
Indicates whether the object can be replicated via the getUpdated and getDeleted calls (True) or not (False).
retrieveable
boolean
Indicates whether the object can be retrieved via the retrieve call (True) or not (False).
searchable
boolean
Indicates whether the object can be searched via the search call (True) or not (False).
undeletable
boolean
Reserved for future use.
updateable
boolean
Indicates whether the object can be updated via the update call (True) or not (False).
urlDetail
string
URL to the view details screen (read-only) for this object. Compare with urlEdit, which is read-write.
 
Client applications can use this URL to redirect to, or access, the standard salesforce.com user interface for standard and custom objects. To provide flexibility and allow for future enhancements, returned urlDetail values are dynamic. To ensure that client applications are forward compatible, it is recommended that they use this capability where possible. Note that, for objects for which a stable URL API is not available, this field is returned empty.
urlEdit
string
URL to the edit screen for this object. For example, the urlEdit field for the Account object returns https://na1.salesforce.com/{ID}/e. Substituting the {ID} field for the current object ID will return the salesforce.com Web interface's edit page for that object specific account. Compare with urlDetail, which is read-only.
 
Client applications can use this URL to redirect to, or access, the standard salesforce.com user interface for standard and custom objects. To provide flexibility and allow for future enhancements, returned urlDetail values are dynamic. To ensure that client applications are forward compatible, it is recommended that they use this capability where possible. Note that, for objects for which a stable URL API is not available, this field is returned empty.
urlNew
string
URL to the new/create screen for this object type. Client applications can use this URL to redirect to, or access, the standard salesforce.com user interface for standard and custom objects. To provide flexibility and allow for future enhancements, returned urlNew values are dynamic. To ensure that client applications are forward compatible, it is recommended that they use this capability where possible. Note that, for objects for which a stable URL API is not available, this field is returned empty.


© Copyright 2000-2003 SalesForce.com, Inc.
All rights reserved • Various trademarks held by their respective owners.