Operations with Specific CustomField
This resource lets you work with the custom fields. In the old REST API we called them "prototypes".
Resource | /api/admin/customFieldSettings/customFields/{fieldID} |
Returned entity | CustomField. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
CustomField attributes
Represents a custom field in YouTrack.
This table describes attributes of the CustomField
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 |
---|---|---|
name | String | The name of the custom field. |
localizedName | String | If set, then this value is used for the field presentation in UI. |
fieldType | FieldType | The type of the custom field. |
isAutoAttached | Boolean | If |
isDisplayedInIssueList | Boolean | If |
ordinal | Int | Number of the field. |
aliases | String | A comma-separated list of aliases that can be used in search and commands. |
fieldDefaults | CustomFieldDefaults | Default project-related settings for the custom field. May contain different values for custom fields of different types. |
hasRunningJob | Boolean | Indicates whether a background job is running for this field. In this case, some field operations may be temporary unavailable. |
isUpdateable | Boolean | Indicates whether the current user has permissions to update this field. |
instances | Array of ProjectCustomFields | Project-related settings. May contain different values for custom fields of different types |
Update a Specific CustomField
Update the custom field with the specific ID.
Required permissions
Requires Project Update permission in all the projects where field is used. If field is auto-attached, Low-level Admin Write permission is required.
Request syntax
{fieldID} | Database ID of the custom field. |
Request parameters
Parameter | Type | Description |
---|---|---|
fields | String | A list of CustomField attributes that should be returned in the response. If no field is specified,only the |
Sample
Sample request URI
Sample request body
Sample response body
Delete a Specific CustomField
Delete the custom field with the specific ID.
Required permissions
Requires Project Update permission in all the projects where field is used. If field is auto-attached, Low-level Admin Write permission is required.
Request syntax
{fieldID} | Database ID of the custom field. |
Request parameters
Parameter | Type | Description |
---|---|---|
fields | String | A list of CustomField attributes that should be returned in the response. If no field is specified,only the |
Sample
Sample request URI
Read a Specific CustomField
Read the custom field with the specific ID.
Required permissions
Requires access to the field in any of the projects OR Low-level Admin Read permission OR Update Project permission
Request syntax
{fieldID} | Database ID of the custom field. |
Request parameters
Parameter | Type | Description |
---|---|---|
fields | String | A list of CustomField attributes that should be returned in the response. If no field is specified,only the |