Build Bundles

This resource provides operations with sets of builds.

Resource	/api/admin/customFieldSettings/bundles/build
Returned entity	BuildBundle. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: Read a List of BuildBundles. `POST`: Add a New BuildBundle.
Supported sub-resources	/api/admin/customFieldSettings/bundles/build/{bundleID}: Operations with Specific BuildBundle /api/admin/customFieldSettings/bundles/build/{bundleID}/values: Values in the Build Bundle

BuildBundle attributes

Represents a set of builds in YouTrack.

Related Resources

Below you can find the list of resources that let you work with this entity.

Build Bundles

Extends BaseBundle

Attributes

This table describes attributes of the BuildBundle entity.

To receive an attribute in the response from the server, specify it explicitly in the fields request parameter.
To update an attribute, provide it in the body of a POST request.

Field	Type	Description
id	String	The ID of the set of builds. `Read-only`.
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 List of BuildBundles

Get all available sets of builds in the system.

Request syntax

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

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.

$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. If you don't set the $top value, the server limits the maximum number of returned entries.

The server returns a maximum of 42 entries for most resources that return collections. For more information, see Pagination.

Sample

Sample request

                https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/build?fields=id,name,fieldType(presentation,id)&$top=3
            

Sample response body

                [
                  {
                    "name": "Sample Project: Fixed in builds",
                    "id": "95-0",
                    "$type": "BuildBundle"
                  },
                  {
                    "name": "Rest Api Project: Fixed in builds",
                    "id": "95-2",
                    "$type": "BuildBundle"
                  },
                  {
                    "name": "Sandbox: Fixed in builds",
                    "id": "95-3",
                    "$type": "BuildBundle"
                  }
                ]
            

Add a New BuildBundle

Create a new set of builds.

Required permissions

Requires permissions: Update Project or Low-level Admin Write

Request syntax

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

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

https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/build

Sample request body

                {
                  "values": [
                    {
                      "name": "11111.3.2342",
                      "$type": "BuildBundleElement"
                    },
                    {
                      "name": "11112.3.6528",
                      "$type": "BuildBundleElement"
                    }
                  ],
                  "name": "Base Builds"
                }
            

Sample response body

                {
                  "id": "95-10",
                  "$type": "BuildBundle"
                }
            

Last modified: 7 November 2024