Metadata API Developer’s Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

DescribeValueTypeResult

Contains information about a value type that’s useful for developers working with declarative metadata.

The describeValueType() call returns a DescribeValueTypeResult object.

Each DescribeMetadataResult object has the following properties.

Name Type Description
valueTypeFields ValueTypeField[] One or more metadata components and their attributes.

ValueTypeField

This object is returned as part of the DescribeValueTypeResult and represents the metadata for one field. Each ValueTypeField has the following properties.

Name Type Description
fields ValueTypeField The ValueTypeField object for the next field, if any.
foreignKeyDomain string If isForeignKey is True, foreignKeyDomain is the the type of object, such as Account or Opportunity.
isForeignKey boolean True if the field is a foreign key. That means this field is the primary key in a different database table.
isNameField boolean True if this value type field is a fullName field, otherwise False.
minOccurs int 1 if this field is required, 0 otherwise.
name string The name of this value type field.
picklistValues PicklistEntry The individual picklist values if the field is a picklist.
soapType string The data type of the field, such as boolean or double.