Leggi e rivedi la documentazione di Automation Anywhere

Automation 360

Chiudi contenuti

Contenuti

Apri contenuti

Retrieve details of device pool by ID

  • Aggiornato: 2021/01/29
    • Automation 360 v.x
    • Esplora
    • Spazio di lavoro RPA

Retrieve details of device pool by ID

Retrieve the details of a specific device pool by its numeric identifier (ID).

Prerequisiti

Nota: È possibile visualizzare il Control Room APIs nel file Community Editionma le funzionalità dell'API sono limitate. È necessario disporre di una licenza Automation 360 Edition per accedere a tutte le funzionalità delle API.

Ensure you have the following to use this API:

  • View and manage ALL device(s): View and manage all the devices, including devices registerd by other users.
  • Tutte le chiamate API devono contenere un token di autenticazione nell'intestazione della richiesta. Usare la funzione Autenticazione per generare un token web JSON. Vedi API di autenticazione.
  • Device pool id: The unique numeric identifier of the device pool for which you want to retrieve details.

This task searches in the Control Room for a specific device pool. The API passes the device pool {id} as part of the URL string. No request body is required.

Procedura

  1. Aggiungere il token di autenticazione all'intestazione della richiesta.
  2. Utilizzare il metodo GET e l'URL dell'endpoint: <your_control_room_url>/v2/devices/pools/{id}.
    Enter the device pool ID in the URL.
    In this example, the device pool ID is 27.
    https://<your_control_room_url>/v2/devices/pools/27
  3. Inviare la richiesta.
    When the request is successful, all the details associated with the passed device pools ID are returned in response body.
    In this example, the name, automation scheme, status, Bot Runners, owners, and consumers, associated with the device pool ID 27 are returned in the response body
    Response body:
    {
      "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"
    }
Review the details of the listed device pool to determine if it meets your bot deployment requirements. Some of the fields in the response are used as input to other APIs.
Evaluate these details:
id
The id uniquely identifies this device pool in the Control Room. Use this id as input for the poolIds for bot deployment.

Distribuzione del bot

nome
This is the user-defined name for the device pool. Filter the device pool name using filters in the list device pools task.

Elenco dei pool di dispositivi API

deviceIds
List of the unique numeric IDs for Bot Runner devices that are part of this device pool.
ownerIds
The IDs of the owners of this device pool. Device pool owners can view, edit, or delete the device pool.
consumerIds
The IDs for users who can view this device while running automations.

L'API REST risponde a ogni richiesta con un codice di risposta HTTP. Per i codici di risposta, vedere Codici di risposta API.

Invia feedback