---
schema_version: "1"
id: 23d9ba38b72c6130ae7cedeb991d473226db344d1b36587c514a1c31f1b899e7
title: DescribeValueTypeResult
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_describeValueTypeResult.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_describeValueTypeResult.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: b186fdf7eb9ea55d7c3b1187f6518f59f843489be13842cc954a7d8624d6f240
description: Contains information about a value type that’s useful for developers working with declarative metadata.
---
# DescribeValueTypeResult

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

The [describeValueType()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_describeValueType.htm "Retrieves the metadata describing a given metadata type (value type).") call returns a DescribeValueTypeResult object.

Each DescribeValueTypeResult object has these properties.

## Fields

### apiCreatable

- **Type**: boolean
- **Description**: Indicates whether this value type can be created through the [createMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_createMetadata.htm "Adds one or more new metadata components to your organization synchronously.") call (true) or not (false). This field is available in API version 36.0 and later.

### apiDeletable

- **Type**: boolean
- **Description**: Indicates whether this value type can be created through the [deleteMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deleteMetadata.htm "Deletes one or more metadata components from your organization synchronously.") call (true) or not (false). This field is available in API version 36.0 and later.

### apiReadable

- **Type**: boolean
- **Description**: Indicates whether this value type can be created through the [readMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_readMetadata.htm "Returns one or more metadata components from your organization synchronously.") call (true) or not (false). This field is available in API version 36.0 and later.

### apiUpdatable

- **Type**: boolean
- **Description**: Indicates whether this value type can be created through the [updateMetadata()](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_updateMetadata.htm "Updates one or more metadata components in your organization synchronously.") call (true) or not (false). This field is available in API version 36.0 and later.

### parentField

- **Type**: [ValueTypeField](#describemetadataobject)
- **Description**: Information about the parent of this value type. Parent field information is useful for metadata types that are specified with the parent in their name, such as custom fields, email templates, workflow rules, and reports. For example, the full name of a custom field includes the sObject that contains it (for example, Account.field1\_\_c). Similarly, the full name of an email template includes the folder where the template is stored (for example, MyFolder/EmailTemplate1). If the value type has no parent, this field is null.
    
    This field is available in API version 36.0 and later.

### valueTypeFields

- **Type**: [ValueTypeField](#describemetadataobject)\[\]
- **Description**: 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

### fields

- **Type**: ValueTypeField
- **Description**: The ValueTypeField object for the next field, if any.

### foreignKeyDomain

- **Type**: string
- **Description**: If isForeignKey is True, foreignKeyDomain is the type of object, such as Account or Opportunity.

### isForeignKey

- **Type**: boolean
- **Description**: True if the field is a foreign key. That means this field is the primary key in a different database table.

### isNameField

- **Type**: boolean
- **Description**: True if this value type field is a fullName field; otherwise False.

### minOccurs

- **Type**: int
- **Description**: 1 if this field is required, 0 otherwise.

### name

- **Type**: string
- **Description**: The name of this value type field. The name is null for parent fields.

### picklistValues

- **Type**: [PicklistEntry](#describepicklistentry)\[\]
- **Description**: The individual picklist values if the field is a picklist.

### soapType

- **Type**: string
- **Description**: The data type of the field, such as boolean or double.

### valueRequired

- **Type**: boolean
- **Description**: Required. Indicates whether this value type field must have a value (true) or can be null (false).

## PicklistEntry

This object is returned as part of the DescribeValueTypeResult and represents the metadata for one picklist value. Each PicklistEntry has these properties.

### active

- **Type**: boolean
- **Description**: True if the picklist value is active and displayed in the drop-down list for the picklist field in the user interface. False if the picklist value is inactive.

### defaultValue

- **Type**: boolean
- **Description**: True if the picklist value is a default value, otherwise, False.

### label

- **Type**: string
- **Description**: Display name of this item in the picklist.

### validFor

- **Type**: string

### value

- **Type**: string
- **Description**: Value of this item in the picklist.