Lire et examiner la documentation 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
    • Automation 360 v.x
    • Explorer
    • Espace de travail RPA

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

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

Prérequis

Remarque : Vous pouvez consulter le Control Room APIs dans le Community Editionmais la fonctionnalité de l'API est limitée. Vous devez posséder une licence Automation 360 Edition pour accéder à l'ensemble des fonctionnalités des API.

Assurez-vous que vous disposez des éléments suivants pour utiliser cette API :

  • Visualisez et gérez TOUS les appareils : Visualisez et gérez tous les appareils, y compris ceux enregistrés par d'autres utilisateurs.
  • Tous les appels d'API doivent contenir un jeton d'authentification dans l'en-tête de la demande. Utilisez l'option Authentification pour générer un jeton Web JSON. Reportez-vous à API d'authentification.
  • Pool de dispositifs id: L'identifiant numérique unique du pool de périphériques pour lequel vous voulez récupérer les détails.

Cette tâche recherche dans le Control Room pour un pool de périphériques spécifique. L'API transmet le pool de périphériques {id} comme partie de la chaîne URL. Aucun corps de demande 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 :<votre_salle_de_contrôle_url>/v2/appareils/pools/{id}.
    Saisissez 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 demande.
    Lorsque la demande aboutit, tous les détails associés à l'identifiant des pools de dispositifs transmis sont renvoyés dans le corps de la réponse.
    Dans cet exemple, le nom, le schéma d'automatisation, le statut, Bot Runnersles propriétaires et les consommateurs, associés à l'ID du pool de périphériques. 27 sont retournés dans le corps de la réponse
    Corps de la 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"
    }
Passez en revue les détails du pool de périphériques répertorié pour déterminer s'il répond à vos bot exigences de déploiement. Certains des champs de la réponse sont utilisés comme entrée pour d'autres API.
Évaluez ces détails :
id
Le site id identifie de manière unique ce pool de dispositifs dans le fichier Control Room. Utilisez cet id comme entrée pour les poolIds pour bot déploiement.

Déploiement de robots

nom
Il s'agit du nom défini par l'utilisateur pour le pool de périphériques. Filtrer le pool de périphériques nom en utilisant les filtres de la tâche Liste des pools de périphériques.

Liste des pools de périphériques API

deviceIds
Liste des identifiants numériques uniques pour les Bot Runner périphériques qui font partie de ce pool de périphériques.
Nom du propriétaire
Les ID des propriétaires de ce pool de périphériques. Les propriétaires de pools de périphériques peuvent visualiser, modifier ou supprimer le pool de périphériques.
consumerIds
Les identifiants des utilisateurs qui peuvent visualiser ce dispositif lors de l'exécution d'automatismes.

L'API REST répond à chaque demande par un code de réponse HTTP. Pour les codes de réponse, voir Codes de réponse de l'API.

Envoyer le commentaire