YouTrack InCloud 2019.2 Help

Saved Queries

This resource lets you get the list of saved searches that the specific user created.

Resource

/api/admin/users/{userID}/savedQueries

Returned entity

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

Supported methods

SavedQuery attributes

Represents a saved search.

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

The query that is saved in this search. Can be null.

issues

Array of Issues

The collection of issues that match this saved search. Read-only.

owner

User

A user who created — hence, owns — the watch folder. Read-only. Can be null.

visibleFor

UserGroup

Group of users that can see this watch folder. If the folder is visible only for its owner, this property is null. Can be null.

updateableBy

UserGroup

Group of users that can update this watch folder. If only the folder's owner can update it, this property is null. Can be null.

name

String

The name of the issue folder. Can be null.

Read a List of SavedQueries

Get the list of all saved searches that this user created.

Request syntax

GET /api/admin/users/{userID}/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.

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/admin/users/1-2/savedQueries?fields=query,id,name,visibleFor(id,name),isUpdateable,owner(id,name)&$top=3

Sample response body

[ { "query": "project: RAP #Unassigned", "visibleFor": null, "owner": { "name": "John Doe", "id": "1-2", "$type": "User" }, "name": "Unassigned in RAP", "id": "51-4", "$type": "SavedQuery" }, { "query": "project: RP #Unassigned", "visibleFor": null, "owner": { "name": "John Doe", "id": "1-2", "$type": "User" }, "name": "Unassigned in RP", "id": "51-7", "$type": "SavedQuery" }, { "query": "project: GRP #Unassigned", "visibleFor": null, "owner": { "name": "John Doe", "id": "1-2", "$type": "User" }, "name": "Unassigned in GRP", "id": "51-8", "$type": "SavedQuery" } ]
Last modified: 17 October 2019