YouTrack InCloud 2019.2 Help

Operations with Specific VersionBundle

This resource provides operations with version bundles.

Resource

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

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 Specific VersionBundle

Get attributes of a version bundle with a specific ID.

Request syntax

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

{bundleID}

Database ID of the bundle.

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/71-1?fields=id,name,fieldType(presentation,id),values(id,name,$type)

Sample response body

{ "values": [ { "name": "2019.1", "id": "133-19", "$type": "VersionBundleElement" } ], "name": "Sample Project: Versions", "id": "71-1", "$type": "VersionBundle" }

Update a Specific VersionBundle

Update a version bundle with the specific ID.

Request syntax

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

{bundleID}

Database ID of the bundle.

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/71-11?fields=id,name,fieldType(presentation,id),values(id,name,$type)

Sample request body

{ "values": [ { "name": "2019.1.5", "$type": "VersionBundleElement" }, { "name": "2019.1.6", "$type": "VersionBundleElement" } ] }

Sample response body

{ "values": [ { "name": "2019.1.5", "id": "133-25", "$type": "VersionBundleElement" }, { "name": "2019.1.6", "id": "133-26", "$type": "VersionBundleElement" } ], "name": "Base Versions", "id": "71-11", "$type": "VersionBundle" }

Delete a Specific VersionBundle

Delete a version bundle with the specific ID.

Request syntax

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

{bundleID}

Database ID of the bundle.

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/71-12
Last modified: 22 October 2019