YouTrack Server
 
2019.2
Get YouTrack Standalone
You are viewing the documentation for an earlier version of YouTrack Server. View this page in the current documentation
  1. Resources for Developers
  2. REST API
  3. REST API Reference
  4. Resources
  5. Custom Fields
  6. Sub-resources
  7. Project Custom Fields

Project Custom Fields

Last modified: 17 December 2019

This resource lets you read a so called instances of the custom fields - settings of the custom field in each project that uses it.

Resource 

/api/admin/customFieldSettings/customFields/{fieldID}/instances

Returned entity

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

Supported methods

ProjectCustomField attributes

Represents custom field settings for the particular project.

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

field

CustomField

Custom field which project settings are described. Read-only. Can be null.

project

Project

Project to which custom field belongs. Read-only. Can be null.

canBeEmpty

Boolean

If true, this field can have empty value in the issue, otherwise false.

emptyFieldText

String

Text that is shown as a placeholder when field is empty. Can be null.

ordinal

Int

Number of this field in project.

isPublic

Boolean

If true, issue public read/update are sufficient for accessing this field, otherwise private read/update are required.

hasRunningJob

Boolean

true, if there is a background job running for this field. In this case, some field operations may be temporary inaccessible. Read-only.

Read a List of ProjectCustomFields

Get all project related settings of this custom field. Basically, this method lets you see in which projects this custom field is used.

Request syntax 

GET /api/admin/customFieldSettings/customFields/{fieldID}/instances?{fields}&{$top}&{$skip}

Request parameters

Parameter

Type

Description

fields

String

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

$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.

Sample

Sample request URI 

https://example.myjetbrains.com/youtrack/api/admin/customFieldSettings/customFields/58-8/instances?fields=field(name,id),project(id,name),canBeEmpty,emptyFieldText,isPublic,ordinal

Sample response body 

[
  {
    "emptyFieldText": "No due date",
    "project": {
      "name": "Sandbox",
      "id": "0-3",
      "$type": "Project"
    },
    "ordinal": 0,
    "canBeEmpty": true,
    "isPublic": true,
    "field": {
      "name": "Due Date",
      "id": "58-8",
      "$type": "CustomField"
    },
    "$type": "SimpleProjectCustomField"
  }
]