Custom Fields
This resource lets you work with the custom fields. In the old REST API we called them "prototypes".
Resource | |
Returned entity | CustomField. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
Supported sub-resources |
|
CustomField attributes
Represents a custom field in YouTrack.
Related Resources
Below you can find the list of resources that let you work with this entity.
Attributes
This table describes attributes of the CustomField 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 custom field. |
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 |
Read a List of CustomFields
Get all available custom fields in the system.
Request syntax
GET /api/admin/customFieldSettings/customFields?{fields}&{$top}&{$skip}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 |
$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/customFields?fields=id,name,fieldType(presentation,id)&$top=3Sample response body
[
{
"fieldType": {
"presentation": "ownedField[1]",
"id": "ownedField[1]",
"$type": "FieldType"
},
"name": "Subsystem",
"id": "58-0",
"$type": "CustomField"
},
{
"fieldType": {
"presentation": "enum[1]",
"id": "enum[1]",
"$type": "FieldType"
},
"name": "Priority",
"id": "58-1",
"$type": "CustomField"
},
{
"fieldType": {
"presentation": "enum[1]",
"id": "enum[1]",
"$type": "FieldType"
},
"name": "Type",
"id": "58-2",
"$type": "CustomField"
}
]Add a New CustomField
Create a new custom field in the system.
Required fields: name, fieldType.
For the list of available field type options, see Type Mapping for Custom Fields. As you're creating a new custom field in the system, you're going to need a value from the Custom Field Type column. Check the sample request below for more details.
Required permissions
Requires permissions: Update Project or Low-level Admin Write
Request syntax
POST /api/admin/customFieldSettings/customFields?{fields}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
https://example.youtrack.cloud/api/admin/customFieldSettings/customFields?fields=id,name,fieldType(presentation,id)Sample request body
{
"fieldType": {
"id": "enum[1]"
},
"name": "Severity",
"isDisplayedInIssueList": true,
"isAutoAttached": false,
"isPublic": true
}Sample response body
{
"fieldType": {
"presentation": "enum[1]",
"id": "enum[1]",
"$type": "FieldType"
},
"name": "Severity",
"id": "58-22",
"$type": "CustomField"
}