Operations with Specific VersionBundle
This resource provides operations with version bundles.
Resource |
|
---|---|
Returned entity | VersionBundle. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
Represents a set of versions in YouTrack.
Below you can find the list of resources that let you work with this entity.
Extends BaseBundle
This table describes attributes of the VersionBundle
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 versions. |
values | Collection of versions contained in the bundle. | |
isUpdateable | Boolean | If |
Get attributes of a version bundle with a specific ID.
Requires read or update access to one of the fields that use the bundle. If the bundle is not used in any field, Update Project permission is required in at least one project.
GET /api/admin/customFieldSettings/bundles/version/{bundleID}?{fields}
{bundleID} | Database ID of the bundle. |
---|
Parameter | Type | Description |
---|---|---|
fields | String | A list of VersionBundle attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/version/71-1?fields=id,name,fieldType(presentation,id),values(id,name,$type)
{
"values": [
{
"name": "2019.1",
"id": "133-19",
"$type": "VersionBundleElement"
}
],
"name": "Sample Project: Versions",
"id": "71-1",
"$type": "VersionBundle"
}
Update a version bundle with the specific ID.
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.
POST /api/admin/customFieldSettings/bundles/version/{bundleID}?{fields}
{bundleID} | Database ID of the bundle. |
---|
Parameter | Type | Description |
---|---|---|
fields | String | A list of VersionBundle attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/version/71-11?fields=id,name,fieldType(presentation,id),values(id,name,$type)
{
"values": [
{
"name": "2019.1.5",
"$type": "VersionBundleElement"
},
{
"name": "2019.1.6",
"$type": "VersionBundleElement"
}
]
}
{
"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 version bundle with the specific ID.
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.
DELETE /api/admin/customFieldSettings/bundles/version/{bundleID}
{bundleID} | Database ID of the bundle. |
---|
Parameter | Type | Description |
---|---|---|
fields | String | A list of VersionBundle attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/version/71-12
Thanks for your feedback!