YouTrack Standalone 2019.2 Help

Operations with Specific SavedQuery

This resource lets you work with saved searches that belong to specific user.

Resource

/api/admin/customFieldSettings/bundles/user/{bundleID}/individuals/{userID}/savedQueries/{queryID}

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 Specific SavedQuery

Get the saved search with the specific ID that belongs to the specific user.

Request syntax

GET /api/admin/customFieldSettings/bundles/user/{bundleID}/individuals/{userID}/savedQueries/{queryID}?{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

Update a Specific SavedQuery

Update the saved search with the specific ID that belongs to the specific user.

Request syntax

POST /api/admin/customFieldSettings/bundles/user/{bundleID}/individuals/{userID}/savedQueries/{queryID}?{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

Delete a Specific SavedQuery

Delete the saved search with the specific ID that belongs to the specific user.

Request syntax

DELETE /api/admin/customFieldSettings/bundles/user/{bundleID}/individuals/{userID}/savedQueries/{queryID}

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: 20 August 2019