Teamsettings - Get

Служба:

Work

Версия API:

7.1

Получение параметров команды

GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings?api-version=7.1

Параметры URI

Имя	В	Обязательно	Тип	Описание
organization	path	True	string	Имя организации Azure DevOps.
project	path	True	string	Идентификатор проекта или имя проекта
team	path		string	Идентификатор команды или имя команды
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение "7.1".

Ответы

Имя	Тип	Описание
200 OK	TeamSetting	успешная операция

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

oauth2

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
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

Области

Имя	Описание
vso.work	Предоставляет возможность считывать рабочие элементы, запросы, доски, области и пути итерации и другие связанные метаданные рабочих элементов. Кроме того, предоставляет возможность выполнять запросы, выполнять поиск рабочих элементов и получать уведомления о событиях рабочих элементов с помощью перехватчиков служб.

Примеры

Get team settings for a team

Образец запроса

HTTP

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

Пример ответа

Код состояния:

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	Представляет мелкое ссылка для одной итерации.
TimeFrame	Период времени итерации, например прошлого, текущего или будущего.

BugsBehavior

Перечисление

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

Значение	Описание
asRequirements
asTasks
off

DayOfWeek

Перечисление

Дни работы команды

Значение	Описание
friday
monday
saturday
sunday
thursday
tuesday
wednesday

ReferenceLinks

Object

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

Имя	Тип	Описание
links	object	Режим чтения ссылок. Так как ссылки ссылки доступны только для чтения, мы хотим предоставлять их только как доступные только для чтения.

TeamIterationAttributes

Object

Имя	Тип	Описание
finishDate	string (date-time)	Дата окончания итерации. Только дата, исправлена в полночь в формате UTC.
startDate	string (date-time)	Дата начала итерации. Только дата, исправлена в полночь в формате UTC.
timeFrame	TimeFrame	Период времени итерации, например прошлого, текущего или будущего.

TeamSetting

Object

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

Имя	Тип	Описание
_links	ReferenceLinks	Коллекция ссылок, относящихся к ресурсу
backlogIteration	TeamSettingsIteration	Невыполненная итерация
backlogVisibilities	object	Сведения о категориях, видимых в невыполненной работы.
bugsBehavior	BugsBehavior	BugsBehavior (Off, AsTasks, AsRequirements, ...)
defaultIteration	TeamSettingsIteration	Итерация по умолчанию, итерация, используемая при создании нового рабочего элемента на странице запросов.
defaultIterationMacro	string	Макрос итерации по умолчанию (если таковой есть)
url	string	Полная ссылка http на ресурс
workingDays	DayOfWeek[]	Дни работы команды

TeamSettingsIteration

Object

Представляет мелкое ссылка для одной итерации.

Имя	Тип	Описание
_links	ReferenceLinks	Коллекция ссылок, относящихся к ресурсу
attributes	TeamIterationAttributes	Атрибуты итерации, такие как дата начала и окончания.
id	string (uuid)	Идентификатор итерации.
name	string	Имя итерации.
path	string	Относительный путь итерации.
url	string	Полная ссылка http на ресурс

TimeFrame

Перечисление

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

Значение	Описание
current
future
past