Fields - Update

Ссылка

Служба:: Work Item Tracking

Версия API:: 7.1

Обновите поле.

PATCH 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".

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

Имя	Тип	Описание
isDeleted	boolean	Указывает, хочет ли пользователь восстановить поле.
isLocked	boolean	Указывает, хочет ли пользователь заблокировать поле.

Ответы

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

Имя

Описание

vso.work_write

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

Примеры

Set field locked

Undelete a field

Set field locked

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

HTTP

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

{
  "isLocked": true
}

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

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

persistent-Auth: true
lfs-Authenticate: NTLM
wwW-Authenticate: Negotiate oRswGaADCgEAoxIEEAEAAAAMDzOy0XQtlQAAAAA=

{
  "name": "New Work Item Field3",
  "referenceName": "Custom.TestField",
  "description": "New work item field for testing",
  "type": "string",
  "usage": "workItem",
  "readOnly": false,
  "canSortBy": true,
  "isQueryable": true,
  "supportedOperations": [
    {
      "referenceName": "SupportedOperations.Equals",
      "name": "="
    },
    {
      "referenceName": "SupportedOperations.NotEquals",
      "name": "<>"
    },
    {
      "referenceName": "SupportedOperations.GreaterThan",
      "name": ">"
    },
    {
      "referenceName": "SupportedOperations.LessThan",
      "name": "<"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanEquals",
      "name": ">="
    },
    {
      "referenceName": "SupportedOperations.LessThanEquals",
      "name": "<="
    },
    {
      "referenceName": "SupportedOperations.Contains",
      "name": "Contains"
    },
    {
      "referenceName": "SupportedOperations.NotContains",
      "name": "Does Not Contain"
    },
    {
      "referenceName": "SupportedOperations.In",
      "name": "In"
    },
    {
      "name": "Not In"
    },
    {
      "referenceName": "SupportedOperations.InGroup",
      "name": "In Group"
    },
    {
      "referenceName": "SupportedOperations.NotInGroup",
      "name": "Not In Group"
    },
    {
      "referenceName": "SupportedOperations.Ever",
      "name": "Was Ever"
    },
    {
      "referenceName": "SupportedOperations.EqualsField",
      "name": "= [Field]"
    },
    {
      "referenceName": "SupportedOperations.NotEqualsField",
      "name": "<> [Field]"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanField",
      "name": "> [Field]"
    },
    {
      "referenceName": "SupportedOperations.LessThanField",
      "name": "< [Field]"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanEqualsField",
      "name": ">= [Field]"
    },
    {
      "referenceName": "SupportedOperations.LessThanEqualsField",
      "name": "<= [Field]"
    }
  ],
  "isIdentity": false,
  "isPicklist": false,
  "isLocked": true,
  "isPicklistSuggested": false,
  "url": "http://localhost/DefaultCollection/_apis/wit/fields/Custom.TestField"
}

Undelete a field

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

HTTP

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

{
  "isDeleted": false
}

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

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

persistent-Auth: true
lfs-Authenticate: NTLM
wwW-Authenticate: Negotiate oRswGaADCgEAoxIEEAEAAAAMDzOy0XQtlQAAAAA=

{
  "name": "New Work Item Field3",
  "referenceName": "Custom.TestField",
  "description": "New work item field for testing",
  "type": "string",
  "usage": "workItem",
  "readOnly": false,
  "canSortBy": true,
  "isQueryable": true,
  "supportedOperations": [
    {
      "referenceName": "SupportedOperations.Equals",
      "name": "="
    },
    {
      "referenceName": "SupportedOperations.NotEquals",
      "name": "<>"
    },
    {
      "referenceName": "SupportedOperations.GreaterThan",
      "name": ">"
    },
    {
      "referenceName": "SupportedOperations.LessThan",
      "name": "<"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanEquals",
      "name": ">="
    },
    {
      "referenceName": "SupportedOperations.LessThanEquals",
      "name": "<="
    },
    {
      "referenceName": "SupportedOperations.Contains",
      "name": "Contains"
    },
    {
      "referenceName": "SupportedOperations.NotContains",
      "name": "Does Not Contain"
    },
    {
      "referenceName": "SupportedOperations.In",
      "name": "In"
    },
    {
      "name": "Not In"
    },
    {
      "referenceName": "SupportedOperations.InGroup",
      "name": "In Group"
    },
    {
      "referenceName": "SupportedOperations.NotInGroup",
      "name": "Not In Group"
    },
    {
      "referenceName": "SupportedOperations.Ever",
      "name": "Was Ever"
    },
    {
      "referenceName": "SupportedOperations.EqualsField",
      "name": "= [Field]"
    },
    {
      "referenceName": "SupportedOperations.NotEqualsField",
      "name": "<> [Field]"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanField",
      "name": "> [Field]"
    },
    {
      "referenceName": "SupportedOperations.LessThanField",
      "name": "< [Field]"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanEqualsField",
      "name": ">= [Field]"
    },
    {
      "referenceName": "SupportedOperations.LessThanEqualsField",
      "name": "<= [Field]"
    }
  ],
  "isIdentity": false,
  "isPicklist": false,
  "isPicklistSuggested": false,
  "url": "http://localhost/DefaultCollection/_apis/wit/fields/Custom.TestField"
}

Определения

Имя	Описание
FieldType	Тип поля.
FieldUpdate	Описывает запрос на обновление поля рабочего элемента.
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.

FieldUpdate

Object

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

Имя	Тип	Описание
isDeleted	boolean	Указывает, хочет ли пользователь восстановить поле.
isLocked	boolean	Указывает, хочет ли пользователь заблокировать поле.

FieldUsage

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

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

Значение	Описание
none	Пустое использование.
tree	Использование поля Treenode.
workItem	Использование поля рабочего элемента.
workItemLink	Использование поля ссылки на рабочий элемент.
workItemTypeExtension	Использование расширения типа рабочего элемента.

ReferenceLinks

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	Имя операции.

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

Fields - Update

Параметры URI

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

Ответы

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

oauth2

Области

Примеры

Set field locked

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

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

Undelete a field

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

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

Определения

FieldType

FieldUpdate

FieldUsage

ReferenceLinks

WorkItemField2

WorkItemFieldOperation

Дополнительные ресурсы