Operations with Specific EnumBundle
This resource lets you work with a set of values of the enum type.
Resource | |
|---|---|
Returned entity | EnumBundle. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
Represents an enumerated set of values 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 EnumBundle 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 set of enumeration values. |
values | Field values contained in the enumerated set. | |
isUpdateable | Boolean | If |
Get a specific set of values of the enum type.
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/enum/{bundleID}?{fields}{bundleID} | Database ID of the bundle. |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of EnumBundle attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/enum/66-00?fields=name,id,values(name,id,description,ordinal),isUpdateable{
"values": [
{
"description": null,
"ordinal": 0,
"name": "Show-stopper",
"id": "67-0",
"$type": "EnumBundleElement"
},
{
"description": null,
"ordinal": 1,
"name": "Critical",
"id": "67-1",
"$type": "EnumBundleElement"
},
{
"description": null,
"ordinal": 2,
"name": "Major",
"id": "67-2",
"$type": "EnumBundleElement"
},
{
"description": null,
"ordinal": 3,
"name": "Normal",
"id": "67-3",
"$type": "EnumBundleElement"
},
{
"description": null,
"ordinal": 4,
"name": "Minor",
"id": "67-4",
"$type": "EnumBundleElement"
}
],
"isUpdateable": true,
"name": "Priorities",
"id": "66-0",
"$type": "EnumBundle"
}Update a specific set of values of the enum type.
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}?{fields}{bundleID} | Database ID of the bundle. |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of EnumBundle attributes that should be returned in the response. If no field is specified, only the |
Let's update the values of an existing enumeration bundle. Please notice that when you use this endpoint, the current json object of values will be replaced with the one that you provide in the request. To add a new value to the bundle, use the /bundles/enum/id/values endpoint.
https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/enum/66-12?fields=name,id,values(name,id,description,ordinal),isUpdateable{
"values": [
{
"name": "Stranger Things"
},
{
"name": "Legion"
},
{
"name": "Good Omens"
}
]
}{
"values": [
{
"description": null,
"ordinal": 1,
"name": "Stranger Things",
"id": "67-57",
"$type": "EnumBundleElement"
},
{
"description": null,
"ordinal": 2,
"name": "Legion",
"id": "67-58",
"$type": "EnumBundleElement"
},
{
"description": null,
"ordinal": 0,
"name": "Good Omens",
"id": "67-59",
"$type": "EnumBundleElement"
}
],
"isUpdateable": true,
"name": "Series",
"id": "66-12",
"$type": "EnumBundle"
}Delete a specific set of values of the enum type.
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/enum/{bundleID}{bundleID} | Database ID of the bundle. |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of EnumBundle attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/enum/66-12