Teamfieldvalues - Update
Обновление значений полей команды
PATCH https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/teamfieldvalues?api-version=7.1-preview.1
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
organization
|
path | True |
string |
Название организации Azure DevOps. |
project
|
path | True |
string |
Идентификатор проекта или имя проекта |
team
|
path |
string |
Идентификатор или имя команды |
|
api-version
|
query | True |
string |
Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.1. |
Текст запроса
Имя | Тип | Описание |
---|---|---|
defaultValue |
string |
|
values |
Представляет одно значение TeamFieldValue. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
успешная операция |
Безопасность
oauth2
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL:
https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
Scopes
Имя | Описание |
---|---|
vso.work_write | Предоставляет возможность считывать, создавать и обновлять рабочие элементы и запросы, обновлять метаданные доски, пути чтения областей и итераций, другие метаданные, связанные с отслеживанием рабочих элементов, выполнять запросы и получать уведомления о событиях рабочих элементов с помощью перехватчиков служб. |
Примеры
Update team field values. Example 1 |
Update team field values. Example 2 |
Update team field values. Example 1
Sample Request
PATCH https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/work/teamsettings/teamfieldvalues?api-version=7.1-preview.1
{
"defaultValue": "Fabrikam-Fiber\\Auto",
"values": [
{
"value": "Fabrikam-Fiber\\Auto",
"includeChildren": true
},
{
"value": "Fabrikam-Fiber\\Fiber",
"includeChildren": false
},
{
"value": "Fabrikam-Fiber\\Optics",
"includeChildren": false
}
]
}
Sample Response
{
"field": {
"referenceName": "System.AreaPath",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.AreaPath"
},
"defaultValue": "Fabrikam-Fiber\\Auto",
"values": [
{
"value": "Fabrikam-Fiber\\Auto",
"includeChildren": true
},
{
"value": "Fabrikam-Fiber\\Fiber",
"includeChildren": false
},
{
"value": "Fabrikam-Fiber\\Optics",
"includeChildren": false
}
],
"url": "https://dev.azure.com/fabrikam/6d823a47-2d51-4f31-acff-74927f88ee1e/748b18b6-4b3c-425a-bcae-ff9b3e703012/_apis/work/teamsettings/teamfieldvalues",
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/6d823a47-2d51-4f31-acff-74927f88ee1e/748b18b6-4b3c-425a-bcae-ff9b3e703012/_apis/work/teamsettings/teamfieldvalues"
},
"project": {
"href": "https://dev.azure.com/fabrikam/_apis/projects/6d823a47-2d51-4f31-acff-74927f88ee1e"
},
"team": {
"href": "https://dev.azure.com/fabrikam/_apis/projects/6d823a47-2d51-4f31-acff-74927f88ee1e/teams/748b18b6-4b3c-425a-bcae-ff9b3e703012"
},
"teamSettings": {
"href": "https://dev.azure.com/fabrikam/6d823a47-2d51-4f31-acff-74927f88ee1e/748b18b6-4b3c-425a-bcae-ff9b3e703012/_apis/work/teamsettings"
},
"areaPathClassificationNodes": {
"href": "https://dev.azure.com/fabrikam/6d823a47-2d51-4f31-acff-74927f88ee1e/_apis/wit/classificationNodes/Areas"
}
}
}
Update team field values. Example 2
Sample Request
PATCH https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/work/teamsettings/teamfieldvalues?api-version=7.1-preview.1
{
"defaultValue": "Fabrikam-Fiber\\Auto",
"values": [
{
"value": "Fabrikam-Fiber\\Auto",
"includeChildren": false
},
{
"value": "Fabrikam-Fiber\\Fiber",
"includeChildren": false
},
{
"value": "Fabrikam-Fiber\\Optics",
"includeChildren": false
}
]
}
Sample Response
{
"field": {
"referenceName": "System.AreaPath",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.AreaPath"
},
"defaultValue": "Fabrikam-Fiber\\Auto",
"values": [
{
"value": "Fabrikam-Fiber\\Auto",
"includeChildren": false
},
{
"value": "Fabrikam-Fiber\\Fiber",
"includeChildren": false
},
{
"value": "Fabrikam-Fiber\\Optics",
"includeChildren": false
}
],
"url": "https://dev.azure.com/fabrikam/6d823a47-2d51-4f31-acff-74927f88ee1e/748b18b6-4b3c-425a-bcae-ff9b3e703012/_apis/work/teamsettings/teamfieldvalues",
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/6d823a47-2d51-4f31-acff-74927f88ee1e/748b18b6-4b3c-425a-bcae-ff9b3e703012/_apis/work/teamsettings/teamfieldvalues"
},
"project": {
"href": "https://dev.azure.com/fabrikam/_apis/projects/6d823a47-2d51-4f31-acff-74927f88ee1e"
},
"team": {
"href": "https://dev.azure.com/fabrikam/_apis/projects/6d823a47-2d51-4f31-acff-74927f88ee1e/teams/748b18b6-4b3c-425a-bcae-ff9b3e703012"
},
"teamSettings": {
"href": "https://dev.azure.com/fabrikam/6d823a47-2d51-4f31-acff-74927f88ee1e/748b18b6-4b3c-425a-bcae-ff9b3e703012/_apis/work/teamsettings"
},
"areaPathClassificationNodes": {
"href": "https://dev.azure.com/fabrikam/6d823a47-2d51-4f31-acff-74927f88ee1e/_apis/wit/classificationNodes/Areas"
}
}
}
Определения
Имя | Описание |
---|---|
Field |
Абстрактная ссылка на поле |
Reference |
Класс, представляющий коллекцию ссылок REST. |
Team |
Представляет одно значение TeamFieldValue. |
Team |
По сути, коллекция значений полей команды |
Team |
Ожидаемые данные из PATCH |
FieldReference
Абстрактная ссылка на поле
Имя | Тип | Описание |
---|---|---|
referenceName |
string |
fieldRefName для поля |
url |
string |
Полная ссылка http для получения дополнительных сведений о поле |
ReferenceLinks
Класс, представляющий коллекцию ссылок REST.
Имя | Тип | Описание |
---|---|---|
links |
object |
Представление ссылок только для чтения. Так как ссылочные ссылки доступны только для чтения, мы хотим предоставить их только для чтения. |
TeamFieldValue
Представляет одно значение TeamFieldValue.
Имя | Тип | Описание |
---|---|---|
includeChildren |
boolean |
|
value |
string |
TeamFieldValues
По сути, коллекция значений полей команды
Имя | Тип | Описание |
---|---|---|
_links |
Коллекция ссылок, относящихся к ресурсу |
|
defaultValue |
string |
Значение поля команды по умолчанию |
field |
Неглубокая ссылка на поле, используемое в качестве поля команды |
|
url |
string |
Полная ссылка http на ресурс |
values |
Коллекция всех допустимых значений полей команды |
TeamFieldValuesPatch
Ожидаемые данные из PATCH
Имя | Тип | Описание |
---|---|---|
defaultValue |
string |
|
values |
Представляет одно значение TeamFieldValue. |