Operations with Specific EnumBundle
This resource lets you work with 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 |
|
EnumBundle attributes
Represents a set of values of the enumeration type in YouTrack.
Extends BaseBundle
This table describes attributes of the EnumBundle
entity.
To receive an attribute in the response from server, specify it explicitly in the request parameter
fields
.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
---|---|---|
values | Array of EnumBundleElements | Field values contained in the enumeration. |
isUpdateable | Boolean | If |
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
{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 |
Sample
Sample request URI
Sample response body
Update a Specific EnumBundle
Update a specific set of values of the enum
type.
Required permissions
Requires Project Update 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
{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 |
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 URI
Sample request body
Sample response body
Delete a Specific EnumBundle
Delete a specific set of values of the enum
type.
Required permissions
Requires Project Update 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
{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 |