Fields - Update

Ссылка

Service:: Work Item Tracking

API Version:: 7.1-preview.3

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

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

Параметры URI

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

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

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

Ответы

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

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

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

Имя

Описание

vso.work_write

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

Примеры

Set field locked

Undelete a field

Set field locked

Sample Request

HTTP

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

{
  "isLocked": true
}

Sample Response

Status code:: 200

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

Response Body

{
  "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

Sample Request

HTTP

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

{
  "isDeleted": false
}

Sample Response

Status code:: 200

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

Response Body

{
  "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	string	Логический тип поля.
dateTime	string	Тип поля даты и времени.
double	string	Тип поля Double.
guid	string	Тип поля GUID.
history	string	Тип поля журнала.
html	string	Тип поля HTML (многостроковый).
identity	string	Тип поля удостоверения.
integer	string	Тип целочисленного поля.
picklistDouble	string	Тип поля double picklist. При создании поля двойного списка выбора из REST API используйте "Double" FieldType.
picklistInteger	string	Тип поля списка выбора целочисленного типа. При создании целочисленного поля списка выбора из REST API используйте "Integer" FieldType.
picklistString	string	Тип поля "Список выбора строк". При создании поля списка выбора строк из REST API используйте "String" FieldType.
plainText	string	Тип поля "Обычный текст".
string	string	Тип строкового поля.
treePath	string	Тип поля "Путь к дереву".

FieldUpdate

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

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

FieldUsage

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

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

ReferenceLinks

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

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

WorkItemField2

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

Имя	Тип	Описание
_links	ReferenceLinks	Ссылки на связанные ресурсы REST.
canSortBy	boolean	Указывает, можно ли сортировать поле в серверных запросах.
description	string	Описание поля.
isDeleted	boolean	Указывает, удаляется ли это поле.
isIdentity	boolean	Указывает, является ли это поле полем идентификатора.
isLocked	boolean	Указывает, помечается ли это поле как заблокированное для редактирования.
isPicklist	boolean	Указывает, является ли этот экземпляр списком выбора.
isPicklistSuggested	boolean	Указывает, является ли этот экземпляр предлагаемым списком выбора .
isQueryable	boolean	Указывает, можно ли запрашивать поле на сервере.
name	string	Имя поля.
picklistId	string	Если это поле является списком выбора, идентификатор связанного списка выбора; в противном случае — значение NULL.
readOnly	boolean	Указывает, является ли поле [только для чтения].
referenceName	string	Имя ссылки на поле.
supportedOperations	WorkItemFieldOperation[]	Поддерживаемые операции с этим полем.
type	FieldType	Тип поля.
url	string
usage	FieldUsage	Использование поля.

WorkItemFieldOperation

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

Имя	Тип	Описание
name	string	Понятное имя операции.
referenceName	string	Имя ссылки на операцию.

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

Fields - Update

Параметры URI

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

Ответы

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

oauth2

Scopes

Примеры

Set field locked

Sample Request

Sample Response

Undelete a field

Sample Request

Sample Response

Определения

FieldType

FieldUpdate

FieldUsage

ReferenceLinks

WorkItemField2

WorkItemFieldOperation

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