YouTrack InCloud 2019.1 Help

Operations with Specific CustomFieldDefaults

Resource

/api/admin/customFieldSettings/customFields/fieldDefaults

Returned entity

CustomFieldDefaults. For the description of the entity attributes, see Supported Fields section.

Supported methods

CustomFieldDefaults attributes

Represents default project-related settings of the custom field. They are applied when the custom field is attached to the project. After the field is attached to the project, changes in defaults won't affect field settings for this project.

This table describes attributes of the CustomFieldDefaults 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

canBeEmpty

Boolean

Indicates whether this field can have empty value in the issue.

emptyFieldText

String

The text that is shown as a placeholder when the field is empty. Can be null.

isPublic

Boolean

If `true`, then a user needs Read Issue and Update Issue permissions to access this field. Otherwise, the field is considered private, and Read Issue Private Fields and Update Issue Private Fields permissions are required.

parent

CustomField

Reference to the custom field. Read-only.

Read a Specific CustomFieldDefaults

Get default settings for the field.

Request syntax

GET /api/admin/customFieldSettings/customFields/fieldDefaults/{defaultsID}?{fields}

Request parameters

Parameter

Type

Description

fields

string

A list of CustomFieldDefaults attributes that should be returned in the response. If no field is specified, only the entityID is returned.

Update a Specific CustomFieldDefaults

Update default settings for the field.

Request syntax

UPDATE /api/admin/customFieldSettings/customFields/fieldDefaults/{defaultsID}?{fields}

Request parameters

Parameter

Type

Description

fields

string

A list of CustomFieldDefaults attributes that should be returned in the response. If no field is specified, only the entityID is returned.

Last modified: 12 April 2019