Values in the Enum Bundle
This resource lets you work with the values in a specific set of enumerated values (enum bundle).
Resource | |
|---|---|
Returned entity | EnumBundleElement. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
Represents an enumeration value in YouTrack.
Below you can find the list of resources that let you work with this entity.
Values in the Enum Bundle
Extends LocalizableBundleElement
This table describes attributes of the EnumBundleElement 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 enumeration value. |
localizedName | String | The localized name of the field value. |
name | String | The name of the value. |
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 | 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. |
Get the list of all enumerated values in the specific bundle.
GET /api/admin/customFieldSettings/bundles/enum/{bundleID}/values?{fields}&{$top}&{$skip}null | Database ID of EnumBundleElement |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of EnumBundleElement attributes that should be returned in the response. If no field is specified, only the |
$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. |
https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/enum/54-1/values?fields=id,name[
{
"name": "Bug",
"id": "55-5",
"$type": "EnumBundleElement"
},
{
"name": "Exception",
"id": "55-7",
"$type": "EnumBundleElement"
},
{
"name": "Feature",
"id": "55-8",
"$type": "EnumBundleElement"
},
{
"name": "Task",
"id": "55-9",
"$type": "EnumBundleElement"
},
{
"name": "Usability Problem",
"id": "55-10",
"$type": "EnumBundleElement"
},
{
"name": "Epic",
"id": "55-12",
"$type": "EnumBundleElement"
},
{
"name": "Story",
"id": "55-308",
"$type": "EnumBundleElement"
},
{
"name": "Incident",
"id": "55-317",
"$type": "EnumBundleElement"
}
]Add a new enumerated value to the bundle.
Required fields: name.
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/enum/{bundleID}/values?{fields}null | Database ID of EnumBundleElement |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of EnumBundleElement attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/enum/54-1/values?fields=id,name{
"name": "User Story"
}{
"name": "User Story",
"id": "55-318",
"$type": "EnumBundleElement"
}