YouTrack InCloud 2019.2 Help

Operations with Specific UserBundle

This resource lets you work with the sets of users in YouTrack.

Resource

/api/admin/customFieldSettings/bundles/user/{bundleID}

Returned entity

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

Supported methods

UserBundle attributes

Represents a set of values that contains users. You can add to the set both individual user accounts and groups of users.

Extends Bundle

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

groups

Array of UserGroups

User groups that belong to this bundle.

individuals

Array of Users

Individual users that belong to this bundle.

aggregatedUsers

Array of Users

All users that belong to this bundle. Read-only.

isUpdateable

Boolean

If true, then the currently logged-in user can update this bundle. Otherwise, false. Read-only.

Read a Specific UserBundle

Get the set of users with the specific ID.

Request syntax

GET /api/admin/customFieldSettings/bundles/user/{bundleID}?{fields}

{bundleID}

Database ID of the bundle.

Request parameters

Parameter

Type

Description

fields

String

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

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/admin/customFieldSettings/bundles/user/8-20?fields=name,id,isUpdateable,individuals(login,id,name),groups(name,id),aggregatedUsers(name,id,login)

Sample response body

{ "groups": [], "aggregatedUsers": [ { "login": "john.doe", "name": "John Doe", "id": "1-2", "$type": "User" }, { "login": "jane.doe", "name": "Jane Doe", "id": "1-3", "$type": "User" }, { "login": "Jane_Smith", "name": "Jane Smith", "id": "1-4", "$type": "User" } ], "individuals": [ { "login": "john.doe", "name": "John Doe", "id": "1-2", "$type": "User" }, { "login": "jane.doe", "name": "Jane Doe", "id": "1-3", "$type": "User" }, { "login": "Jane_Smith", "name": "Jane Smith", "id": "1-4", "$type": "User" } ], "isUpdateable": true, "name": "Hero-team", "id": "8-20", "$type": "UserBundle" }

Update a Specific UserBundle

Change the set of users with the specific ID.

Request syntax

POST /api/admin/customFieldSettings/bundles/user/{bundleID}?{fields}

{bundleID}

Database ID of the bundle.

Request parameters

Parameter

Type

Description

fields

String

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

Sample

Let's add a group of users to the specific set if users, and change the name of this set to 'Heroes'.

Sample request URI

https://example.myjetbrains.com/youtrack/api/admin/customFieldSettings/bundles/user/8-20?fields=id,name,aggregatedUsers(id,login),groups(name,id)

Sample request body

{ "groups": [ { "id": "3-2" } ], "name": "Heroes", "isUpdateable": true }

Sample response body

{ "groups": [ { "name": "Sample Project Team", "id": "3-2", "$type": "UserGroup" } ], "aggregatedUsers": [ { "login": "root", "id": "1-1", "$type": "User" }, { "login": "john.doe", "id": "1-2", "$type": "User" }, { "login": "jane.doe", "id": "1-3", "$type": "User" }, { "login": "Jane_Smith", "id": "1-4", "$type": "User" } ], "name": "Heroes", "id": "8-20", "$type": "UserBundle" }

Delete a Specific UserBundle

Delete the set of users with the specific ID.

Request syntax

DELETE /api/admin/customFieldSettings/bundles/user/{bundleID}

{bundleID}

Database ID of the bundle.

Request parameters

Parameter

Type

Description

fields

String

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

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/admin/customFieldSettings/bundles/user/8-18
Last modified: 22 October 2019