Udostępnij za pośrednictwem


Fields - Update

Zaktualizuj pole.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
fieldNameOrRefName
path True

string

Nazwa/nazwa odwołania pola do zaktualizowania

organization
path True

string

Nazwa organizacji usługi Azure DevOps.

project
path

string

Identyfikator projektu lub nazwa projektu

api-version
query True

string

Wersja interfejsu API do użycia. Powinno to być ustawione na wartość "7.1-preview.3", aby używać tej wersji interfejsu API.

Treść żądania

Nazwa Typ Opis
isDeleted

boolean

Wskazuje, czy użytkownik chce przywrócić pole.

isLocked

boolean

Wskazuje, czy użytkownik chce zablokować pole.

Odpowiedzi

Nazwa Typ Opis
200 OK

WorkItemField2

operacja zakończona powodzeniem

Zabezpieczenia

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

Nazwa Opis
vso.work_write Umożliwia odczytywanie, tworzenie i aktualizowanie elementów roboczych i zapytań, metadanych tablicy aktualizacji, ścieżek obszaru odczytu i iteracji innych metadanych powiązanych elementów roboczych, wykonywania zapytań i odbierania powiadomień o zdarzeniach elementów roboczych za pośrednictwem punktów zaczepienia usługi.

Przykłady

Set field locked
Undelete a field

Set field locked

Sample Request

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

{
  "isLocked": true
}

Sample Response

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

Sample Request

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

{
  "isDeleted": false
}

Sample Response

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

Definicje

Nazwa Opis
FieldType

Typ pola.

FieldUpdate

Opisuje żądanie aktualizacji pola elementu roboczego.

FieldUsage

Użycie pola.

ReferenceLinks

Klasa reprezentująca kolekcję linków referencyjnych REST.

WorkItemField2

Opisuje pole elementu roboczego i właściwości specyficzne dla tego typu elementu roboczego.

WorkItemFieldOperation

Opisuje operację pola elementu roboczego.

FieldType

Typ pola.

Nazwa Typ Opis
boolean

string

Typ pola logicznego.

dateTime

string

Typ pola Data/godzina.

double

string

Typ podwójnego pola.

guid

string

Typ pola Guid.

history

string

Typ pola Historia.

html

string

Typ pola HTML (wielowierszowy).

identity

string

Typ pola Tożsamość.

integer

string

Typ pola Liczba całkowita.

picklistDouble

string

Podwójny typ pola listy wyboru. Podczas tworzenia pola podwójnej listy wyboru z interfejsu API REST użyj wartości "Double" FieldType.

picklistInteger

string

Typ pola Listy wyboru liczby całkowitej. Podczas tworzenia pola listy wyboru liczb całkowitych z interfejsu API REST użyj pola "Liczba całkowita" FieldType.

picklistString

string

Typ pola listy wyboru ciągu. Podczas tworzenia pola listy wyboru ciągów z interfejsu API REST użyj pola "String" FieldType.

plainText

string

Typ pola zwykłego tekstu.

string

string

Typ pola ciągu.

treePath

string

Typ pola Ścieżka drzewa.

FieldUpdate

Opisuje żądanie aktualizacji pola elementu roboczego.

Nazwa Typ Opis
isDeleted

boolean

Wskazuje, czy użytkownik chce przywrócić pole.

isLocked

boolean

Wskazuje, czy użytkownik chce zablokować pole.

FieldUsage

Użycie pola.

Nazwa Typ Opis
none

string

Puste użycie.

tree

string

Użycie pola węzła drzewa.

workItem

string

Użycie pola elementu roboczego.

workItemLink

string

Użycie pola łącza elementu roboczego.

workItemTypeExtension

string

Użycie rozszerzenia typu elementu roboczego.

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwa Typ Opis
links

object

Czytelny widok linków. Ponieważ linki referencyjne są czytelne, chcemy uwidocznić je tylko jako tylko do odczytu.

WorkItemField2

Opisuje pole elementu roboczego i właściwości specyficzne dla tego typu elementu roboczego.

Nazwa Typ Opis
_links

ReferenceLinks

Połącz odwołania do powiązanych zasobów REST.

canSortBy

boolean

Wskazuje, czy pole można sortować w zapytaniach serwera.

description

string

Opis pola.

isDeleted

boolean

Wskazuje, czy to pole zostało usunięte.

isIdentity

boolean

Wskazuje, czy to pole jest polem tożsamości.

isLocked

boolean

Wskazuje, czy to pole jest oznaczone jako zablokowane do edycji.

isPicklist

boolean

Wskazuje, czy to wystąpienie jest listą wyboru.

isPicklistSuggested

boolean

Wskazuje, czy to wystąpienie jest sugerowaną listą wyboru .

isQueryable

boolean

Wskazuje, czy pole może być odpytywane na serwerze.

name

string

Nazwa pola.

picklistId

string

Jeśli to pole jest listą wyboru, identyfikator skojarzonej listy wyboru, w przeciwnym razie wartość null

readOnly

boolean

Wskazuje, czy pole jest [tylko do odczytu].

referenceName

string

Nazwa odwołania pola.

supportedOperations

WorkItemFieldOperation[]

Obsługiwane operacje w tym polu.

type

FieldType

Typ pola.

url

string

usage

FieldUsage

Użycie pola.

WorkItemFieldOperation

Opisuje operację pola elementu roboczego.

Nazwa Typ Opis
name

string

Przyjazna nazwa operacji.

referenceName

string

Nazwa odwołania operacji.