Work Item Search Results - Fetch Work Item Search Results

Reference

Service:: Search

API Version:: 7.1-preview.1

Poskytuje sadu výsledků pro hledaný text.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
organization	path	True	string	Název organizace Azure DevOps.
project	path		string	ID projektu nebo název projektu
api-version	query	True	string	Verze rozhraní API, která se má použít. Tato verze rozhraní API by měla být nastavená na 7.1-preview.1.

Text požadavku

Name	Typ	Description
$orderBy	SortOption[]	Možnosti řazení výsledků hledání Pokud je nastavená hodnota null, vrátí se výsledky seřazené podle relevance. Pokud je k dispozici více než jedna možnost řazení, výsledky se seřadí v pořadí zadaném v orderBy.
$skip	integer	Počet přeskočených výsledků
$top	integer	Počet vrácených výsledků
filters	object	Filtry, které se mají použít. Pokud neexistují žádné filtry, které by se použily, nastavte hodnotu null.
includeFacets	boolean	Příznak, který ve výsledku zvolí fazetu. Výchozí chování je false.
searchText	string	Hledaný text

Odpovědi

Name	Typ	Description
200 OK	WorkItemSearchResponse	úspěšná operace

Zabezpečení

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

Name	Description
vso.work	Umožňuje číst pracovní položky, dotazy, panely, cesty oblastí a iterací a další metadata související se sledováním pracovních položek. Poskytuje také možnost spouštět dotazy, vyhledávat pracovní položky a přijímat oznámení o událostech pracovních položek prostřednictvím volání služeb.

Příklady

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

Definice

Name	Description
Project	Definuje podrobnosti projektu.
SortOption	Definuje, jak seřadit výsledek.
WorkItemHit	Definuje odpovídající termíny v poli výsledku pracovní položky.
WorkItemResult	Definuje výsledek pracovní položky, který odpovídá požadavku hledání pracovní položky.
WorkItemSearchRequest	Definuje požadavek hledání pracovní položky.
WorkItemSearchResponse	Definuje položku odpovědi, která se vrátí pro požadavek hledání pracovní položky.

Project

Definuje podrobnosti projektu.

Name	Typ	Description
id	string	ID projektu.
name	string	Název projektu

SortOption

Definuje, jak seřadit výsledek.

Name	Typ	Description
field	string	Název pole, podle kterého se má řazení provést.
sortOrder	string	Pořadí (ASC/DESC), ve kterém by měly být výsledky seřazeny.

WorkItemHit

Definuje odpovídající termíny v poli výsledku pracovní položky.

Name	Typ	Description
fieldReferenceName	string	Název odkazu zvýrazněného pole.
highlights	string[]	Odpovídající nebo zvýrazněné fragmenty kódu pole

WorkItemResult

Definuje výsledek pracovní položky, který odpovídá požadavku hledání pracovní položky.

Name	Typ	Description
fields	object	Standardní sada polí pracovních položek a jejich hodnot
hits	WorkItemHit[]	Zvýrazněné fragmenty polí, které odpovídají požadavku vyhledávání. Seznam je seřazený podle relevance fragmentů kódu.
project	Project	Podrobnosti projektu pracovní položky
url	string	Odkaz na pracovní položku

WorkItemSearchRequest

Definuje požadavek hledání pracovní položky.

Name	Typ	Description
$orderBy	SortOption[]	Možnosti řazení výsledků hledání Pokud je nastavená hodnota null, vrátí se výsledky seřazené podle relevance. Pokud je k dispozici více než jedna možnost řazení, výsledky se seřadí v pořadí zadaném v orderBy.
$skip	integer	Počet přeskočených výsledků
$top	integer	Počet vrácených výsledků
filters	object	Filtry, které se mají použít. Pokud neexistují žádné filtry, které by se použily, nastavte hodnotu null.
includeFacets	boolean	Příznak, který ve výsledku zvolí fazetu. Výchozí chování je false.
searchText	string	Hledaný text

WorkItemSearchResponse

Definuje položku odpovědi, která se vrátí pro požadavek hledání pracovní položky.

Name	Typ	Description
count	integer	Celkový počet odpovídajících pracovních položek
facets	object	Slovník, který ukládá pole objektu `Filter` pro každou omezující vlastnost.
infoCode	integer	Číselný kód označující jakékoli další informace: 0 – OK, 1 – Probíhá přeindexování účtu, 2 – indexování účtu se nezačne, 3 – neplatný požadavek, 4 – nepodporovaný dotaz se zástupnými čísly, 5 – vícewords s nepodporovanou omezující vlastností kódu, 6 – onboarding účtu, 7 – onboarding nebo přeindexování účtu, 8 – horní hodnota oříznutá na maximální povolený limit 9 – větve se indexují, 10 – Fasetování není povoleno, 11 – Pracovní položky nejsou přístupné, 19 – Dotazy frází s filtry typu kódu nejsou podporovány, 20 – Dotazy se zástupnými znakůýmimi kódy s filtry typu kódu nejsou podporovány. Jakýkoli jiný informační kód se používá pro interní účely.
results	WorkItemResult[]	Seznam pracovních položek s nejvyšší shodou

Share via