TeamCity REST API Reference 2026.2 Help

TypedValueSet

Represents a named set of predefined selectable values for a typed build parameter. When a parameter is configured as a select (dropdown) type, users must choose its value from the entries in the associated TypedValueSet. For example, a 'Target environment' parameter might offer a fixed list of values such as 'staging' and 'production'. Each entry in the set is a LabeledValue with an internal key (stored in the build) and a human-readable label (shown to users).

Properties

keyword

The list of search keywords associated with this typed value set.

value

The list of predefined LabeledValue objects available for selection in this typed value set.

description

The full description of this typed value set explaining the kind of values it contains.

shortDescription

A brief description of this typed value set.

name

The internal identifier (type name) of this typed value set.

displayName

The human-readable display name of this typed value set.

Schema

Below, you can find a full schema of this object, in XML and JSON formats. You can choose what fields to submit depending on your current needs. Different methods might expect different fields: the best approach is to request this entity via GET and use the response as a base for the following POST request.

A link to another object implies that you can substitute it with the schema of the linked object, if it is required for your call.

<TypedValueSet description="The deployment environment to target." displayName="Target environment" keyword="string" name="builtin:vcsHostingProvider" shortDescription="Deployment target"> <value>[[[LabeledValue...|labeledvalue.html]]]</value> </TypedValueSet>
{ "displayName" : "Target environment", "name" : "builtin:vcsHostingProvider", "description" : "The deployment environment to target.", "shortDescription" : "Deployment target", "keyword" : [ "keyword" ], "value" : [ { "label" : "Production", "value" : "prod" } ] }
Last modified: 18 August 2026