Work Items - Get Work Item
Retorna um único item de trabalho.
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
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
id
|
path | True |
integer int32 |
A ID do item de trabalho |
organization
|
path | True |
string |
O nome da organização do Azure DevOps. |
project
|
path |
string |
ID do projeto ou nome do projeto |
|
api-version
|
query | True |
string |
Versão da API a ser usada. Isso deve ser definido como '4.1' para usar essa versão da api. |
$expand
|
query |
Os parâmetros de expansão para atributos de item de trabalho. As opções possíveis são { None, Relations, Fields, Links, All }. |
||
as
|
query |
string date-time |
Cadeia de caracteres de hora de data UTC asOf |
|
fields
|
query |
string array (string) |
Lista separada por vírgulas de campos solicitados |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
operação bem-sucedida |
Segurança
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
Nome | Description |
---|---|
vso.work | Concede a capacidade de ler itens de trabalho, consultas, quadros, caminhos de área e iterações e outros metadados relacionados ao acompanhamento de itens de trabalho. Também concede a capacidade de executar consultas e receber notificações sobre eventos de item de trabalho por meio de ganchos de serviço. |
Exemplos
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"
}
Definições
Nome | Description |
---|---|
Reference |
A classe para representar uma coleção de links de referência REST. |
Work |
Descreve um item de trabalho. |
Work |
Os parâmetros de expansão para atributos de item de trabalho. As opções possíveis são { None, Relations, Fields, Links, All }. |
Work |
ReferenceLinks
A classe para representar uma coleção de links de referência REST.
Nome | Tipo | Description |
---|---|---|
links |
object |
A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura. |
WorkItem
Descreve um item de trabalho.
Nome | Tipo | Description |
---|---|---|
_links |
Vincular referências a recursos REST relacionados. |
|
fields |
object |
Mapa de campos e valores para o item de trabalho. |
id |
integer |
O ID do item de trabalho. |
relations |
Relações do item de trabalho. |
|
rev |
integer |
Número de revisão do item de trabalho. |
url |
string |
WorkItemExpand
Os parâmetros de expansão para atributos de item de trabalho. As opções possíveis são { None, Relations, Fields, Links, All }.
Nome | Tipo | Description |
---|---|---|
all |
string |
|
fields |
string |
|
links |
string |
|
none |
string |
|
relations |
string |
WorkItemRelation
Nome | Tipo | Description |
---|---|---|
attributes |
object |
Coleção de atributos de link. |
rel |
string |
Tipo de relação. |
url |
string |
Url do link. |
Comentários
https://aka.ms/ContentUserFeedback.
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja:Submeter e ver comentários