Partilhar via

Queries - Get Queries Batch

  • Referência
Service:
Work Item Tracking
API Version:
7.1-preview.1

Obtém uma lista de consultas por IDs (máximo de 1000)

POST https://dev.azure.com/{organization}/{project}/_apis/wit/queriesbatch?api-version=7.1-preview.1

Parâmetros de URI

Nome Em Obrigatório Tipo Description
organization
 path True

string

O nome da organização do Azure DevOps.
project
 path True

string

ID do projeto ou nome do projeto
api-version
 query True

string

Versão da API a ser usada. Isso deve ser definido como '7.1-preview.1' para usar essa versão da api.

Corpo da solicitação

Nome Tipo Description
$expand

QueryExpand

Os parâmetros de expansão para consultas. As opções possíveis são { None, Wiql, Clauses, All, Minimal }
errorPolicy

QueryErrorPolicy

O sinalizador para controlar a política de erro em uma solicitação de lote de consulta. As opções possíveis são { Fail, Omitir }.
ids

string[]

As IDs de consulta solicitadas

Respostas

Nome Tipo Description
200 OK

QueryHierarchyItem[]

operação bem-sucedida

Segurança

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Nome Description
vso.work Concede a capacidade de ler itens de trabalho, consultas, quadros, caminhos de área e iterações e outros metadados relacionados ao acompanhamento de itens de trabalho. Também concede a capacidade de executar consultas, pesquisar itens de trabalho e receber notificações sobre eventos de item de trabalho por meio de ganchos de serviço.

Exemplos

Gets a list of queries by ids

Sample Request

POST https://dev.azure.com/fabrikam/{project}/_apis/wit/queriesbatch?api-version=7.1-preview.1

{
  "ids": [
    "c6725763-d9ae-487e-bb42-00222e2f4d9f",
    "c19eec2d-07a0-4c20-be57-3f7903792ca6",
    "298f94fd-30ea-40f3-8d25-3202c9effa3a"
  ]
}

Sample Response

Status code:
200 
{
  "count": 3,
  "value": [
    {
      "id": "c6725763-d9ae-487e-bb42-00222e2f4d9f",
      "name": "Work Items With Summary Values",
      "path": "Shared Queries/Troubleshooting/Work Items With Summary Values",
      "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": "2018-09-26T19:01:44.6Z",
      "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": "2018-09-26T19:01:44.6Z",
      "queryType": "oneHop",
      "isPublic": true,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/c6725763-d9ae-487e-bb42-00222e2f4d9f"
        },
        "html": {
          "href": "http://localhost:8080/tfs/web/qr.aspx?pguid=833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d&qid=c6725763-d9ae-487e-bb42-00222e2f4d9f"
        },
        "parent": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/0389af80-0be8-4c1b-800e-9e91d081e052"
        },
        "wiql": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/wiql/c6725763-d9ae-487e-bb42-00222e2f4d9f"
        }
      },
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/c6725763-d9ae-487e-bb42-00222e2f4d9f"
    },
    {
      "id": "c19eec2d-07a0-4c20-be57-3f7903792ca6",
      "name": "Product Planning",
      "path": "Shared Queries/Product Planning",
      "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": "2018-09-26T19:01:44.6Z",
      "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": "2018-09-26T19:01:44.6Z",
      "queryType": "flat",
      "isPublic": true,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/c19eec2d-07a0-4c20-be57-3f7903792ca6"
        },
        "html": {
          "href": "http://localhost:8080/tfs/web/qr.aspx?pguid=833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d&qid=c19eec2d-07a0-4c20-be57-3f7903792ca6"
        },
        "parent": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/06285cdf-e6f2-4230-80fd-66a2e11116d2"
        },
        "wiql": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/wiql/c19eec2d-07a0-4c20-be57-3f7903792ca6"
        }
      },
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/c19eec2d-07a0-4c20-be57-3f7903792ca6"
    },
    {
      "id": "298f94fd-30ea-40f3-8d25-3202c9effa3a",
      "name": "Current Iteration",
      "path": "Shared Queries/Current Iteration",
      "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": "2018-09-26T19:01:44.6Z",
      "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": "2018-09-26T19:01:44.6Z",
      "isFolder": true,
      "hasChildren": true,
      "isPublic": true,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/298f94fd-30ea-40f3-8d25-3202c9effa3a"
        },
        "html": {
          "href": "http://localhost:8080/tfs/web/qr.aspx?pguid=833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d&qid=298f94fd-30ea-40f3-8d25-3202c9effa3a"
        },
        "parent": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/06285cdf-e6f2-4230-80fd-66a2e11116d2"
        }
      },
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/298f94fd-30ea-40f3-8d25-3202c9effa3a"
    }
  ]
}

Definições

Nome Description
IdentityReference

Descreve uma referência a uma identidade.
LinkQueryMode

O modo de consulta de link.
LogicalOperation

Operador lógico que separa a cláusula condition
QueryBatchGetRequest

Descreve uma solicitação para obter uma lista de consultas
QueryErrorPolicy

O sinalizador para controlar a política de erro em uma solicitação de lote de consulta. As opções possíveis são { Fail, Omitir }.
QueryExpand

Os parâmetros de expansão para consultas. As opções possíveis são { None, Wiql, Clauses, All, Minimal }
QueryHierarchyItem

Representa um item na hierarquia de consulta do item de trabalho. Isso pode ser uma consulta ou uma pasta.
QueryRecursionOption

A opção de recursão para uso em uma consulta de árvore.
QueryType

O tipo de consulta.
ReferenceLinks

A classe para representar uma coleção de links de referência REST.
WorkItemFieldOperation

Descreve uma operação de campo de item de trabalho.
WorkItemFieldReference

Referência a um campo em um item de trabalho
WorkItemQueryClause

Representa uma cláusula em uma consulta de item de trabalho. Isso mostra a estrutura de uma consulta de item de trabalho.
WorkItemQuerySortColumn

Uma coluna de classificação.

IdentityReference

Descreve uma referência a uma identidade.

Nome Tipo Description
_links

ReferenceLinks

Esse campo contém zero ou mais links interessantes sobre o assunto do grafo. Esses links podem ser invocados para obter relações adicionais ou informações mais detalhadas sobre esse assunto do grafo.
descriptor

string

O descritor é a principal maneira de referenciar o assunto do grafo enquanto o sistema está em execução. Esse campo identificará exclusivamente o mesmo assunto de grafo entre contas e organizações.
directoryAlias

string

Preterido – pode ser recuperado consultando o usuário do Graph referenciado na entrada "self" do dicionário IdentityRef "_links"
displayName

string

Esse é o nome de exibição não exclusivo do assunto do grafo. Para alterar esse campo, você deve alterar seu valor no provedor de origem.
id

string

imageUrl

string

Preterido – Disponível na entrada "avatar" do dicionário IdentityRef "_links"
inactive

boolean

Preterido – pode ser recuperado consultando o estado de associação do Graph referenciado na entrada "membershipState" do dicionário "_links" do GraphUser
isAadIdentity

boolean

Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer

boolean

Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsGroupType)
isDeletedInOrigin

boolean

name

string

Propriedade back-compat herdada. Esse foi o valor específico de WIT de Constantes. Será ocultado (mas existe) no cliente, a menos que ele esteja direcionando a versão mais recente
profileUrl

string

Preterido – não em uso na maioria das implementações preexistir de ToIdentityRef
uniqueName

string

Preterido – use Domain+PrincipalName em vez disso
url

string

Essa URL é a rota completa para o recurso de origem desta entidade de grafo.

LinkQueryMode

O modo de consulta de link.

Nome Tipo Description
linksOneHopDoesNotContain

string

Retorna itens de trabalho que satisfazem a origem, somente se nenhum item de trabalho vinculado atender aos critérios de link e de destino.
linksOneHopMayContain

string

Retorna itens de trabalho que atendem aos critérios de origem e link, mesmo que nenhum item de trabalho vinculado atenda aos critérios de destino.
linksOneHopMustContain

string

Retorna itens de trabalho em que os critérios de origem, destino e link são todos atendidos.
linksRecursiveDoesNotContain

string

linksRecursiveMayContain

string

Retorna itens de trabalho uma hierarquia de itens de trabalho que, por padrão, satisfazem a origem
linksRecursiveMustContain

string

workItems

string

Retorna uma lista simples de itens de trabalho.

LogicalOperation

Operador lógico que separa a cláusula condition

Nome Tipo Description
and

string

none

string

or

string

QueryBatchGetRequest

Descreve uma solicitação para obter uma lista de consultas

Nome Tipo Description
$expand

QueryExpand

Os parâmetros de expansão para consultas. As opções possíveis são { None, Wiql, Clauses, All, Minimal }
errorPolicy

QueryErrorPolicy

O sinalizador para controlar a política de erro em uma solicitação de lote de consulta. As opções possíveis são { Fail, Omitir }.
ids

string[]

As IDs de consulta solicitadas

QueryErrorPolicy

O sinalizador para controlar a política de erro em uma solicitação de lote de consulta. As opções possíveis são { Fail, Omitir }.

Nome Tipo Description
fail

string

omit

string

QueryExpand

Os parâmetros de expansão para consultas. As opções possíveis são { None, Wiql, Clauses, All, Minimal }

Nome Tipo Description
all

string

Expande todas as propriedades
clauses

string

Expande colunas, links, changeInfo, texto WIQL e cláusulas
minimal

string

Exibe propriedades mínimas e o texto WIQL
none

string

Expande Colunas, Links e ChangeInfo
wiql

string

Expande colunas, links, texto ChangeInfo e WIQL

QueryHierarchyItem

Representa um item na hierarquia de consulta do item de trabalho. Isso pode ser uma consulta ou uma pasta.

Nome Tipo Description
_links

ReferenceLinks

Vincular referências a recursos REST relacionados.
children

QueryHierarchyItem[]

Os itens de consulta filho dentro de uma pasta de consulta.
clauses

WorkItemQueryClause

As cláusulas de uma consulta simples.
columns

WorkItemFieldReference[]

As colunas da consulta.
createdBy

IdentityReference

A identidade que criou o item de consulta.
createdDate

string

Quando o item de consulta foi criado.
filterOptions

LinkQueryMode

O modo de consulta de link.
hasChildren

boolean

Se essa for uma pasta de consulta, indica se ela contém filhos.
id

string

A ID do item de consulta.
isDeleted

boolean

Indica se esse item de consulta foi excluído. Definir isso como false em um item de consulta excluído o desmarcará. Desmarcando uma consulta ou pasta não trará de volta as alterações de permissão que foram aplicadas anteriormente a ela.
isFolder

boolean

Indica se esta é uma pasta de consulta ou uma consulta.
isInvalidSyntax

boolean

Indica se o WIQL dessa consulta é inválido. Isso pode ser devido à sintaxe inválida ou a um caminho de iteração/área não mais válido.
isPublic

boolean

Indica se esse item de consulta é público ou privado.
lastExecutedBy

IdentityReference

A identidade que executou a consulta pela última vez.
lastExecutedDate

string

Quando a consulta foi executada pela última vez.
lastModifiedBy

IdentityReference

A identidade que modificou o item de consulta pela última vez.
lastModifiedDate

string

Quando o item de consulta foi modificado pela última vez.
linkClauses

WorkItemQueryClause

A cláusula de consulta de link.
name

string

O nome do item de consulta.
path

string

O caminho do item de consulta.
queryRecursionOption

QueryRecursionOption

A opção de recursão para uso em uma consulta de árvore.
queryType

QueryType

O tipo de consulta.
sortColumns

WorkItemQuerySortColumn[]

As colunas de classificação da consulta.
sourceClauses

WorkItemQueryClause

As cláusulas de origem em uma consulta de link de árvore ou de um salto.
targetClauses

WorkItemQueryClause

As cláusulas de destino em uma consulta de link de árvore ou de um salto.
url

string

wiql

string

O texto WIQL da consulta

QueryRecursionOption

A opção de recursão para uso em uma consulta de árvore.

Nome Tipo Description
childFirst

string

Retorna itens de trabalho que atendem aos critérios de destino, mesmo que nenhum item de trabalho atenda aos critérios de origem e link.
parentFirst

string

Retorna itens de trabalho que satisfazem a origem, mesmo que nenhum item de trabalho vinculado atenda aos critérios de destino e link.

QueryType

O tipo de consulta.

Nome Tipo Description
flat

string

Obtém uma lista simples de itens de trabalho.
oneHop

string

Obtém uma lista de itens de trabalho e seus links diretos.
tree

string

Obtém uma árvore de itens de trabalho mostrando sua hierarquia de vínculo.

A classe para representar uma coleção de links de referência REST.

Nome Tipo Description
links

object

A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura.

WorkItemFieldOperation

Descreve uma operação de campo de item de trabalho.

Nome Tipo Description
name

string

Nome amigável da operação.
referenceName

string

Nome de referência da operação.

WorkItemFieldReference

Referência a um campo em um item de trabalho

Nome Tipo Description
name

string

O nome amigável do campo.
referenceName

string

O nome de referência do campo.
url

string

A URL REST do recurso.

WorkItemQueryClause

Representa uma cláusula em uma consulta de item de trabalho. Isso mostra a estrutura de uma consulta de item de trabalho.

Nome Tipo Description
clauses

WorkItemQueryClause[]

Cláusulas filho se a cláusula atual for um operador lógico
field

WorkItemFieldReference

Campo associado à condição
fieldValue

WorkItemFieldReference

Lado direito da condição quando uma comparação campo a campo
isFieldValue

boolean

Determina se essa é uma comparação de campo a campo
logicalOperator

LogicalOperation

Operador lógico que separa a cláusula condition
operator

WorkItemFieldOperation

O operador de campo
value

string

Lado direito da condição quando um campo para comparação de valor

WorkItemQuerySortColumn

Uma coluna de classificação.

Nome Tipo Description
descending

boolean

A direção a ser classificada por.
field

WorkItemFieldReference

Um campo de item de trabalho.