Queries - Get
Načte individuální dotaz a jeho podřízené položky.
GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries/{query}?api-version=7.1-preview.2GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries/{query}?$expand={$expand}&$depth={$depth}&$includeDeleted={$includeDeleted}&$useIsoDateFormat={$useIsoDateFormat}&api-version=7.1-preview.2Parametry identifikátoru URI
| Name | V | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Název organizace Azure DevOps. |
|
project
|
path | True |
string |
ID projektu nebo název projektu |
|
query
|
path | True |
string |
ID nebo cesta dotazu. |
|
api-version
|
query | True |
string |
Verze rozhraní API, která se má použít. Tato verze rozhraní API by měla být nastavená na 7.1-preview.2. |
|
$depth
|
query |
integer int32 |
Ve složce dotazů vraťte podřízené dotazy a složky do této hloubky. |
|
|
$expand
|
query |
Do výsledků zahrňte řetězec dotazu (wiql), klauzule, sloupce výsledků dotazu a možnosti řazení. |
||
|
$include
|
query |
boolean |
Zahrnutí odstraněných dotazů a složek |
|
|
$use
|
query |
boolean |
Klauzule dotazu DateTime budou formátovány pomocí formátu kompatibilního se standardem ISO 8601. |
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. Umožňuje také spouštět dotazy, prohledávat pracovní položky a přijímat oznámení o událostech pracovních položek prostřednictvím služeb. |
Příklady
| 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=7.1-preview.2
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=7.1-preview.2
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=7.1-preview.2
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=7.1-preview.2
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=7.1-preview.2
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=7.1-preview.2
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=7.1-preview.2
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"
}Definice
| Name | Description |
|---|---|
|
Identity |
Popisuje odkaz na identitu. |
|
Link |
Režim dotazu odkazu. |
|
Logical |
Logický operátor oddělující klauzuli podmínky |
|
Query |
Parametry rozbalení pro dotazy. Možné možnosti jsou { None, Wiql, Clauses, All, Minimal } |
|
Query |
Představuje položku v hierarchii dotazů pracovních položek. Může se jednat o dotaz nebo složku. |
|
Query |
Možnost rekurze pro použití ve stromovém dotazu. |
|
Query |
Typ dotazu. |
|
Reference |
Třída představující kolekci odkazů REST. |
|
Work |
Popisuje operaci pole pracovní položky. |
|
Work |
Odkaz na pole v pracovní položce |
|
Work |
Představuje klauzuli v dotazu na pracovní položku. Zobrazí se struktura dotazu na pracovní položky. |
|
Work |
Sloupec řazení. |
IdentityReference
Popisuje odkaz na identitu.
| Name | Typ | Description |
|---|---|---|
| _links |
Toto pole obsahuje nula nebo více zajímavých odkazů o předmětu grafu. Tyto odkazy mohou být vyvolány za účelem získání dalších relací nebo podrobnějších informací o tomto předmětu grafu. |
|
| descriptor |
string |
Popisovač je primárním způsobem, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejný předmět grafu napříč účty i organizacemi. |
| directoryAlias |
string |
Zastaralé – lze načíst dotazem uživatele Graphu, na který odkazuje položka "self" slovníku IdentityRef "_links". |
| displayName |
string |
Toto je jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém poskytovateli. |
| id |
string |
|
| imageUrl |
string |
Zastaralé – k dispozici v položce avatar ve slovníku IdentityRef "_links". |
| inactive |
boolean |
Zastaralé – lze načíst dotazem na stav členství graphu, na který odkazuje položka membershipState slovníku GraphUser "_links". |
| isAadIdentity |
boolean |
Zastaralé – lze odvodit z typu předmětu popisovače (Descriptor.IsAadUserType/Descriptor.IsAadGroupType). |
| isContainer |
boolean |
Zastaralé – lze odvodit z typu předmětu popisovače (Descriptor.IsGroupType) |
| isDeletedInOrigin |
boolean |
|
| name |
string |
Starší vlastnost back-compat Jedná se o hodnotu specifickou pro WIT z konstant. Bude na klientovi skrytá (ale existuje), pokud cílí na nejnovější verzi. |
| profileUrl |
string |
Zastaralé – nepoužívá se ve většině existujících implementací ToIdentityRef |
| uniqueName |
string |
Zastaralé – místo toho použijte Domain+PrincipalName. |
| url |
string |
Tato adresa URL je úplná trasa ke zdrojovému prostředku tohoto předmětu grafu. |
LinkQueryMode
Režim dotazu odkazu.
| Name | Typ | Description |
|---|---|---|
| linksOneHopDoesNotContain |
string |
Vrátí pracovní položky, které splňují zdroj, pouze pokud žádná propojená pracovní položka nesplňuje kritéria propojení a cíle. |
| linksOneHopMayContain |
string |
Vrátí pracovní položky, které splňují kritéria zdroje a propojení, i když žádná propojená pracovní položka nesplňuje cílová kritéria. |
| linksOneHopMustContain |
string |
Vrátí pracovní položky, u kterých jsou splněná kritéria zdroje, cíle a odkazu. |
| linksRecursiveDoesNotContain |
string |
|
| linksRecursiveMayContain |
string |
Vrátí pracovní položky jako hierarchii pracovních položek, které ve výchozím nastavení vyhovují zdroji. |
| linksRecursiveMustContain |
string |
|
| workItems |
string |
Vrátí plochý seznam pracovních položek. |
LogicalOperation
Logický operátor oddělující klauzuli podmínky
| Name | Typ | Description |
|---|---|---|
| and |
string |
|
| none |
string |
|
| or |
string |
QueryExpand
Parametry rozbalení pro dotazy. Možné možnosti jsou { None, Wiql, Clauses, All, Minimal }
| Name | Typ | Description |
|---|---|---|
| all |
string |
Rozbalí všechny vlastnosti. |
| clauses |
string |
Rozbalí sloupce, odkazy, changeinfo, text a klauzule WIQL. |
| minimal |
string |
Zobrazí minimální vlastnosti a text WIQL. |
| none |
string |
Rozbalí sloupce, odkazy a ChangeInfo. |
| wiql |
string |
Rozbalí sloupce, odkazy, changeinfo a text WIQL. |
QueryHierarchyItem
Představuje položku v hierarchii dotazů pracovních položek. Může se jednat o dotaz nebo složku.
| Name | Typ | Description |
|---|---|---|
| _links |
Odkazy na související prostředky REST |
|
| children |
Podřízené položky dotazů ve složce dotazů. |
|
| clauses |
Klauzule pro plochý dotaz. |
|
| columns |
Sloupce dotazu |
|
| createdBy |
Identita, která vytvořila položku dotazu. |
|
| createdDate |
string |
Při vytvoření položky dotazu. |
| filterOptions |
Režim dotazu odkazu. |
|
| hasChildren |
boolean |
Pokud se jedná o složku dotazu, označuje, jestli obsahuje podřízené položky. |
| id |
string |
ID položky dotazu. |
| isDeleted |
boolean |
Označuje, jestli je tato položka dotazu odstraněna. Pokud tuto hodnotu nastavíte u odstraněné položky dotazu na hodnotu false, zrušíte ji. Zrušením příkazu nebo složky se nevrátí změny oprávnění, které se na něj dříve použily. |
| isFolder |
boolean |
Označuje, jestli se jedná o složku dotazu nebo dotaz. |
| isInvalidSyntax |
boolean |
Označuje, jestli je hodnota WIQL tohoto dotazu neplatná. Příčinou může být neplatná syntaxe nebo neplatná cesta k oblasti nebo iteraci. |
| isPublic |
boolean |
Označuje, jestli je tato položka dotazu veřejná nebo soukromá. |
| lastExecutedBy |
Identita, která naposledy spustila dotaz. |
|
| lastExecutedDate |
string |
Kdy byl dotaz naposledy spuštěn. |
| lastModifiedBy |
Identita, která naposledy upravila položku dotazu |
|
| lastModifiedDate |
string |
Kdy byla položka dotazu naposledy změněna. |
| linkClauses |
Klauzule dotazu odkazu |
|
| name |
string |
Název položky dotazu. |
| path |
string |
Cesta k položce dotazu. |
| queryRecursionOption |
Možnost rekurze pro použití ve stromovém dotazu. |
|
| queryType |
Typ dotazu. |
|
| sortColumns |
Sloupce řazení dotazu. |
|
| sourceClauses |
Zdrojové klauzule ve stromovém dotazu nebo dotazu s jedním směrováním. |
|
| targetClauses |
Cílové klauzule ve stromu nebo dotazu na propojení s jedním segmentem směrování. |
|
| url |
string |
|
| wiql |
string |
Text WIQL dotazu |
QueryRecursionOption
Možnost rekurze pro použití ve stromovém dotazu.
| Name | Typ | Description |
|---|---|---|
| childFirst |
string |
Vrátí pracovní položky, které splňují cílová kritéria, i když žádná pracovní položka nesplňuje kritéria zdroje a odkazu. |
| parentFirst |
string |
Vrátí pracovní položky, které vyhovují zdroji, i když žádná propojená pracovní položka nesplňuje kritéria cíle a odkazu. |
QueryType
Typ dotazu.
| Name | Typ | Description |
|---|---|---|
| flat |
string |
Získá plochý seznam pracovních položek. |
| oneHop |
string |
Získá seznam pracovních položek a jejich přímé odkazy. |
| tree |
string |
Získá strom pracovních položek zobrazující jejich hierarchii propojení. |
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 jen pro čtení. |
WorkItemFieldOperation
Popisuje operaci pole pracovní položky.
| Name | Typ | Description |
|---|---|---|
| name |
string |
Popisný název operace |
| referenceName |
string |
Referenční název operace. |
WorkItemFieldReference
Odkaz na pole v pracovní položce
| Name | Typ | Description |
|---|---|---|
| name |
string |
Popisný název pole |
| referenceName |
string |
Referenční název pole. |
| url |
string |
Adresa URL REST prostředku. |
WorkItemQueryClause
Představuje klauzuli v dotazu na pracovní položku. Zobrazí se struktura dotazu na pracovní položky.
| Name | Typ | Description |
|---|---|---|
| clauses |
Podřízené klauzule, pokud je aktuální klauzule logickým operátorem |
|
| field |
Pole přidružené k podmínce |
|
| fieldValue |
Pravá strana podmínky při porovnání polí s poli |
|
| isFieldValue |
boolean |
Určuje, jestli se jedná o porovnání polí. |
| logicalOperator |
Logický operátor oddělující klauzuli podmínky |
|
| operator |
Operátor pole |
|
| value |
string |
Pravá strana podmínky při porovnání pole s hodnotou |
WorkItemQuerySortColumn
Sloupec řazení.
| Name | Typ | Description |
|---|---|---|
| descending |
boolean |
Směr řazení. |
| field |
Pole pracovní položky. |
Váš názor
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu: https://aka.ms/ContentUserFeedback.
Odeslat a zobrazit názory pro