Work Items - Create
Crée un seul élément de travail.
POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?api-version=6.1-preview.3
POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/${type}?validateOnly={validateOnly}&bypassRules={bypassRules}&suppressNotifications={suppressNotifications}&$expand={$expand}&api-version=6.1-preview.3
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
organization
|
path | True |
string |
Nom de l’organisation Azure DevOps. |
project
|
path | True |
string |
ID de projet ou nom du projet |
type
|
path | True |
string |
Type d’élément de travail de l’élément de travail à créer |
api-version
|
query | True |
string |
Version de l’API à utiliser. Cette valeur doit être définie sur « 6.1-preview.3 » pour utiliser cette version de l’API. |
$expand
|
query |
Paramètres de développement pour les attributs d’élément de travail. Les options possibles sont { None, Relations, Fields, Links, All }. |
||
bypass
|
query |
boolean |
N’appliquez pas les règles de type d’élément de travail sur cette mise à jour |
|
suppress
|
query |
boolean |
Ne pas déclencher de notifications pour cette modification |
|
validate
|
query |
boolean |
Indiquez si vous souhaitez uniquement valider les modifications sans enregistrer l’élément de travail |
Corps de la demande
Media Types: "application/json-patch+json"
Nom | Type | Description |
---|---|---|
from |
string |
Chemin d’accès à partir duquel effectuer la copie pour l’opération Move/Copy. |
op |
Opération de correctif |
|
path |
string |
Chemin d’accès de l’opération. Dans le cas d’un tableau, un index de base zéro peut être utilisé pour spécifier la position dans le tableau (par exemple, /biscuits/0/name). Le caractère « - » peut être utilisé à la place d’un index à insérer à la fin du tableau (par exemple, /biscuits/-). |
value |
object |
Valeur de l’opération. Il s’agit d’une primitive ou d’un JToken. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
opération réussie |
Sécurité
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
Nom | Description |
---|---|
vso.work_write | Accorde la possibilité de lire, créer et mettre à jour des éléments de travail et des requêtes, mettre à jour les métadonnées du tableau, les zones de lecture et les itérations chemins d’autres métadonnées associées au suivi des éléments de travail, exécuter des requêtes et recevoir des notifications sur les événements d’élément de travail via des hooks de service. |
Exemples
Create work item
Sample Request
POST https://dev.azure.com/fabrikam/{project}/_apis/wit/workitems/${type}?api-version=6.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"
}
Définitions
Nom | Description |
---|---|
Json |
Modèle JSON pour les opérations de correctif JSON |
Operation |
Opération de correctif |
Reference |
Classe pour représenter une collection de liens de référence REST. |
Work |
Décrit un élément de travail. |
Work |
Représente la référence à une version spécifique d’un commentaire sur un élément de travail. |
Work |
Paramètres de développement pour les attributs d’élément de travail. Les options possibles sont { None, Relations, Fields, Links, All } |
Work |
JsonPatchDocument
Modèle JSON pour les opérations de correctif JSON
Nom | Type | Description |
---|---|---|
from |
string |
Chemin d’accès à partir duquel effectuer la copie pour l’opération Move/Copy. |
op |
Opération de correctif |
|
path |
string |
Chemin d’accès de l’opération. Dans le cas d’un tableau, un index de base zéro peut être utilisé pour spécifier la position dans le tableau (par exemple, /biscuits/0/name). Le caractère « - » peut être utilisé à la place d’un index à insérer à la fin du tableau (par exemple, /biscuits/-). |
value |
object |
Valeur de l’opération. Il s’agit d’une primitive ou d’un JToken. |
Operation
Opération de correctif
Nom | Type | Description |
---|---|---|
add |
string |
|
copy |
string |
|
move |
string |
|
remove |
string |
|
replace |
string |
|
test |
string |
ReferenceLinks
Classe pour représenter une collection de liens de référence REST.
Nom | Type | Description |
---|---|---|
links |
object |
Vue en lecture seule des liens. Étant donné que les liens référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule. |
WorkItem
Décrit un élément de travail.
Nom | Type | Description |
---|---|---|
_links |
Lier des références à des ressources REST associées. |
|
commentVersionRef |
Référence à une version spécifique du commentaire ajouté/modifié/supprimé dans cette révision. |
|
fields |
object |
Carte du champ et des valeurs de l’élément de travail. |
id |
integer |
ID de l’élément de travail. |
relations |
Relations de l’élément de travail. |
|
rev |
integer |
Numéro de révision de l’élément de travail. |
url |
string |
WorkItemCommentVersionRef
Représente la référence à une version spécifique d’un commentaire sur un élément de travail.
Nom | Type | Description |
---|---|---|
commentId |
integer |
ID attribué au commentaire. |
createdInRevision |
integer |
[Interne] Révision de l’élément de travail où ce commentaire a été ajouté à l’origine. |
isDeleted |
boolean |
[Interne] Spécifie si le commentaire a été supprimé. |
text |
string |
[Interne] Texte du commentaire. |
url |
string |
|
version |
integer |
Numéro de version. |
WorkItemExpand
Paramètres de développement pour les attributs d’élément de travail. Les options possibles sont { None, Relations, Fields, Links, All }
Nom | Type | Description |
---|---|---|
all |
string |
Développe tout. |
fields |
string |
Champs, élément de travail développer. |
links |
string |
Développez l’élément de travail liens. |
none |
string |
Comportement par défaut |
relations |
string |
Développez l’élément de travail Relations. |
WorkItemRelation
Nom | Type | Description |
---|---|---|
attributes |
object |
Collection d’attributs de lien. |
rel |
string |
Type de relation. |
url |
string |
URL du lien. |