YouTrack Standalone 2019.1 Help

Enum Bundles

This resource provides operations with enum-type bundles.

Resource

/api/admin/customFieldSettings/bundles/enum

Returned entity

EnumBundle. For the description of the entity attributes, see Supported Fields section.

Supported methods

EnumBundle attributes

Represents enumeration bundle in YouTrack.

Extends BaseBundle

This table describes attributes of the EnumBundle entity.

  • To receive an attribute in the response from server, specify it explicitly in the request parameter fields.

  • To update an attribute, provide it in the body of a POST request.

Field

Type

Description

values

Array of EnumBundleElements

Field values contained in the enumeration.

Read a List of EnumBundles

Request syntax

GET /api/admin/customFieldSettings/bundles/enum?{fields}&{$top}&{$skip}

Request parameters

Parameter

Type

Description

fields

string

A list of EnumBundle attributes that should be returned in the response. If no field is specified, only the entityID is returned.

$skip

int

Optional. Lets you set a number of returned entities to skip before returning the first one.

$top

int

Optional. Lets you specify the maximum number of entries that are returned in the response.

Add a New EnumBundle

Request syntax

POST /api/admin/customFieldSettings/bundles/enum?{fields}

Request parameters

Parameter

Type

Description

fields

string

A list of EnumBundle attributes that should be returned in the response. If no field is specified, only the entityID is returned.

Last modified: 8 July 2019