Work Items - Create
Erstellt ein einzelnes Arbeitselement.
POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?api-version=7.1-preview.3
POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?validateOnly={validateOnly}&bypassRules={bypassRules}&suppressNotifications={suppressNotifications}&$expand={$expand}&api-version=7.1-preview.3
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
organization
|
path | True |
string |
Der Name der Azure DevOps-Organisation. |
project
|
path | True |
string |
Projekt-ID oder Projektname |
type
|
path | True |
string |
Der Arbeitselementtyp des zu erstellenden Arbeitselements. |
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. |
$expand
|
query |
Die Erweiterungsparameter für Arbeitselementattribute. Mögliche Optionen sind { None, Relations, Fields, Links, All }. |
||
bypass
|
query |
boolean |
Erzwingen Sie die Arbeitselementtypregeln für dieses Update nicht. |
|
suppress
|
query |
boolean |
Keine Benachrichtigungen für diese Änderung auslösen |
|
validate
|
query |
boolean |
Geben Sie an, ob Sie die Änderungen nur überprüfen möchten, ohne das Arbeitselement zu speichern. |
Anforderungstext
Media Types: "application/json-patch+json"
Name | Typ | Beschreibung |
---|---|---|
from |
string |
Der Pfad, aus dem kopiert werden soll, für den Vorgang Verschieben/Kopieren. |
op |
Der Patchvorgang |
|
path |
string |
Der Pfad für den Vorgang. Im Fall eines Arrays kann ein nullbasierter Index verwendet werden, um die Position im Array anzugeben (z. B. /biscuits/0/name). Das Zeichen "-" kann anstelle eines Indexes verwendet werden, um am Ende des Arrays (z. B. /biscuits/-) einzufügen. |
value |
object |
Der Wert für den Vorgang. Dies ist entweder ein Primitiver oder ein JToken. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
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
Create work item
Sample Request
POST https://dev.azure.com/fabrikam/{project}/_apis/wit/workitems/${type}?api-version=7.1-preview.3
[
{
"op": "add",
"path": "/fields/System.Title",
"from": null,
"value": "Sample task"
}
]
Sample Response
{
"id": 131489,
"rev": 1,
"fields": {
"System.AreaPath": "CustomProcessPrj",
"System.TeamProject": "CustomProcessPrj",
"System.IterationPath": "CustomProcessPrj",
"System.WorkItemType": "Task",
"System.State": "New",
"System.Reason": "New",
"System.CreatedDate": "2017-10-06T01:04:51.57Z",
"System.CreatedBy": {
"displayName": "Jamal Hartnett",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"_links": {
"avatar": {
"href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
}
},
"id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"uniqueName": "fabrikamfiber4@hotmail.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
},
"System.ChangedDate": "2017-10-06T01:04:51.57Z",
"System.ChangedBy": {
"displayName": "Jamal Hartnett",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"_links": {
"avatar": {
"href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
}
},
"id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"uniqueName": "fabrikamfiber4@hotmail.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
},
"System.Title": "Sample task",
"Microsoft.VSTS.Common.StateChangeDate": "2017-10-06T01:04:51.57Z",
"Microsoft.VSTS.Common.Priority": 2
},
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489"
},
"workItemUpdates": {
"href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489/updates"
},
"workItemRevisions": {
"href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489/revisions"
},
"workItemHistory": {
"href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489/history"
},
"html": {
"href": "https://dev.azure.com/fabrikam/web/wi.aspx?pcguid=20cda608-32f0-4e6e-9b7c-8def7b38d15a&id=131489"
},
"workItemType": {
"href": "https://dev.azure.com/fabrikam/aaee31d9-14cf-48b9-a92b-3f1446c13f80/_apis/wit/workItemTypes/Task"
},
"fields": {
"href": "https://dev.azure.com/fabrikam/_apis/wit/fields"
}
},
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/131489"
}
Definitionen
Name | Beschreibung |
---|---|
Json |
Das JSON-Modell für JSON-Patchvorgänge |
Operation |
Der Patchvorgang |
Reference |
Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt. |
Work |
Beschreibt ein Arbeitselement. |
Work |
Stellt den Verweis auf eine bestimmte Version eines Kommentars zu einem Arbeitselement dar. |
Work |
Die Erweiterungsparameter für Arbeitselementattribute. Mögliche Optionen sind { None, Relations, Fields, Links, All } |
Work |
JsonPatchDocument
Das JSON-Modell für JSON-Patchvorgänge
Name | Typ | Beschreibung |
---|---|---|
from |
string |
Der Pfad, aus dem kopiert werden soll, für den Vorgang Verschieben/Kopieren. |
op |
Der Patchvorgang |
|
path |
string |
Der Pfad für den Vorgang. Im Fall eines Arrays kann ein nullbasierter Index verwendet werden, um die Position im Array anzugeben (z. B. /biscuits/0/name). Das Zeichen "-" kann anstelle eines Indexes verwendet werden, um am Ende des Arrays (z. B. /biscuits/-) einzufügen. |
value |
object |
Der Wert für den Vorgang. Dies ist entweder ein Primitiver oder ein JToken. |
Operation
Der Patchvorgang
Name | Typ | Beschreibung |
---|---|---|
add |
string |
|
copy |
string |
|
move |
string |
|
remove |
string |
|
replace |
string |
|
test |
string |
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. |
WorkItem
Beschreibt ein Arbeitselement.
Name | Typ | Beschreibung |
---|---|---|
_links |
Links zu verwandten REST-Ressourcen. |
|
commentVersionRef |
Verweis auf eine bestimmte Version des Kommentars, der in dieser Überarbeitung hinzugefügt/bearbeitet/gelöscht wurde. |
|
fields |
object |
Zuordnung von Feld und Werten für das Arbeitselement. |
id |
integer |
Die Arbeitselement-ID. |
relations |
Beziehungen des Arbeitselements. |
|
rev |
integer |
Revisionsnummer des Arbeitselements. |
url |
string |
WorkItemCommentVersionRef
Stellt den Verweis auf eine bestimmte Version eines Kommentars zu einem Arbeitselement dar.
Name | Typ | Beschreibung |
---|---|---|
commentId |
integer |
Die dem Kommentar zugewiesene ID. |
createdInRevision |
integer |
[Intern] Die Überarbeitung des Arbeitselements, in der dieser Kommentar ursprünglich hinzugefügt wurde. |
isDeleted |
boolean |
[Intern] Gibt an, ob der Kommentar gelöscht wurde. |
text |
string |
[Intern] Der Text des Kommentars. |
url |
string |
|
version |
integer |
Die Versionsnummer. |
WorkItemExpand
Die Erweiterungsparameter für Arbeitselementattribute. Mögliche Optionen sind { None, Relations, Fields, Links, All }
Name | Typ | Beschreibung |
---|---|---|
all |
string |
Erweitert alle. |
fields |
string |
Arbeitselement "Felder" erweitern. |
links |
string |
Arbeitselement "Links" erweitern. |
none |
string |
Standardverhalten. |
relations |
string |
Arbeitselement "Beziehungen" erweitern. |
WorkItemRelation
Name | Typ | Beschreibung |
---|---|---|
attributes |
object |
Sammlung von Linkattributen. |
rel |
string |
Beziehungstyp. |
url |
string |
Link-URL. |