YouTrack Standalone 2019.2 Help

Operations with Specific BuildBundle

This resource provides operations with sets of builds.

Resource

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

Returned entity

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

Supported methods

BuildBundle attributes

Represents a set of builds in YouTrack.

Extends BaseBundle

This table describes attributes of the BuildBundle 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 BuildBundleElements

Collection of builds that this bundle contains.

isUpdateable

Boolean

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

Read a Specific BuildBundle

Read a set of builds with the specific ID.

Request syntax

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

{bundleID}

Database ID of the bundle.

Request parameters

Parameter

Type

Description

fields

String

A list of BuildBundle 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/build/95-10?fields=name,id,values(name,id,description,ordinal,hasRunningJob,assembleDate),isUpdateable

Sample response body

{ "values": [ { "assembleDate": 1551265655000, "description": "Alpha", "ordinal": 1, "name": "11111.3.2342", "hasRunningJob": false, "id": "135-9", "$type": "BuildBundleElement" }, { "assembleDate": 1555385700000, "description": "RC1", "ordinal": 0, "name": "11112.3.6528", "hasRunningJob": false, "id": "135-10", "$type": "BuildBundleElement" }, { "assembleDate": 1554440460000, "description": null, "ordinal": 2, "name": "11111.4.7644", "hasRunningJob": false, "id": "135-13", "$type": "BuildBundleElement" } ], "name": "Base Builds", "isUpdateable": true, "id": "95-10", "$type": "BuildBundle" }

Update a Specific BuildBundle

Update the specific set of builds.

Request syntax

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

{bundleID}

Database ID of the bundle.

Request parameters

Parameter

Type

Description

fields

String

A list of BuildBundle 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/build

Sample request body

{ "values": [ { "name": "11112.4.4744", "description": "RC2", "assembleDate": 1556709720000, "$type": "BuildBundleElement" }, { "name": "11112.4.6526", "description": "RC3 (public)", "assembleDate": 1557408600000, "$type": "BuildBundleElement" } ] }

Sample response body

{ "values": [ { "assembleDate": 1556709720000, "description": "RC2", "ordinal": 1, "name": "11112.4.4744", "hasRunningJob": false, "id": "135-14", "$type": "BuildBundleElement" }, { "assembleDate": 1557408600000, "description": "RC3 (public)", "ordinal": 0, "name": "11112.4.6526", "hasRunningJob": false, "id": "135-15", "$type": "BuildBundleElement" } ], "name": "Base Builds", "isUpdateable": true, "id": "95-10", "$type": "BuildBundle" }

Delete a Specific BuildBundle

Delete a set of builds with the specific ID.

Request syntax

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

{bundleID}

Database ID of the bundle.

Request parameters

Parameter

Type

Description

fields

String

A list of BuildBundle 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/build/95-11
Last modified: 22 October 2019