Fields - Update

Reference

Service:: Work Item Tracking

API Version:: 7.1-preview.3

Aktualizace pole

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
fieldNameOrRefName	path	True	string	Název nebo název odkazu pole, které se má aktualizovat
organization	path	True	string	Název organizace Azure DevOps.
project	path		string	ID projektu nebo název projektu
api-version	query	True	string	Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavená na 7.1-preview.3.

Text požadavku

Name	Typ	Description
isDeleted	boolean	Určuje, jestli uživatel chce pole obnovit.
isLocked	boolean	Určuje, jestli uživatel chce pole uzamknout.

Odpovědi

Name	Typ	Description
200 OK	WorkItemField2	úspěšná operace

Zabezpečení

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

Name	Description
vso.work_write	Uděluje možnost číst, vytvářet a aktualizovat pracovní položky a dotazy, metadata aktualizačního panelu, oblast čtení a iterace cest k jiným metadatům souvisejícím se sledováním pracovních položek, spouštět dotazy a přijímat oznámení o událostech pracovních položek prostřednictvím zachytávání služeb.

Příklady

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

Definice

Name	Description
FieldType	Typ pole
FieldUpdate	Popisuje žádost o aktualizaci pro pole pracovní položky.
FieldUsage	Použití pole.
ReferenceLinks	Třída představující kolekci odkazů REST.
WorkItemField2	Popisuje pole u pracovní položky a jeho vlastnosti specifické pro daný typ pracovní položky.
WorkItemFieldOperation	Popisuje operaci pole pracovní položky.

FieldType

Typ pole

Name	Typ	Description
boolean	string	Typ pole typu logická hodnota
dateTime	string	Typ pole Datetime
double	string	Typ dvojitého pole.
guid	string	Typ pole Guid.
history	string	Typ pole Historie
html	string	Typ pole HTML (víceřádkový).
identity	string	Typ pole Identita.
integer	string	Typ pole Celé číslo.
picklistDouble	string	Typ pole dvojitého rozevíracího seznamu Při vytváření dvojitého rozevíracího seznamu pole z rozhraní REST API použijte Double FieldType.
picklistInteger	string	Typ pole rozevíracího seznamu celé číslo Při vytváření pole rozevíracího seznamu pro celé číslo z rozhraní REST API použijte typ pole Integer.
picklistString	string	Typ pole rozevíracího seznamu řetězců Při vytváření pole rozevíracího seznamu řetězců z rozhraní REST API použijte řetězec FieldType.
plainText	string	Typ pole ve formátu prostého textu
string	string	Typ pole Řetězec.
treePath	string	Typ pole Cesta stromové struktury.

FieldUpdate

Popisuje žádost o aktualizaci pro pole pracovní položky.

Name	Typ	Description
isDeleted	boolean	Určuje, jestli uživatel chce pole obnovit.
isLocked	boolean	Určuje, jestli uživatel chce pole uzamknout.

FieldUsage

Použití pole.

Name	Typ	Description
none	string	Prázdné využití.
tree	string	Využití pole TreeNode.
workItem	string	Využití pole pracovní položky
workItemLink	string	Použití pole propojení pracovní položky
workItemTypeExtension	string	Použití rozšíření typu pracovní položky

ReferenceLinks

Třída představující kolekci odkazů REST.

Name	Typ	Description
links	object	Zobrazení odkazů jen pro čtení. Vzhledem k tomu, že odkazy jsou jen pro čtení, chceme je zveřejnit jenom jako odkazy jen pro čtení.

WorkItemField2

Popisuje pole u pracovní položky a jeho vlastnosti specifické pro daný typ pracovní položky.

Name	Typ	Description
_links	ReferenceLinks	Odkazy na související prostředky REST.
canSortBy	boolean	Určuje, jestli je pole možné seřadit v serverových dotazech.
description	string	Popis pole
isDeleted	boolean	Určuje, zda je toto pole odstraněno.
isIdentity	boolean	Určuje, zda je toto pole polem identity.
isLocked	boolean	Určuje, jestli je toto pole označené jako uzamčené pro úpravy.
isPicklist	boolean	Určuje, zda je tato instance rozevírací seznam.
isPicklistSuggested	boolean	Označuje, zda je tato instance navrhovaným rozevíracím seznamem .
isQueryable	boolean	Určuje, jestli se pole může dotazovat na serveru.
name	string	Název pole.
picklistId	string	Pokud je toto pole rozevírací seznam, identifikátor přidruženého rozevíracího seznamu, jinak null
readOnly	boolean	Určuje, jestli je pole [jen pro čtení].
referenceName	string	Název odkazu pole.
supportedOperations	WorkItemFieldOperation[]	Podporované operace v tomto poli
type	FieldType	Typ pole
url	string
usage	FieldUsage	Použití pole.

WorkItemFieldOperation

Popisuje operaci pole pracovní položky.

Name	Typ	Description
name	string	Popisný název operace
referenceName	string	Referenční název operace.

Sdílet prostřednictvím

Fields - Update

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

oauth2

Scopes

Příklady

Set field locked

Sample Request

Sample Response

Undelete a field

Sample Request

Sample Response

Definice

FieldType

FieldUpdate

FieldUsage

ReferenceLinks

WorkItemField2

WorkItemFieldOperation

Váš názor

Další materiály