Operations with Specific OwnedBundle

This resource provides operations with owned field bundles.

Resource	/api/admin/customFieldSettings/bundles/ownedField/{bundleID}
Returned entity	OwnedBundle. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: Read a Specific OwnedBundle. `POST`: Update a Specific OwnedBundle. `DELETE`: Delete a Specific OwnedBundle.

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.
isUpdateable	Boolean	If `true`, then the currently logged-in user can update this bundle. Otherwise, `false`. `Read-only`.

Read a Specific OwnedBundle

Get a specific bundle of owned values.

Required permissions

Requires read or update access to one of the fields that use the bundle. If the bundle is not used in any field, Update Project permission is required in at least one project.

Request syntax

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

{bundleID}

The database ID of the bundle.

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/93-2?fields=id,name,values(owner(name,login,id),name,description)
            

Sample response body

                {
                  "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"
                }
            

Update a Specific OwnedBundle

Update a specific bundle of owned values.

Required permissions

Requires Project Update permission in all projects where the bundle is used. If the bundle is not used in any field, Update Project permission is required in at least one project.

Request syntax

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

{bundleID}

The database ID of the bundle.

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/93-2?fields=id,name,values(owner(name,login,id),name,description)
            

Sample request body

                {
                  "values": [
                    {
                      "owner": {
                        "id": "1-4",
                        "$type": "User"
                      },
                      "description": "Questions from users",
                      "name": "Support"
                    }
                  ]
                }
            

Sample response body

                {
                  "values": [
                    {
                      "owner": {
                        "login": "Jane_Smith",
                        "name": "Jane Smith",
                        "id": "1-4",
                        "$type": "User"
                      },
                      "description": "Questions from users",
                      "name": "Support",
                      "$type": "OwnedBundleElement"
                    }
                  ],
                  "name": "Rest Api Project: Subsystems",
                  "id": "93-2",
                  "$type": "OwnedBundle"
                }
            

Delete a Specific OwnedBundle

Delete a specific bundle of owned values.

Required permissions

Requires Project Update permission in all projects where the bundle is used. If the bundle is not used in any field, Update Project permission is required in at least one project.

Request syntax

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

{bundleID}

The database ID of the bundle.

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/93-13
            

Last modified: 17 December 2019