GlobalValueSet

Represents a set of values used by a global picklist.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Version 

Introduced in API version 39.0.

Supported SOAP API Calls 

create(), describeLayout(), describeSObjects(), query(), retrieve(), search(), update(), upsert()

Supported REST API Methods 

GET, HEAD, PATCH, POST, Query

Fields 

Description 

• Type: textarea

• Required: No

• Properties: Filter, Nillable, Sort

• Description: A picklist value’s description. It’s useful to include a description for a picklist value so the reason for creating it can be tracked. Limit: 255 characters.

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The unique name for the Global Value Set object.

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Description: The full name of the associated metadata object in the Metadata API.

Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

Any global value set created in API version 57.0 or later automatically has the __gvs suffix appended to FullName. When you make any CRUD-based call with the GlobalValueSet type, you must append the suffix to the FullName field when you reference the type.

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.

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

MasterLabel 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: Label for the Global Value Set. In the UI, this field is MasterLabel.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Description: Global Value Set metadata. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

The namespace prefix can have one of the following values:

• In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer.
• In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.

CustomValue Metadata 

Metadata about the global value set is returned in the CustomValue field.

Field Type Description Color string The color assigned to the picklist value when it’s used in charts on reports and dashboards. The color is in hexadecimal format; for example, #FF6600. If a color isn’t specified, it’s assigned dynamically upon chart generation. Default boolean Required. Indicates whether this value is the default selection for the global picklist and the custom picklists that share its picklist value set. This field is set to true by default. Description string A picklist value’s description. It’s useful to include a description for a picklist value so the reason for creating it can be tracked. Limit: 255 characters. IsActive boolean Indicates whether this value is active or inactive. The default value is true. Users can select only active values from a picklist. An API retrieve operation for global picklist values returns all active and inactive values in the picklist. But retrieving the values of a non-global, unrestricted picklist returns only the active values. Label string The global picklist value’s label, or API name. If you don’t specify the label when creating a value, it defaults to the text of the picklist value (ValueName). The ValueName isn’t used if you update the label. ValueName string The text of the picklist value.