Lire et examiner la documentation Automation Anywhere

Automation Anywhere Automation 360

Fermer les contenus

Contenus

Ouvrir les contenus

API Déployer robots

  • Mis à jour le : 2/01/2021
    • Automation 360 v.x
    • Gestion
    • Espace de travail RPA

API Déployer robots

En tant qu’utilisateur disposant d’une licence Exécuteur de robots, déployez robots sur vos périphériques attribués. Vous pouvez également transmettre des variables aux robots lorsqu’ils sont déployés.

Prérequis

Remarque : Vous pouvez afficher l’Control Room APIs dans la Édition Community, mais la fonctionnalité de l’API est limitée. Vous avez besoin d'une licence Automation 360 Edition pour accéder à l'ensemble des fonctionnalité API.
Assurez-vous que les ressources suivantes vous sont allouées :
  • Autorisation de fonctionnalité Afficher et exécuter mes robots
  • Autorisations Exécuter et planifier pour les dossiers qui contiennent les robots
  • Accès aux utilisateurs sous licence Exécuteur de robots
  • Accès à un périphérique par défaut ou à un pool de périphériques
    Remarque : Si l’utilisateur associé à la licence Exécuteur de robots dispose d’un périphérique par défaut affecté à son compte, le robot se déploie sur ce périphérique. Si aucun périphérique par défaut n’est attribué, ou si vous souhaitez sélectionner un périphérique différent, vous devez spécifier un pool de périphériques.

Pour déployer un robot et transmettre une valeur de variable au robot, vous devez fournir les informations suivantes à l’API :

Paramètre Obligatoire Type Description
fileId Oui Number Identifiant du robot à déployer.

API Répertorier les dossiers et fichiers par espace de travail

runAsUserIds Oui Number Identifiant d’un utilisateur enregistré auprès de votre Salle de contrôle en tant que Bot Runner non assisté.

API Répertorier les Exécuteurs de robots disponibles non assistés

poolIds Non Number Identifiant d’un pool de périphériques qui a au moins un périphérique actif.
Remarque : Si l’utilisateur associé à la licence Exécuteur de robots dispose d’un périphérique par défaut affecté à son compte, le robot se déploie sur ce périphérique. Si aucun périphérique par défaut n’est attribué, ou si vous souhaitez sélectionner un périphérique différent, vous devez spécifier un pool de périphériques.

API Répertorier les pools de périphériques

overrideDefaultDevice Non Booléen Si l’utilisateur Exécuteur de robots est affecté à un périphérique par défaut et que vous souhaitez spécifier un pool de périphériques, définissez ce paramètre sur true.

Si vous effectuez un déploiement sur le périphérique par défaut, définissez ce paramètre sur false.

BotInput Non Varie Spécifiez le nom, la valeur et le type de données de la variable d’entrée.
numOfRunAsUsersToUse Non Number Spécifie le nombre de Exécuteurs de robots à utiliser dans la liste des runAsUserIds. Un algorithme système pondéré sélectionne les Exécuteurs de robots avec le moins de tâches en file d’attente.
callbackInfo Non Objet Fournit l’URL et le jeton d’authentification pour le serveur de rappel. Après le déploiement du robot, la Salle de contrôle envoie le statut de déploiement et les valeurs de variable de sortie à ce serveur de rappel.

Procédure

  1. Ajoutez le jeton d’authentification à l’en-tête de la requête.
  2. Utilisez la méthode POST et l’URL du point de terminaison : <your_control_room_url>/v3/automations/deploy.

    Corps de la requête :

    Cet exemple de corps de requête spécifie les paramètres requis ainsi qu’une valeur pour une variable d’entrée.
    {
      "fileId": 14277,
      "runAsUserIds": [
        2538
      ],
      "botInput": {
        "sDocHello": {
          "type": "STRING",
          "string": "Hello world, go be great."
        }
      }
    }
    Cet exemple de corps de requête spécifie quatre runAsUserIds et deux numOfRunAsUsersToUse. L’algorithme pondéré sélectionne les deux Exécuteurs de robots avec le moins de tâches mises en file d’attente au moment de la requête de déploiement.
    {
      "fileId": 14277,
      "runAsUserIds": [
        2538,
        4256,
        2213,
        789
      ],
       "poolIds": [
        27
      ],
      "numOfRunAsUsersToUse": 2
    }
    Cet exemple de corps de requête inclut le overrideDefaultDevice par défaut défini sur true, de sorte que le robot sera déployé dans le pool de périphériques plutôt que sur le périphérique par défaut de l’utilisateur Exécuter en tant que. Cet exemple contient également la syntaxe qui spécifie l’URL du serveur de rappel et fournit l’autorisation.
    {
      "fileId": 14277,
      "runAsUserIds": [
        245
      ],
       "poolIds": [
        27
      ],
      "overrideDefaultDevice": true,
      "callbackInfo": {
        "url": "https://callbackserver.com/storeBotExecutionStatus",
        "headers": {
          "X-Authorization": "eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiI0Ii"
        }
      }
    }
  3. Envoyez la requête.

    Corps de réponse :

    En cas de réussite, l’RobotAPI de déploiement renvoie une réponse avec l’deploymentId.
    {
      "deploymentId": "14c2b6f8-c2a0-4a57-959d-ef413df0d179"
    }
    L’API REST répond à chaque requête par un code de réponse HTTP. Pour les codes de réponse, consultez Codes de réponse de l'API.

Étapes suivantes

Effectuer cette tâche : Demander le statut API de déploiement du robot.

Envoyer le commentaire