Share via

Work Items - Get Work Item

  • Riferimento
Service:
Work Item Tracking
API Version:
4.1

Restituisce un singolo elemento di lavoro.

GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id}?api-version=4.1
With optional parameters: 
GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id}?fields={fields}&asOf={asOf}&$expand={$expand}&api-version=4.1

Parametri dell'URI

Nome In Necessario Tipo Descrizione
id
 path True

integer

int32

ID elemento di lavoro
organization
 path True

string

Nome dell'organizzazione di Azure DevOps.
project
 path

string

ID progetto o nome del progetto
api-version
 query True

string

Versione dell'API da usare. Deve essere impostato su '4.1' per usare questa versione dell'API.
$expand
 query

WorkItemExpand

Parametri di espansione per gli attributi degli elementi di lavoro. Le opzioni possibili sono { None, Relations, Fields, Links, All }.
asOf
 query

string

date-time

Stringa di data e ora UTC AsOf
fields
 query

string

array (string)

Elenco delimitato da virgole di campi richiesti

Risposte

Nome Tipo Descrizione
200 OK

WorkItem

operazione riuscita

Sicurezza

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 Descrizione
vso.work Concede la possibilità di leggere elementi di lavoro, query, bacheche, percorsi di aree e iterazioni e altri metadati correlati al rilevamento degli elementi di lavoro. Concede inoltre la possibilità di eseguire query e ricevere notifiche sugli eventi degli elementi di lavoro tramite hook del servizio.

Esempio

Get work item
Get work item with asOf parameter

Get work item

Sample Request

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/workitems/12?api-version=4.1

Sample Response

Status code:
200 
{
  "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

Status code:
200 
{
  "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"
}

Definizioni

Nome Descrizione
ReferenceLinks

Classe per rappresentare una raccolta di collegamenti di riferimento REST.
WorkItem

Descrive un elemento di lavoro.
WorkItemExpand

Parametri di espansione per gli attributi degli elementi di lavoro. Le opzioni possibili sono { None, Relations, Fields, Links, All }.
WorkItemRelation

Classe per rappresentare una raccolta di collegamenti di riferimento REST.

Nome Tipo Descrizione
links

object

Visualizzazione di sola lettura dei collegamenti. Poiché i collegamenti di riferimento sono di sola lettura, è consigliabile esporli solo come di sola lettura.

WorkItem

Descrive un elemento di lavoro.

Nome Tipo Descrizione
_links

ReferenceLinks

Collegare i riferimenti alle risorse REST correlate.
fields

object

Mappa di campi e valori per l'elemento di lavoro.
id

integer

ID elemento di lavoro.
relations

WorkItemRelation[]

Relazioni dell'elemento di lavoro.
rev

integer

Numero di revisione dell'elemento di lavoro.
url

string

WorkItemExpand

Parametri di espansione per gli attributi degli elementi di lavoro. Le opzioni possibili sono { None, Relations, Fields, Links, All }.

Nome Tipo Descrizione
all

string

fields

string

links

string

none

string

relations

string

WorkItemRelation

Nome Tipo Descrizione
attributes

object

Raccolta di attributi di collegamento.
rel

string

Tipo di relazione.
url

string

URL di collegamento.