YouTrack InCloud 2019.2 Help

Operations with Specific StateBundle

This resource provides operations with sets of values of the state type.

Resource

/api/admin/customFieldSettings/bundles/state/{bundleID}

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

The list of states that this set of values contains.

isUpdateable

Boolean

If true, then the currently logged-in user can update this bundle. Otherwise, false. Read-only.

Read a Specific StateBundle

Read the list of states in a set with the specific ID.

Request syntax

GET /api/admin/customFieldSettings/bundles/state/{bundleID}?{fields}

{bundleID}

Database ID of the set of values.

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

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/admin/customFieldSettings/bundles/state/68-3?fields=name,id,values(name,id,ordinal,isResolved),isUpdateable

Sample response body

{ "values": [ { "isResolved": false, "ordinal": 0, "name": "Open", "id": "69-22", "$type": "StateBundleElement" }, { "isResolved": false, "ordinal": 1, "name": "In Progress", "id": "69-23", "$type": "StateBundleElement" }, { "isResolved": false, "ordinal": 2, "name": "To Verify", "id": "69-24", "$type": "StateBundleElement" }, { "isResolved": true, "ordinal": 3, "name": "Done", "id": "69-25", "$type": "StateBundleElement" }, { "isResolved": true, "ordinal": 4, "name": "Duplicate", "id": "69-26", "$type": "StateBundleElement" } ], "name": "AnotherScrum project from RESTState004a258b-bdd7-4d4b-b7b6-f5d633c49d3b", "isUpdateable": true, "id": "68-3", "$type": "StateBundle" }

Update a Specific StateBundle

Change the list of states in a set with the specific ID.

Request syntax

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

{bundleID}

Database ID of the set of values.

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

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/admin/customFieldSettings/bundles/state/68-3?fields=name,id,values(name,id,ordinal,isResolved),isUpdateable

Sample request body

{ "name": "States for Another Scrum Project", "values": [ { "isResolved": true, "name": "Won't fix" } ] }

Sample response body

{ "values": [ { "isResolved": true, "ordinal": 0, "name": "Won't fix", "id": "69-63", "$type": "StateBundleElement" } ], "name": "States for Another Scrum Project", "isUpdateable": true, "id": "68-3", "$type": "StateBundle" }

Delete a Specific StateBundle

Delete the set of values with the specific ID.

Request syntax

DELETE /api/admin/customFieldSettings/bundles/state/{bundleID}

{bundleID}

Database ID of the set of values.

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

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/admin/customFieldSettings/bundles/state/68-9
Last modified: 17 October 2019