Compartir a través de

Queries - Get Queries Batch

  • Referencia
Service:
Work Item Tracking
API Version:
7.1-preview.1

Obtiene una lista de consultas por identificadores (máximo 1000)

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
organization
 path True

string

El nombre de la organización de Azure DevOps.
project
 path True

string

Id. de proyecto o nombre del proyecto
api-version
 query True

string

Versión de la API que se va a usar. Debe establecerse en "7.1-preview.1" para usar esta versión de la API.

Cuerpo de la solicitud

Nombre Tipo Description
$expand

QueryExpand

Parámetros expand para consultas. Las opciones posibles son { None, Wiql, Clauses, All, Minimal }
errorPolicy

QueryErrorPolicy

Marca para controlar la directiva de error en una solicitud por lotes de consulta. Las opciones posibles son { Fail, Omit }.
ids

string[]

Identificadores de consulta solicitados

Respuestas

Nombre Tipo Description
200 OK

QueryHierarchyItem[]

operación correcta

Seguridad

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

Nombre Description
vso.work Concede la capacidad de leer elementos de trabajo, consultas, paneles, rutas de acceso de área e iteraciones, y otros metadatos relacionados con el seguimiento de elementos de trabajo. También concede la capacidad de ejecutar consultas, buscar elementos de trabajo y recibir notificaciones sobre eventos de elementos de trabajo a través de enlaces de servicio.

Ejemplos

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"
    }
  ]
}

Definiciones

Nombre Description
IdentityReference

Describe una referencia a una identidad.
LinkQueryMode

Modo de consulta de vínculo.
LogicalOperation

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

Describe una solicitud para obtener una lista de consultas.
QueryErrorPolicy

Marca para controlar la directiva de error en una solicitud por lotes de consulta. Las opciones posibles son { Fail, Omit }.
QueryExpand

Parámetros de expansión para las consultas. Las opciones posibles son { None, Wiql, Clauses, All, Minimal }
QueryHierarchyItem

Representa un elemento de la jerarquía de consultas de elementos de trabajo. Puede ser una consulta o una carpeta.
QueryRecursionOption

Opción de recursividad para su uso en una consulta de árbol.
QueryType

Tipo de consulta.
ReferenceLinks

Clase que representa una colección de vínculos de referencia de REST.
WorkItemFieldOperation

Describe una operación de campo de elemento de trabajo.
WorkItemFieldReference

Referencia a un campo de un elemento de trabajo
WorkItemQueryClause

Representa una cláusula en una consulta de elemento de trabajo. Esto muestra la estructura de una consulta de elemento de trabajo.
WorkItemQuerySortColumn

Una columna de ordenación.

IdentityReference

Describe una referencia a una identidad.

Nombre Tipo Description
_links

ReferenceLinks

Este campo contiene cero o más vínculos interesantes sobre el tema del grafo. Estos vínculos se pueden invocar para obtener relaciones adicionales o información más detallada sobre este tema del grafo.
descriptor

string

El descriptor es la forma principal de hacer referencia al asunto del grafo mientras se ejecuta el sistema. Este campo identificará de forma única el mismo asunto del grafo en cuentas y organizaciones.
directoryAlias

string

En desuso: se puede recuperar consultando el usuario de Graph al que se hace referencia en la entrada "self" del diccionario IdentityRef "_links".
displayName

string

Este es el nombre para mostrar no único del asunto del grafo. Para cambiar este campo, debe modificar su valor en el proveedor de origen.
id

string

imageUrl

string

En desuso: disponible en la entrada "avatar" del diccionario "_links" de IdentityRef
inactive

boolean

En desuso: se puede recuperar consultando el estado de pertenencia de Graph al que se hace referencia en la entrada "membershipState" del diccionario GraphUser "_links".
isAadIdentity

boolean

En desuso: se puede deducir del tipo de asunto del descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer

boolean

En desuso: se puede deducir del tipo de sujeto del descriptor (Descriptor.IsGroupType)
isDeletedInOrigin

boolean

name

string

Propiedad back-compat heredada. Este ha sido el valor específico de WIT de Constants. Se ocultará (pero existe) en el cliente a menos que tengan como destino la versión más reciente.
profileUrl

string

En desuso: no en uso en la mayoría de las implementaciones preexistentes de ToIdentityRef
uniqueName

string

En desuso: use Domain+PrincipalName en su lugar.
url

string

Esta dirección URL es la ruta completa al recurso de origen de este tema del grafo.

LinkQueryMode

Modo de consulta de vínculo.

Nombre Tipo Description
linksOneHopDoesNotContain

string

Devuelve elementos de trabajo que satisfacen el origen, solo si ningún elemento de trabajo vinculado cumple los criterios de vínculo y de destino.
linksOneHopMayContain

string

Devuelve elementos de trabajo que cumplen los criterios de origen y vínculo, incluso si ningún elemento de trabajo vinculado cumple los criterios de destino.
linksOneHopMustContain

string

Devuelve elementos de trabajo en los que se cumplen todos los criterios de origen, destino y vínculo.
linksRecursiveDoesNotContain

string

linksRecursiveMayContain

string

Devuelve elementos de trabajo una jerarquía de elementos de trabajo que, de forma predeterminada, satisfacen el origen.
linksRecursiveMustContain

string

workItems

string

Devuelve una lista plana de elementos de trabajo.

LogicalOperation

Operador lógico que separa la cláusula condition

Nombre Tipo Description
and

string

none

string

or

string

QueryBatchGetRequest

Describe una solicitud para obtener una lista de consultas.

Nombre Tipo Description
$expand

QueryExpand

Parámetros de expansión para las consultas. Las opciones posibles son { None, Wiql, Clauses, All, Minimal }
errorPolicy

QueryErrorPolicy

Marca para controlar la directiva de error en una solicitud por lotes de consulta. Las opciones posibles son { Fail, Omit }.
ids

string[]

Identificadores de consulta solicitados

QueryErrorPolicy

Marca para controlar la directiva de error en una solicitud por lotes de consulta. Las opciones posibles son { Fail, Omit }.

Nombre Tipo Description
fail

string

omit

string

QueryExpand

Parámetros de expansión para las consultas. Las opciones posibles son { None, Wiql, Clauses, All, Minimal }

Nombre Tipo Description
all

string

Expande todas las propiedades
clauses

string

Expande columnas, vínculos, ChangeInfo, texto y cláusulas WIQL
minimal

string

Muestra las propiedades mínimas y el texto WIQL
none

string

Expande columnas, vínculos y ChangeInfo
wiql

string

Expande columnas, vínculos, ChangeInfo y texto WIQL

QueryHierarchyItem

Representa un elemento de la jerarquía de consultas de elementos de trabajo. Puede ser una consulta o una carpeta.

Nombre Tipo Description
_links

ReferenceLinks

Vincular referencias a recursos REST relacionados.
children

QueryHierarchyItem[]

Elementos de consulta secundarios dentro de una carpeta de consulta.
clauses

WorkItemQueryClause

Las cláusulas de una consulta plana.
columns

WorkItemFieldReference[]

Columnas de la consulta.
createdBy

IdentityReference

Identidad que creó el elemento de consulta.
createdDate

string

Cuando se creó el elemento de consulta.
filterOptions

LinkQueryMode

Modo de consulta de vínculo.
hasChildren

boolean

Si se trata de una carpeta de consulta, indica si contiene elementos secundarios.
id

string

Identificador del elemento de consulta.
isDeleted

boolean

Indica si se elimina este elemento de consulta. Si se establece en false en un elemento de consulta eliminado, se eliminará. La eliminación de una consulta o carpeta no devolverá los cambios de permisos que se aplicaron anteriormente.
isFolder

boolean

Indica si se trata de una carpeta de consulta o una consulta.
isInvalidSyntax

boolean

Indica si el WIQL de esta consulta no es válido. Esto puede deberse a una sintaxis no válida o a una ruta de acceso de área o iteración no válida.
isPublic

boolean

Indica si este elemento de consulta es público o privado.
lastExecutedBy

IdentityReference

Identidad que ejecutó la consulta por última vez.
lastExecutedDate

string

Cuándo se ejecutó por última vez la consulta.
lastModifiedBy

IdentityReference

Identidad que modificó por última vez el elemento de consulta.
lastModifiedDate

string

Cuándo se modificó por última vez el elemento de consulta.
linkClauses

WorkItemQueryClause

Cláusula de consulta de vínculo.
name

string

Nombre del elemento de consulta.
path

string

Ruta de acceso del elemento de consulta.
queryRecursionOption

QueryRecursionOption

Opción de recursividad para su uso en una consulta de árbol.
queryType

QueryType

Tipo de consulta.
sortColumns

WorkItemQuerySortColumn[]

Columnas de ordenación de la consulta.
sourceClauses

WorkItemQueryClause

Las cláusulas de origen de una consulta de vínculo de un solo salto o árbol.
targetClauses

WorkItemQueryClause

Las cláusulas de destino de una consulta de vínculo de un solo salto o árbol.
url

string

wiql

string

Texto WIQL de la consulta

QueryRecursionOption

Opción de recursividad para su uso en una consulta de árbol.

Nombre Tipo Description
childFirst

string

Devuelve elementos de trabajo que cumplen los criterios de destino, incluso si ningún elemento de trabajo cumple los criterios de origen y vínculo.
parentFirst

string

Devuelve elementos de trabajo que satisfacen el origen, incluso si ningún elemento de trabajo vinculado cumple los criterios de destino y vínculo.

QueryType

Tipo de consulta.

Nombre Tipo Description
flat

string

Obtiene una lista plana de elementos de trabajo.
oneHop

string

Obtiene una lista de elementos de trabajo y sus vínculos directos.
tree

string

Obtiene un árbol de elementos de trabajo que muestra su jerarquía de vínculos.

Clase que representa una colección de vínculos de referencia de REST.

Nombre Tipo Description
links

object

Vista de solo lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura.

WorkItemFieldOperation

Describe una operación de campo de elemento de trabajo.

Nombre Tipo Description
name

string

Nombre descriptivo de la operación.
referenceName

string

Nombre de referencia de la operación.

WorkItemFieldReference

Referencia a un campo de un elemento de trabajo

Nombre Tipo Description
name

string

Nombre descriptivo del campo.
referenceName

string

Nombre de referencia del campo.
url

string

Dirección URL de REST del recurso.

WorkItemQueryClause

Representa una cláusula en una consulta de elemento de trabajo. Esto muestra la estructura de una consulta de elemento de trabajo.

Nombre Tipo Description
clauses

WorkItemQueryClause[]

Cláusulas secundarias si la cláusula actual es un operador lógico
field

WorkItemFieldReference

Campo asociado a la condición
fieldValue

WorkItemFieldReference

Lado derecho de la condición cuando se compara un campo a campo
isFieldValue

boolean

Determina si se trata de un campo a una comparación de campos.
logicalOperator

LogicalOperation

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

WorkItemFieldOperation

Operador de campo
value

string

Lado derecho de la condición cuando un campo para la comparación de valores

WorkItemQuerySortColumn

Una columna de ordenación.

Nombre Tipo Description
descending

boolean

Dirección por la que se va a ordenar.
field

WorkItemFieldReference

Un campo de elemento de trabajo.