Values in the Owned Bundle
This resource lets you work with the values in a specific set of owned values (owned bundle).
Resource | |
Returned entity | OwnedBundleElement. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
OwnedBundleElement attributes
Represents a single owned value of a set. For example, a subsystem.
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 OwnedBundleElement 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 owned value. |
owner | User | The user who is associated with the value. |
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 OwnedBundleElement
Get a specific owned value from the bundle.
Required permissions
Requires read access to the bundle.
Request syntax
GET /api/admin/customFieldSettings/bundles/ownedField/{bundleID}/values/{elementID}?{fields}{elementID} | Database ID of the owned value. |
Request parameters
Parameter | Type | Description |
|---|---|---|
fields | String | A list of OwnedBundleElement 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/ownedField/83-0/values/148-6?fields=id,name,owner(id,login,fullName)Sample response body
{
"owner": {
"fullName": "John Smith",
"login": "john.smith",
"id": "24-2",
"$type": "User"
},
"name": "Testing",
"id": "148-6",
"$type": "OwnedBundleElement"
}Update a Specific OwnedBundleElement
Update a specific owned 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
POST /api/admin/customFieldSettings/bundles/ownedField/{bundleID}/values/{elementID}?{fields}{elementID} | Database ID of the owned value. |
Request parameters
Parameter | Type | Description |
|---|---|---|
fields | String | A list of OwnedBundleElement 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/ownedField/83-0/values/148-6?fields=id,name,owner(id,login,fullName)Sample request body
{
"name": "Quality Assurance"
}Sample response body
{
"owner": {
"fullName": "John Smith",
"login": "john.smith",
"id": "24-2",
"$type": "User"
},
"name": "Quality Assurance",
"id": "148-6",
"$type": "OwnedBundleElement"
}Delete a Specific OwnedBundleElement
Remove a specific owned value 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/ownedField/{bundleID}/values/{elementID}{elementID} | Database ID of the owned value. |
Request parameters
Parameter | Type | Description |
|---|---|---|
fields | String | A list of OwnedBundleElement 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/ownedField/83-0/values/148-36