YouTrack InCloud 2018.3 Help

Fields Syntax

In YouTrack REST API, when you send an HTTP request to a resource, by default, the server sends back only the ID of the resource entity. To receive an attribute in the response from server, you must specify it explicitly in the fields parameter of a request.

Let's see how it works on a sample request for the current user account.

Samples

Request without Fields Parameter

Here we use a default request without providing the fields parameter.

Request

curl -X GET \ 'https://example.myjetbrains.com/youtrack/api/admin/users/me' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer perm:am9obi5kb2U=.UG9zdG1hbiBKb2huIERvZQ==.jJe0eYhhkV271j1lCpfknNYOEakNk7' \ -H 'Cache-Control: no-cache' \ -H 'Content-Type: application/json'

Response body

In response, the server sends the entity ID:

{ "id": "1-2" }

Request with Fields Parameter

Here we use the fields request parameter to specify explicitly which attributes of the entity should be returned in the response body: id, login, name, and email of the current user.

Request

curl -X GET \ 'https://example.myjetbrains.com/youtrack/api/admin/users/me?fields=id,login,name,email' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer perm:am9obi5kb2U=.UG9zdG1hbiBKb2huIERvZQ==.jJe0eYhhkV271j1lCpfknNYOEakNk7' \ -H 'Cache-Control: no-cache' \ -H 'Content-Type: application/json'

Response body

In response, the server sends the requested attributes:

{ "email": "john.doe@example.com", "login": "john.doe", "name": "John Doe", "id": "1-2" }
Last modified: 12 October 2018