Work Item Search Results - Fetch Work Item Search Results

Référence

Service:: Search

API Version:: 7.1-preview.1

Fournit un ensemble de résultats pour le texte de recherche.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
organization	path	True	string	Nom de l’organisation Azure DevOps.
project	path		string	ID de projet ou nom du projet
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1-preview.1 » pour utiliser cette version de l’API.

Corps de la demande

Nom	Type	Description
$orderBy	SortOption[]	Options de tri des résultats de recherche. Si la valeur est null, les résultats sont retournés triés par pertinence. Si plusieurs options de tri sont fournies, les résultats sont triés dans l’ordre spécifié dans orderBy.
$skip	integer	Nombre de résultats à ignorer.
$top	integer	Nombre de résultats à retourner.
filters	object	Filtres à appliquer. Définissez-le sur null s’il n’y a aucun filtre à appliquer.
includeFacets	boolean	Indicateur d’opter pour la facette dans le résultat. Le comportement par défaut est false.
searchText	string	Texte de la recherche.

Réponses

Nom	Type	Description
200 OK	WorkItemSearchResponse	opération réussie

Sécurité

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

Nom	Description
vso.work	Accorde la possibilité de lire des éléments de travail, des requêtes, des tableaux, des chemins d’accès de zone et d’itérations, ainsi que d’autres métadonnées associées au suivi des éléments de travail. Accorde également la possibilité d’exécuter des requêtes, de rechercher des éléments de travail et de recevoir des notifications sur les événements d’élément de travail via des hooks de service.

Nom

Description

vso.work

Accorde la possibilité de lire des éléments de travail, des requêtes, des tableaux, des chemins d’accès de zone et d’itérations, ainsi que d’autres métadonnées associées au suivi des éléments de travail. Accorde également la possibilité d’exécuter des requêtes, de rechercher des éléments de travail et de recevoir des notifications sur les événements d’élément de travail via des hooks de service.

Exemples

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

Définitions

Nom	Description
Project	Définit les détails du projet.
SortOption	Définit comment trier le résultat.
WorkItemHit	Définit les termes mis en correspondance dans le champ du résultat de l’élément de travail.
WorkItemResult	Définit le résultat de l’élément de travail correspondant à une demande de recherche d’élément de travail.
WorkItemSearchRequest	Définit une demande de recherche d’élément de travail.
WorkItemSearchResponse	Définit un élément de réponse retourné pour une demande de recherche d’élément de travail.

Project

Définit les détails du projet.

Nom	Type	Description
id	string	ID du projet.
name	string	Nom du projet.

SortOption

Définit comment trier le résultat.

Nom	Type	Description
field	string	Nom du champ sur lequel le tri doit être effectué.
sortOrder	string	Ordre (ASC/DESC) dans lequel les résultats doivent être triés.

WorkItemHit

Définit les termes mis en correspondance dans le champ du résultat de l’élément de travail.

Nom	Type	Description
fieldReferenceName	string	Nom de référence du champ en surbrillance.
highlights	string[]	Extraits de code mis en correspondance/mis en évidence du champ.

WorkItemResult

Définit le résultat de l’élément de travail correspondant à une demande de recherche d’élément de travail.

Nom	Type	Description
fields	object	Ensemble standard de champs d’éléments de travail et de leurs valeurs.
hits	WorkItemHit[]	Extraits de code de champs en surbrillance qui correspondent à la demande de recherche. La liste est triée par pertinence des extraits de code.
project	Project	Détails du projet de l’élément de travail.
url	string	Référence à l’élément de travail.

WorkItemSearchRequest

Définit une demande de recherche d’élément de travail.

Nom	Type	Description
$orderBy	SortOption[]	Options de tri des résultats de recherche. Si la valeur est null, les résultats sont retournés triés par pertinence. Si plusieurs options de tri sont fournies, les résultats sont triés dans l’ordre spécifié dans orderBy.
$skip	integer	Nombre de résultats à ignorer.
$top	integer	Nombre de résultats à retourner.
filters	object	Filtres à appliquer. Définissez-le sur null s’il n’y a aucun filtre à appliquer.
includeFacets	boolean	Indicateur d’opter pour la facette dans le résultat. Le comportement par défaut est false.
searchText	string	Texte de la recherche.

WorkItemSearchResponse

Définit un élément de réponse retourné pour une demande de recherche d’élément de travail.

Nom	Type	Description
count	integer	Nombre total d’éléments de travail correspondants.
facets	object	Dictionnaire stockant un tableau d’objet `Filter` sur chaque facette.
infoCode	integer	Code numérique indiquant des informations supplémentaires : 0 - Ok, 1 - Le compte est en cours de réindexation, 2 - L’indexation de compte n’a pas démarré, 3 - Requête non valide, 4 - Requête générique de préfixe non prise en charge, 5 - MultiWords avec facette de code non prise en charge, 6 - Compte en cours d’intégration, 7 - Compte en cours d’intégration ou de réindexation, 8 - Valeur supérieure réduite à maxresult autorisé 9 - Les branches sont en cours d’indexation, 10 - Facettes non activées, 11 - Éléments de travail non accessibles, 19 - Requêtes d’expressions avec des filtres de type de code non pris en charge, 20 - Requêtes génériques avec des filtres de type de code non pris en charge. Tout autre code d’informations est utilisé à des fins internes.
results	WorkItemResult[]	Liste des principaux éléments de travail correspondants.

Partager via