Field Types
This resource lets you read the list of supported types of custom fields in YouTrack.
Resource | |
Returned entity | FieldType. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
FieldType attributes
Represents the type of 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 FieldType 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 | A string representation of the custom field type. For the full list of possible field types, see the Custom Field Type column at Type Mapping for Custom Fields. Read-only. |
Read a List of FieldTypes
Get all available field types.
Request syntax
GET /api/admin/customFieldSettings/types?{fields}&{$top}&{$skip}Request parameters
Parameter | Type | Description |
|---|---|---|
fields | String | A list of FieldType 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/types?fields=id,presentation,isMultiValue,valueType&$skip=4&$top=3Sample response body
[
{
"isMultiValue": false,
"presentation": "integer",
"valueType": "integer",
"id": "integer",
"$type": "FieldType"
},
{
"isMultiValue": true,
"presentation": "enum[*]",
"valueType": "enum",
"id": "enum[*]",
"$type": "FieldType"
},
{
"isMultiValue": false,
"presentation": "enum[1]",
"valueType": "enum",
"id": "enum[1]",
"$type": "FieldType"
}
]