Operations with Specific EnumBundle

This resource lets you work with a set of values of the enum type.

Resource	/api/admin/customFieldSettings/bundles/enum/{bundleID}
Returned entity	EnumBundle. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: Read a Specific EnumBundle. `POST`: Update a Specific EnumBundle. `DELETE`: Delete a Specific EnumBundle.

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.

Enum Bundles

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. `Read-only`.
values	Array of EnumBundleElements	Field values contained in the enumerated set.
isUpdateable	Boolean	If `true`, then the currently logged-in user can update this bundle. Otherwise, `false`. `Read-only`.

Read a Specific EnumBundle

Get a specific set of values of the enum type.

Required permissions

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.

Request syntax

GET /api/admin/customFieldSettings/bundles/enum/{bundleID}?{fields}

{bundleID}

Database ID of the bundle.

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 `entityID` is returned.

Sample

Sample request

                https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/enum/66-00?fields=name,id,values(name,id,description,ordinal),isUpdateable
            

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"
                }
            

Update a Specific EnumBundle

Update a specific set of values of the enum type.

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/enum/{bundleID}?{fields}

{bundleID}

Database ID of the bundle.

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 `entityID` is returned.

Sample

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.

Sample request

                https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/enum/66-12?fields=name,id,values(name,id,description,ordinal),isUpdateable
            

Sample request body

                {
                  "values": [
                    {
                      "name": "Stranger Things"
                    },
                    {
                      "name": "Legion"
                    },
                    {
                      "name": "Good Omens"
                    }
                  ]
                }
            

Sample response body

                {
                  "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 EnumBundle

Delete a specific set of values of the enum type.

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/enum/{bundleID}

{bundleID}

Database ID of the bundle.

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 `entityID` is returned.

Sample

Sample request

https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/enum/66-12

Last modified: 7 November 2024