Compartir a través de


Work Item Search Results - Fetch Work Item Search Results

Proporciona un conjunto de resultados para el texto de búsqueda.

POST https://almsearch.dev.azure.com/{organization}/{project}/_apis/search/workitemsearchresults?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

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

SortOption[]

Opciones para ordenar los resultados de búsqueda. Si se establece en null, los resultados se devolverán ordenados por relevancia. Si se proporciona más de una opción de ordenación, los resultados se ordenan en el orden especificado en OrderBy.

$skip

integer

Número de resultados que se van a omitir.

$top

integer

Número de resultados que se van a devolver.

filters

object

Filtros que se van a aplicar. Establézcalo en NULL si no hay filtros que se van a aplicar.

includeFacets

boolean

Marca para optar por facetas en el resultado. El comportamiento predeterminado es false.

searchText

string

Texto de búsqueda.

Respuestas

Nombre Tipo Description
200 OK

WorkItemSearchResponse

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

Sample Request

POST https://almsearch.dev.azure.com/fabrikam/_apis/search/workitemsearchresults?api-version=7.1-preview.1

{
  "searchText": "Rest Api Story",
  "$skip": 0,
  "$top": 1,
  "filters": {
    "System.TeamProject": [
      "MyFirstProject"
    ],
    "System.AreaPath": [
      "MyFirstProject"
    ],
    "System.WorkItemType": [
      "Bug",
      "User Story",
      "Feature",
      "Task"
    ],
    "System.State": [
      "New",
      "Active",
      "Closed"
    ],
    "System.AssignedTo": [
      "John Doe <jodoe@microsoft.com>"
    ]
  },
  "$orderBy": [
    {
      "field": "system.id",
      "sortOrder": "ASC"
    }
  ],
  "includeFacets": true
}

Sample Response

{
  "count": 2,
  "results": [
    {
      "project": {
        "name": "MyFirstProject",
        "id": "5a0690b2-823c-4389-a3ab-5ea2a9cbde75"
      },
      "fields": {
        "system.id": "2",
        "system.workitemtype": "User Story",
        "system.title": "Rest Api User Story",
        "system.assignedto": "John Doe <jodoe@microsoft.com>",
        "system.state": "Closed",
        "system.tags": "api; rest",
        "system.rev": "5",
        "system.createddate": "2018-01-05T17:14:40.033Z",
        "system.changeddate": "2018-01-05T17:55:36.953Z"
      },
      "hits": [
        {
          "fieldReferenceName": "system.tags",
          "highlights": [
            "<highlighthit>api</highlighthit>; <highlighthit>rest</highlighthit>"
          ]
        },
        {
          "fieldReferenceName": "system.title",
          "highlights": [
            "<highlighthit>Rest</highlighthit> <highlighthit>Api</highlighthit> User <highlighthit>Story</highlighthit>"
          ]
        }
      ],
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/2"
    }
  ],
  "infoCode": 0,
  "facets": {
    "System.TeamProject": [
      {
        "name": "MyFirstProject",
        "id": "MyFirstProject",
        "resultCount": 2
      }
    ],
    "System.WorkItemType": [
      {
        "name": "Task",
        "id": "Task",
        "resultCount": 1
      },
      {
        "name": "User Story",
        "id": "User Story",
        "resultCount": 1
      },
      {
        "name": "Bug",
        "id": "Bug",
        "resultCount": 0
      },
      {
        "name": "Feature",
        "id": "Feature",
        "resultCount": 0
      }
    ],
    "System.State": [
      {
        "name": "Closed",
        "id": "Closed",
        "resultCount": 1
      },
      {
        "name": "New",
        "id": "New",
        "resultCount": 1
      },
      {
        "name": "Active",
        "id": "Active",
        "resultCount": 0
      }
    ],
    "System.AssignedTo": [
      {
        "name": "John Doe <jodoe@microsoft.com>",
        "id": "John Doe <jodoe@microsoft.com>",
        "resultCount": 2
      }
    ]
  }
}

Definiciones

Nombre Description
Project

Define los detalles del proyecto.

SortOption

Define cómo ordenar el resultado.

WorkItemHit

Define los términos coincidentes en el campo del resultado del elemento de trabajo.

WorkItemResult

Define el resultado del elemento de trabajo que coincide con una solicitud de búsqueda de elementos de trabajo.

WorkItemSearchRequest

Define una solicitud de búsqueda de elementos de trabajo.

WorkItemSearchResponse

Define un elemento de respuesta que se devuelve para una solicitud de búsqueda de elementos de trabajo.

Project

Define los detalles del proyecto.

Nombre Tipo Description
id

string

Identificador del proyecto.

name

string

Nombre del proyecto.

SortOption

Define cómo ordenar el resultado.

Nombre Tipo Description
field

string

Nombre de campo en el que se debe realizar la ordenación.

sortOrder

string

Orden (ASC/DESC) en el que se deben ordenar los resultados.

WorkItemHit

Define los términos coincidentes en el campo del resultado del elemento de trabajo.

Nombre Tipo Description
fieldReferenceName

string

Nombre de referencia del campo resaltado.

highlights

string[]

Fragmentos de código coincidentes o resaltados del campo.

WorkItemResult

Define el resultado del elemento de trabajo que coincide con una solicitud de búsqueda de elementos de trabajo.

Nombre Tipo Description
fields

object

Un conjunto estándar de campos de elementos de trabajo y sus valores.

hits

WorkItemHit[]

Fragmentos de código resaltados de campos que coinciden con la solicitud de búsqueda. La lista se ordena por relevancia de los fragmentos de código.

project

Project

Detalles del proyecto del elemento de trabajo.

url

string

Referencia al elemento de trabajo.

WorkItemSearchRequest

Define una solicitud de búsqueda de elementos de trabajo.

Nombre Tipo Description
$orderBy

SortOption[]

Opciones para ordenar los resultados de búsqueda. Si se establece en null, los resultados se devolverán ordenados por relevancia. Si se proporciona más de una opción de ordenación, los resultados se ordenan en el orden especificado en OrderBy.

$skip

integer

Número de resultados que se van a omitir.

$top

integer

Número de resultados que se van a devolver.

filters

object

Filtros que se van a aplicar. Establézcalo en NULL si no hay filtros que se van a aplicar.

includeFacets

boolean

Marca para optar por facetas en el resultado. El comportamiento predeterminado es false.

searchText

string

Texto de búsqueda.

WorkItemSearchResponse

Define un elemento de respuesta que se devuelve para una solicitud de búsqueda de elementos de trabajo.

Nombre Tipo Description
count

integer

Número total de elementos de trabajo coincidentes.

facets

object

Diccionario que almacena una matriz de Filter objetos en cada faceta.

infoCode

integer

Código numérico que indica cualquier información adicional: 0 - Ok, 1 - Account is being reindexed, 2 - Account indexing has not started, 3 - Invalid Request, 4 - Prefix wildcard query not supported, 5 - MultiWords with code facet not supported, 6 - Account is being onboarded, 7 - Account is being onboarded or reindexed, 8 - Top value trimed to maxresult allowed 9 - Branches are being indexed, 10 - Facetas no habilitadas, 11 - Elementos de trabajo no accesibles, 19 - Consultas de frases con filtros de tipo de código no compatibles, 20 - Consultas con caracteres comodín con filtros de tipo de código no admitidos. Cualquier otro código de información se usa para fines internos.

results

WorkItemResult[]

Lista de elementos de trabajo principales coincidentes.