Work Item Search Results - Fetch Work Item Search Results

Referência

Service:: Search

API Version:: 7.1-preview.1

Fornece um conjunto de resultados para o texto da pesquisa.

POST https://almsearch.dev.azure.com/{organization}/{project}/_apis/search/workitemsearchresults?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		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
$orderBy	SortOption[]	Opções para classificar os resultados da pesquisa. Se definido como nulo, os resultados serão retornados classificados por relevância. Se mais de uma opção de classificação for fornecida, os resultados serão classificados na ordem especificada em OrderBy.
$skip	integer	Número de resultados a serem ignorados.
$top	integer	Número de resultados a serem retornados.
filters	object	Filtros a serem aplicados. Defina-o como nulo se não houver filtros a serem aplicados.
includeFacets	boolean	Sinalizador para optar pela faceta no resultado. O comportamento padrão é false.
searchText	string	O texto de pesquisa.

Respostas

Nome	Tipo	Description
200 OK	WorkItemSearchResponse	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

Sample Request

HTTP

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

Status code:: 200

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

Definições

Nome	Description
Project	Define os detalhes do projeto.
SortOption	Define como classificar o resultado.
WorkItemHit	Define os termos correspondentes no campo do resultado do item de trabalho.
WorkItemResult	Define o resultado do item de trabalho que correspondeu a uma solicitação de pesquisa de item de trabalho.
WorkItemSearchRequest	Define uma solicitação de pesquisa de item de trabalho.
WorkItemSearchResponse	Define um item de resposta retornado para uma solicitação de pesquisa de item de trabalho.

Project

Define os detalhes do projeto.

Nome	Tipo	Description
id	string	Id do projeto.
name	string	Nome do projeto.

SortOption

Define como classificar o resultado.

Nome	Tipo	Description
field	string	Nome do campo no qual a classificação deve ser feita.
sortOrder	string	Ordem (ASC/DESC) na qual os resultados devem ser classificados.

WorkItemHit

Define os termos correspondentes no campo do resultado do item de trabalho.

Nome	Tipo	Description
fieldReferenceName	string	Nome de referência do campo realçado.
highlights	string[]	Snippets correspondentes/realçados do campo.

WorkItemResult

Define o resultado do item de trabalho que correspondeu a uma solicitação de pesquisa de item de trabalho.

Nome	Tipo	Description
fields	object	Um conjunto padrão de campos de item de trabalho e seus valores.
hits	WorkItemHit[]	Snippets de código realçados de campos que correspondem à solicitação de pesquisa. A lista é classificada por relevância dos snippets.
project	Project	Detalhes do projeto do item de trabalho.
url	string	Referência ao item de trabalho.

WorkItemSearchRequest

Define uma solicitação de pesquisa de item de trabalho.

Nome	Tipo	Description
$orderBy	SortOption[]	Opções para classificar os resultados da pesquisa. Se definido como nulo, os resultados serão retornados classificados por relevância. Se mais de uma opção de classificação for fornecida, os resultados serão classificados na ordem especificada em OrderBy.
$skip	integer	Número de resultados a serem ignorados.
$top	integer	Número de resultados a serem retornados.
filters	object	Filtros a serem aplicados. Defina-o como nulo se não houver filtros a serem aplicados.
includeFacets	boolean	Sinalizador para optar pela faceta no resultado. O comportamento padrão é false.
searchText	string	O texto de pesquisa.

WorkItemSearchResponse

Define um item de resposta retornado para uma solicitação de pesquisa de item de trabalho.

Nome	Tipo	Description
count	integer	Número total de itens de trabalho correspondentes.
facets	object	Um dicionário que armazena uma matriz de `Filter` objeto em cada faceta.
infoCode	integer	Código numérico que indica qualquer informação adicional: 0 – Ok, 1 – A conta está sendo reindexada, 2 – A indexação de conta não foi iniciada, 3 – Solicitação Inválida, 4 – Não há suporte para consulta curinga de prefixo, 5 – MultiWords com faceta de código sem suporte, 6 – a conta está sendo integrada, 7 – a conta está sendo integrada ou reindexada, 8 – Valor superior cortado para maxresult permitido 9 – Branches estão sendo indexados, 10 – Faceta não habilitada, 11 – Itens de trabalho não acessíveis, 19 – Consultas de frase com filtros de tipo de código sem suporte, 20 – Consultas curinga com filtros de tipo de código sem suporte. Qualquer outro código de informações é usado para fins internos.
results	WorkItemResult[]	Lista dos principais itens de trabalho correspondentes.

Partilhar via