Work Items - Get Work Item
Retourne un seul élément de travail.
GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id}?api-version=4.1
GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id}?fields={fields}&asOf={asOf}&$expand={$expand}&api-version=4.1
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
id
|
path | True |
integer int32 |
ID de l’élément de travail |
organization
|
path | True |
string |
Nom de l’organisation Azure DevOps. |
project
|
path |
string |
ID de projet ou nom du projet |
|
api-version
|
query | True |
string |
Version de l’API à utiliser. Cette valeur doit être définie sur « 4.1 » 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 }. |
||
as
|
query |
string date-time |
Chaîne d’heure de date UTC AsOf |
|
fields
|
query |
string array (string) |
Liste séparée par des virgules des champs demandés |
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 | Accorde la possibilité de lire des éléments de travail, des requêtes, des tableaux, des chemins d’accès de zone et d’itérations, ainsi que d’autres métadonnées associées au suivi des éléments de travail. Accorde également la possibilité d’exécuter des requêtes et de recevoir des notifications sur les événements d’élément de travail via des hooks de service. |
Exemples
Get work item |
Get work item with as |
Get work item
Sample Request
GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/workitems/12?api-version=4.1
Sample Response
{
"id": 12,
"rev": 3,
"fields": {
"System.AreaPath": "MyAgilePrj2",
"System.TeamProject": "MyAgilePrj2",
"System.IterationPath": "MyAgilePrj2\\Iteration 1",
"System.WorkItemType": "User Story",
"System.State": "Active",
"System.Reason": "Implementation started",
"System.AssignedTo": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
"System.CreatedDate": "2017-09-04T06:11:59.05Z",
"System.CreatedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
"System.ChangedDate": "2017-10-04T23:32:02.18Z",
"System.ChangedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
"System.Title": "Epic 2",
"Microsoft.VSTS.Common.StateChangeDate": "2017-10-04T23:32:01.6Z",
"Microsoft.VSTS.Common.ActivatedDate": "2017-10-04T23:32:01.6Z",
"Microsoft.VSTS.Common.ActivatedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
"Microsoft.VSTS.Common.Priority": 2,
"Microsoft.VSTS.Common.ValueArea": "Business",
"System.Tags": "client; sample; teamservices"
},
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/12"
},
"workItemUpdates": {
"href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/12/updates"
},
"workItemRevisions": {
"href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/12/revisions"
},
"workItemHistory": {
"href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/12/history"
},
"html": {
"href": "https://dev.azure.com/fabrikam/web/wi.aspx?pcguid=20cda608-32f0-4e6e-9b7c-8def7b38d15a&id=12"
},
"workItemType": {
"href": "https://dev.azure.com/fabrikam/54332e84-3d54-4c67-9bd0-0e88a9849330/_apis/wit/workItemTypes/User%20Story"
},
"fields": {
"href": "https://dev.azure.com/fabrikam/_apis/wit/fields"
}
},
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/12"
}
Get work item with asOf parameter
Sample Request
GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/workitems/564?asOf=2017-12-21T19:42:54.230Z&api-version=4.1
Sample Response
{
"id": 564,
"rev": 4,
"fields": {
"System.AreaPath": "MyAgilePrj2",
"System.TeamProject": "MyAgilePrj2",
"System.IterationPath": "MyAgilePrj2\\Iteration 0",
"System.WorkItemType": "Task",
"System.State": "Proposed",
"System.Reason": "New",
"System.AssignedTo": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
"System.CreatedDate": "2017-12-16T00:46:58.01Z",
"System.CreatedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
"System.ChangedDate": "2017-12-16T00:49:08.81Z",
"System.ChangedBy": "Jamal Hartnett <fabrikamfiber4@hotmail.com>",
"System.Title": "t1.3",
"Microsoft.VSTS.Common.StateChangeDate": "2017-12-16T00:46:58.01Z",
"Microsoft.VSTS.Common.Priority": 2,
"Microsoft.VSTS.CMMI.Blocked": "No",
"Microsoft.VSTS.Common.Triage": "Pending",
"Microsoft.VSTS.CMMI.TaskType": "Planned",
"Microsoft.VSTS.CMMI.RequiresReview": "No",
"Microsoft.VSTS.CMMI.RequiresTest": "No"
},
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/564/revisions/4"
},
"workItemRevisions": {
"href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/564/revisions"
},
"parent": {
"href": "https://dev.azure.com/fabrikam/_apis/wit/workItems/564"
}
},
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/564/revisions/4"
}
Définitions
Nom | Description |
---|---|
Reference |
Classe pour représenter une collection de liens de référence REST. |
Work |
Décrit 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 |
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 de 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. |
|
fields |
object |
Mappage 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 |
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 |
|
fields |
string |
|
links |
string |
|
none |
string |
|
relations |
string |
WorkItemRelation
Nom | Type | Description |
---|---|---|
attributes |
object |
Collection d’attributs de lien. |
rel |
string |
Type de relation. |
url |
string |
URL du lien. |