Поделиться через

Teamsettings - Update

  • Ссылка
Service:
Work
API Version:
7.1-preview.1

Обновление параметров команды

PATCH https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings?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.

Текст запроса

Имя Тип Описание
backlogIteration

string

backlogVisibilities

object

bugsBehavior

BugsBehavior

defaultIteration

string

defaultIterationMacro

string

workingDays

DayOfWeek[]

Ответы

Имя Тип Описание
200 OK

TeamSetting

успешная операция

Безопасность

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 settings. Example 1
Update team settings. Example 2

Update team settings. Example 1

Sample Request

PATCH https://dev.azure.com/fabrikam/fabrikam-fiber/_apis/work/teamsettings?api-version=7.1-preview.1

{
  "bugsBehavior": "AsTasks",
  "workingDays": [
    "monday",
    "tuesday",
    "wednesday",
    "thursday"
  ],
  "defaultIteration": "8C2457E8-8936-4CDC-B3AA-17B20F56C76C"
}

Sample Response

Status code:
200 
{
  "backlogIteration": {
    "id": "323b04b6-2fb8-4093-94f4-fbe3bd36a19f",
    "name": "Iteration",
    "path": "",
    "url": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/_apis/wit/classificationNodes/Iterations"
  },
  "bugsBehavior": "asTasks",
  "workingDays": [
    "monday",
    "tuesday",
    "wednesday",
    "thursday"
  ],
  "backlogVisibilities": {
    "Microsoft.EpicCategory": false,
    "Microsoft.FeatureCategory": true,
    "Microsoft.RequirementCategory": true
  },
  "defaultIteration": {
    "id": "8c2457e8-8936-4cdc-b3aa-17b20f56c76c",
    "name": "Iteration 3",
    "path": "\\Iteration 3",
    "url": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/_apis/wit/classificationNodes/Iterations/Iteration%203"
  },
  "defaultIterationMacro": null,
  "url": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/3e9700ae-46cb-4ee3-ad77-3a1b1ae99572/_apis/work/teamsettings",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/3e9700ae-46cb-4ee3-ad77-3a1b1ae99572/_apis/work/teamsettings"
    },
    "project": {
      "href": "https://dev.azure.com/fabrikam/_apis/projects/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb"
    },
    "team": {
      "href": "https://dev.azure.com/fabrikam/_apis/projects/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/teams/3e9700ae-46cb-4ee3-ad77-3a1b1ae99572"
    },
    "teamIterations": {
      "href": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/3e9700ae-46cb-4ee3-ad77-3a1b1ae99572/_apis/work/teamsettings/iterations"
    },
    "teamFieldValues": {
      "href": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/3e9700ae-46cb-4ee3-ad77-3a1b1ae99572/_apis/work/teamsettings/teamfieldvalues"
    },
    "classificationNode": [
      {
        "href": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/_apis/wit/classificationNodes/Iterations"
      },
      {
        "href": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/_apis/wit/classificationNodes/Iterations/Iteration%203"
      }
    ]
  }
}

Update team settings. Example 2

Sample Request

PATCH https://dev.azure.com/fabrikam/fabrikam-fiber/_apis/work/teamsettings?api-version=7.1-preview.1

{
  "bugsBehavior": "AsRequirements",
  "workingDays": [
    "monday",
    "tuesday",
    "wednesday",
    "thursday",
    "friday"
  ],
  "defaultIterationMacro": "@CurrentIteration"
}

Sample Response

Status code:
200 
{
  "backlogIteration": {
    "id": "323b04b6-2fb8-4093-94f4-fbe3bd36a19f",
    "name": "Iteration",
    "path": "",
    "url": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/_apis/wit/classificationNodes/Iterations"
  },
  "bugsBehavior": "asRequirements",
  "workingDays": [
    "monday",
    "tuesday",
    "wednesday",
    "thursday",
    "friday"
  ],
  "backlogVisibilities": {
    "Microsoft.EpicCategory": false,
    "Microsoft.FeatureCategory": true,
    "Microsoft.RequirementCategory": true
  },
  "defaultIteration": {
    "id": "a912d62f-3eba-44b9-ab54-aa82af94b1d7",
    "name": "Iteration 1",
    "path": "\\Iteration 1",
    "url": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/_apis/wit/classificationNodes/Iterations/Iteration%201"
  },
  "defaultIterationMacro": "@currentIteration",
  "url": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/3e9700ae-46cb-4ee3-ad77-3a1b1ae99572/_apis/work/teamsettings",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/3e9700ae-46cb-4ee3-ad77-3a1b1ae99572/_apis/work/teamsettings"
    },
    "project": {
      "href": "https://dev.azure.com/fabrikam/_apis/projects/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb"
    },
    "team": {
      "href": "https://dev.azure.com/fabrikam/_apis/projects/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/teams/3e9700ae-46cb-4ee3-ad77-3a1b1ae99572"
    },
    "teamIterations": {
      "href": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/3e9700ae-46cb-4ee3-ad77-3a1b1ae99572/_apis/work/teamsettings/iterations"
    },
    "teamFieldValues": {
      "href": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/3e9700ae-46cb-4ee3-ad77-3a1b1ae99572/_apis/work/teamsettings/teamfieldvalues"
    },
    "classificationNode": [
      {
        "href": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/_apis/wit/classificationNodes/Iterations"
      },
      {
        "href": "https://dev.azure.com/fabrikam/c1f04a4e-c4e5-4e0d-8096-e5f9fd214bfb/_apis/wit/classificationNodes/Iterations/Iteration%201"
      }
    ]
  }
}

Определения

Имя Описание
BugsBehavior

Поведение ошибок
DayOfWeek

Дни, когда команда работает
ReferenceLinks

Класс, представляющий коллекцию ссылок REST.
TeamIterationAttributes
TeamSetting

Контракт данных для TeamSettings
TeamSettingsIteration

Представляет неглубокий ссылочный элемент для одной итерации.
TeamSettingsPatch

Контракт данных для того, что мы ожидаем получить при исправлении
TimeFrame

Временной интервал итерации, например прошлый, текущий или будущий.

BugsBehavior

Поведение ошибок

Имя Тип Описание
asRequirements

string

asTasks

string

off

string

DayOfWeek

Дни, когда команда работает

Имя Тип Описание
friday

string

monday

string

saturday

string

sunday

string

thursday

string

tuesday

string

wednesday

string

Класс, представляющий коллекцию ссылок REST.

Имя Тип Описание
links

object

Представление ссылок только для чтения. Так как ссылочные ссылки доступны только для чтения, мы хотим предоставить их только для чтения.

TeamIterationAttributes

Имя Тип Описание
finishDate

string

Дата окончания итерации. Только дата, исправление без корректировки в полночь в формате UTC.
startDate

string

Дата начала итерации. Только дата, исправление без корректировки в полночь в формате UTC.
timeFrame

TimeFrame

Временной интервал итерации, например прошлый, текущий или будущий.

TeamSetting

Контракт данных для TeamSettings

Имя Тип Описание
_links

ReferenceLinks

Коллекция ссылок, относящихся к ресурсу
backlogIteration

TeamSettingsIteration

Итерация невыполненной работы
backlogVisibilities

object

Сведения о категориях, которые отображаются в невыполненной работы.
bugsBehavior

BugsBehavior

BugsBehavior (Off, AsTasks, AsRequirements, ...)
defaultIteration

TeamSettingsIteration

Итерация по умолчанию— итерация, используемая при создании нового рабочего элемента на странице запросов.
defaultIterationMacro

string

Макрос итерации по умолчанию (при наличии)
url

string

Полная ссылка http на ресурс
workingDays

DayOfWeek[]

Дни, когда команда работает

TeamSettingsIteration

Представляет неглубокий ссылочный элемент для одной итерации.

Имя Тип Описание
_links

ReferenceLinks

Коллекция ссылок, относящихся к ресурсу
attributes

TeamIterationAttributes

Атрибуты итерации, такие как дата начала и окончания.
id

string

Идентификатор итерации.
name

string

Имя итерации.
path

string

Относительный путь итерации.
url

string

Полная ссылка http на ресурс

TeamSettingsPatch

Контракт данных для того, что мы ожидаем получить при исправлении

Имя Тип Описание
backlogIteration

string

backlogVisibilities

object

bugsBehavior

BugsBehavior

defaultIteration

string

defaultIterationMacro

string

workingDays

DayOfWeek[]

TimeFrame

Временной интервал итерации, например прошлый, текущий или будущий.

Имя Тип Описание
current

string

future

string

past

string