YouTrack Standalone 2019.1 Help

State Bundles

This resource provides operations with state bundles.

Resource

/api/admin/customFieldSettings/bundles/state

Returned entity

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

Supported methods

StateBundle attributes

Represents a set of states in YouTrack.

Extends BaseBundle

This table describes attributes of the StateBundle 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 StateBundleElements

States contained in the bundle.

Read a List of StateBundles

Request syntax

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

Request parameters

Parameter

Type

Description

fields

string

A list of StateBundle 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 StateBundle

Request syntax

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

Request parameters

Parameter

Type

Description

fields

string

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

Last modified: 12 April 2019