Fields - Get

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

GET https://{instance}/{collection}/{project}/_apis/wit/fields/{fieldNameOrRefName}?api-version=4.1

Параметры URI

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

string

Имя коллекции Team Foundation Server.

fieldNameOrRefName
path True

string

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

instance
path True

string

Имя сервера TFS ({server:port})

project
path

string

Идентификатор проекта или имя проекта

api-version
query True

string

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

Ответы

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

WorkItemField

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

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

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

Примеры

Sample Request

GET https://{instance}/{collection}/_apis/wit/fields/{fieldNameOrRefName}?api-version=4.1

Sample Response

{
  "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://fabrikam:8080/tfs/_apis/wit/fields/System.IterationPath"
}

Определения

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

Тип поля.

FieldUsage

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

ReferenceLinks

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

WorkItemField

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

WorkItemFieldOperation

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

FieldType

Тип поля.

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

string

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

dateTime

string

Тип поля даты и времени.

double

string

Тип поля Double.

guid

string

Тип поля GUID.

history

string

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

html

string

Тип поля HTML (многостроковый).

identity

string

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

integer

string

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

picklistDouble

string

Тип поля double picklist.

picklistInteger

string

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

picklistString

string

Тип поля "Список выбора строк".

plainText

string

Тип поля "Обычный текст".

string

string

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

treePath

string

Тип поля "Путь к дереву".

FieldUsage

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

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

string

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

tree

string

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

workItem

string

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

workItemLink

string

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

workItemTypeExtension

string

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

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

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

object

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

WorkItemField

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

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

ReferenceLinks

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

description

string

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

isIdentity

boolean

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

isPicklist

boolean

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

isPicklistSuggested

boolean

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

name

string

Имя поля.

readOnly

boolean

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

referenceName

string

Имя ссылки на поле.

supportedOperations

WorkItemFieldOperation[]

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

type

FieldType

Тип поля.

url

string

usage

FieldUsage

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

WorkItemFieldOperation

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

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

string

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

referenceName

string

Имя ссылки на операцию.