Enum Bundles
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 |
|
Supported sub-resources |
|
EnumBundle attributes
Represents an enumerated set of values in YouTrack.
Related Resources
Below you can find the list of resources that let you work with this entity.
Extends BaseBundle
Attributes
This table describes attributes of the EnumBundle
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 enumeration values. |
values | Array of EnumBundleElements | Field values contained in the enumerated set. |
isUpdateable | Boolean | If |
Read a List of EnumBundles
Read the list of all available sets of values of the enum
type.
Request syntax
GET /api/admin/customFieldSettings/bundles/enum?{fields}&{$top}&{$skip}
Request parameters
Parameter | Type | Description |
---|---|---|
fields | String | A list of EnumBundle 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. |
Sample
Sample request
https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/enum?fields=name,id,values(name,id,description,ordinal),isUpdateable&$top=2
Sample response body
[
{
"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"
},
{
"values": [
{
"description": null,
"ordinal": 0,
"name": "Bug",
"id": "67-5",
"$type": "EnumBundleElement"
},
{
"description": null,
"ordinal": 1,
"name": "Cosmetics",
"id": "67-6",
"$type": "EnumBundleElement"
},
{
"description": null,
"ordinal": 2,
"name": "Exception",
"id": "67-7",
"$type": "EnumBundleElement"
},
{
"description": null,
"ordinal": 3,
"name": "Feature",
"id": "67-8",
"$type": "EnumBundleElement"
},
{
"description": null,
"ordinal": 4,
"name": "Task",
"id": "67-9",
"$type": "EnumBundleElement"
},
{
"description": null,
"ordinal": 5,
"name": "Usability Problem",
"id": "67-10",
"$type": "EnumBundleElement"
},
{
"description": null,
"ordinal": 6,
"name": "Performance Problem",
"id": "67-11",
"$type": "EnumBundleElement"
},
{
"description": null,
"ordinal": 7,
"name": "Epic",
"id": "67-12",
"$type": "EnumBundleElement"
}
],
"isUpdateable": true,
"name": "Types",
"id": "66-1",
"$type": "EnumBundle"
}
]
Add a New EnumBundle
Create a new set of values of the enum
type.
Required permissions
Requires permissions: Update Project or Low-level Admin Write
Request syntax
POST /api/admin/customFieldSettings/bundles/enum?{fields}
Request parameters
Parameter | Type | Description |
---|---|---|
fields | String | A list of EnumBundle 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/enum?fields=name,id,values(name,id,description,ordinal),isUpdateable
Sample request body
{
"name": "Series",
"values": [
{
"name": "Doctor Who: Classic"
},
{
"name": "Doctor Who"
},
{
"name": "Stranger Things"
},
{
"name": "Legion"
},
{
"name": "Good Omens"
}
]
}
Sample response body
{
"values": [
{
"description": null,
"ordinal": 1,
"name": "Doctor Who: Classic",
"id": "67-52",
"$type": "EnumBundleElement"
},
{
"description": null,
"ordinal": 2,
"name": "Doctor Who",
"id": "67-53",
"$type": "EnumBundleElement"
},
{
"description": null,
"ordinal": 3,
"name": "Stranger Things",
"id": "67-54",
"$type": "EnumBundleElement"
},
{
"description": null,
"ordinal": 4,
"name": "Legion",
"id": "67-55",
"$type": "EnumBundleElement"
},
{
"description": null,
"ordinal": 0,
"name": "Good Omens",
"id": "67-56",
"$type": "EnumBundleElement"
}
],
"isUpdateable": true,
"name": "Series",
"id": "66-12",
"$type": "EnumBundle"
}