Operations with Specific ProjectTeam
This resource lets you read and update the project team.
Resource | /api/admin/projects/{projectID}/team |
|---|---|
Returned entity | ProjectTeam. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
ProjectTeam attributes
User group representing all members of the project team.
Extends UserGroup
Attributes
This table describes attributes of the ProjectTeam entity.
To receive an attribute in the response from the server, specify it explicitly in the
fieldsrequest parameter.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
|---|---|---|
project | The project that the team belongs to. | |
users | All users in the project team, including users from groups added to the team. | |
ownUsers | Users added to the project team directly. | |
groups | Groups added to the project team. | |
id | String | The ID of the user group. |
name | String | The name of the group. |
ringId | String | ID of the group in Hub. Use this ID for operations in Hub, and for matching groups between YouTrack and Hub. |
usersCount | Long | The number of users in the group. |
icon | String | The URL of the group logo. |
allUsersGroup | Boolean | True if this group contains all users, otherwise false. |
Read a Specific ProjectTeam
Read the project team.
Required permissions
Requires permissions: Read Project Basic.
Request syntax
null | The database ID of ProjectTeam |
|---|
Request parameters
Parameter | Type | Description |
|---|---|---|
fields | String | A list of ProjectTeam attributes that should be returned in the response. If no field is specified, only the |
Sample
Sample request
Sample response body
Update a Specific ProjectTeam
Update the users and groups that are added to the project team directly.
Required permissions
Requires permissions: Update Project.
Request syntax
null | The database ID of ProjectTeam |
|---|
Request parameters
Parameter | Type | Description |
|---|---|---|
fields | String | A list of ProjectTeam attributes that should be returned in the response. If no field is specified, only the |