Compartir a través de

Queries - Get

  • Referencia
Servicio:
Work Item Tracking
Versión de la API:
5.0

Recupera una consulta individual y sus elementos secundarios.

GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries/{query}?api-version=5.0
Con parámetros opcionales: 
GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries/{query}?$expand={$expand}&$depth={$depth}&$includeDeleted={$includeDeleted}&api-version=5.0

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
query
 path True

string

Identificador o ruta de acceso de la consulta.
api-version
 query True

string

Versión de la API que se va a usar. Debe establecerse en "5.0" para usar esta versión de la API.
$depth
 query

integer

int32

En la carpeta de consultas, devuelva las consultas secundarias y las carpetas a esta profundidad.
$expand
 query

QueryExpand

Incluya la cadena de consulta (wiql), cláusulas, columnas de resultados de consulta y opciones de ordenación en los resultados.
$includeDeleted
 query

boolean

Incluir consultas y carpetas eliminadas

Respuestas

Nombre Tipo Description
200 OK

QueryHierarchyItem

operación correcta

Seguridad

oauth2

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Dirección URL del 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

Ámbitos

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

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

Solicitud de ejemplo

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?$includeDeleted=true&api-version=5.0

Respuesta de muestra

status code:
200 
{
  "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

Solicitud de ejemplo

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?$expand=clauses&api-version=5.0

Respuesta de muestra

status code:
200 
{
  "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

Solicitud de ejemplo

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?api-version=5.0

Respuesta de muestra

status code:
200 
{
  "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

Solicitud de ejemplo

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?api-version=5.0

Respuesta de muestra

status code:
200 
{
  "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

Solicitud de ejemplo

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?$expand=clauses&api-version=5.0

Respuesta de muestra

status code:
200 
{
  "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

Solicitud de ejemplo

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?api-version=5.0

Respuesta de muestra

status code:
200 
{
  "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

Solicitud de ejemplo

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?api-version=5.0

Respuesta de muestra

status code:
200 
{
  "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"
}

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
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

Object

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

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

inactive

boolean

isAadIdentity

boolean

isContainer

boolean

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

uniqueName

string

url

string

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

LinkQueryMode

Enumeration

Modo de consulta de vínculo.

Valor Description
linksOneHopDoesNotContain

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

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

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

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

LogicalOperation

Enumeration

Operador lógico que separa la cláusula condition

Valor Description
aND
nONE
oR

QueryExpand

Enumeration

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

Valor Description
all

Expande todas las propiedades
clauses

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

Muestra las propiedades mínimas y el texto WIQL
none

Expande columnas, vínculos y ChangeInfo
wiql

Expande columnas, vínculos, ChangeInfo y texto WIQL

QueryHierarchyItem

Object

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

Enumeration

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

Valor Description
childFirst

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

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

Enumeration

Tipo de consulta.

Valor Description
flat

Obtiene una lista plana de elementos de trabajo.
oneHop

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

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

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

Object

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

Nombre Tipo Description
name

string

Nombre de la operación.
referenceName

string

Nombre de referencia de la operación.

WorkItemFieldReference

Object

Referencia a un campo de un elemento de trabajo

Nombre Tipo Description
name

string

Nombre del campo.
referenceName

string

Nombre de referencia del campo.
url

string

Dirección URL de REST del recurso.

WorkItemQueryClause

Object

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

Object

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.