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

Fields - Get

  • Ссылка
Служба:
Work Item Tracking
Версия API:
7.1

Возвращает сведения о определенном поле.

GET https://dev.azure.com/{organization}/{project}/_apis/wit/fields/{fieldNameOrRefName}?api-version=7.1

Параметры URI

Имя В Обязательно Тип Описание
fieldNameOrRefName
 path True

string

Простое имя поля или имя ссылки
organization
 path True

string

Имя организации Azure DevOps.
project
 path

string

Идентификатор проекта или имя проекта
api-version
 query True

string

Используемая версия API. Для использования этой версии API необходимо задать значение "7.1".

Ответы

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

WorkItemField2

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

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

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 Предоставляет возможность считывать рабочие элементы, запросы, доски, области и пути итерации и другие связанные метаданные рабочих элементов. Кроме того, предоставляет возможность выполнять запросы, выполнять поиск рабочих элементов и получать уведомления о событиях рабочих элементов с помощью перехватчиков служб.

Примеры

Gets information on a specific field

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

GET https://dev.azure.com/fabrikam/_apis/wit/fields/{fieldNameOrRefName}?api-version=7.1

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

Код состояния:
200 
{
  "name": "Iteration Path",
  "referenceName": "System.IterationPath",
  "type": "treePath",
  "readOnly": true,
  "supportedOperations": [
    {
      "referenceName": "SupportedOperations.Under",
      "name": "Under"
    },
    {
      "referenceName": "SupportedOperations.NotUnder",
      "name": "Not Under"
    },
    {
      "referenceName": "SupportedOperations.Equals",
      "name": "="
    },
    {
      "referenceName": "SupportedOperations.NotEquals",
      "name": "<>"
    },
    {
      "referenceName": "SupportedOperations.In",
      "name": "In"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.IterationPath"
}

Определения

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

Тип поля.
FieldUsage

Использование поля.
ReferenceLinks

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

Описывает поле для рабочего элемента и свойства, относящиеся к этому типу рабочего элемента.
WorkItemFieldOperation

Описывает операцию поля рабочего элемента.

FieldType

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

Тип поля.

Значение Описание
boolean

Логический тип поля.
dateTime

Тип поля Datetime.
double

Тип двойного поля.
guid

Тип поля Guid.
history

Тип поля журнала.
html

Тип поля HTML (Multiline).
identity

Тип поля удостоверения.
integer

Тип целочисленного поля.
picklistDouble

Тип поля двойного выбора. При создании поля двойного списка выбора из REST API используйте FieldType double.
picklistInteger

Тип поля целочисленного списка выбора. При создании целочисленного поля списка выбора из REST API используйте FieldType "Целочисленное".
picklistString

Тип поля выбора строк. При создании поля списка строк из REST API используйте FieldType "String".
plainText

Тип обычного текстового поля.
string

Тип строкового поля.
treePath

Тип поля Treepath.

FieldUsage

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

Использование поля.

Значение Описание
none

Пустое использование.
tree

Использование поля Treenode.
workItem

Использование поля рабочего элемента.
workItemLink

Использование поля ссылки на рабочий элемент.
workItemTypeExtension

Использование расширения типа рабочего элемента.
Object

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

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

object

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

WorkItemField2

Object

Описывает поле для рабочего элемента и свойства, относящиеся к этому типу рабочего элемента.

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

ReferenceLinks

Ссылки на связанные ресурсы REST.
canSortBy

boolean

Указывает, можно ли сортировать поле в запросах сервера.
description

string

Описание поля.
isDeleted

boolean

Указывает, удаляется ли это поле.
isIdentity

boolean

Указывает, является ли это поле полем удостоверения.
isLocked

boolean

Указывает, помечено ли это поле как заблокировано для редактирования.
isPicklist

boolean

Указывает, является ли этот экземпляр списком выбора.
isPicklistSuggested

boolean

Указывает, является ли этот экземпляр предлагаемым списком выбора.
isQueryable

boolean

Указывает, может ли поле запрашиваться на сервере.
name

string

Имя поля.
picklistId

string (uuid)

Если это поле является списком выбора, идентификатор связанного списка выбора, в противном случае — null.
readOnly

boolean

Указывает, является ли поле [только для чтения].
referenceName

string

Имя ссылки поля.
supportedOperations

WorkItemFieldOperation[]

Поддерживаемые операции с этим полем.
type

FieldType

Тип поля.
url

string

usage

FieldUsage

Использование поля.

WorkItemFieldOperation

Object

Описывает операцию поля рабочего элемента.

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

string

Понятное имя операции.
referenceName

string

Имя операции.