Queries - Get
Pobiera pojedyncze zapytanie i jego elementy podrzędne
GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries/{query}?api-version=5.0GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries/{query}?$expand={$expand}&$depth={$depth}&$includeDeleted={$includeDeleted}&api-version=5.0Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Nazwa organizacji usługi Azure DevOps. |
|
project
|
path | True |
string |
Identyfikator projektu lub nazwa projektu |
|
query
|
path | True |
string |
Identyfikator lub ścieżka zapytania. |
|
api-version
|
query | True |
string |
Wersja interfejsu API do użycia. Należy ustawić wartość "5.0", aby używać tej wersji interfejsu API. |
|
$depth
|
query |
integer int32 |
W folderze zapytań zwróć podrzędne zapytania i foldery do tej głębi. |
|
|
$expand
|
query |
Uwzględnij ciąg zapytania (wiql), klauzule, kolumny wyników zapytania i opcje sortowania w wynikach. |
||
|
$include
|
query |
boolean |
Uwzględnianie usuniętych zapytań i folderów |
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 200 OK |
operacja zakończona powodzeniem |
Zabezpieczenia
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
| Nazwa | Opis |
|---|---|
| vso.work | Umożliwia odczytywanie elementów roboczych, zapytań, tablic, ścieżek obszaru i iteracji oraz innych metadanych powiązanych ze śledzeniem elementów roboczych. Umożliwia również wykonywanie zapytań, wyszukiwanie elementów roboczych i odbieranie powiadomień o zdarzeniach elementów roboczych za pośrednictwem punktów zaczepienia usługi. |
Przykłady
| Deleted query by ID |
| Flat query with expanded clauses |
| Folder by ID |
| Folder by Name |
| Hierarchical query with expanded clauses |
| Query by ID |
| Query by Name |
Deleted query by ID
Sample Request
GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?$includeDeleted=true&api-version=5.0
Sample Response
{
"id": "342f0f44-4069-46b1-a940-3d0468979ceb",
"name": "Active Bugs",
"path": "My Queries/Website/Active Bugs",
"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"
},
"createdDate": "2014-03-18T17:18:36.06Z",
"lastModifiedBy": {
"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"
},
"lastModifiedDate": "2014-03-18T17:18:36.06Z",
"lastExecutedBy": {
"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"
},
"lastExecutedDate": "2014-03-18T17:19:36.06Z",
"isDeleted": true,
"isPublic": false,
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/342f0f44-4069-46b1-a940-3d0468979ceb"
},
"html": {
"href": "https://dev.azure.com/fabrikam/web/qr.aspx?pguid=6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c&qid=342f0f44-4069-46b1-a940-3d0468979ceb"
},
"parent": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
},
"wiql": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/wiql/342f0f44-4069-46b1-a940-3d0468979ceb"
}
},
"url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/342f0f44-4069-46b1-a940-3d0468979ceb"
}Flat query with expanded clauses
Sample Request
GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?$expand=clauses&api-version=5.0
Sample Response
{
"id": "df60fdf6-3b5f-4928-aae8-29ee63df6e31",
"name": "All Bugs",
"path": "Shared Queries/Website team/All Bugs",
"queryType": "flat",
"columns": [
{
"referenceName": "System.Id",
"name": "ID",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Id"
},
{
"referenceName": "System.Title",
"name": "Title",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
},
{
"referenceName": "System.State",
"name": "State",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.State"
}
],
"sortColumns": [
{
"field": {
"referenceName": "Microsoft.VSTS.Common.Priority",
"name": "Priority",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.Priority"
},
"descending": false
},
{
"field": {
"referenceName": "System.CreatedDate",
"name": "Created Date",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.CreatedDate"
},
"descending": true
}
],
"wiql": "Select [System.Id], [System.Title], [System.State] From WorkItems Where [System.WorkItemType] = 'Bug' order by [Microsoft.VSTS.Common.Priority] asc, [System.CreatedDate] desc",
"isPublic": true,
"clauses": {
"field": {
"referenceName": "System.WorkItemType",
"name": "Work Item Type",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.WorkItemType"
},
"operator": {
"referenceName": "SupportedOperations.Equals",
"name": "="
},
"value": "Bug"
},
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/df60fdf6-3b5f-4928-aae8-29ee63df6e31"
},
"html": {
"href": "https://dev.azure.com/fabrikam/web/qr.aspx?pguid=6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c&qid=df60fdf6-3b5f-4928-aae8-29ee63df6e31"
},
"parent": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/addcb8b3-12d0-4f2c-b6ca-52bb584ae286"
},
"wiql": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/wiql/df60fdf6-3b5f-4928-aae8-29ee63df6e31"
}
},
"url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/df60fdf6-3b5f-4928-aae8-29ee63df6e31"
}Folder by ID
Sample Request
GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?api-version=5.0
Sample Response
{
"id": "8a8c8212-15ca-41ed-97aa-1d6fbfbcd581",
"name": "Website team",
"path": "Shared Queries/Website team",
"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"
},
"createdDate": "2016-06-01T16:58:56.323Z",
"lastModifiedBy": {
"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"
},
"lastModifiedDate": "2016-06-01T16:58:56.323Z",
"isFolder": true,
"hasChildren": true,
"isPublic": true,
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
},
"html": {
"href": "https://dev.azure.com/fabrikam/web/qr.aspx?pguid=6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c&qid=8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
},
"parent": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/eb5c1e25-9b3e-4416-a833-e500122882c7"
}
},
"url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
}Folder by Name
Sample Request
GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?api-version=5.0
Sample Response
{
"id": "8a8c8212-15ca-41ed-97aa-1d6fbfbcd581",
"name": "Website team",
"path": "Shared Queries/Website team",
"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"
},
"createdDate": "2016-06-01T16:58:56.323Z",
"lastModifiedBy": {
"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"
},
"lastModifiedDate": "2016-06-01T16:58:56.323Z",
"isFolder": true,
"hasChildren": true,
"isPublic": true,
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
},
"html": {
"href": "https://dev.azure.com/fabrikam/web/qr.aspx?pguid=6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c&qid=8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
},
"parent": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/eb5c1e25-9b3e-4416-a833-e500122882c7"
}
},
"url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
}Hierarchical query with expanded clauses
Sample Request
GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?$expand=clauses&api-version=5.0
Sample Response
{
"id": "f0ade206-32f8-4360-9254-ad33f906cd2e",
"name": "Active stories with tasks",
"path": "Shared Queries/Website team/Active stories with tasks",
"queryType": "tree",
"columns": [
{
"referenceName": "System.Id",
"name": "ID",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Id"
},
{
"referenceName": "System.WorkItemType",
"name": "Work Item Type",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.WorkItemType"
},
{
"referenceName": "System.Title",
"name": "Title",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
},
{
"referenceName": "System.AssignedTo",
"name": "Assigned To",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.AssignedTo"
},
{
"referenceName": "System.State",
"name": "State",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.State"
},
{
"referenceName": "System.Tags",
"name": "Tags",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Tags"
}
],
"wiql": "SELECT [System.Id],[System.WorkItemType],[System.Title],[System.AssignedTo],[System.State],[System.Tags] FROM WorkItemLinks WHERE ([Source].[System.TeamProject] = @project AND [Source].[System.WorkItemType] = 'Product Backlog Item' AND [Source].[System.State] <> 'Removed') AND ([System.Links.LinkType] = 'System.LinkTypes.Hierarchy-Forward') AND ([Target].[System.WorkItemType] = 'Task') mode(Recursive)",
"isPublic": true,
"linkClauses": {
"logicalOperator": "and",
"clauses": [
{
"field": {
"referenceName": "System.Links.LinkType",
"name": "Link Type",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Links.LinkType"
},
"operator": {
"referenceName": "SupportedOperations.Equals",
"name": "="
},
"value": "System.LinkTypes.Hierarchy-Forward"
}
]
},
"filterOptions": "linksRecursiveMayContain",
"sourceClauses": {
"logicalOperator": "and",
"clauses": [
{
"field": {
"referenceName": "System.TeamProject",
"name": "Team Project",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.TeamProject"
},
"operator": {
"referenceName": "SupportedOperations.Equals",
"name": "="
},
"value": "@project"
},
{
"field": {
"referenceName": "System.WorkItemType",
"name": "Work Item Type",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.WorkItemType"
},
"operator": {
"referenceName": "SupportedOperations.Equals",
"name": "="
},
"value": "Product Backlog Item"
},
{
"field": {
"referenceName": "System.State",
"name": "State",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.State"
},
"operator": {
"referenceName": "SupportedOperations.NotEquals",
"name": "<>"
},
"value": "Removed"
}
]
},
"targetClauses": {
"logicalOperator": "and",
"clauses": [
{
"field": {
"referenceName": "System.WorkItemType",
"name": "Work Item Type",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.WorkItemType"
},
"operator": {
"referenceName": "SupportedOperations.Equals",
"name": "="
},
"value": "Task"
}
]
},
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/f0ade206-32f8-4360-9254-ad33f906cd2e"
},
"html": {
"href": "https://dev.azure.com/fabrikam/web/qr.aspx?pguid=6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c&qid=f0ade206-32f8-4360-9254-ad33f906cd2e"
},
"parent": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/addcb8b3-12d0-4f2c-b6ca-52bb584ae286"
},
"wiql": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/wiql/f0ade206-32f8-4360-9254-ad33f906cd2e"
}
},
"url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/f0ade206-32f8-4360-9254-ad33f906cd2e"
}Query by ID
Sample Request
GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?api-version=5.0
Sample Response
{
"id": "342f0f44-4069-46b1-a940-3d0468979ceb",
"name": "All Bugs",
"path": "Shared Queries/Website team/All Bugs",
"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"
},
"createdDate": "2014-03-18T17:18:36.06Z",
"lastModifiedBy": {
"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"
},
"lastModifiedDate": "2014-03-18T17:18:36.06Z",
"lastExecutedBy": {
"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"
},
"lastExecutedDate": "2014-03-18T17:19:36.06Z",
"isPublic": true,
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/342f0f44-4069-46b1-a940-3d0468979ceb"
},
"html": {
"href": "https://dev.azure.com/fabrikam/web/qr.aspx?pguid=6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c&qid=342f0f44-4069-46b1-a940-3d0468979ceb"
},
"parent": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
},
"wiql": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/wiql/342f0f44-4069-46b1-a940-3d0468979ceb"
}
},
"url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/342f0f44-4069-46b1-a940-3d0468979ceb"
}Query by Name
Sample Request
GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?api-version=5.0
Sample Response
{
"id": "342f0f44-4069-46b1-a940-3d0468979ceb",
"name": "All Bugs",
"path": "Shared Queries/Website team/All Bugs",
"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"
},
"createdDate": "2014-03-18T17:18:36.06Z",
"lastModifiedBy": {
"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"
},
"lastModifiedDate": "2014-03-18T17:18:36.06Z",
"lastExecutedBy": {
"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"
},
"lastExecutedDate": "2014-03-18T17:19:36.06Z",
"isPublic": true,
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/342f0f44-4069-46b1-a940-3d0468979ceb"
},
"html": {
"href": "https://dev.azure.com/fabrikam/web/qr.aspx?pguid=6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c&qid=342f0f44-4069-46b1-a940-3d0468979ceb"
},
"parent": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
},
"wiql": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/wiql/342f0f44-4069-46b1-a940-3d0468979ceb"
}
},
"url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/342f0f44-4069-46b1-a940-3d0468979ceb"
}Definicje
| Nazwa | Opis |
|---|---|
|
Identity |
Opisuje odwołanie do tożsamości. |
|
Link |
Tryb zapytania łącza. |
|
Logical |
Operator logiczny oddzielający klauzulę warunku |
|
Query |
Parametry rozwijania zapytań. Możliwe opcje to { None, Wiql, Clauses, All, Minimum } |
|
Query |
Reprezentuje element w hierarchii zapytań elementu roboczego. Może to być zapytanie lub folder. |
|
Query |
Opcja rekursji do użycia w zapytaniu drzewa. |
|
Query |
Typ zapytania. |
|
Reference |
Klasa reprezentująca kolekcję linków referencyjnych REST. |
|
Work |
Opisuje operację pola elementu roboczego. |
|
Work |
Odwołanie do pola w elemencie roboczym |
|
Work |
Reprezentuje klauzulę w zapytaniu elementu roboczego. Spowoduje to wyświetlenie struktury zapytania elementu roboczego. |
|
Work |
Kolumna sortowania. |
IdentityReference
Opisuje odwołanie do tożsamości.
| Nazwa | Typ | Opis |
|---|---|---|
| _links |
To pole zawiera zero lub więcej interesujących linków dotyczących tematu grafu. Te linki mogą być wywoływane w celu uzyskania dodatkowych relacji lub bardziej szczegółowych informacji na temat tego tematu grafu. |
|
| descriptor |
string |
Deskryptor jest podstawowym sposobem odwoływanie się do tematu grafu podczas działania systemu. To pole będzie jednoznacznie identyfikować ten sam temat grafu zarówno w ramach kont, jak i organizacji. |
| directoryAlias |
string |
|
| displayName |
string |
Jest to nieu unikatowa nazwa wyświetlana podmiotu grafu. Aby zmienić to pole, należy zmienić jego wartość u dostawcy źródłowego. |
| id |
string |
|
| imageUrl |
string |
|
| inactive |
boolean |
|
| isAadIdentity |
boolean |
|
| isContainer |
boolean |
|
| isDeletedInOrigin |
boolean |
|
| name |
string |
Starsza właściwość back-compat. Była to wartość specyficzna dla funkcji WIT z stałych. Będzie ukryty (ale istnieje) na kliencie, chyba że są one przeznaczone dla najnowszej wersji |
| profileUrl |
string |
|
| uniqueName |
string |
|
| url |
string |
Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu. |
LinkQueryMode
Tryb zapytania łącza.
| Nazwa | Typ | Opis |
|---|---|---|
| linksOneHopDoesNotContain |
string |
Zwraca elementy robocze spełniające źródło tylko wtedy, gdy żaden połączony element roboczy nie spełnia kryteriów łącza i elementu docelowego. |
| linksOneHopMayContain |
string |
Zwraca elementy robocze spełniające kryteria źródła i łącza, nawet jeśli żaden połączony element roboczy nie spełnia kryteriów docelowych. |
| linksOneHopMustContain |
string |
Zwraca elementy robocze, w których wszystkie kryteria źródła, elementu docelowego i łącza są spełnione. |
| linksRecursiveDoesNotContain |
string |
|
| linksRecursiveMayContain |
string |
Zwraca elementy robocze hierarchię elementów roboczych, które domyślnie spełniają kryteria źródła |
| linksRecursiveMustContain |
string |
|
| workItems |
string |
LogicalOperation
Operator logiczny oddzielający klauzulę warunku
| Nazwa | Typ | Opis |
|---|---|---|
| aND |
string |
|
| nONE |
string |
|
| oR |
string |
QueryExpand
Parametry rozwijania zapytań. Możliwe opcje to { None, Wiql, Clauses, All, Minimum }
| Nazwa | Typ | Opis |
|---|---|---|
| all |
string |
Rozwija wszystkie właściwości |
| clauses |
string |
Rozwija kolumny, łącza, ChangeInfo, tekst I klauzule WIQL |
| minimal |
string |
Wyświetla minimalne właściwości i tekst WIQL |
| none |
string |
Rozwija kolumny, łącza i informacje o zmianie |
| wiql |
string |
Rozwija kolumny, łącza, tekst ChangeInfo i WIQL |
QueryHierarchyItem
Reprezentuje element w hierarchii zapytań elementu roboczego. Może to być zapytanie lub folder.
| Nazwa | Typ | Opis |
|---|---|---|
| _links |
Linki do powiązanych zasobów REST. |
|
| children |
Podrzędne elementy zapytania wewnątrz folderu zapytania. |
|
| clauses |
Klauzule dla zapytania płaskiego. |
|
| columns |
Kolumny zapytania. |
|
| createdBy |
Tożsamość, która utworzyła element zapytania. |
|
| createdDate |
string |
Po utworzeniu elementu zapytania. |
| filterOptions |
Tryb zapytania łącza. |
|
| hasChildren |
boolean |
Jeśli jest to folder zapytań, wskazuje, czy zawiera jakiekolwiek elementy podrzędne. |
| id |
string |
Identyfikator elementu zapytania. |
| isDeleted |
boolean |
Wskazuje, czy ten element zapytania został usunięty. Ustawienie wartości false w usuniętym elemencie zapytania spowoduje jego cofnięcie. Usunięcie zapytania lub folderu nie spowoduje przywrócenia zmian uprawnień, które zostały wcześniej do niego zastosowane. |
| isFolder |
boolean |
Wskazuje, czy jest to folder zapytania, czy zapytanie. |
| isInvalidSyntax |
boolean |
Wskazuje, czy WIQL tego zapytania jest nieprawidłowy. Może to być spowodowane nieprawidłową składnią lub nieprawidłową ścieżką obszaru/iteracji. |
| isPublic |
boolean |
Wskazuje, czy ten element zapytania jest publiczny lub prywatny. |
| lastExecutedBy |
Tożsamość, która ostatnio uruchomiła zapytanie. |
|
| lastExecutedDate |
string |
Kiedy zapytanie zostało ostatnio uruchomione. |
| lastModifiedBy |
Tożsamość, która ostatnio zmodyfikowała element zapytania. |
|
| lastModifiedDate |
string |
Kiedy element zapytania został ostatnio zmodyfikowany. |
| linkClauses |
Klauzula kwerendy linku. |
|
| name |
string |
Nazwa elementu zapytania. |
| path |
string |
Ścieżka elementu zapytania. |
| queryRecursionOption |
Opcja rekursji do użycia w zapytaniu drzewa. |
|
| queryType |
Typ zapytania. |
|
| sortColumns |
Sortowanie kolumn zapytania. |
|
| sourceClauses |
Klauzule źródłowe w zapytaniu linku drzewa lub jednego przeskoku. |
|
| targetClauses |
Klauzule docelowe w zapytaniu linku drzewa lub jednego przeskoku. |
|
| url |
string |
|
| wiql |
string |
Tekst WIQL zapytania |
QueryRecursionOption
Opcja rekursji do użycia w zapytaniu drzewa.
| Nazwa | Typ | Opis |
|---|---|---|
| childFirst |
string |
Zwraca elementy robocze spełniające kryteria docelowe, nawet jeśli żaden element roboczy nie spełnia kryteriów źródła i łącza. |
| parentFirst |
string |
Zwraca elementy robocze spełniające źródło, nawet jeśli żaden połączony element roboczy nie spełnia kryteriów elementu docelowego i linku. |
QueryType
Typ zapytania.
| Nazwa | Typ | Opis |
|---|---|---|
| flat |
string |
Pobiera płaską listę elementów roboczych. |
| oneHop |
string |
Pobiera listę elementów roboczych i ich linków bezpośrednich. |
| tree |
string |
Pobiera drzewo elementów roboczych z ich hierarchią łączy. |
ReferenceLinks
Klasa reprezentująca kolekcję linków referencyjnych REST.
| Nazwa | Typ | Opis |
|---|---|---|
| links |
object |
Widok linków w trybie tylko do odczytu. Ponieważ linki odwołania są tylko do odczytu, chcemy uwidocznić je tylko jako tylko do odczytu. |
WorkItemFieldOperation
Opisuje operację pola elementu roboczego.
| Nazwa | Typ | Opis |
|---|---|---|
| name |
string |
Nazwa operacji. |
| referenceName |
string |
Nazwa odwołania do operacji. |
WorkItemFieldReference
Odwołanie do pola w elemencie roboczym
| Nazwa | Typ | Opis |
|---|---|---|
| name |
string |
Nazwa pola. |
| referenceName |
string |
Nazwa odwołania do pola. |
| url |
string |
Adres URL REST zasobu. |
WorkItemQueryClause
Reprezentuje klauzulę w zapytaniu elementu roboczego. Spowoduje to wyświetlenie struktury zapytania elementu roboczego.
| Nazwa | Typ | Opis |
|---|---|---|
| clauses |
Klauzule podrzędne, jeśli bieżąca klauzula jest operatorem logicznym |
|
| field |
Pole skojarzone z warunkiem |
|
| fieldValue |
Prawa strona warunku, gdy porównywanie pól do pola |
|
| isFieldValue |
boolean |
Określa, czy jest to pole do porównania pól |
| logicalOperator |
Operator logiczny oddzielający klauzulę warunku |
|
| operator |
Operator pola |
|
| value |
string |
Prawa strona warunku, gdy pole do porównania wartości |
WorkItemQuerySortColumn
Kolumna sortowania.
| Nazwa | Typ | Opis |
|---|---|---|
| descending |
boolean |
Kierunek sortowania według. |
| field |
Pole elementu roboczego. |
Opinia
Dostępne już wkrótce: W 2024 r. będziemy stopniowo wycofywać zgłoszenia z serwisu GitHub jako mechanizm przesyłania opinii na temat zawartości i zastępować go nowym systemem opinii. Aby uzyskać więcej informacji, sprawdź: https://aka.ms/ContentUserFeedback.
Prześlij i wyświetl opinię dla