Lire et examiner la documentation Automation Anywhere

Fermer les contenus

Contenus

Ouvrir les contenus

API de déploiement et surveillance de la progression des robots

  • Mis à jour le : 5/10/2019
    • 11.3.x
    • Exploration
    • Enterprise
    • Docs API

API de déploiement et surveillance de la progression des robots

En tant qu'administrateur de la Enterprise Control Room ou utilisateur possédant l'autorisation Afficher et gérer une activité planifiée, déployez des robots et suivez leur évolution à l'aide d'un ensemble d'API de la Enterprise Control Room.

Les API de déploiement et de surveillance des robots vous permettent d'effectuer les opérations suivantes :

  1. Récupérer les détails d'un robot donné à partir du référentiel du serveur pour identifier l'identifiant de fichier à utiliser pour son déploiement
  2. Récupérer la liste des périphériques (Exécuteur de robots :s) disponibles pour l'automatisation et le statut de son automatisation
  3. Déploiement d'un robot sur des périphériques donnés et récupération de son identifiant d'automatisation
  4. Surveillance de la progression du robot en fonction de l'identifiant d'automatisation
Remarque : Les exemples fournis dans cet article sont présentés pour référence uniquement.

Avant d'accéder aux API de déploiement et de surveillance, vous devez d'abord utiliser l'API d'authentification et la transmettre sous forme de jeton pour utiliser une API spécifique.

  1. À l'aide de la méthode POST, générez un jeton au moyen du point de terminaison http(s)://<hostname:port>/v1/authentication. Pour cela, fournissez l'instance de la Enterprise Control Room à savoir Nom du serveur / Nom d'hôte / IP et numéro de port.
    • Par exemple, https://crdevenv.com:81/v1/authentication
  2. Fournissez la charge utile de demande suivante dans les en-têtes :

    "X-Authorization" : "Authorization token"

    "Content-Type" : "application/json"

  3. Fournissez la charge utile des demandes suivante dans le corps :
    { "username": "<Username>", "password": "<Password>" }
    • Par exemple :
      { "usename":"Ellie.Brown", "password":"12345678" }

API permettant de récupérer les détails du robot

Utilisez cette API pour récupérer les détails d'un robot à partir du référentiel du serveur. L'identifiant du robot extrait de cette API est utilisé dans l'API pour le déploiement du robot :.

Point de terminaison d'API

Utilisez le point de terminaison suivant pour accéder aux API :

<Enterprise Control Room URL>/v2/repository/file/list

Par exemple, https://crdevenv.com:81/v2/repository/file/list

Récupération des détails du robot

  1. Indiquez les paramètres « X-Authorization » et « Content Type » dans les en-têtes.
  2. Utilisez la méthode POST pour fournir la charge utile des demandes suivantes dans le corps :
    { "filter": { "operator": "<eq, ne, lt, le, gt, or ge>", "value": "<bot name>", "field": "fileName" } }
    Conseil : Utilisez l'opérateur « eq » ou « substring » avec fileld comme « nom » et saisissez le nom du robot dans la « valeur » du filtre pour récupérer les détails de tous les robots correspondant au nom de robot fourni. D'autres règles de filtrage, de commande et de pagination peuvent également être interrogées.
    • Par exemple, les informations suivantes vont permettre d'extraire les détails du robot Import-Table.atmx :
      { "filter": { "operator": "eq", "value": "Import-Table.atmx", "field": "fileName" } }
  3. Cliquez sur Envoyer.
  4. L'action est réussie lorsque l'état de la réponse est 200.
  5. Vous pouvez afficher la réponse dans les données du corps.
    { "page": { "offset": 0, "total": 1, "totalFilter": 1 }, "list": [ { "id": "10", "parentid": "9", "name": "Import-Table.atmx", "canDelete": true, "canDownload": true, "canExecute": true, "canUpload": true, "canRun": true, "lastModified": "2018-07-18T04:42:05Z", "lastModifiedBy": "0", "path": "Automation Anywhere\\My Tasks\\Sample Tasks\\Import-Table.atmx", "directory": false, "size": 418719, "isLocked": false, "productionVersion": "", "lockedBy": "", "latestVersion": "", "fileLastModified": "2018-07-18T04:42:05Z" } ] } 

Description des paramètres

Paramètre

Description

opérateur
  • AUCUN
  • lt - inférieur à
  • le - inférieur ou égal à
  • eq - est égal à
  • ne - n'est pas égal à
  • ge - est supérieur ou égal à
  • gt - est supérieur à
  • sous-chaîne
  • et
  • ou
  • n'est pas
value Nom du robot
fileId L'identifiant de fichier du robot pour lequel des détails sont recherchés
id Identifiant du robot
parentId Identifiant du répertoire parent du robot
name Nom du robot
canDelete L'utilisateur connecté a le droit de supprimer le robot - vrai ou faux
canDownload L'utilisateur connecté a le droit de télécharger le robot - vrai ou faux
canExecute L'utilisateur connecté a le droit d'exécuter le robot# - vrai ou faux
canUpload L'utilisateur connecté a le droit de charger le robot - vrai ou faux
canRun L'utilisateur connecté a le droit d'exécuter/planifier le robot - vrai ou faux
lastModified La date et l'heure de la dernière mise à jour du robot
path Chemin relatif du robot
directory Pour indiquer un répertoire - vrai ou faux
size La taille du robot en Ko
isLocked Le robot a-t-il été extrait par un autre utilisateur* - vrai ou faux
productionVersion La version de production actuelle du robot*
lockedBy Identifiant de l'utilisateur qui a verrouillé le robot*
latestVersion La dernière version du robot*
fileLastModified La date et l'heure de la dernière mise à jour du robot

# s'applique uniquement aux Méta robots

* s'applique lorsque le contrôle de version est activé

API permettant de récupérer la liste des périphériques disponibles (clients de Exécuteur de robots :)

Utilisez cette API pour récupérer la liste des périphériques disponibles pour le déploiement de l'automatisation et son statut d'automatisation actuel. Pour ce faire, vous devez suivre le flux de travail mentionné ici :

  1. Récupération de la liste des périphériques, de leur type et de leur statut de connexion
  2. Vérification du statut d'exécution du robot des périphériques

1. Récupération de la liste des périphériques

Utilisez cette API pour extraire la liste des périphériques, c'est-à-dire des Exécuteur de robots :s disponibles pour le déploiement de robots. L'identifiant de périphérique récupéré à partir de cette opération peut être défini en tant que paramètre lors de l'utilisation de l'API de déploiement.

Point de terminaison d'API

Utilisez le point de terminaison suivant pour accéder aux API :

<Enterprise Control Room URL>/v2/devices/list

Par exemple, https://crdevenv.com:81/v2/devices/list

  1. Indiquez les paramètres « X-Authorization » et « Content Type » dans les en-têtes.
  2. Utilisez la méthode POST pour fournir la charge utile des demandes suivantes dans le corps :
    { "filter": { "operator": "<eq, ne, lt, le, gt, or ge>", "value": "<connected or disconnected>", "fileld": "<status>" }, "page": {} }
    Conseil : Utilisez les champs « type » et « statut » pour filtrer le type et le statut des robots. D'autres règles de filtrage, de commande et de pagination peuvent également être interrogées.
    • Par exemple, les informations suivantes récupèrent le statut des périphériques de type Bot Runner connectés :
      { "filter": { "operator": "eq", "value": "CONNECTED", "fileld": "status" }, "page": {} }
  3. Cliquez sur Envoyer.
  4. L'action est réussie lorsque l'état de la réponse est 200
  5. Vous pouvez afficher la réponse dans les données du corps.
    { "page": { "offset": 0, "total": 2, "totalFilter": 2 }, "list": [ { "id": "1", "type": "BOT_RUNNER", "hostname": "CRDEVENV", "userid": "3", "username": "amy.cheng", "status": "CONNECTED", "poolname": "" }, { "id": "2", "type": "BOT_RUNNER", "hostname": "CRDEVENV", "userid": "5", "username": "jane.smith", "status": "CONNECTED", "poolname": "" } ] }

Description des paramètres

Paramètre Description
opérateur
  • AUCUN
  • lt - inférieur à
  • le - inférieur ou égal à
  • eq - est égal à
  • ne - n'est pas égal à
  • ge - est supérieur ou égal à
  • gt - est supérieur à
  • sous-chaîne
  • et
  • ou
  • n'est pas
value Valeur du champ à filtrer
fileld Identifiant, nom d'hôte, identifiant utilisateur
id Identifiant du périphérique
type Type de périphérique : BOT_RUNNER ou BOT_CREATOR
hostname Le nom d'hôte de la machine sur laquelle le périphérique est connecté
userid L'identifiant utilisateur du périphérique
username Le nom de l'utilisateur du périphérique
status Le statut du périphérique - HORS LIGNE, CONNECTÉ ou DÉCONNECTÉ
poolname Le nom du pool de périphériques

2. L'API permettant de récupérer le statut de l'automatisation

Utilisez cette API pour récupérer l'état actuel de l'automatisation, qu'un robot soit ou non en cours d'exécution.

Point de terminaison d'API

Utilisez le point de terminaison suivant pour accéder aux API :

<Enterprise Control Room URL>/v2/activity/list

Par exemple, https://crdevenv.com:81/v2/activity/list

  1. Indiquez les paramètres « X-Authorization » et « Content Type » dans les en-têtes.
  2. Utilisez la méthode POST pour fournir la charge utile des demandes suivantes dans le corps :
    { "filter": { "operator": "<and/or>", "operands": [ { "operator": "<eq, ne, lt, le, gt, or ge>", "value": "<id>", "fileld": "deviceId" }, { "operator": "<and/or>", "operands": [ { "operator": "<eq, ne, lt, le, gt, or ge>", "value": "<Automation status>", "fileld": "status" }, { "operator": "<eq, ne, lt, le, gt, or ge>", "value": "<Automation status>", "fileld": "status" } ] } ] } }
    • Par exemple, les opérations suivantes permettent de récupérer le statut d'exécution du robot pour le périphérique avec l'identifiant 2 :
      { "filter": { "operator": "and", "operands": [ { "operator": "eq", "value": "2", "fileld": "deviceId" }, { "operator": "or", "operands": [ { "operator": "eq", "value": "RUNNING", "fileld": "status" } ] } ] } }
  3. Cliquez sur Envoyer.
  4. L'action est réussie lorsque l'état de la réponse est 200.
  5. Vous pouvez afficher la réponse dans les données du corps.
    { "page": { "offset": 0, "total": 3, "totalFilter": 1 }, "list": [ { "id": "6e312e83-4115-4861-b118-26660b2b7b08", "automationName": "Import-Table_18.07.24.16.13.52_ellie.brown_API", "fileName": "Import-Table.atmx", "filePath": "\\My Tasks\\Sample Tasks\\Import-Table.atmx", "type": "TASK", "startDateTime": "2018-07-24T10:43:59Z", "endDateTime": "2018-07-24T10:44:25Z", "command": "Web Recorder", "status": "RUN_PAUSED", "progress": 43, "automationId": "6", "userId": "5", "deviceId": "2", "currentLine": 7, "totalLines": 16, "fileId": "10", "modifiedBy": "5", "createdBy": "1", "modifiedOn": "2018-07-24T10:44:26.209Z", "createdOn": "2018-07-24T10:43:52.808Z", "deploymentId": "e11d7888-1187-4ce7-b9c4-5790715bf93b", "queueName": "", "queueId": "", "usingRdp": false, "message": "Task is stopped by user.\r\n An error occurred at line number 7 of Task 'Import-Table'. Open the Task in Workbench to view action at line number 7.", "canManage": true } ] }

Description des paramètres

Paramètre Description
opérateur
  • AUCUN
  • lt - inférieur à
  • le - inférieur ou égal à
  • eq - est égal à
  • ne - n'est pas égal à
  • ge - est supérieur ou égal à
  • gt - est supérieur à
  • sous-chaîne
  • et
  • ou
  • n'est pas
value Statut d'automatisation - DEPLOYED, RUNNING, RUN_PAUSED, UNKNOWN, COMPLETED, RUN_FAILED, RUN_ABORTED, RUN_TIMED_OUT ou DEPLOY_FAILED
fileld Le statut du robot pour lequel des détails sont recherchés
id Identifiant d'exécution unique
automationName Le nom de l'automatisation à laquelle l'exécution est associée
fileName Le nom du robot qui est déployé pour l'exécution
filePath Le chemin relatif du robot qui est déployé pour l'exécution
type Type d'activité- TÂCHE
startDateTime La date et l'heure du début de l'exécution
endDateTime La date et l'heure de la fin de l'exécution
command La commande actuelle de l'exécution
status Le statut actuel de l'exécution - DEPLOYED, RUNNING, RUN_PAUSED, UNKNOWN, COMPLETED, RUN_FAILED, RUN_ABORTED, RUN_TIMED_OUT ou DEPLOY_FAILED
progress La progression actuelle de l'exécution exprimée en pourcentage
automationId L'identifiant de l'automatisation à laquelle l'exécution est associée
userId L'identifiant d'utilisateur correspondant au périphérique sur lequel le robot est déployé
deviceId L'identifiant du périphérique sur lequel le robot est déployé
currentLine La ligne actuelle du robot qui est déployé pour l'exécution
totalLines Le nombre total de lignes du robot qui est déployé pour l'exécution
fileId L'identifiant du robot qui est déployé pour l'exécution
modifiedBy L'identifiant de l'utilisateur qui a mis à jour l'exécution en dernier
createdBy L'identifiant de l'utilisateur qui a créé l'automatisation associée à l'exécution
modifiedOn La date et l'heure de la dernière mise à jour de l'exécution.
createdOn La date et l'heure de la création de l'exécution.
deploymentId L'identifiant de déploiement auquel l'exécution est associée
queueName Nom de la file d'attente
queueId L'identifiant de la file d'attente
usingRdp Indique si le robot doit être déployé à l'aide d'un processus de bureau à distance - vrai ou faux
message Le message, si un message est disponible
canManage L'utilisateur actuellement connecté possède-t-il les droits nécessaires pour gérer l'exécution - true ou false

API to deploy bot

Utilisez cette option pour déployer un robot (avec l'identifiant de périphérique) sur un ou plusieurs périphériques à l'aide de l'identifiant de fichier d'un robot :.

Point de terminaison d'API

Utilisez le point de terminaison suivant pour accéder aux API :

<Enterprise Control Room URL>/v2/automations/deploy

Par exemple, https://crdevenv.com:81/v2/automations/deploy

  1. Indiquez les paramètres « X-Authorization » et « Content Type » dans les en-têtes.
  2. Utilisez la méthode POST pour fournir la charge utile des demandes suivantes dans le corps :
    { "fileId": "<file id of bot>", "deviceIds": [ "<device id 1>", "<device id 2>", "<device id 3>" ], "runWithRdp": "<true or false>" }
    • Par exemple, les opérations suivantes permettent de déployer un robot avec l'identifiant 10 sur des périphériques ayant les identifiants 1, 2 et 3 et de déployer un robot à l'aide de RDP :
      { "fileId": "10", "deviceIds": [ "1", "2", "3" ], "runWithRDP": true }
  3. Cliquez sur Envoyer.
  4. L'action est réussie lorsque l'état de la réponse est 200
  5. Vous pouvez afficher la réponse dans les données du corps.
    { "automationId": "6" }

Description des paramètres

Paramètre Description
fileId Identifiant du robot pour lequel le déploiement doit être effectué
deviceId L'identifiant du périphérique sur lequel le robot doit être déployé
runWithRDP Indique si le robot doit être déployé à l'aide d'un processus de bureau à distance - vrai ou faux
automationId L'identifiant de l'automatisation à laquelle l'exécution est associée

API permettant de surveiller l'exécution du robot

Utilisez cette API pour surveiller la progression du robot en fonction de l'identifiant d'automatisation récupéré à l'aide de l'API de déploiement des robots.

Remarque : Cette API permet également de récupérer une liste des robots en cours d'exécution sur les périphériques.

Point de terminaison d'API

Utilisez le point de terminaison suivant pour accéder aux API :

<Enterprise Control Room URL>/v2/activity/list

Par exemple, https://crdevenv.com:81/v2/activity/list

  1. Indiquez les paramètres « X-Authorization » et « Content Type » dans les en-têtes.
  2. Utilisez la méthode POST pour fournir la charge utile des demandes suivantes dans le corps :
    { "filter": { "operator": "<eq, ne, lt, le, gt, or ge>", "value": "<automationId>", "fileld": "automationId" } }
    • Par exemple, les opérations suivantes permettent de récupérer le statut d'automatisation portant l'identifiant 15 :
      { "filter": { "operator": "eq", "value": "6", "fileld": "automationId" } }
  3. Cliquez sur Envoyer.
  4. L'action est réussie lorsque l'état de la réponse est 200
  5. Vous pouvez afficher la réponse dans les données du corps.
    { "page": { "offset": 0, "total": 3, "totalFilter": 1 }, "list": [ { "id": "6e312e83-4115-4861-b118-26660b2b7b08", "automationName": "Import-Table_18.07.24.16.13.52_ellie.brown_API", "fileName": "Import-Table.atmx", "filePath": "\\My Tasks\\Sample Tasks\\Import-Table.atmx", "type": "TASK", "startDateTime": "2018-07-24T10:43:59Z", "endDateTime": "2018-07-24T10:44:25Z", "command": "Web Recorder", "status": "RUN_PAUSED", "progress": 43, "automationId": "6", "userId": "5", "deviceId": "2", "currentLine": 7, "totalLines": 16, "fileId": "10", "modifiedBy": "5", "createdBy": "1", "modifiedOn": "2018-07-24T10:44:26.209Z", "createdOn": "2018-07-24T10:43:52.808Z", "deploymentId": "e11d7888-1187-4ce7-b9c4-5790715bf93b", "queueName": "", "queueId": "", "usingRdp": false, "message": "Task is stopped by user.\r\n An error occurred at line number 7 of Task 'Import-Table'. Open the Task in Workbench to view action at line number 7.", "canManage": true } ] }

Description des paramètres

Paramètre Description
opérateur
  • AUCUN
  • lt - inférieur à
  • le - inférieur ou égal à
  • eq - est égal à
  • ne - n'est pas égal à
  • ge - est supérieur ou égal à
  • gt - est supérieur à
  • sous-chaîne
  • et
  • ou
  • n'est pas
value Statut d'automatisation - DEPLOYED, RUNNING, RUN_PAUSED, UNKNOWN, COMPLETED, RUN_FAILED, RUN_ABORTED, RUN_TIMED_OUT ou DEPLOY_FAILED
fileld L'identifiant du robot pour lequel des détails sont recherchés
id Identifiant d'exécution unique
automationName Le nom de l'automatisation à laquelle l'exécution est associée
fileName Le nom du robot qui est déployé pour l'exécution
filePath Le chemin relatif du robot qui est déployé pour l'exécution
type Type d'activité- TÂCHE
startDateTime La date et l'heure du début de l'exécution
endDateTime La date et l'heure de la fin de l'exécution
command La commande actuelle de l'exécution
status Le statut actuel de l'exécution - DEPLOYED, RUNNING, RUN_PAUSED, UNKNOWN, COMPLETED, RUN_FAILED, RUN_ABORTED, RUN_TIMED_OUT ou DEPLOY_FAILED
progress La progression actuelle de l'exécution exprimée en pourcentage
automationId L'identifiant de l'automatisation à laquelle l'exécution est associée
userId L'identifiant d'utilisateur correspondant au périphérique sur lequel le robot est déployé
deviceId L'identifiant du périphérique sur lequel le robot est déployé
currentLine La ligne actuelle du robot qui est déployé pour l'exécution
totalLines Le nombre total de lignes du robot qui est déployé pour l'exécution
fileId L'identifiant du robot qui est déployé pour l'exécution
modifiedBy L'identifiant de l'utilisateur qui a mis à jour l'exécution en dernier
createdBy L'identifiant de l'utilisateur qui a créé l'automatisation associée à l'exécution
modifiedOn La date et l'heure de la dernière mise à jour de l'exécution.
createdOn La date et l'heure de la création de l'exécution.
deploymentId L'identifiant de déploiement auquel l'exécution est associée
queueName Nom de la file d'attente
queueId L'identifiant de la file d'attente
usingRdp Indique si le robot doit être déployé à l'aide d'un processus de bureau à distance - vrai ou faux
message Le message, si un message est disponible
canManage L'utilisateur actuellement connecté possède-t-il les droits nécessaires pour gérer l'exécution - true ou false

Codes de réponse de l'API

Code d'état Http(s) Réponse - Description Action corrective
200/204 Action terminée s/o
304 Aucune modification appliquée Mettre à jour si nécessaire.
400 Paramètre de demande non valide Réessayer avec des paramètres valides
401 Authentification requise Fournir des paramètres d'authentification. Par exemple, la clé X-Authorization.
403 Accès non autorisé Vérifier si vous êtes autorisé à accéder à la Enterprise Control Room.
404 Introuvable S'assurer que la charge utile de la demande est disponible dans la Enterprise Control Room.
409 Conflit S'assurer que les paramètres fournis sont corrects.
500 Erreur de serveur interne Vérifiez que le serveur est opérationnel.
501 Erreur d'autorisation Assurez-vous de disposer de l'autorisation requise

Journaux d'audit

L'activité de déploiement utilisant l'API est enregistrée dans la page Journal d'audit de la Enterprise Control Room. En tant qu'administrateur de la Enterprise Control Room ou en tant qu'utilisateur disposant de l'autorisation Afficher les actions du journal d'audit de tout le monde, vous pouvez afficher les entrées d'audit indiquées.

L'illustration suivante représente un exemple de la page de détails du journal d'audit permettant de déployer un robot à l'aide de l'API de déploiement :

Envoyer le commentaire