Values in the Version Bundle
This resource lets you work with the version values in a specific set of versions (version bundle).
Resource | /api/admin/customFieldSettings/bundles/version/{bundleID}/values/{elementID} |
Returned entity | VersionBundleElement. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
VersionBundleElement attributes
Represents a version in YouTrack.
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 VersionBundleElement
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 version. |
archived | Boolean | Indicates whether the version is archived. |
released | Boolean | Indicates whether the version is marked as released. |
releaseDate | Long | The release date that is associated with the version. |
startDate | Long | The start date that is associated with the version. Available since 2023.1. |
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. |
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 VersionBundleElement
Get a specific version from the bundle.
Required permissions
Requires read access to the bundle.
Request syntax
{elementID} | Database ID of the version value. |
Request parameters
Parameter | Type | Description |
---|---|---|
fields | String | A list of VersionBundleElement attributes that should be returned in the response. If no field is specified, only the |
Sample
Sample request
Sample response body
Update a Specific VersionBundleElement
Update a specific version value 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
{elementID} | Database ID of the version value. |
Request parameters
Parameter | Type | Description |
---|---|---|
fields | String | A list of VersionBundleElement attributes that should be returned in the response. If no field is specified, only the |
Sample
Sample request
Sample request body
Sample response body
Delete a Specific VersionBundleElement
Remove a specific version 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
{elementID} | Database ID of the version value. |
Request parameters
Parameter | Type | Description |
---|---|---|
fields | String | A list of VersionBundleElement attributes that should be returned in the response. If no field is specified, only the |