Values in the Build Bundle
This resource lets you work with the values in a specific set of builds (build bundle).
Resource | |
Returned entity | BuildBundleElement. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
BuildBundleElement attributes
Represents a build - a single element of a builds bundle.
Related Resources
Below you can find the list of resources that let you work with this entity.
Extends BundleElement
Attributes
This table describes attributes of the BuildBundleElement entity.
To receive an attribute in the response from the server, specify it explicitly in the
fieldsrequest parameter.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
|---|---|---|
id | String | The ID of the build. |
assembleDate | Long | The timestamp in milliseconds indicating the moment when the build was assembled. Stored as a unix timestamp at UTC. |
name | String | The name of the value. |
bundle | Bundle | The reference to the bundle that contains this value. |
description | String | The description of the value. |
archived | Boolean | When |
ordinal | Int | The position of the value in the set of values for the custom field. |
color | FieldStyle | The color that is assigned to the value in the custom field. |
hasRunningJob | Boolean | If true, there are some jobs running in the background for this bundle element. Otherwise, false. |
Read a Specific BuildBundleElement
Get a specific build from the bundle.
Required permissions
Requires read access to the bundle.
Request syntax
GET /api/admin/customFieldSettings/bundles/build/{bundleID}/values/{elementID}?{fields}{elementID} | Database ID of the build value. |
Request parameters
Parameter | Type | Description |
|---|---|---|
fields | String | A list of BuildBundleElement attributes that should be returned in the response. If no field is specified, only the |
Sample
Sample request
https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/build/86-1/values/150-5?fields=id,name,assembleDate,descriptionSample response body
{
"assembleDate": 1627300800000,
"description": null,
"name": "135",
"id": "150-5",
"$type": "BuildBundleElement"
}Update a Specific BuildBundleElement
Update a specific build in the bundle.
Required permissions
Requires Update Project permission in all projects where the bundle is used. If the bundle is not used in any field, Update Project permission is required in at least one project.
Request syntax
POST /api/admin/customFieldSettings/bundles/build/{bundleID}/values/{elementID}?{fields}{elementID} | Database ID of the build value. |
Request parameters
Parameter | Type | Description |
|---|---|---|
fields | String | A list of BuildBundleElement attributes that should be returned in the response. If no field is specified, only the |
Sample
Sample request
https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/build/86-1/values/150-8?fields=id,name,assembleDate,descriptionSample request body
{
"assembleDate": 1627984025000,
"description": null,
"name": "141"
}Sample response body
{
"assembleDate": 1627984025000,
"description": null,
"name": "141",
"id": "150-8",
"$type": "BuildBundleElement"
}Delete a Specific BuildBundleElement
Remove a specific build from the bundle.
Required permissions
Requires Update Project permission in all projects where the bundle is used. If the bundle is not used in any field, Update Project permission is required in at least one project.
Request syntax
DELETE /api/admin/customFieldSettings/bundles/build/{bundleID}/values/{elementID}{elementID} | Database ID of the build value. |
Request parameters
Parameter | Type | Description |
|---|---|---|
fields | String | A list of BuildBundleElement attributes that should be returned in the response. If no field is specified, only the |
Sample
Sample request
https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/build/86-1/values/150-10