YouTrack Standalone 2019.1 Help

Saved Queries

Resource

/api/savedQueries

Returned entity

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

Supported methods

SavedQuery attributes

Represents saved query.

Extends WatchFolder

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

query

String

Query that is saved in this search. Can be null.

issues

Array of Issues

Issues that match this search. Read-only.

Read a List of SavedQueries

Get all searches visible to current user.

Request syntax

GET /api/savedQueries?{fields}&{$top}&{$skip}

Request parameters

Parameter

Type

Description

fields

string

A list of SavedQuery 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.

Add a New SavedQuery

Creates new saved query. Name and query must be provided.

Request syntax

POST /api/savedQueries?{fields}

Request parameters

Parameter

Type

Description

fields

string

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

Last modified: 8 July 2019