Fields - Update

Referenz

Service:: Work Item Tracking

API Version:: 7.1-preview.3

Aktualisieren sie ein Feld.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
fieldNameOrRefName	path	True	string	Name/Verweisname des zu aktualisierenden Felds
organization	path	True	string	Der Name der Azure DevOps-Organisation.
project	path		string	Projekt-ID oder Projektname
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1-preview.3" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name	Typ	Beschreibung
isDeleted	boolean	Gibt an, ob der Benutzer das Feld wiederherstellen möchte.
isLocked	boolean	Gibt an, ob der Benutzer das Feld sperren möchte.

Antworten

Name	Typ	Beschreibung
200 OK	WorkItemField2	Erfolgreicher Vorgang

Sicherheit

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	Beschreibung
vso.work_write	Ermöglicht das Lesen, Erstellen und Aktualisieren von Arbeitselementen und Abfragen, aktualisieren von Boardmetadaten, Lesebereichs- und Iterationspfaden für andere Metadaten im Zusammenhang mit der Nachverfolgung von Arbeitselementen, Ausführen von Abfragen und das Empfangen von Benachrichtigungen zu Arbeitselementereignissen über Diensthooks.

Beispiele

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

Definitionen

Name	Beschreibung
FieldType	Der Typ des Felds.
FieldUpdate	Beschreibt eine Aktualisierungsanforderung für ein Arbeitselementfeld.
FieldUsage	Die Verwendung des Felds.
ReferenceLinks	Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.
WorkItemField2	Beschreibt ein Feld für ein Arbeitselement und dessen Eigenschaften, die für diesen Arbeitselementtyp spezifisch sind.
WorkItemFieldOperation	Beschreibt einen Arbeitselementfeldvorgang.

FieldType

Der Typ des Felds.

Name	Typ	Beschreibung
boolean	string	Boolescher Feldtyp.
dateTime	string	Datetime-Feldtyp.
double	string	Doppelter Feldtyp.
guid	string	Guid-Feldtyp.
history	string	Typ des Verlaufsfelds.
html	string	HTML-Feldtyp (Mehrzeile).
identity	string	Identitätsfeldtyp.
integer	string	Ganzzahlfeldtyp.
picklistDouble	string	Doppelter Auswahlfeldtyp. Verwenden Sie beim Erstellen eines Felds mit doppelter Auswahl über die REST-API den Feldtyp "Double".
picklistInteger	string	Ganzzahliger Auswahlfeldtyp. Verwenden Sie beim Erstellen eines Ganzzahlauswahlfelds über die REST-API den Feldtyp "Integer".
picklistString	string	Zeichenfolgenauswahlfeldtyp. Verwenden Sie beim Erstellen eines Zeichenfolgenauswahlfelds über die REST-API den FieldType "String".
plainText	string	Nur-Text-Feldtyp.
string	string	Zeichenfolgenfeldtyp.
treePath	string	Treepath-Feldtyp.

FieldUpdate

Beschreibt eine Aktualisierungsanforderung für ein Arbeitselementfeld.

Name	Typ	Beschreibung
isDeleted	boolean	Gibt an, ob der Benutzer das Feld wiederherstellen möchte.
isLocked	boolean	Gibt an, ob der Benutzer das Feld sperren möchte.

FieldUsage

Die Verwendung des Felds.

Name	Typ	Beschreibung
none	string	Leere Verwendung.
tree	string	Verwendung des Treenode-Felds.
workItem	string	Verwendung des Arbeitselementfelds.
workItemLink	string	Verwendung des Arbeitselementlinkfelds.
workItemTypeExtension	string	Verwendung der Arbeitselementtyperweiterung.

ReferenceLinks

Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name	Typ	Beschreibung
links	object	Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützter Sind, möchten wir sie nur als schreibgeschützter Link verfügbar machen.

WorkItemField2

Beschreibt ein Feld für ein Arbeitselement und dessen Eigenschaften, die für diesen Arbeitselementtyp spezifisch sind.

Name	Typ	Beschreibung
_links	ReferenceLinks	Links zu verwandten REST-Ressourcen.
canSortBy	boolean	Gibt an, ob das Feld in Serverabfragen sortierbar ist.
description	string	Die Beschreibung des Felds.
isDeleted	boolean	Gibt an, ob dieses Feld gelöscht wird.
isIdentity	boolean	Gibt an, ob es sich bei diesem Feld um ein Identitätsfeld handelt.
isLocked	boolean	Gibt an, ob dieses Feld für die Bearbeitung als gesperrt markiert ist.
isPicklist	boolean	Gibt an, ob es sich bei diesem instance um eine Auswahlliste handelt.
isPicklistSuggested	boolean	Gibt an, ob es sich bei diesem instance um eine vorgeschlagene Auswahlliste handelt.
isQueryable	boolean	Gibt an, ob das Feld auf dem Server abgefragt werden kann.
name	string	Der Name des Felds.
picklistId	string	Wenn es sich bei diesem Feld um eine Auswahlliste handelt, ist der Bezeichner der zugeordneten Auswahlliste, andernfalls NULL.
readOnly	boolean	Gibt an, ob das Feld [schreibschutz] ist.
referenceName	string	Der Verweisname des Felds.
supportedOperations	WorkItemFieldOperation[]	Die unterstützten Vorgänge in diesem Feld.
type	FieldType	Der Typ des Felds.
url	string
usage	FieldUsage	Die Verwendung des Felds.

WorkItemFieldOperation

Beschreibt einen Arbeitselementfeldvorgang.

Name	Typ	Beschreibung
name	string	Anzeigename des Vorgangs.
referenceName	string	Verweisname des Vorgangs.

Fields - Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

oauth2

Scopes

Beispiele

Set field locked

Sample Request

Sample Response

Undelete a field

Sample Request

Sample Response

Definitionen

FieldType

FieldUpdate

FieldUsage

ReferenceLinks

WorkItemField2

WorkItemFieldOperation

Feedback

Zusätzliche Ressourcen