À propos d'OData et des références

L'implémentation de l'API Orchestrator est basée sur le protocole OData. OData (Open Data Protocol) est une norme OASIS approuvée ISO/IEC qui définit un ensemble de meilleures pratiques pour la création et l'utilisation des API RESTful.

Open Data Protocol (OData) permet la création de services de données basés sur REST, qui permettent à des ressources, identifiées à l'aide d'URL et définies dans un modèle de données, d'être publiées et modifiées par des clients Web à l'aide de messages HTTP simples. Cette spécification définit la sémantique de base et les aspects comportementaux du protocole.

Le format par défaut du point de terminaison des métadonnées Orchestrator OData est JSON, et l'URL des métadonnées est https://{yourDomain}/odata. Pour passer le format par défaut en XML, ajoutez /?$format=xml à cette URL.

Pour plus d’informations sur les principes et définitions du protocole, nous vous recommandons de consulter la documentation officielle OData.

Remarque : Nous visons la conformité à la norme OData, mais ne pouvons la garantir. Alors que la norme exige que le point de terminaison de métadonnées renvoie le format XML par défaut, nous renvoyons JSON pour une compatibilité historique.

Ressources logiques et métadonnées

L'API Orchestrator fournit des méthodes personnalisées pour demander des statistiques sur les différentes entités enregistrées dans Orchestrator. Chaque ressource logique est une entité OData. Toutes les entités (telles que Robot, Processus, File d'attente) comprennent des propriétés, des relations et des opérations.

Opérations disponibles

Opérations CRUD

Ces types d'opérations sont essentiellement disponibles dans les ressources logiques. Les opérations CRUD incluent les requêtes GET, POST, PUT et DELETE. Notez, cependant, que les ressources logiques n'utilisent pas toutes ces verbes pour des raisons techniques et commerciales.

Demande de données

Il est possible de demander des informations particulières à partir d'une ressource particulière, conjointement à des opérations GET, via des paramètres spécifiques d'OData.

Ils vous permettent d'interroger, de filtrer, de trier, de sélectionner et de développer des informations. Vous trouverez plus de détails dans la documentation officielle d' OData.

Actions personnalisées

Les actions personnalisées suivantes et les actions non liées à une ressource logique sont disponibles dans l'API Orchestrator :

• les méthodes statistiques (Stats methods) fournissent des informations agrégées sur des entités différentes ;
• les méthodes de compte fournissent des méthodes d'authentification à Orchestrator ;
• les méthodes de files d'attente sont utilisées par le Robot pour accéder aux files d'attente, tandis que le point de terminaison QueueDefinitions doit être, par contre, utilisé pour les systèmes externes via l'API ;
• les méthodes QueueProcessingRecords offrent des informations statistiques et agrégées sur les files d'attente ;

• Les ressources RobotsService peuvent être utilisées par Orchestrator pour communiquer avec le Robot.