API de modèle Azure Time Series Insights Gen2

Aperçu

Chacun des trois composants qui composent 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ées et/ou par lots.

  • L’API d’instance prend en charge les opérations GET paginées, les opérations CREATE,READ,UPDATE et DELETE par lots, la recherche et les suggestions de mots-clés pour les opérations de recherche.
  • L’API Hierarchy prend en charge les opérations GET paginées et les opérations CREATE,READ,UPDATE et DELETE par lots.
  • 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 fournit une prise 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 plus d’informations sur le modèle de série chronologique et les définitions d’instance, de hiérarchie et de type .

Instances API

L’API Instances permet d’effectuer les opérations CREATE,READ,UPDATE et DELETE sur les instances de séries chronologiques :

  • L’API Obtenir des instances renvoie toutes les instances de série chronologique qui correspondent à la demande.

  • L’API Gérer les instances permet d’effectuer des opérations par lots sur les instances. Toutes les opérations effectuées 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 seule propriété. 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éries chronologiques :

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

    Conseil / Astuce

    En savoir plus sur les fonctionnalités de recherche ci-dessous.

API de hiérarchies

L’API Hiérarchies permet de CRÉER, LIRE, METTRE à jour et SUPPRIMER sur les hiérarchies de séries chronologiques.

API (Interface de Programmation d'Applications) Descriptif
Obtenir l’API Hiérarchies Renvoie toutes les hiérarchies de séries chronologiques qui correspondent à la demande.
API de gestion des hiérarchies Permet d’effectuer des opérations par lots sur les hiérarchies. Toutes les opérations effectuées 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 seule propriété. 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.

Types d’API

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

API (Interface de Programmation d'Applications) Descriptif
API Obtenir les types Renvoie tous les types de séries chronologiques et leurs variables associées.
API de types de publication Active les opérations par lots sur les types. Toutes les opérations effectuées 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 seule propriété. 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.

API des paramètres du modèle

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

API (Interface de Programmation d'Applications) Descriptif
Obtenir l’API des paramètres du modèle Renvoie le modèle créé automatiquement dans l’environnement pour TimeSeriesIds.
Mettre à jour l’API des paramètres du modèle Met à jour le modèle dans l’environnement pour TimeSeriesIds avec les nouvelles valeurs fournies dans la demande.

Fonctionnalités de recherche

Recherches avec des caractères génériques

Nous prenons en charge les recherches génériques à un ou plusieurs caractères dans des termes uniques (et non dans des recherches par expression).

Un seul caractère

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

Pour rechercher l’un ou text l’autre ou test, recherchez : te?t.

Plusieurs caractères

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

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

Vous pouvez également utiliser les recherches 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 à l’aide 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 en MAJUSCULES.
  • Les opérateurs booléens doivent être séparés des clauses de recherche par des espaces.
  • 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 seul document.

Pour rechercher des documents contenant dryer washer et foo bar utiliser la recherche : dryer washer AND foo bar.

Remarque

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

OPÉRATEUR OR

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

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

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

Remarque

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

+ Opérateur

L’opérateur + ou required exige que le terme après le + symbole existe quelque part dans une zone d’un seul document.

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

-Opérateur

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

Pour rechercher des documents qui contiennent, mais qui n’utilisent dryer washer 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, mais qui n’utilisent dryer washer 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 donne aucun résultat : NOT dryer washer.

Remarque

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 d’application 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 demande et d’authentification, consultez Authentification et autorisation.

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

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

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

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

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