YouTrack InCloud 2019.2 Help

Owned Bundles

This resource provides operations with owned field bundles.

Resource

/api/admin/customFieldSettings/bundles/ownedField

Returned entity

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

Supported methods

OwnedBundle attributes

Represents a set of owned values in YouTrack.

Extends BaseBundle

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

values

Array of OwnedBundleElements

Owned values.

Read a List of OwnedBundles

Get a list of all available bundles of owned values.

Request syntax

GET /api/admin/customFieldSettings/bundles/ownedField?{fields}&{$top}&{$skip}

Request parameters

Parameter

Type

Description

fields

String

A list of OwnedBundle 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/customFieldSettings/bundles/ownedField?fields=id,name,values(owner(name,login,id),name,description)

Sample response body

[ { "values": [ { "owner": { "login": "john.doe", "name": "John Doe", "id": "1-2", "$type": "User" }, "description": null, "name": "Documentation", "$type": "OwnedBundleElement" } ], "name": "Sample Project: Subsystems", "id": "93-0", "$type": "OwnedBundle" }, { "values": [ { "owner": { "login": "jane.doe", "name": "Jane Doe", "id": "1-3", "$type": "User" }, "description": null, "name": "Documentation", "$type": "OwnedBundleElement" }, { "owner": { "login": "Jane_Smith", "name": "Jane Smith", "id": "1-4", "$type": "User" }, "description": null, "name": "Tests", "$type": "OwnedBundleElement" }, { "owner": { "login": "john.doe", "name": "John Doe", "id": "1-2", "$type": "User" }, "description": null, "name": "Core", "$type": "OwnedBundleElement" } ], "name": "Rest Api Project: Subsystems", "id": "93-2", "$type": "OwnedBundle" }, { "values": [], "name": "Sandbox: Subsystems", "id": "93-3", "$type": "OwnedBundle" }, { "values": [], "name": "Rest Project: Subsystems", "id": "93-6", "$type": "OwnedBundle" }, { "values": [], "name": "GRA Project: Subsystems", "id": "93-7", "$type": "OwnedBundle" } ]

Add a New OwnedBundle

Create a new bundle of owned values.

Request syntax

POST /api/admin/customFieldSettings/bundles/ownedField?{fields}

Request parameters

Parameter

Type

Description

fields

String

A list of OwnedBundle 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/ownedField?fields=id,name,values(owner(name,login,id),name,description)

Sample request body

{ "name" : "General Subsystems", "isUpdateable" : true, "values" : [ { "name" : "Documentation", "description" : "Docs and wording related issues" }, { "name" : "Core functionality" }, { "name" : "Testing" } ] }

Sample response body

{ "values": [ { "owner": null, "description": "Docs and wording related issues", "name": "Documentation", "$type": "OwnedBundleElement" }, { "owner": null, "description": null, "name": "Core functionality", "$type": "OwnedBundleElement" }, { "owner": null, "description": null, "name": "Testing", "$type": "OwnedBundleElement" } ], "name": "General Subsystems", "id": "93-10", "$type": "OwnedBundle" }
Last modified: 17 July 2019