Work Item Types - Update Work Item Type

Dienst:

Work Item Tracking Process Definitions

API-Version:

4.1-preview.1

Updates einen Arbeitselementtyp des Prozesses.

PATCH https://dev.azure.com/{organization}/_apis/work/processdefinitions/{processId}/workitemtypes/{witRefName}?api-version=4.1-preview.1

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
processId	path	True	string uuid	Die ID des Prozesses
witRefName	path	True	string	Der Verweisname des Arbeitselementtyps
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "4.1-preview.1" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name	Typ	Beschreibung
color	string	Farbe des Arbeitselementtyps
description	string	Beschreibung des Arbeitselementtyps
icon	string	Symbol des Arbeitselementtyps
isDisabled	boolean	Ist der zu deaktivierende Arbeitselementtyp

Antworten

Name	Typ	Beschreibung
200 OK	WorkItemTypeModel	Erfolgreicher Vorgang

Sicherheit

accessToken

Persönliches Zugriffstoken. Verwenden Sie einen beliebigen Wert für den Benutzernamen und das Token als Kennwort.

Typ: basic

Beispiele

Update work item type

Beispielanforderung

HTTP

PATCH https://dev.azure.com/{organization}/_apis/work/processdefinitions/{processId}/workitemtypes/{witRefName}?api-version=4.1-preview.1

{
  "isDisabled": true
}

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "myAgile.CustomWIT",
  "name": "CustomWIT",
  "description": null,
  "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/myAgile.CustomWIT",
  "inherits": null,
  "class": "custom",
  "color": "009CCC",
  "icon": null,
  "isDisabled": true
}

Definitionen

Name	Beschreibung
Control	Stellen Sie ein Steuerelement im Formular dar.
Extension	Stellt den Erweiterungsteil des Layouts dar.
FormLayout
Group	Stellen Sie eine Gruppe in der Form dar, in der Steuerelemente enthalten sind.
Page
PageType	Das Symbol für die Seite.
Section	Ein Layoutknoten, der Gruppen auf einer Seite zusammenhält
WitContribution
WorkItemBehaviorReference
WorkItemStateResultModel
WorkItemTypeBehavior
WorkItemTypeClass	Klasse des Arbeitselementtyps
WorkItemTypeModel
WorkItemTypeUpdateModel

Control

Objekt

Stellen Sie ein Steuerelement im Formular dar.

Name	Typ	Beschreibung
contribution	WitContribution	Beitrag für das Steuerelement.
controlType	string	Typ des Steuerelements.
height	integer	Höhe des Steuerelements für HTML-Steuerelemente.
id	string	Die ID für den Layoutknoten.
inherited	boolean	Ein Wert, der angibt, ob dieser Layoutknoten von einem übergeordneten Layout geerbt wurde. Dies wird nur vom Combiner festgelegt.
isContribution	boolean	Ein Wert, der angibt, ob der Layoutknoten ein Beitrag ist oder nicht.
label	string	Bezeichnung für das Feld
metadata	string	Innerer Text des Steuerelements.
order	integer
overridden	boolean	Ein Wert, der angibt, ob dieser Layoutknoten von einem untergeordneten Layout überschrieben wurde.
readOnly	boolean	Ein Wert, der angibt, ob das Steuerelement schreibgeschützt ist.
visible	boolean	Ein Wert, der angibt, ob das Steuerelement ausgeblendet werden soll oder nicht.
watermark	string	Wasserzeichentext für das Textfeld.

Extension

Objekt

Stellt den Erweiterungsteil des Layouts dar.

Name	Typ	Beschreibung
id	string

FormLayout

Objekt

Name	Typ	Beschreibung
extensions	Extension[]	Ruft die Erweiterungsliste ab und legt sie fest.
pages	Page[]	Registerkarten der obersten Ebene des Layouts.
systemControls	Control[]	Headersteuerelemente des Layouts.

Group

Objekt

Stellen Sie eine Gruppe in der Form dar, in der Steuerelemente enthalten sind.

Name	Typ	Beschreibung
contribution	WitContribution	Beitrag für die Gruppe.
controls	Control[]	Steuerelemente, die in die Gruppe eingefügt werden sollen.
height	integer	Die Höhe des Beitrags.
id	string	Die ID für den Layoutknoten.
inherited	boolean	Ein Wert, der angibt, ob dieser Layoutknoten von einem übergeordneten Layout geerbt wurde. Dies wird nur vom Combiner festgelegt.
isContribution	boolean	Ein Wert, der angibt, ob der Layoutknoten ein Beitrag ist, sind nicht.
label	string	Die Beschriftung für die Gruppe.
order	integer	Reihenfolge, in der die Gruppe im Abschnitt angezeigt werden soll.
overridden	boolean	Ein Wert, der angibt, ob dieser Layoutknoten von einem untergeordneten Layout überschrieben wurde.
visible	boolean	Ein Wert, der angibt, ob die Gruppe ausgeblendet werden soll oder nicht.

Page

Objekt

Name	Typ	Beschreibung
contribution	WitContribution	Beitrag für die Seite.
id	string	Die ID für den Layoutknoten.
inherited	boolean	Ein Wert, der angibt, ob dieser Layoutknoten von einem übergeordneten Layout geerbt wurde. Dies wird nur vom Combiner festgelegt.
isContribution	boolean	Ein Wert, der angibt, ob der Layoutknoten ein Beitrag ist, sind nicht.
label	string	Die Bezeichnung für die Seite.
locked	boolean	Ein Wert, der angibt, ob Benutzervorgänge auf dieser Seite und dem Inhalt dieser Seite zulässig sind.
order	integer	Reihenfolge, in der die Seite im Layout angezeigt werden soll.
overridden	boolean	Ein Wert, der angibt, ob dieser Layoutknoten von einem untergeordneten Layout überschrieben wurde.
pageType	PageType	Das Symbol für die Seite.
sections	Section[]	Die Abschnitte der Seite.
visible	boolean	Ein Wert, der angibt, ob die Seite ausgeblendet werden soll oder nicht.

PageType

Enumeration

Das Symbol für die Seite.

Wert	Beschreibung
attachments
custom
history
links

Section

Objekt

Ein Layoutknoten, der Gruppen auf einer Seite zusammenhält

Name	Typ	Beschreibung
groups	Group[]	Stellen Sie eine Gruppe in der Form dar, in der Steuerelemente enthalten sind.
id	string	Die ID für den Layoutknoten.
overridden	boolean	Ein Wert, der angibt, ob dieser Layoutknoten von einem untergeordneten Layout überschrieben wurde.

WitContribution

Objekt

Name	Typ	Beschreibung
contributionId	string	Die ID für den Beitrag.
height	integer	Die Höhe des Beitrags.
inputs	object	Ein Wörterbuch mit Schlüsselwertpaaren für Beitragseingaben.
showOnDeletedWorkItem	boolean	Ein Wert, der angibt, ob der Beitrag auf gelöschtem workItem angezeigt werden soll.

WorkItemBehaviorReference

Objekt

Name	Typ	Beschreibung
id	string	Die ID des Verweisverhaltens
url	string	Die URL des Verweisverhaltens

WorkItemStateResultModel

Objekt

Name	Typ	Beschreibung
color	string	Farbe des Zustands
hidden	boolean	Ist der Zustand ausgeblendet
id	string	Die ID des Staates
name	string	Name des Zustands
order	integer	Reihenfolge, in welchem Zustand angezeigt werden soll
stateCategory	string	Kategorie des Staates
url	string	URL des Zustands

WorkItemTypeBehavior

Objekt

Name	Typ	Beschreibung
behavior	WorkItemBehaviorReference
isDefault	boolean
url	string

WorkItemTypeClass

Enumeration

Klasse des Arbeitselementtyps

Wert	Beschreibung
custom
derived
system

WorkItemTypeModel

Objekt

Name	Typ	Beschreibung
behaviors	WorkItemTypeBehavior[]	Verhalten des Arbeitselementtyps
class	WorkItemTypeClass	Klasse des Arbeitselementtyps
color	string	Farbe des Arbeitselementtyps
description	string	Beschreibung des Arbeitselementtyps
icon	string	Symbol des Arbeitselementtyps
id	string	Die ID des Arbeitselementtyps
inherits	string	Übergeordnete WIT-ID/Interner Verweisname, von dem er erbt
isDisabled	boolean	Ist der Arbeitselementtyp deaktiviert?
layout	FormLayout	Layout des Arbeitselementtyps
name	string	Name des Arbeitselementtyps
states	WorkItemStateResultModel[]	Zustände des Arbeitselementtyps
url	string	URL des Arbeitselementtyps

WorkItemTypeUpdateModel

Objekt

Name	Typ	Beschreibung
color	string	Farbe des Arbeitselementtyps
description	string	Beschreibung des Arbeitselementtyps
icon	string	Symbol des Arbeitselementtyps
isDisabled	boolean	Ist der zu deaktivierende Arbeitselementtyp