Lea y revise la documentación de Automation Anywhere

Automation 360

Cerrar contenidos

Contenidos

Abrir contenidos

Retrieve details of device pool by ID

  • Actualizado: 2021/01/29
    • Automation 360 v.x
    • Explorar
    • Espacio de trabajo de RPA

Retrieve details of device pool by ID

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

Antes de empezar

Nota: Puede ver el Control Room APIs en el Community Editionpero la funcionalidad de la API es limitada. Necesita una licencia Automation 360 Edition para acceder a toda la funcionalidad de las APIs.

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.
  • Todas las llamadas a la API deben contener un token de autenticación en la cabecera de la solicitud. Utilizar la Autenticación para generar un token web JSON. Véase API de autenticación.
  • 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.

Procedimiento

  1. Añade el token de autenticación a la cabecera de la solicitud.
  2. Utilice el método GET y la URL del punto final: <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. Envía la solicitud.
    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.

Implementación bot

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

List device pools 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.

La API REST responde a cada solicitud con un código de respuesta HTTP. Para los códigos de respuesta, véase API response codes.

Enviar comentarios