135
Description
Type
Name
Indicates whether the object can be merged with other objects of its type
(
true
) or not (
false
).
true
for leads, contacts, and accounts.
boolean
mergeable
Name of the object.This is the same string that was passed in as the
sObjectType
parameter.
string
name
Indicates whether the object can be queried via the
query()
call (
true
)
or not (
false
).
boolean
queryable
An array of the record types supported by this object.The user need not
have access to all the returned record types to see them here.
RecordTypeInfo[]
recordTypeInfos
Available in API version 11 and later.This field is valid for all master-detail
relationships, but the value is only non-zero for junction objects. A junction
int
relationshipOrder
object has two master-detail relationships, and is analogous to an association
table in a many-to-many relationship. Junction objects must define one
parent object as primary (0), the other as secondary (1).The definition of
primary or secondary affects delete behavior and inheritance of look and
feel, and record ownership for junction objects. For more information, see
the Salesforce online help.
0 or 1 are the only valid values, and 0 is always the value for objects that
are not junction objects.
Indicates whether the object can be replicated via the
getUpdated()
and
getDeleted()
calls (
true
) or not (
false
).
boolean
replicateable
Indicates whether the object can be retrieved via the
retrieve()
call
(
true
) or not (
false
).
boolean
retrieveable
Indicates whether the object can be searched via the
search()
call (
true
)
or not (
false
).
boolean
searchable
Indicates whether an object can be undeleted using the
undelete()
call
(
true
) or not (
false
).
boolean
undeletable
Indicates whether the object can be updated via the
update()
call (
true
)
or not (
false
).
boolean
updateable
URL to the read-only detail page for this object. Compare with
urlEdit
,
which is read-write. Client applications can use this URL to redirect to,
string
urlDetail
or access, the Salesforce 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 is not available, this field is
returned empty.
URL to the edit page for this object. For example, the
urlEdit
field for
the Account object returns
https://na1.salesforce.com/{
ID
}/e
.
string
urlEdit
Substituting the
{
ID
}
field for the current object ID will return the edit
page for that specific account in the Salesforce user interface. Compare
with
urlDetail
, which is read-only. Client applications can use this URL
to redirect to, or access, the Salesforce 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
433
describeSObjects()
C# HTML5 Viewer: Deployment on ASP.NET MVC under Views according to config in picture above. RasterEdge.XDoc.PDF.HTML5Editor. dll. Open RasterEdge_MVC3 DemoProject, copy following content to your project:
paste picture pdf; how to copy images from pdf to word
76
Description
Type
Name
where possible. Note that, for objects for which a stable URL is not
available, this field is returned empty.
URL to the new/create page for this object. Client applications can use
this URL to redirect to, or access, the Salesforce user interface for standard
string
urlNew
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 is
not available, this field is returned empty.
Sets the minimum sharing access level required on the master record to
create, edit, or delete child records.This field applies only to master-detail
or junction object custom field types.
boolean
writeRequiresMasterRead
•
true
- Allows users with "Read" access to the master record permission
to create, edit, or delete child records.This setting makes sharing less
restrictive.
•
false
- Allows users with "Read/Write" access to the master record
permission to create, edit, or delete child records.This setting is more
restrictive than
true
, and is the default value.
For junction objects, the most restrictive access from the two parents is
enforced. For example, if you set to
true
on both master-detail fields, but
users have "Read" access to one master record and "Read/Write" access to
the other master record, users won't be able to create, edit, or delete child
records. Junction objects are available in API version 11 and later.
Note:The properties with a Boolean value indicate whether certain API calls can be used for an object. However,
other factors such as permissions, or lack thereof, on the user profile also affect whether such operations can be
performed on the object.
ChildRelationship
The name of the sObject that has a foreign key to the sObject being described.
Description
Type
Name
Indicates whether the child object is deleted when the parent object is deleted (
true
)
or not (
false
).
boolean
cascadeDelete
The name of the object on which there is a foreign key back to the parent sObject.
string
childSObject
The name of the field that has a foreign key back to the parent sObject.
string
field
The name of the relationship, usually the plural of the value in
childSObject
.
string
relationshipName
Field
In the DescribeSObjectResult, the
fields
property contains an array of
Field
objects. Each field represents a field in an
API object.The array contains only the fields that the user can view, as defined by the user's field-level security settings.
434
describeSObjects()
149
Description
Type
Name
Indicates whether this field is an autonumber field (
true
) or not (
false
).
Analogous to a SQL
IDENTITY
type, autonumber fields are read only,
boolean
autonumber
non-createable text fields with a maximum length of 30 characters. Autonumber
fields are read-only fields used to provide a unique ID that is independent of
the internal object ID (such as a purchase order number or invoice number).
Autonumber fields are configured entirely in the Salesforce user interface.The
API provides access to this attribute so that client applications can determine
whether a given field is an autonumber field.
For variable-length fields (including binary fields), the maximum size of the
field, in bytes.
int
byteLength
Indicates whether the field is a custom formula field (
true
) or not (
false
).
Note that custom formula fields are always read-only.
boolean
calculated
Indicates whether the field is case sensitive (
true
) or not (
false
).
boolean
caseSensitive
The name of the field that controls the values of this picklist. It only applies if
type
is
picklist
or
multipicklist
and
dependentPicklist
is true. See
string
controllerName
About Dependent Picklists.The mapping of controlling field to dependent
field is stored in the
validFor
attribute of each
PicklistEntry
for this
picklist. See
validFor
.
Indicates whether the field can be created (
true
) or not (
false
). If
true
, then
this field value can be set in a
create()
call.
boolean
createable
Indicates whether the field is a custom field (
true
) or not (
false
).
boolean
custom
Indicates whether this field is defaulted when created (
true
) or not (
false
).
If
true
, then Salesforce implicitly assigns a value for this field when the object
boolean
defaultedOnCreate
is created, even if a value for this field is not passed in on the
create()
call.
For example, in the Opportunity object, the
Probability
field has this attribute
because its value is derived from the
Stage
field. Similarly, the
Owner
has this
attribute on most objects because its value is derived from the current user (if
the
Owner
field is not specified).
The default value specified for this field if the formula is not used. If no value
has been specified, this field is not returned.
string
defaultValueFormula
Indicates whether a picklist is a dependent picklist (
true
) where available values
depend on the chosen values from a controlling field, or not (
false
). See About
Dependent Picklists.
boolean
dependentPicklist
For fields of type integer. Maximum number of digits.The API returns an error
if an integer value exceeds the number of digits.
int
digits
Indicates whether the field is filterable (
true
) or not (
false
). If
true
, then
this field can be specified in the WHERE clause of a query string in a
query()
call.
boolean
filterable
The formula specified for this field. If no formula is specified for this field, it
is not returned.
string
formula
Indicates whether a field such as a hyperlink custom formula field has been
formatted for HTML and should be encoded for display in HTML (
true
) or
boolean
htmlFormatted
not (
false
). Also indicates whether a field is a custom formula field that has
an
IMAGE
text function.
435
describeSObjects()
126
Description
Type
Name
Indicates whether the field can be used to specify a record in an
upsert()
call
(
true
) or not (
false
).
boolean
idLookup
The text that displays in the field-level help hover text for this field.
string
inlineHelpText
Note:This property is not returned unless at least one field on the
object contains a value.When at least one field has field-level help, all
fields on the object list the property with either the field-level help value
or null for fields that have blank field-level help.
Text label that is displayed next to the field in the Salesforce user interface.This
label can be localized.
string
label
For string fields, the maximum size of the field in Unicode characters (not
bytes).
int
length
Field name used in API calls, such as
create()
,
delete()
, and
query()
.
string
name
Indicates whether this field is a name field (
true
) or not (
false
). Used to
identify the name field for standard objects (such as
AccountName
for an
boolean
nameField
Account object) and custom objects. Limited to one per object, except where
FirstName
and
LastName
fields are used (such as in the Contact object).
If a compound name is present, for example the
Name
field on a person account,
nameField
is set to
true
for that record. If no compound name is present,
FirstName
and
LastName
have this field set to
true
.
Indicates whether the field's value is the Name of the parent of this object (
true
)
or not (
false
). Used for objects whose parents may be more than one type of
object, for example a task may have an account or a contact as a parent.
boolean
namePointing
Indicates whether the field is nillable (
true
) or not (
false
). A nillable field
can have empty content. A non-nillable field must have a value in order for the
object to be created or saved.
boolean
nillable
Provides the list of valid values for the picklist. Specified only if
restrictedPicklist
is
true
.
PicklistEntry[]
picklistValues
For fields of type double. Maximum number of digits that can be stored,
including all numbers to the left and to the right of the decimal point (but
excluding the decimal point character).
int
precision
The name of the relationship.
string
relationshipName
For fields that refer to other objects, this array indicates the object types of the
referenced objects.
string[]
referenceTo
Indicates whether the field is a restricted picklist (
true
) or not (
false
).
boolean
restrictedPicklist
For fields of type double. Number of digits to the right of the decimal point.
The API silently truncates any extra digits to the right of the decimal point,
int
scale
but it returns a fault response if the number has too many digits to the left of
the decimal point.
See SOAPType for a list of allowable values.
SOAPType
soapType
Indicates whether a query can sort on this field (
true
) or not (
false).
boolean
sortable
436
describeSObjects()
106
Description
Type
Name
See FieldType for a list of allowable values.
FieldType
type
Indicates whether the value must be unique
true
) or not
false
).
boolean
unique
Indicates whether the field is updateable (
true
) or not (
false
). If
true
, then
this field value can be set in an
update()
call.
boolean
updateable
FieldType
In the
Field
object associated with the DescribeSObjectResult, the
type
field can contain one of the following strings. For
more information about field types, see Field Types.
What the Field Object Contains
type Field Value
String values.
string
Boolean (
true
/
false
) values.
boolean
Integer values.
int
Double values.
double
Date values.
c
date
Date and time values.
dateTime
Base64-encoded arbitrary binary data (of type base64Binary). Used for Attachment,
Document, and Scontrol objects.
base64
Primary key field for the object. For information on IDs, see ID Field Type
ID
Cross-references to a different object. Analogous to a foreign key field in SQL.
reference
Currency values.
currency
String that is displayed as a multiline text field.
textarea
Percentage values.
percent
Phone numbers.Values can include alphabetic characters. Client applications are
responsible for phone number formatting.
phone
URL values. Client applications should commonly display these as hyperlinks.
url
Email addresses.
email
Comboboxes, which provide a set of enumerated values and allow the user to specify
a value not in the list.
combobox
Single-select picklists, which provide a set of enumerated values from which only one
value can be selected.
picklist
multi-select picklists, which provide a set of enumerated values from which multiple
values can be selected.
multipicklist
Values can be any of these types:
string
,
picklist
,
boolean
,
int
,
double
,
percent
,
ID
,
date
,
dateTime
,
url
, or
email
.
anyType
437
describeSObjects()
84
SOAPType
The DescribeSObjectResult returns the
fields
property, which contains an array of fields whose value provides information
about the object being described. One of those fields,
soapType
, contains one of the following string values. All of the values
preceded by
xsd:
are XML schema primitive data types. For more information about the XML schema primitive data types,
see the World Wide Web Consortium’s publication XML Schema Part 2: Data Types at:http://www.w3.org/TR/xmlschema-2/.
Description
Value
Unique ID associated with an sObject. For information on IDs, see ID Field Type.
tns:ID
Can be ID, Boolean, double, integer, string, date, or dateTime.
xsd:anyType
Base 64-encoded binary data.
xsd:base64Binary
Boolean (
true
/
false
) values.
xsd:boolean
Date values.
xsd:date
Date/time values.
xsd:dateTime
Double values.
xsd:double
Integer values.
xsd:int
Character strings.
xsd:string
PicklistEntry
In the
Field
object associated with the DescribeSObjectResult, the
picklistValues
field contains an array of
PicklistEntry
properties. Each
PicklistEntry
can contain any one of the following string values. For more information,
see Picklist Field Type.
Description
Type
Name
Indicates whether this item must be displayed (
true
) or not (
false
) in the
drop-down list for the picklist field in the user interface.
boolean
active
A set of bits where each bit indicates a controlling value for which this
PicklistEntry
is valid. See About Dependent Picklists.
byte[]
validFor
Indicates whether this item is the default item (
true
) in the picklist or not
(
false
). Only one item in a picklist can be designated as the default.
boolean
defaultValue
Display name of this item in the picklist.
string
label
Value of this item in the picklist.
string
value
About Dependent Picklists
A dependent picklist works in conjunction with a controlling field to filter its values.The value chosen in the controlling field
affects the values available in the dependent picklist.
A dependent picklist can be any custom picklist or multi-select picklist field that displays available values based on the value
selected in its corresponding controlling field. A controlling field can be any standard or custom picklist (with at least one and
less than 200 values) or checkbox field whose values control the available values in one or more corresponding dependent fields.
438
describeSObjects()
Documents you may be interested
Documents you may be interested
