Queries - Get
Tek bir sorguyu ve alt öğelerini alır
GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries/{query}?api-version=7.1-preview.2
GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries/{query}?$expand={$expand}&$depth={$depth}&$includeDeleted={$includeDeleted}&$useIsoDateFormat={$useIsoDateFormat}&api-version=7.1-preview.2
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
organization
|
path | True |
string |
Azure DevOps kuruluşunun adı. |
project
|
path | True |
string |
Proje Kimliği veya proje adı |
query
|
path | True |
string |
Sorgunun kimliği veya yolu. |
api-version
|
query | True |
string |
Kullanılacak API sürümü. Api'nin bu sürümünü kullanmak için bu değer '7.1-preview.2' olarak ayarlanmalıdır. |
$depth
|
query |
integer int32 |
Sorgular klasöründe alt sorguları ve klasörleri bu derinliğe döndür. |
|
$expand
|
query |
Sonuçlara sorgu dizesini (wiql), yan tümceleri, sorgu sonucu sütunlarını ve sıralama seçeneklerini ekleyin. |
||
$include
|
query |
boolean |
Silinen sorguları ve klasörleri dahil et |
|
$use
|
query |
boolean |
DateTime sorgu yan tümceleri ISO 8601 uyumlu biçim kullanılarak biçimlendirilecek |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
başarılı işlem |
Güvenlik
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 | İş öğelerini, sorguları, panoları, alan ve yineleme yollarını ve diğer iş öğesi izlemeyle ilgili meta verileri okuma olanağı verir. Ayrıca sorguları yürütme, iş öğelerini arama ve hizmet kancaları aracılığıyla iş öğesi olayları hakkında bildirim alma olanağı verir. |
Örnekler
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"
}
Tanımlar
Name | Description |
---|---|
Identity |
Bir kimliğe başvuru açıklar. |
Link |
Bağlantı sorgusu modu. |
Logical |
Koşul yan tümcesini ayıran mantıksal işleç |
Query |
Sorgular için genişletme parametreleri. Olası seçenekler şunlardır: { None, Wiql, Clauses, All, Minimal } |
Query |
İş öğesi sorgu hiyerarşisindeki bir öğeyi temsil eder. Bu bir sorgu veya klasör olabilir. |
Query |
Ağaç sorgusunda kullanmak için özyineleme seçeneği. |
Query |
Sorgu türü. |
Reference |
REST başvuru bağlantılarının koleksiyonunu temsil eden sınıf. |
Work |
İş öğesi alanı işlemini açıklar. |
Work |
İş öğesindeki bir alana başvuru |
Work |
İş öğesi sorgusundaki bir yan tümceyi temsil eder. Bu, bir iş öğesi sorgusunun yapısını gösterir. |
Work |
Sıralama sütunu. |
IdentityReference
Bir kimliğe başvuru açıklar.
Name | Tür | Description |
---|---|---|
_links |
Bu alan, grafik konusuyla ilgili sıfır veya daha fazla ilgi çekici bağlantı içerir. Bu bağlantılar, bu grafik konusu hakkında ek ilişkiler veya daha ayrıntılı bilgi edinmek için çağrılabilir. |
|
descriptor |
string |
Tanımlayıcı, sistem çalışırken graf konusuna başvurmanın birincil yoludur. Bu alan, hem Hesaplar hem de Kuruluşlar genelinde aynı graf konusunu benzersiz olarak tanımlar. |
directoryAlias |
string |
Kullanım dışı - IdentityRef "_links" sözlüğündeki "self" girişinde başvuruda bulunılan Graph kullanıcısı sorgulanarak alınabilir |
displayName |
string |
Bu, grafik konusunun benzersiz olmayan görünen adıdır. Bu alanı değiştirmek için kaynak sağlayıcıdaki değerini değiştirmeniz gerekir. |
id |
string |
|
imageUrl |
string |
Kullanım dışı - IdentityRef "_links" sözlüğündeki "avatar" girişinde kullanılabilir |
inactive |
boolean |
Kullanım dışı - GraphUser "_links" sözlüğündeki "membershipState" girdisinde başvurulan Graph üyelik durumu sorgulanarak alınabilir |
isAadIdentity |
boolean |
Kullanım dışı - Tanımlayıcının konu türünden çıkarılabilir (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
isContainer |
boolean |
Kullanım dışı - Tanımlayıcının konu türünden çıkarılabilir (Descriptor.IsGroupType) |
isDeletedInOrigin |
boolean |
|
name |
string |
Eski back-compat özelliği. Bu, Sabitler'den WIT'ye özgü değerdir. En yeni sürümü hedeflemedikleri sürece istemcide gizlenir (ancak mevcut olur) |
profileUrl |
string |
Kullanım dışı - ToIdentityRef'in önceden var olan uygulamalarının çoğunda kullanımda değil |
uniqueName |
string |
Kullanım dışı - bunun yerine Domain+PrincipalName kullanın |
url |
string |
Bu URL, bu grafik konusunun kaynak kaynağına giden tam yoldur. |
LinkQueryMode
Bağlantı sorgusu modu.
Name | Tür | Description |
---|---|---|
linksOneHopDoesNotContain |
string |
Yalnızca bağlantılı iş öğesi bağlantıyı ve hedef ölçütleri karşılamazsa, kaynağı karşılayan iş öğelerini döndürür. |
linksOneHopMayContain |
string |
Hiçbir bağlı iş öğesi hedef ölçüte uymasa bile kaynak ve bağlantı ölçütlerini karşılayan iş öğelerini döndürür. |
linksOneHopMustContain |
string |
Kaynak, hedef ve bağlantı ölçütlerinin tümünün karşılandığı iş öğelerini döndürür. |
linksRecursiveDoesNotContain |
string |
|
linksRecursiveMayContain |
string |
İş öğelerine varsayılan olarak kaynağı karşılayan bir iş öğeleri hiyerarşisi döndürür |
linksRecursiveMustContain |
string |
|
workItems |
string |
İş öğelerinin düz listesini döndürür. |
LogicalOperation
Koşul yan tümcesini ayıran mantıksal işleç
Name | Tür | Description |
---|---|---|
and |
string |
|
none |
string |
|
or |
string |
QueryExpand
Sorgular için genişletme parametreleri. Olası seçenekler şunlardır: { None, Wiql, Clauses, All, Minimal }
Name | Tür | Description |
---|---|---|
all |
string |
Tüm özellikleri genişletir |
clauses |
string |
Sütunlar, Bağlantılar, ChangeInfo, WIQL metni ve yan tümcelerini genişletir |
minimal |
string |
Minimum özellikleri ve WIQL metnini görüntüler |
none |
string |
Sütunları, Bağlantıları ve ChangeInfo'ları Genişletir |
wiql |
string |
Sütunlar, Bağlantılar, ChangeInfo ve WIQL metnini genişletir |
QueryHierarchyItem
İş öğesi sorgu hiyerarşisindeki bir öğeyi temsil eder. Bu bir sorgu veya klasör olabilir.
Name | Tür | Description |
---|---|---|
_links |
İlgili REST kaynaklarına bağlantı başvuruları. |
|
children |
Bir sorgu klasörünün içindeki alt sorgu öğeleri. |
|
clauses |
Düz sorgunun yan tümceleri. |
|
columns |
Sorgunun sütunları. |
|
createdBy |
Sorgu öğesini oluşturan kimlik. |
|
createdDate |
string |
Sorgu öğesi oluşturulduğunda. |
filterOptions |
Bağlantı sorgusu modu. |
|
hasChildren |
boolean |
Bu bir sorgu klasörüyse, alt öğe içerip içermediğini gösterir. |
id |
string |
Sorgu öğesinin kimliği. |
isDeleted |
boolean |
Bu sorgu öğesinin silinip silinmediğini gösterir. Silinen bir sorgu öğesinde bunu false olarak ayarlamak, öğeyi geri alır. Bir sorgunun veya klasörün kullanımdan kaldırılması, daha önce uygulanmış olan izin değişikliklerini geri getirmez. |
isFolder |
boolean |
Bunun bir sorgu klasörü veya sorgu olduğunu gösterir. |
isInvalidSyntax |
boolean |
Bu sorgunun WIQL değerinin geçersiz olup olmadığını gösterir. Bunun nedeni geçersiz söz dizimi veya artık geçerli olmayan bir alan/yineleme yolu olabilir. |
isPublic |
boolean |
Bu sorgu öğesinin genel mi yoksa özel mi olduğunu gösterir. |
lastExecutedBy |
Sorguyu en son çalıştıran kimlik. |
|
lastExecutedDate |
string |
Sorgunun son çalıştırıldığı zaman. |
lastModifiedBy |
Sorgu öğesini en son değiştiren kimlik. |
|
lastModifiedDate |
string |
Sorgu öğesinin en son ne zaman değiştirildiği. |
linkClauses |
Bağlantı sorgusu yan tümcesi. |
|
name |
string |
Sorgu öğesinin adı. |
path |
string |
Sorgu öğesinin yolu. |
queryRecursionOption |
Ağaç sorgusunda kullanmak için özyineleme seçeneği. |
|
queryType |
Sorgu türü. |
|
sortColumns |
Sorgunun sıralama sütunları. |
|
sourceClauses |
Bir ağaç veya tek atlamalı bağlantı sorgusundaki kaynak yan tümceleri. |
|
targetClauses |
Bir ağaç veya tek atlamalı bağlantı sorgusundaki hedef yan tümceleri. |
|
url |
string |
|
wiql |
string |
Sorgunun WIQL metni |
QueryRecursionOption
Ağaç sorgusunda kullanmak için özyineleme seçeneği.
Name | Tür | Description |
---|---|---|
childFirst |
string |
Hiçbir iş öğesi kaynak ve bağlantı ölçütlerini karşılamasa bile hedef ölçütleri karşılayan iş öğelerini döndürür. |
parentFirst |
string |
Hiçbir bağlı iş öğesi hedef ve bağlantı ölçütlerini karşılamasa bile, kaynağı karşılayan iş öğelerini döndürür. |
QueryType
Sorgu türü.
Name | Tür | Description |
---|---|---|
flat |
string |
İş öğelerinin düz bir listesini alır. |
oneHop |
string |
İş öğelerinin ve bunların doğrudan bağlantılarının listesini alır. |
tree |
string |
Bağlantı hiyerarşilerini gösteren bir iş öğesi ağacı alır. |
ReferenceLinks
REST başvuru bağlantılarının koleksiyonunu temsil eden sınıf.
Name | Tür | Description |
---|---|---|
links |
object |
Bağlantıların salt okunur görünümü. Başvuru bağlantıları salt okunur olduğundan, bunları yalnızca salt okunur olarak kullanıma açmak istiyoruz. |
WorkItemFieldOperation
İş öğesi alanı işlemini açıklar.
Name | Tür | Description |
---|---|---|
name |
string |
İşlemin kolay adı. |
referenceName |
string |
İşlemin başvuru adı. |
WorkItemFieldReference
İş öğesindeki bir alana başvuru
Name | Tür | Description |
---|---|---|
name |
string |
Alanın kolay adı. |
referenceName |
string |
Alanın başvuru adı. |
url |
string |
Kaynağın REST URL'si. |
WorkItemQueryClause
İş öğesi sorgusundaki bir yan tümceyi temsil eder. Bu, bir iş öğesi sorgusunun yapısını gösterir.
Name | Tür | Description |
---|---|---|
clauses |
Geçerli yan tümce bir mantıksal işleçse alt yan tümceleri |
|
field |
Koşulla ilişkili alan |
|
fieldValue |
Alandan alana karşılaştırma yapıldığında koşulun sağ tarafı |
|
isFieldValue |
boolean |
Bunun alan karşılaştırması olup olmadığını belirler |
logicalOperator |
Koşul yan tümcesini ayıran mantıksal işleç |
|
operator |
Alan işleci |
|
value |
string |
Bir alandan değere karşılaştırma olduğunda koşulun sağ tarafı |
WorkItemQuerySortColumn
Sıralama sütunu.
Name | Tür | Description |
---|---|---|
descending |
boolean |
Sıralama ölçütü. |
field |
İş öğesi alanı. |
Geri Bildirim
https://aka.ms/ContentUserFeedback.
Çok yakında: 2024 boyunca, içerik için geri bildirim mekanizması olarak GitHub Sorunları’nı kullanımdan kaldıracak ve yeni bir geri bildirim sistemiyle değiştireceğiz. Daha fazla bilgi için bkz.Gönderin ve geri bildirimi görüntüleyin