Lire et examiner la documentation Automation Anywhere

Automation Anywhere Automation 360

Fermer les contenus

Contenus

Ouvrir les contenus

Planification de bot pour l’exécution de l’API

  • Mis à jour le : 2021/01/28

    Planification de bot pour l’exécution de l’API

    Planifiez un bot pour qu’il s’exécute sur un Bot Runner non-assisté, soit une seule fois soit de manière récurrente.

    Prérequis

    Remarque : Vous pouvez afficher l’Control Room APIs dans la Community Edition, 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.
    • Utilisez l’API Authentification pour générer un jeton JWT. Reportez-vous à la rubrique API d’authentification.
    • 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 bots
      • Accès aux utilisateurs sous licence Bot Runner
      • Accès à un périphérique par défaut ou à un pool de périphériques
        Remarque : Si l’utilisateur associé à la licence Bot Runner dispose d’un périphérique par défaut affecté à son compte, le bot 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 planifier un bot, fournissez les informations suivantes :

    Paramètre Obligatoire Type Description
    fileId Oui Nombre Identifiant du bot. API Répertorier les dossiers et fichiers par espace de travail
    runAsUserIds Oui Nombre Identifiant d’un utilisateur enregistré auprès de votre Control Room en tant que Bot Runner non assisté. API Répertorier les Bot Runners 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 Bot Runner dispose d’un périphérique par défaut affecté à son compte, le bot 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

    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 : <control_room_url>/v1/schedule/automations.
      Corps de requête :
      Cet exemple de corps de requête contient les paramètres requis pour planifier l’exécution d’un bot une seule fois.
      {
         "name":"UpdateInventory.20.12.16.10.40.48",
         "fileId":"14277",
         "poolIds":[
            "27"
         ],
         "timeZone":"Asia/Calcutta",
         "runAsUserIds":[
            "472",
            "480",
            "80"
         ],
         "startDate":"2020-12-16",
         "startTime":"15:00",
         "scheduleType":"NONE"
         }
      Cet exemple de corps de requête contient les paramètres requis pour planifier l’exécution d’un bot sur une base récurrente.
      {
         "name":"UpdateInventory.20.12.16.10.40.48",
         "fileId":"14277",
         "poolIds":[
            "27"
         ],
         "timeZone":"Australia/Melbourne",
         "runAsUserIds":[
            "1103",
            "36",
            "80"
         ],
         "startDate":"2020-12-16",
         "repeatOccurrence":{
            "endTime":"23:59",
            "runEvery":"1",
            "timeUnit":"HOURS"
         },
         "repeatEnabled":true,
         "endDate":"2020-12-24",
         "startTime":"20:45",
         "weeklyRecurrence":{
            "interval":"1",
            "daysOfWeek":[
               "TUE",
               "THU",
               "FRI"
            ]
         },
         "scheduleType":"WEEKLY"
      }
    3. Envoyez la requête.
      Corps de réponse : Les deux exemples de réponses incluent les informations suivantes sur l’automatisation :
      • id : la valeur numérique qui identifie l’automatisation. Utilisez ce paramètre dans les API Mettre à jour les automatisations ou Supprimer les automatisations.
      • zonedNextRunDateTime : la date et l’heure de la prochaine exécution planifiée de bot.
      Ceci est un exemple de réponse pour un bot programmé pour s’exécuter une seule fois.
      {
          "id": "989",
          "name": "UpdateInventory.20.12.16.10.40.48",
          "fileId": "14277",
          "status": "ACTIVE",
          "deviceIds": [],
          "description": "",
          "rdpEnabled": false,
          "scheduleType": "NONE",
          "timeZone": "Asia/Calcutta",
          "startDate": "2021-12-16",
          "endDate": "",
          "startTime": "15:00",
          "repeatEnabled": false,
          "zonedNextRunDateTime": "2021-12-16T09:30:00Z",
          "createdBy": "1103",
          "createdOn": "2021-01-11T18:57:18.932407Z",
          "updatedBy": "1103",
          "updatedOn": "2021-01-11T18:57:18.932422Z",
          "tenantId": "1",
          "fileName": "appsheet",
          "filePath": "Automation Anywhere\\Bots\\appsheet",
          "runAsUserIds": [
              "480",
              "80",
              "472"
          ],
          "botInput": {},
          "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
          "poolId": [
              "11"
          ],
          "overrideDefaultDevice": false,
          "runElevated": false
      }
      Ceci est un exemple de réponse pour un bot programmé pour s’exécuter sur une base récurrente.
      {
          "id": "990",
          "name": "UpdateInventory.20.12.16.10.40.48",
          "fileId": "14277",
          "status": "ACTIVE",
          "deviceIds": [],
          "description": "",
          "rdpEnabled": false,
          "scheduleType": "WEEKLY",
          "weeklyRecurrence": {
              "interval": 1,
              "daysOfWeek": [
                  "TUE",
                  "THU",
                  "FRI"
              ]
          },
          "timeZone": "Australia/Melbourne",
          "startDate": "2021-01-16",
          "endDate": "2021-12-24",
          "startTime": "20:45",
          "repeatEnabled": true,
          "repeatOccurrence": {
              "runEvery": "1",
              "timeUnit": "HOURS",
              "endTime": "23:59"
          },
          "zonedNextRunDateTime": "2021-01-19T09:45:00Z",
          "createdBy": "1103",
          "createdOn": "2021-01-11T18:59:31.182663Z",
          "updatedBy": "1103",
          "updatedOn": "2021-01-11T18:59:31.182669Z",
          "tenantId": "1",
          "fileName": "a_trigger",
          "filePath": "Automation Anywhere\\Bots\\a_trigger",
          "runAsUserIds": [
              "80",
              "36",
              "1103"
          ],
          "botInput": {},
          "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
          "poolId": [
              "7"
          ],
          "overrideDefaultDevice": false,
          "runElevated": false
      } 
      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

    Utilisez l’ Liste des planifications d’automatisation API pour récupérer des détails sur toutes les automatisations planifiées.
    Envoyer le commentaire