Time Series Instances - Search

Service:

Time Series Insights

Version d'API:

2020-07-31

Liste partielle des accès lors de la recherche d’instances de série chronologique en fonction des attributs instance.

POST https://{environmentFqdn}/timeseries/instances/search?api-version=2020-07-31

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
environmentFqdn	path	True	string	Nom de domaine complet par environnement, par exemple 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. Vous pouvez obtenir ce nom de domaine à partir de la réponse de l’API Obtenir des environnements, Portail Azure ou azure Resource Manager.
api-version	query	True	string	Version de l’API à utiliser avec la demande du client. La version actuellement prise en charge est « 2020-07-31 ».

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-continuation		string	Jeton de continuation de la page précédente des résultats pour récupérer la page suivante des résultats dans les appels qui prennent en charge la pagination. Pour obtenir les premiers résultats de la page, spécifiez le jeton de continuation Null comme valeur de paramètre. Le jeton de continuation retourné est null si tous les résultats ont été retournés et qu’il n’y a pas de page de résultats suivante.
x-ms-client-request-id		string	ID de demande client facultative. Le service enregistre cette valeur. Permet au service de suivre les opérations entre les services et permet au client de contacter le support technique concernant une demande particulière.
x-ms-client-session-id		string	ID de session client facultatif. Le service enregistre cette valeur. Permet au service de suivre un groupe d’opérations associées entre les services et permet au client de contacter le support technique concernant un groupe particulier de demandes.

Corps de la demande

Nom	Obligatoire	Type	Description
searchString	True	string	Chaîne de recherche de requête qui sera mise en correspondance avec les attributs des instances de série chronologique. Exemple : « floor 100 ». Ne respectant pas la casse, doit être présent, mais peut être une chaîne vide.
hierarchies		SearchInstancesHierarchiesParameters	Paramètres de la façon de retourner des hiérarchies de série chronologique instance. Si la valeur est null, les hiérarchies ne sont pas retournées. Si le paramètre instances a la valeur null et que le paramètre de hiérarchies n’est pas null, seules les hiérarchies sans instances sont retournées.
instances		SearchInstancesParameters	Paramètres de la façon de retourner des instances de série chronologique. Peuvent avoir la valeur null. Lorsque les paramètres d’instances et de hiérarchies sont tous deux null, les instances sont retournées dans les résultats en fonction des valeurs par défaut des paramètres, et les hiérarchies ne sont pas retournées.
path		string[]	Filtrez sur le chemin de hiérarchie des instances de série chronologique. Path est représenté sous la forme d’un tableau de segments de chemin de chaîne. Le premier élément doit être le nom de la hiérarchie. Exemple : ["Location », « California"]. Facultatif, respectant la casse, jamais vide et peut être null.

Réponses

Nom	Type	Description
200 OK	SearchInstancesResponsePage	Réponse de recherche réussie. En-têtes x-ms-request-id: string
Other Status Codes	TsiError	Erreur inattendue. En-têtes x-ms-request-id: string

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

SearchInstancesDefault

SearchInstancesExpandHierarchiesOnly

SearchInstancesHierarchiesDefaultInputPage1

SearchInstancesHierarchiesDefaultInputPage2

SearchInstancesHierarchiesDefaultInputPage3

SearchInstancesOneLevel

SearchInstancesRecursive

SearchInstancesUntilChildren

SearchInstancesDefault

Exemple de requête

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31

{
  "searchString": "floor 100"
}

Exemple de réponse

Code d’état:

200

{
  "instances": {
    "hits": [
      {
        "timeSeriesId": [
          "Id1One",
          "Id2One",
          "1.0"
        ],
        "name": "instance1",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": null
      },
      {
        "timeSeriesId": [
          "Id1Two",
          "Id2Two",
          "2.0"
        ],
        "name": "instance2",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": null
      }
    ],
    "hitCount": 2,
    "continuationToken": null
  },
  "hierarchyNodes": null
}

SearchInstancesExpandHierarchiesOnly

Exemple de requête

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31

{
  "searchString": "floor 100",
  "path": [
    "Location"
  ],
  "instances": null,
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "Name"
    },
    "pageSize": 2
  }
}

Exemple de réponse

Code d’état:

200

{
  "instances": {
    "hits": [],
    "hitCount": 0,
    "continuationToken": null
  },
  "hierarchyNodes": {
    "hits": [
      {
        "name": "California",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": {
          "hits": [
            {
              "name": "San Diego",
              "cumulativeInstanceCount": 1,
              "hierarchyNodes": null
            },
            {
              "name": "San Francisco",
              "cumulativeInstanceCount": 1,
              "hierarchyNodes": null
            }
          ],
          "hitCount": 2,
          "continuationToken": null
        }
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

SearchInstancesHierarchiesDefaultInputPage1

Exemple de requête

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": true,
    "sort": {
      "by": "Rank"
    },
    "highlights": true,
    "pageSize": 1
  },
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "CumulativeInstanceCount"
    },
    "pageSize": 1
  }
}

Exemple de réponse

Code d’état:

200

{
  "instances": {
    "hits": [
      {
        "timeSeriesId": [
          "Id1Two",
          "Id2Two",
          "2.0"
        ],
        "name": "instance2",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": {
          "timeSeriesId": [
            "Id1Two",
            "Id2Two",
            "2.0"
          ],
          "typeName": "DefaultType",
          "name": "instance2",
          "description": "<hit>floor</hit> <hit>100</hit>",
          "hierarchyIds": [
            "1643004c-0a84-48a5-80e5-7688c5ae9295"
          ],
          "hierarchyNames": [
            "Location"
          ],
          "instanceFieldNames": [
            "state",
            "city"
          ],
          "instanceFieldValues": [
            "California",
            "San Francisco"
          ]
        }
      }
    ],
    "hitCount": 2,
    "continuationToken": "c3sic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNTE3MDUxOTg0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0="
  },
  "hierarchyNodes": {
    "hits": [
      {
        "name": "Location",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": {
          "hits": [
            {
              "name": "California",
              "cumulativeInstanceCount": 2,
              "hierarchyNodes": {
                "hits": [
                  {
                    "name": "San Francisco",
                    "cumulativeInstanceCount": 1,
                    "hierarchyNodes": null
                  }
                ],
                "hitCount": 2,
                "continuationToken": "aHsic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNzA4NTgyODU0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0="
              }
            }
          ],
          "hitCount": 1,
          "continuationToken": null
        }
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

SearchInstancesHierarchiesDefaultInputPage2

Exemple de requête

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": true,
    "sort": {
      "by": "Rank"
    },
    "highlights": true,
    "pageSize": 1
  },
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "CumulativeInstanceCount"
    },
    "pageSize": 1
  }
}

Exemple de réponse

Code d’état:

200

{
  "instances": {
    "hits": [
      {
        "timeSeriesId": [
          "Id1One",
          "Id2One",
          "1.0"
        ],
        "name": "instance1",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": {
          "timeSeriesId": [
            "Id1One",
            "Id2One",
            "1.0"
          ],
          "typeName": "DefaultType",
          "name": "instance1",
          "description": "<hit>floor</hit> <hit>100</hit>",
          "hierarchyIds": [
            "1643004c-0a84-48a5-80e5-7688c5ae9295"
          ],
          "hierarchyNames": [
            "Location"
          ],
          "instanceFieldNames": [
            "state",
            "city"
          ],
          "instanceFieldValues": [
            "California",
            "Los Angeles"
          ]
        }
      }
    ],
    "hitCount": 2,
    "continuationToken": null
  },
  "hierarchyNodes": null
}

SearchInstancesHierarchiesDefaultInputPage3

Exemple de requête

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": true,
    "sort": {
      "by": "Rank"
    },
    "highlights": true,
    "pageSize": 1
  },
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "CumulativeInstanceCount"
    },
    "pageSize": 1
  }
}

Exemple de réponse

Code d’état:

200

{
  "instances": null,
  "hierarchyNodes": {
    "hits": [
      {
        "name": "Location",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": {
          "hits": [
            {
              "name": "California",
              "cumulativeInstanceCount": 2,
              "hierarchyNodes": {
                "hits": [
                  {
                    "name": "San Diego",
                    "cumulativeInstanceCount": 1,
                    "hierarchyNodes": null
                  }
                ],
                "hitCount": 2,
                "continuationToken": "aHsic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNzA4NTgyODU0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0="
              }
            }
          ],
          "hitCount": 1,
          "continuationToken": null
        }
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

SearchInstancesOneLevel

Exemple de requête

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": false,
    "sort": {
      "by": "DisplayName"
    },
    "highlights": false,
    "pageSize": 2
  },
  "hierarchies": {
    "expand": {
      "kind": "OneLevel"
    },
    "sort": {
      "by": "Name"
    },
    "pageSize": 2
  }
}

Exemple de réponse

Code d’état:

200

{
  "instances": {
    "hits": [],
    "hitCount": 0,
    "continuationToken": null
  },
  "hierarchyNodes": {
    "hits": [
      {
        "name": "Location",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": null
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

SearchInstancesRecursive

Exemple de requête

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31

{
  "searchString": "floor 100",
  "path": null,
  "instances": {
    "recursive": true,
    "sort": {
      "by": "DisplayName"
    },
    "highlights": false,
    "pageSize": 2
  },
  "hierarchies": null
}

Exemple de réponse

Code d’état:

200

{
  "instances": {
    "hits": [
      {
        "timeSeriesId": [
          "Id1One",
          "Id2One",
          "1.0"
        ],
        "name": "instance1",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": null
      },
      {
        "timeSeriesId": [
          "Id1Two",
          "Id2Two",
          "2.0"
        ],
        "name": "instance2",
        "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393",
        "hierarchyIds": [
          "1643004c-0a84-48a5-80e5-7688c5ae9295"
        ],
        "highlights": null
      }
    ],
    "hitCount": 2,
    "continuationToken": null
  },
  "hierarchyNodes": null
}

SearchInstancesUntilChildren

Exemple de requête

HTTP

POST https://10000000-0000-0000-0000-100000000109.env.timeseries.azure.com/timeseries/instances/search?api-version=2020-07-31

{
  "searchString": "floor 100",
  "path": [
    "Location"
  ],
  "instances": {
    "recursive": false,
    "sort": {
      "by": "DisplayName"
    },
    "highlights": false,
    "pageSize": 2
  },
  "hierarchies": {
    "expand": {
      "kind": "UntilChildren"
    },
    "sort": {
      "by": "Name"
    },
    "pageSize": 2
  }
}

Exemple de réponse

Code d’état:

200

{
  "instances": {
    "hits": [],
    "hitCount": 0,
    "continuationToken": null
  },
  "hierarchyNodes": {
    "hits": [
      {
        "name": "California",
        "cumulativeInstanceCount": 2,
        "hierarchyNodes": {
          "hits": [
            {
              "name": "San Diego",
              "cumulativeInstanceCount": 1,
              "hierarchyNodes": null
            },
            {
              "name": "San Francisco",
              "cumulativeInstanceCount": 1,
              "hierarchyNodes": null
            }
          ],
          "hitCount": 2,
          "continuationToken": null
        }
      }
    ],
    "hitCount": 1,
    "continuationToken": null
  }
}

Définitions

Nom	Description
HierarchiesExpandKind	Type d’expansion des nœuds de hiérarchie. Lorsqu’il est défini sur « UntilChildren », les nœuds de hiérarchie sont développés de manière récursive jusqu’à ce qu’il y ait plusieurs enfants. Lorsqu’elle est définie sur « OneLevel », les hiérarchies sont développées uniquement au paramètre d’instances de recherche de chemin d’accès correspondant à un seul niveau. Facultatif, la valeur par défaut est « UntilChildren ».
HierarchiesExpandParameter	Définition de l’extension des nœuds de hiérarchie dans le même appel d’instances de recherche.
HierarchiesSortBy	Valeur à utiliser pour le tri des nœuds de hiérarchie. Lorsqu’elle est définie sur « CumulativeInstanceCount », les hiérarchies retournées sont triées en fonction du nombre total d’instances appartenant au nœud de hiérarchie et de ses nœuds de hiérarchie enfants. Lorsqu’elle est définie sur « Name », les hiérarchies retournées sont triées en fonction du nom de la hiérarchie. Facultatif, la valeur par défaut est « CumulativeInstanceCount ».
HierarchiesSortParameter	Définition du tri des nœuds de hiérarchie.
HierarchyHit	Nœud de hiérarchie qui contient les instances correspondant à la requête en fonction de l’entrée. Peut être vide ou null.
Highlights	Le texte de série chronologique mis en surbrillance instance être affiché à l’utilisateur. Mise en surbrillance des insertions et des balises dans les parties de texte correspondant à la chaîne de recherche. N’utilisez aucune des propriétés mises en surbrillance pour effectuer d’autres appels d’API.
InstanceHit	La série chronologique instance retournée par l’appel de recherche d’instances. Retourné instance correspond à la demande de recherche et contient le texte en surbrillance à afficher à l’utilisateur s’il est défini sur « true ».
InstancesSortBy	Valeur à utiliser pour le tri des instances de série chronologique avant d’être retournée par l’appel d’instances de recherche. Lorsqu’elle est définie sur « Rank », les instances retournées sont triées en fonction de la pertinence. Lorsqu’il est défini sur « DisplayName », les résultats retournés sont triés en fonction du nom d’affichage. Nom d’affichage est le nom du instance s’il existe, sinon, nom d’affichage est l’ID de série chronologique. La valeur par défaut est « Rank ».
InstancesSortParameter	Définition de la façon dont les instances de série chronologique sont triées avant d’être retournées par l’appel d’instances de recherche.
SearchHierarchyNodesResponse	Nœuds de hiérarchie qui contiennent les instances correspondant à la requête en fonction de l’entrée. Peut être vide ou null.
SearchInstancesHierarchiesParameters	Paramètre de la façon de retourner des séries chronologiques instance hiérarchies par appel d’instances de recherche.
SearchInstancesParameters	Paramètres de la façon de retourner des instances de série chronologique par appel d’instances de recherche.
SearchInstancesRequest	Demande d’exécuter une requête de recherche sur des instances de série chronologique et de retourner des instances de série chronologique correspondantes.
SearchInstancesResponse	Instances correspondant à la requête en fonction de l’entrée. Peut être vide ou null.
SearchInstancesResponsePage	Page unique des résultats de la recherche.
TsiError	Informations sur une erreur d’API.
TsiErrorBody	Erreur d’API particulière avec un code d’erreur et un message.
TsiErrorDetails	Informations supplémentaires sur l’erreur.

HierarchiesExpandKind

Type d’expansion des nœuds de hiérarchie. Lorsqu’il est défini sur « UntilChildren », les nœuds de hiérarchie sont développés de manière récursive jusqu’à ce qu’il y ait plusieurs enfants. Lorsqu’elle est définie sur « OneLevel », les hiérarchies sont développées uniquement au paramètre d’instances de recherche de chemin d’accès correspondant à un seul niveau. Facultatif, la valeur par défaut est « UntilChildren ».

Nom	Type	Description
OneLevel	string
UntilChildren	string

HierarchiesExpandParameter

Définition de l’extension des nœuds de hiérarchie dans le même appel d’instances de recherche.

Nom	Type	Description
kind	HierarchiesExpandKind	Type d’expansion des nœuds de hiérarchie. Lorsqu’il est défini sur « UntilChildren », les nœuds de hiérarchie sont développés de manière récursive jusqu’à ce qu’il y ait plusieurs enfants. Lorsqu’elle est définie sur « OneLevel », les hiérarchies sont développées uniquement au paramètre d’instances de recherche de chemin d’accès correspondant à un seul niveau. Facultatif, la valeur par défaut est « UntilChildren ».

HierarchiesSortBy

Valeur à utiliser pour le tri des nœuds de hiérarchie. Lorsqu’elle est définie sur « CumulativeInstanceCount », les hiérarchies retournées sont triées en fonction du nombre total d’instances appartenant au nœud de hiérarchie et de ses nœuds de hiérarchie enfants. Lorsqu’elle est définie sur « Name », les hiérarchies retournées sont triées en fonction du nom de la hiérarchie. Facultatif, la valeur par défaut est « CumulativeInstanceCount ».

Nom	Type	Description
CumulativeInstanceCount	string
Name	string

HierarchiesSortParameter

Définition du tri des nœuds de hiérarchie.

Nom	Type	Description
by	HierarchiesSortBy	Valeur à utiliser pour le tri des nœuds de hiérarchie. Lorsqu’elle est définie sur « CumulativeInstanceCount », les hiérarchies retournées sont triées en fonction du nombre total d’instances appartenant au nœud de hiérarchie et de ses nœuds de hiérarchie enfants. Lorsqu’elle est définie sur « Name », les hiérarchies retournées sont triées en fonction du nom de la hiérarchie. Facultatif, la valeur par défaut est « CumulativeInstanceCount ».

HierarchyHit

Nœud de hiérarchie qui contient les instances correspondant à la requête en fonction de l’entrée. Peut être vide ou null.

Nom	Type	Description
cumulativeInstanceCount	integer	Nombre total d’instances qui appartiennent à ce nœud et de ses sous-arborescences correspondant à la requête.
hierarchyNodes	SearchHierarchyNodesResponse	Nœuds de hiérarchie enfants de ce nœud. Peut être vide ou null.
name	string	Nom du nœud de hiérarchie. Peut être vide, ne peut pas être null.

Highlights

Le texte de série chronologique mis en surbrillance instance être affiché à l’utilisateur. Mise en surbrillance des insertions et des balises dans les parties de texte correspondant à la chaîne de recherche. N’utilisez aucune des propriétés mises en surbrillance pour effectuer d’autres appels d’API.

Nom	Type	Description
description	string	Description mise en surbrillance des instance de série chronologique. Ce paramètre peut être null.
hierarchyIds	string[]	Liste des ID de hiérarchie de série chronologique mis en surbrillance auxquels appartient instance série chronologique. Ne peut pas être utilisé pour rechercher des hiérarchies. Ce paramètre peut être null.
hierarchyNames	string[]	Liste des noms de hiérarchie de séries chronologiques mis en surbrillance auxquels appartient instance série chronologique. Ne peut pas être utilisé pour rechercher des hiérarchies. Ce paramètre peut être null.
instanceFieldNames	string[]	Liste des noms de champs de série chronologique instance en surbrillance. Ce paramètre peut être null.
instanceFieldValues	string[]	Liste des valeurs de champ de série chronologique instance en surbrillance. Ce paramètre peut être null.
name	string	Nom de la série chronologique en surbrillance instance. Ce paramètre peut être null.
timeSeriesId	string[]	Liste des valeurs de chaîne en surbrillance de l’ID de série chronologique à afficher. Ne peut pas être utilisé pour rechercher instance.
typeName	string	Nom de type de série chronologique mis en surbrillance auquel appartient cette instance.

InstanceHit

La série chronologique instance retournée par l’appel de recherche d’instances. Retourné instance correspond à la demande de recherche et contient le texte en surbrillance à afficher à l’utilisateur s’il est défini sur « true ».

Nom	Type	Description
hierarchyIds	string[]	Liste des ID de hiérarchie de série chronologique auxquels la série chronologique instance correspondant à la demande de recherche appartient. Ne peut pas être utilisé pour rechercher des hiérarchies. Ce paramètre peut être null.
highlights	Highlights	Le texte de série chronologique mis en surbrillance instance être affiché à l’utilisateur. Mise en surbrillance des insertions et des balises dans les parties de texte correspondant à la chaîne de recherche. N’utilisez aucune des propriétés mises en surbrillance pour effectuer d’autres appels d’API.
name	string	Nom de la série chronologique instance correspondant à la demande de recherche. Ce paramètre peut être null.
timeSeriesId	TimeSeriesId[]	ID de série chronologique de la série chronologique instance correspondant à la demande de recherche.
typeId	string	Représente le type auquel appartient la série chronologique instance qui correspond à la demande de recherche. Jamais null.

InstancesSortBy

Valeur à utiliser pour le tri des instances de série chronologique avant d’être retournée par l’appel d’instances de recherche. Lorsqu’elle est définie sur « Rank », les instances retournées sont triées en fonction de la pertinence. Lorsqu’il est défini sur « DisplayName », les résultats retournés sont triés en fonction du nom d’affichage. Nom d’affichage est le nom du instance s’il existe, sinon, nom d’affichage est l’ID de série chronologique. La valeur par défaut est « Rank ».

Nom	Type	Description
DisplayName	string
Rank	string

InstancesSortParameter

Définition de la façon dont les instances de série chronologique sont triées avant d’être retournées par l’appel d’instances de recherche.

Nom	Type	Description
by	InstancesSortBy	Valeur à utiliser pour le tri des instances de série chronologique avant d’être retournée par l’appel d’instances de recherche. Lorsqu’elle est définie sur « Rank », les instances retournées sont triées en fonction de la pertinence. Lorsqu’il est défini sur « DisplayName », les résultats retournés sont triés en fonction du nom d’affichage. Nom d’affichage est le nom du instance s’il existe, sinon, nom d’affichage est l’ID de série chronologique. La valeur par défaut est « Rank ».

SearchHierarchyNodesResponse

Nœuds de hiérarchie qui contiennent les instances correspondant à la requête en fonction de l’entrée. Peut être vide ou null.

Nom	Type	Description
continuationToken	string	S’il est retourné, cela signifie que les résultats actuels représentent un résultat partiel. Le jeton de continuation permet d’obtenir la page suivante des résultats. Pour obtenir la page suivante des résultats de la requête, envoyez la même requête avec le paramètre de jeton de continuation dans l’en-tête HTTP « x-ms-continuation ».
hitCount	integer	Nombre total de nœuds de hiérarchie qui contient les instances correspondant à la requête en fonction de l’entrée.
hits	HierarchyHit[]	Liste des nœuds de hiérarchie qui contient les instances correspondant à la requête en fonction de l’entrée. Peut être vide.

SearchInstancesHierarchiesParameters

Paramètre de la façon de retourner des séries chronologiques instance hiérarchies par appel d’instances de recherche.

Nom	Type	Description
expand	HierarchiesExpandParameter	Définition de l’extension des nœuds de hiérarchie dans le même appel d’instances de recherche. Facultatif, la valeur par défaut est « UntilChildren ».
pageSize	integer	Nombre maximal de hiérarchies dans le même niveau à retourner dans la même page. Facultatif, la valeur par défaut est 10 quand elle n’est pas définie. La plage est comprise entre 1 et 100. S’il existe des résultats au-delà de la taille de la page, le jeton de continuation peut être utilisé pour extraire la page suivante.
sort	HierarchiesSortParameter	Définition du tri des nœuds de hiérarchie. Facultatif, la valeur par défaut est « CumulativeInstanceCount ».

SearchInstancesParameters

Paramètres de la façon de retourner des instances de série chronologique par appel d’instances de recherche.

Nom	Type	Description
highlights	boolean	Définition des résultats de recherche mis en surbrillance ou non. Lorsqu’il est défini sur « true », les résultats de recherche en surbrillance sont retournés. Lorsqu’elle est définie sur « false », les résultats de la recherche en surbrillance ne sont pas retournés. La valeur par défaut est « True ».
pageSize	integer	Nombre maximal d’instances attendues dans chaque page du résultat. La valeur par défaut est 10 quand elle n’est pas définie. Plages comprises entre 1 et 100. S’il existe des résultats au-delà de la taille de page, l’utilisateur peut utiliser le jeton de continuation pour extraire la page suivante.
recursive	boolean	Définition des instances retournées. Lorsque récursif est défini sur « true », toutes les instances dont le chemin commence par le chemin d’accès du paramètre path sont retournées. Lorsque récursif est défini sur « false », seules les instances dont le chemin correspond exactement au paramètre path sont retournées. L’utilisation de la recherche récursive permet d’implémenter l’expérience utilisateur de recherche, tandis que l’utilisation de la recherche non récursive permet d’implémenter l’expérience de navigation. Facultatif, la valeur par défaut est « true ».
sort	InstancesSortParameter	Définition de la façon dont les instances de série chronologique sont triées avant d’être retournées par l’appel des instances de recherche - pertinence ou alphabétique. Facultatif, la valeur par défaut est « Rank ».

SearchInstancesRequest

Demande d’exécuter une requête de recherche sur des instances de série chronologique et de retourner des instances de série chronologique correspondantes.

Nom	Type	Description
hierarchies	SearchInstancesHierarchiesParameters	Paramètres de la façon de retourner des hiérarchies de série chronologique instance. Si la valeur est null, les hiérarchies ne sont pas retournées. Si le paramètre instances a la valeur null et que le paramètre des hiérarchies n’est pas null, seules les hiérarchies sans instances sont retournées.
instances	SearchInstancesParameters	Paramètres de la façon de retourner des instances de série chronologique. Peuvent avoir la valeur null. Lorsque les paramètres des instances et des hiérarchies sont null, les instances sont retournées dans les résultats en fonction des valeurs par défaut des paramètres, et les hiérarchies ne sont pas retournées.
path	string[]	Filtrez sur le chemin de hiérarchie des instances de série chronologique. Le chemin d’accès est représenté sous forme de tableau de segments de chemin de chaîne. Le premier élément doit être le nom de la hiérarchie. Exemple : ["Location », « Californie"]. Facultatif, respectant la casse, jamais vide et peut être null.
searchString	string	Interroger la chaîne de recherche qui sera mise en correspondance avec les attributs des instances de série chronologique. Exemple : « floor 100 ». Ne respectant pas la casse, doit être présent, mais peut être une chaîne vide.

SearchInstancesResponse

Instances correspondant à la requête en fonction de l’entrée. Peut être vide ou null.

Nom	Type	Description
continuationToken	string	S’il est retourné, cela signifie que les résultats actuels représentent un résultat partiel. Le jeton de continuation permet d’obtenir la page suivante des résultats. Pour obtenir la page suivante des résultats de la requête, envoyez la même requête avec le paramètre de jeton de continuation dans l’en-tête HTTP « x-ms-continuation ».
hitCount	integer	Nombre total d’instances correspondant à la requête en fonction de l’entrée.
hits	InstanceHit[]	Liste des instances correspondant à la requête en fonction de l’entrée. Peut être vide.

SearchInstancesResponsePage

Page unique des résultats de la recherche.

Nom	Type	Description
hierarchyNodes	SearchHierarchyNodesResponse	Nœuds de hiérarchie qui contiennent les instances correspondant à la requête en fonction de l’entrée. Peut être vide ou null.
instances	SearchInstancesResponse	Instances correspondant à la requête en fonction de l’entrée. Peut être vide ou null.

TsiError

Informations sur une erreur d’API.

Nom	Type	Description
error	TsiErrorBody	Erreur d’API particulière avec un code d’erreur et un message.

TsiErrorBody

Erreur d’API particulière avec un code d’erreur et un message.

Nom	Type	Description
code	string	Chaîne indépendante du langage et lisible par l’homme qui définit un code d’erreur spécifique au service. Ce code sert d’indicateur plus spécifique pour le code d’erreur HTTP spécifié dans la réponse. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques.
details	TsiErrorDetails[]	Contient des informations supplémentaires sur les erreurs. Ce paramètre peut être null.
innerError	TsiErrorBody	Contient une erreur plus spécifique qui limite la cause. Ce paramètre peut être null.
message	string	Représentation de l’erreur, lisible et indépendante de la langue. Il est destiné à aider les développeurs et n’est pas adapté à l’exposition aux utilisateurs finaux.
target	string	Cible de l’erreur particulière (par exemple, le nom de la propriété en erreur). Ce paramètre peut être null.

TsiErrorDetails

Informations supplémentaires sur l’erreur.

Nom	Type	Description
code	string	Chaîne indépendante du langage et lisible par l’homme qui définit un code d’erreur spécifique au service. Ce code sert d’indicateur plus spécifique pour le code d’erreur HTTP spécifié dans la réponse. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques.
message	string	Représentation lisible et indépendante du langage de l’erreur. Il est destiné à aider les développeurs et n’est pas adapté à l’exposition des utilisateurs finaux.