Lire et examiner la documentation Automation Anywhere

Automation Anywhere Automation 360

Fermer les contenus

Contenus

Ouvrir les contenus

Récupérer les détails du pool de périphériques par ID

  • Mis à jour le : 2021/01/29

    Récupérer les détails du pool de périphériques par ID

    Récupérez les détails d’un pool de périphériques spécifique par son identifiant numérique (ID).

    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.

    Assurez-vous de disposer des éléments suivants pour utiliser cette API :

    • Afficher et gérer TOUS les périphériques : Affichez et gérez tous les périphériques, y compris les périphériques enregistrés par d’autres utilisateurs.
    • Utilisez l’API Authentification pour générer un jeton JWT. Reportez-vous à la rubrique API d’authentification.
    • ID du pool de périphériques Identifiant numérique unique du pool de périphériques à propos duquel vous souhaitez récupérer des détails.

    Cette tâche recherche un pool de périphériques Control Room spécifique dans. L’API transmet le pool de périphériques {id} dans le cadre de la chaîne d’URL. Aucun corps de requête n’est requis.

    Procédure

    1. Ajoutez le jeton d’authentification à l’en-tête de la requête.
    2. Utilisez la méthode GET et l’URL du point de terminaison : <your_control_room_url>/v2/devices/pools/{id}.
      Entrez l’ID du pool de périphériques dans l’URL.
      Dans cet exemple, l’ID du pool de périphériques est 27.
      https://<your_control_room_url>/v2/devices/pools/27
    3. Envoyez la requête.
      Lorsque la requête est réussie, tous les détails associés à l’ID du pool de périphériques transmis sont renvoyés dans le corps de la réponse.
      Dans cet exemple, le nom, le schéma d’automatisation, le statut, les propriétaires, les Bot Runners et les consommateurs associés à l’ID du pool de périphériques 27, sont renvoyés dans le corps de la réponse.
      Corps de réponse :
      {
        "id": "27",
        "name": "finance-device-pool",
        "description": "Finance department device pool",
        "automationScheme": "ROUND_ROBIN",
        "status": "CONNECTED",
        "timeSlice": "5",
        "timeSliceUnit": "MINUTES",
        "deviceIds": [
          "10",
          "23",
          "41"
        ],
        "ownerIds": [
          "48"
        ],
        "consumerIds": [],
        "detailedStatus": "ALL_DISCONNECTED",
        "updatedBy": "48",
        "updatedOn": "2020-04-27T14:29:05.655896Z",
        "createdBy": "48",
        "createdOn": "2020-04-25T10:46:44.642586Z",
        "tenantUuid": "c0a8f10a-717f-130b-8171-7f4762280000",
        "tenantId": "4"
      }
    Consultez les détails du pool de périphériques répertorié pour déterminer s’il répond à vos besoins en matière de déploiement de bot. Certains des champs de la réponse sont utilisés comme entrées pour d’autres API.
    Évaluez ces informations :
    id
    L’id identifie de manière unique ce pool de périphériques dans la Control Room. Utilisez cet id comme entrée de poolIds pour le déploiement du bot.

    API Déployer bots

    name
    Il s’agit du nom défini par l’utilisateur pour le pool de périphériques. Filtrez le nom du pool de périphériques à l’aide des filtres dans la tâche répertoriée des pools de périphériques.

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

    deviceIds
    Liste des ID numériques uniques des périphériques Bot Runner qui font partie de ce pool de périphériques.
    ownerIds
    Les ID des propriétaires de ce pool de périphériques. Les propriétaires du pool de périphériques peuvent afficher, modifier ou supprimer le pool de périphériques.
    consumerIds
    Les ID des utilisateurs qui peuvent afficher ce périphérique lors de l’exécution des automatisations.

    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.

    Envoyer le commentaire