YouTrack Standalone 2019.2 Help

Version Bundles

This resource provides operations with version bundles.

Resource

/api/admin/customFieldSettings/bundles/version

Returned entity

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

Supported methods

VersionBundle attributes

Represents a set of versions in YouTrack.

Extends BaseBundle

This table describes attributes of the VersionBundle 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 VersionBundleElements

Collection of versions contained in the bundle.

isUpdateable

Boolean

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

Read a List of VersionBundles

Get the list of all available version bundles in the system.

Request syntax

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

Request parameters

Parameter

Type

Description

fields

String

A list of VersionBundle 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.

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/admin/customFieldSettings/bundles/version?fields=id,name,fieldType(presentation,id),values(id,name,$type)

Sample response body

[ { "values": [], "name": "Versions", "id": "71-0", "$type": "VersionBundle" }, { "values": [ { "name": "2019.1", "id": "133-19", "$type": "VersionBundleElement" } ], "name": "Sample Project: Versions", "id": "71-1", "$type": "VersionBundle" }, { "values": [], "name": "Rest Api Project: Versions", "id": "71-3", "$type": "VersionBundle" }, { "values": [], "name": "Sandbox: Versions", "id": "71-4", "$type": "VersionBundle" }, { "values": [], "name": "Rest Project: Versions", "id": "71-7", "$type": "VersionBundle" }, { "values": [], "name": "GRA Project: Versions", "id": "71-8", "$type": "VersionBundle" }, { "values": [ { "name": "0.1.0", "id": "133-8", "$type": "VersionBundleElement" }, { "name": "0.1.1", "id": "133-9", "$type": "VersionBundleElement" }, { "name": "0.1.2", "id": "133-10", "$type": "VersionBundleElement" }, { "name": "0.1.3", "id": "133-11", "$type": "VersionBundleElement" }, { "name": "0.2.0", "id": "133-12", "$type": "VersionBundleElement" }, { "name": "0.2.1", "id": "133-13", "$type": "VersionBundleElement" }, { "name": "0.2.2", "id": "133-14", "$type": "VersionBundleElement" }, { "name": "0.2.3", "id": "133-15", "$type": "VersionBundleElement" }, { "name": "0.2.4", "id": "133-16", "$type": "VersionBundleElement" }, { "name": "0.3.0", "id": "133-17", "$type": "VersionBundleElement" }, { "name": "0.3.1", "id": "133-18", "$type": "VersionBundleElement" }, { "name": "8.3.03", "id": "133-20", "$type": "VersionBundleElement" } ], "name": "92-25-1547566402414", "id": "71-10", "$type": "VersionBundle" } ]

Add a New VersionBundle

Create a new version bundle in the system.

Required permissions

Requires Update Project OR Low-level Admin Write permission.

Request syntax

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

Request parameters

Parameter

Type

Description

fields

String

A list of VersionBundle 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/version?fields=id,name,fieldType(presentation,id),values(id,name,$type)

Sample request body

{ "values": [ { "name": "2019.1.1", "$type": "VersionBundleElement" }, { "name": "2019.1.2", "$type": "VersionBundleElement" } ], "name": "Base Versions", "$type": "VersionBundle" }

Sample response body

{ "values": [ { "name": "2019.1.1", "id": "133-21", "$type": "VersionBundleElement" }, { "name": "2019.1.2", "id": "133-22", "$type": "VersionBundleElement" } ], "name": "Base Versions", "id": "71-11", "$type": "VersionBundle" }
Last modified: 18 November 2019