Queries - Search Queries
Pesquisa todas as consultas às quais o usuário tem acesso no projeto atual
GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries?$filter={$filter}&api-version=7.1GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries?$filter={$filter}&$top={$top}&$expand={$expand}&$includeDeleted={$includeDeleted}&api-version=7.1Parâ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 |
|
$filter
|
query | True |
string |
O texto com o qual filtrar as consultas. |
|
api-version
|
query | True |
string |
Versão da API a ser usada. Isso deve ser definido como '7.1' para usar essa versão da api. |
|
$expand
|
query | |||
|
$include
|
query |
boolean |
Incluir consultas e pastas excluídas |
|
|
$top
|
query |
integer (int32) |
O número de consultas a serem retornadas (o padrão é 50 e o máximo é 200). |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
operação bem-sucedida |
Segurança
oauth2
Tipo:
oauth2
Flow:
accessCode
URL de Autorização:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL do Token:
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
Escopos
| Nome | Description |
|---|---|
| vso.work | Concede a capacidade de ler itens de trabalho, consultas, placas, 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. |
Definições
| Nome | Description |
|---|---|
|
Identity |
Descreve uma referência a uma identidade. |
|
Link |
O modo de consulta de link. |
|
Logical |
Operador lógico que separa a cláusula de condição |
|
Query |
Os parâmetros de expansão para consultas. As opções possíveis são { None, Wiql, Clauses, All, Minimal } |
|
Query |
Representa um item na hierarquia de consulta de item de trabalho. Isso pode ser uma consulta ou uma pasta. |
|
Query |
|
|
Query |
A opção de recursão para uso em uma consulta de árvore. |
|
Query |
O tipo de consulta. |
|
Reference |
A classe para representar uma coleção de links de referência REST. |
|
Work |
Descreve uma operação de campo de item de trabalho. |
|
Work |
Referência a um campo em um item de trabalho |
|
Work |
Representa uma cláusula em uma consulta de item de trabalho. Isso mostra a estrutura de uma consulta de item de trabalho. |
|
Work |
Uma coluna de classificação. |
IdentityReference
Descreve uma referência a uma identidade.
| Nome | Tipo | Description |
|---|---|---|
| _links |
Este 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 em contas e organizações. |
| directoryAlias |
string |
Preterido – pode ser recuperado consultando o usuário do Graph referenciado na entrada "self" do dicionário "_links" identityRef |
| 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 (uuid) |
|
| imageUrl |
string |
Preterido – Disponível na entrada "avatar" do dicionário "_links" do IdentityRef |
| 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 adiado 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 Constants. 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 pré-existentes 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.
| Valor | Description |
|---|---|
| linksOneHopDoesNotContain |
Retorna itens de trabalho que atendem à origem, somente se nenhum item de trabalho vinculado atender aos critérios de link e de destino. |
| linksOneHopMayContain |
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 |
Retorna itens de trabalho em que os critérios de origem, destino e link estão todos satisfeitos. |
| linksRecursiveDoesNotContain | |
| linksRecursiveMayContain |
Retorna itens de trabalho uma hierarquia de itens de trabalho que, por padrão, atendem à origem |
| linksRecursiveMustContain | |
| workItems |
Retorna uma lista simples de itens de trabalho. |
LogicalOperation
Operador lógico que separa a cláusula de condição
| Valor | Description |
|---|---|
| and | |
| none | |
| or |
QueryExpand
Os parâmetros de expansão para consultas. As opções possíveis são { None, Wiql, Clauses, All, Minimal }
| Valor | Description |
|---|---|
| all |
Expande todas as propriedades |
| clauses |
Expande colunas, links, changeinfo, texto wiql e cláusulas |
| minimal |
Exibe propriedades mínimas e o texto WIQL |
| none |
Expande colunas, links e ChangeInfo |
| wiql |
Expande colunas, links, texto ChangeInfo e WIQL |
QueryHierarchyItem
Representa um item na hierarquia de consulta de item de trabalho. Isso pode ser uma consulta ou uma pasta.
| Nome | Tipo | Description |
|---|---|---|
| _links |
Vincular referências a recursos REST relacionados. |
|
| children |
Os itens de consulta filho dentro de uma pasta de consulta. |
|
| clauses |
As cláusulas de uma consulta simples. |
|
| columns |
As colunas da consulta. |
|
| createdBy |
A identidade que criou o item de consulta. |
|
| createdDate |
string (date-time) |
Quando o item de consulta foi criado. |
| filterOptions |
O modo de consulta de link. |
|
| hasChildren |
boolean |
Se esta for uma pasta de consulta, indica se ela contém filhos. |
| id |
string (uuid) |
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 cancelará. Cancelar a exclusão de 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 essa é 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 área/iteração não mais válido. |
| isPublic |
boolean |
Indica se esse item de consulta é público ou privado. |
| lastExecutedBy |
A identidade que executou a consulta pela última vez. |
|
| lastExecutedDate |
string (date-time) |
Quando a consulta foi executada pela última vez. |
| lastModifiedBy |
A identidade que modificou o item de consulta pela última vez. |
|
| lastModifiedDate |
string (date-time) |
Quando o item de consulta foi modificado pela última vez. |
| linkClauses |
A cláusula de consulta de link. |
|
| name |
string |
O nome do item de consulta. |
| path |
string |
O caminho do item de consulta. |
| queryRecursionOption |
A opção de recursão para uso em uma consulta de árvore. |
|
| queryType |
O tipo de consulta. |
|
| sortColumns |
As colunas de classificação da consulta. |
|
| sourceClauses |
As cláusulas de origem em uma consulta de link de árvore ou de um salto. |
|
| targetClauses |
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 |
QueryHierarchyItemsResult
| Nome | Tipo | Description |
|---|---|---|
| count |
integer (int32) |
A contagem de itens. |
| hasMore |
boolean |
Indica se o limite máximo de retorno foi atingido, mas ainda há mais itens |
| value |
A lista de itens |
QueryRecursionOption
A opção de recursão para uso em uma consulta de árvore.
| Valor | Description |
|---|---|
| childFirst |
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 |
Retorna itens de trabalho que atendem à origem, mesmo que nenhum item de trabalho vinculado atenda aos critérios de destino e link. |
QueryType
O tipo de consulta.
| Valor | Description |
|---|---|
| flat |
Obtém uma lista simples de itens de trabalho. |
| oneHop |
Obtém uma lista de itens de trabalho e seus links diretos. |
| tree |
Obtém uma árvore de itens de trabalho mostrando sua hierarquia de vínculos. |
ReferenceLinks
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 |
Cláusulas filho se a cláusula atual for um operador lógico |
|
| field |
Campo associado à condição |
|
| fieldValue |
Lado direito da condição quando uma comparação de campo a campo |
|
| isFieldValue |
boolean |
Determina se essa é uma comparação de campo a campo |
| logicalOperator |
Operador lógico que separa a cláusula de condição |
|
| operator |
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. |
| field |
Um campo de item de trabalho. |