API de modèle Azure Time Series Insights Gen2

Vue d’ensemble

Chacun des trois composants qui créent un modèle de série chronologique (instances, hiérarchies et types) a des API REST correspondantes qui prennent en charge les opérations CREATE, READ, UPDATE et DELETE, paginés et/ou batch.

• L’API d’instance prend en charge les opérations GET paginées, les opérations create, READ, UPDATE et DELETE, la recherche et les suggestions de mot clé pour les opérations de recherche.
• L’API Hierarchy prend en charge les opérations GET paginées et les opérations de lot CREATE, READ, UPDATE et DELETE.
• L’API Type prend en charge les opérations GET paginées et les opérations create, READ, UPDATE et DELETE par lots.

Une quatrième API prend en charge REST pour les paramètres de modèle de série chronologique :

• L’API Paramètres du modèle prend en charge les opérations HTTP GET et UPDATE pour les paramètres de configuration du modèle de série chronologique. Lisez Modèle de série chronologique pour obtenir des informations détaillées sur le modèle de série chronologique et les définitions de instance, de hiérarchie et de type.

Instances API

L’API Instances permet d’effectuer des opérations CREATE, READ, UPDATE et DELETE sur des instances de série chronologique :

• L’API Obtenir des instances retourne toutes les instances de série chronologique qui correspondent à la requête.

• L’API Gérer les instances active les opérations par lot sur les instances. Toutes les opérations sur cette API sont des opérations HTTP POST . Chaque opération accepte une charge utile. La charge utile est un objet JSON. Cet objet définit une propriété unique. La clé de propriété est le nom d’une opération autorisée par l’API. Les opérations prises en charge sont PUT, UPDATE et DELETE.

• Ces API permettent la découverte d’instances de série chronologique :

  • Suggest active les scénarios de saisie semi-automatique lors de la recherche d’un instance.
  • La recherche permet d’identifier les instances en fonction des mots clés fournis.

  Conseil

  Découvrez les fonctionnalités de requête de recherche ci-dessous.

API Hiérarchies

L’API Hierarchies active CREATE, READ, UPDATE et DELETE sur les hiérarchies de série chronologique.

API	Description
API Obtenir des hiérarchies	Retourne toutes les hiérarchies de série chronologique qui correspondent à la demande.
Gérer les API de hiérarchies	Active les opérations par lots sur les hiérarchies. Toutes les opérations sur cette API sont des opérations HTTP POST . Chaque opération accepte une charge utile. La charge utile est un objet JSON. Cet objet définit une propriété unique. La clé de propriété est le nom d’une opération que l’API autorise. Les opérations prises en charge sont PUT, UPDATE et DELETE.

Types API

L’API Types active CREATE, READ, UPDATE et DELETE sur les types de séries chronologiques et leurs variables associées.

API	Description
API Obtenir des types	Retourne tous les types de séries chronologiques et leurs variables associées.
Post Types API	Active les opérations par lot sur les types. Toutes les opérations sur cette API sont des opérations HTTP POST . Chaque opération accepte une charge utile. La charge utile est un objet JSON. Cet objet définit une propriété unique. La clé de propriété est le nom d’une opération que l’API autorise. Les opérations prises en charge sont PUT, UPDATE et DELETE.

API Des paramètres de modèle

L’API Paramètres de modèle active CREATE, READ, UPDATE et DELETE sur les modèles créés automatiquement dans l’environnement par TimeSeriesIds.

API	Description
API Obtenir les paramètres du modèle	Retourne le modèle créé automatiquement dans l’environnement pour TimeSeriesIds.
API Mettre à jour les paramètres du modèle	Mises à jour le modèle dans l’environnement pour TimeSeriesIds avec les nouvelles valeurs fournies dans la requête.

Fonctionnalités de recherche

Recherches avec des caractères génériques

Nous prenons en charge les recherches de caractères génériques uniques et multiples dans des termes uniques (et non dans les recherches d’expressions).

Caractère unique

Pour effectuer une recherche à caractère générique unique, utilisez le ? symbole . La recherche de caractères génériques à caractère unique recherche les termes qui correspondent à la chaîne avec le caractère unique remplacé.

Pour rechercher text ou test, recherchez : te?t.

Plusieurs caractères

Pour effectuer une recherche à caractère générique à plusieurs caractères, utilisez le * symbole . Les recherches avec caractères génériques multiples recherchent zéro ou plusieurs caractères.

Pour rechercher test, testsou tester, utilisez la recherche : test*.

Vous pouvez également utiliser les recherches par caractères génériques au milieu d’un terme. Pour rechercher dryer, vous pouvez utiliser la recherche : dr*r.

Opérateurs booléens

Les opérateurs booléens permettent de combiner des termes par le biais d’opérateurs logiques. Nous prenons en charge AND, OR, +, -et NOT en tant qu’opérateurs booléens.

Important

• Les opérateurs booléens doivent être dans ALL CAPS.
• Les opérateurs booléens doivent être séparés des clauses de recherche à l’aide d’espaces blancs.
• dryer AND washer est valide, mais pas dryer ANDwasher.

AND, opérateur

L’opérateur AND correspond aux documents où les deux termes existent n’importe où dans le texte d’un document unique.

Pour rechercher des documents qui contiennent dryer washer et foo bar utilisent la recherche : dryer washer AND foo bar.

Notes

Le symbole && peut être utilisé à la place de l’opérateur AND.

OR, opérateur

L’opérateur OR lie deux termes et recherche un document correspondant si l’un des termes existe dans un document. L’opérateur OR est l’opérateur de conjonction par défaut. Cela signifie que s’il n’existe aucun opérateur booléen entre deux termes, l’opérateur OR est utilisé.

Pour rechercher des documents contenant dryer washer ou simplement dryer utiliser l’une des recherches suivantes :

1. 'dryer washer' dryer
2. 'dryer washer' OR dryer

Notes

Le symbole || peut être utilisé à la place de l’opérateur OR.

+, opérateur

L’opérateur + ou obligatoire nécessite que le terme après le + symbole existe quelque part dans un champ d’un document unique.

Pour rechercher des documents qui doivent contenir dryer et peuvent contenir washer , utilisez la recherche : +dryer washer.

-, opérateur

L’opérateur - ou interdit exclut les documents qui contiennent le terme après le - symbole.

Pour rechercher des documents qui contiennent mais dryer washer n’utilisent pas foo bar la recherche : dryer washer -foo bar.

NOT

L’opérateur NOT exclut les documents qui contiennent le terme après NOT.

Pour rechercher des documents qui contiennent dryer washer mais n’utilisent pas foo bar la recherche : dryer washer NOT foo bar.

L’opérateur NOT ne peut pas être utilisé avec un seul terme.

La recherche suivante ne retourne aucun résultat : NOT dryer washer.

Notes

Le symbole ! peut être utilisé à la place de l’opérateur NOT.

• Il doit immédiatement précéder le terme de recherche exclu.
• dryer !washer est valide, mais pas dryer ! washer.

Voir aussi

• Pour plus d’informations sur l’inscription des applications et le modèle de programmation Azure Active Directory, consultez Azure Active Directory pour les développeurs.

• Pour en savoir plus sur les paramètres de requête et d’authentification, consultez Authentification et autorisation.

• Les outils qui aident à tester les requêtes et réponses HTTP sont les suivants :

• Fiddler. Ce proxy de débogage web gratuit peut intercepter vos requêtes REST, ce qui vous permet de diagnostiquer les messages de requête et de réponse HTTP.

• JWT.io. Vous pouvez utiliser cet outil pour vider rapidement les revendications dans votre jeton du porteur, puis valider leur contenu.

• Postman. Il s’agit d’un outil de test de requête et de réponse HTTP gratuit pour le débogage des API REST.

• Pour en savoir plus sur Azure Time Series Insights Gen2, consultez la documentation Gen2.