YouTrack InCloud 2018.3 Help

GET Project Custom Field

GET /admin/project/{projectId}/customfield/{customFieldName}

Get a project's custom field by its name.

GET /rest/admin/project/{projectId}/customfield/{customFieldName}

Request parameters:

Name

Type

Description

projectId

projectByIdNotStrict

ID of a project.

customFieldName

string

Name of a custom field to get.

Response parameters:

Name

Description

name

Name of project custom field.

type

Type of this custom field.

canBeEmpty

Mandatory binary parameter defining if the field can have empty value or not.

emptyText

Text that is shown when the custom field has no value.

param

Additional parameter of custom field. For example, a bundle that is attached with custom field.

Samples

Request

GET /rest/admin/project/{projID}/customfield/State

Response

<projectCustomField name="State" type="state[1]" emptyText="No State" canBeEmpty="false"> <defaultValue>Submitted</defaultValue> </projectCustomField>

Please note, that in some cases issue fields might have several default values:

<projectCustomField name="FixVersions" type="version[*]" emptyText="Unscheduled" canBeEmpty="true"> <defaultValue>22</defaultValue> <defaultValue>34</defaultValue> <defaultValue>ww</defaultValue> </projectCustomField>
Last modified: 12 October 2018