Work Items - Get Work Item
Vrátí jednu pracovní položku.
GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id}?api-version=7.1-preview.3
GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id}?fields={fields}&asOf={asOf}&$expand={$expand}&api-version=7.1-preview.3
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
id
|
path | True |
integer int32 |
ID pracovní položky |
organization
|
path | True |
string |
Název organizace Azure DevOps. |
project
|
path |
string |
ID projektu nebo název projektu |
|
api-version
|
query | True |
string |
Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavená na 7.1-preview.3. |
$expand
|
query |
Rozbalení parametrů pro atributy pracovní položky. Možné možnosti jsou { None, Relations, Fields, Links, All }. |
||
as
|
query |
string date-time |
Řetězec data a času ve formátu UTC |
|
fields
|
query |
string array (string) |
Seznam požadovaných polí oddělených čárkami |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
úspěšná operace |
Zabezpečení
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 | Description |
---|---|
vso.work | Umožňuje číst pracovní položky, dotazy, panely, cesty oblastí a iterací a další metadata související se sledováním pracovních položek. Poskytuje také možnost spouštět dotazy, vyhledávat pracovní položky a přijímat oznámení o událostech pracovních položek prostřednictvím volání služeb. |
Příklady
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=7.1-preview.3
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": {
"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.CreatedDate": "2017-09-04T06:11:59.05Z",
"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-04T23:32:02.18Z",
"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": "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=7.1-preview.3
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": {
"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.CreatedDate": "2017-12-16T00:46:58.01Z",
"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-12-16T00:49:08.81Z",
"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": "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"
}
Definice
Name | Description |
---|---|
Reference |
Třída představující kolekci odkazů REST. |
Work |
Popisuje pracovní položku. |
Work |
Představuje odkaz na konkrétní verzi komentáře k pracovní položce. |
Work |
Rozbalení parametrů pro atributy pracovní položky. Možné možnosti jsou { None, Relations, Fields, Links, All } |
Work |
ReferenceLinks
Třída představující kolekci odkazů REST.
Name | Typ | Description |
---|---|---|
links |
object |
Zobrazení odkazů jen pro čtení. Vzhledem k tomu, že odkazy jsou jen pro čtení, chceme je zveřejnit jenom jako odkazy jen pro čtení. |
WorkItem
Popisuje pracovní položku.
Name | Typ | Description |
---|---|---|
_links |
Odkazy na související prostředky REST. |
|
commentVersionRef |
Odkaz na konkrétní verzi komentáře přidaného, upraveného nebo odstraněného v této revizi |
|
fields |
object |
Mapa pole a hodnot pro pracovní položku |
id |
integer |
ID pracovní položky. |
relations |
Vztahy pracovní položky. |
|
rev |
integer |
Číslo revize pracovní položky. |
url |
string |
WorkItemCommentVersionRef
Představuje odkaz na konkrétní verzi komentáře k pracovní položce.
Name | Typ | Description |
---|---|---|
commentId |
integer |
ID přiřazené ke komentáři. |
createdInRevision |
integer |
[Interní] Revize pracovní položky, do které byl tento komentář původně přidán. |
isDeleted |
boolean |
[Interní] Určuje, jestli byl komentář odstraněn. |
text |
string |
[Interní] Text komentáře |
url |
string |
|
version |
integer |
Číslo verze. |
WorkItemExpand
Rozbalení parametrů pro atributy pracovní položky. Možné možnosti jsou { None, Relations, Fields, Links, All }
Name | Typ | Description |
---|---|---|
all |
string |
Rozbalí vše. |
fields |
string |
Rozbalí se pracovní položka Pole. |
links |
string |
Odkazy pracovní položku rozbalí. |
none |
string |
Výchozí chování. |
relations |
string |
Rozbalení pracovní položky relace |
WorkItemRelation
Name | Typ | Description |
---|---|---|
attributes |
object |
Kolekce atributů odkazu. |
rel |
string |
Typ relace. |
url |
string |
Adresa URL odkazu. |