Lea y revise la documentación de Automation Anywhere

Automation 360

Cerrar contenidos

Contenidos

Abrir contenidos

Schedule bot to run API

  • Actualizado: 2021/08/10
    • Automation 360 v.x
    • Explorar
    • Espacio de trabajo de RPA

Schedule bot to run API

Programe un bot para que se ejecute en un Bot Runner no supervisado, ya sea una sola vez o de forma recurrente.

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.
  • 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.
  • Asegúrese de que se le asignan los siguientes recursos:
    • Ver y ejecutar mis bots permiso de la función
    • Ejecutar y programar para las carpetas que contienen el bots
    • Acceso a Bot Runner usuarios con licencia
    • Acceso a un dispositivo por defecto o a un grupo de dispositivos
      Nota: Si el usuario asociado a la Bot Runner licencia tiene un dispositivo por defecto asignado a su cuenta, el bot se despliega en ese dispositivo. Si no se asigna ningún dispositivo por defecto, o se desea seleccionar un dispositivo diferente, se debe especificar un grupo de dispositivos.

To schedule a bot, you provide the following information to the API:

Parámetro Obligatorio Tipo Descripción
fileId Número Identifier for the bot. List files and folders by workspace API
runAsUserIds Número Identifier for a user that is registered with your Control Room as an Unattended bot runner. Lista disponible desatendida Bot Runners API
estado Cadena Indicates whether to create an active or draft schedule. Enter either ACTIVE or DRAFT.
poolIds No Número Identifier of a device pool that has at least one active device.
Nota: Si el usuario asociado a la Bot Runner licencia tiene un dispositivo por defecto asignado a su cuenta, el bot se despliega en ese dispositivo. Si no se asigna ningún dispositivo por defecto, o se desea seleccionar un dispositivo diferente, se debe especificar un grupo de dispositivos.
List device pools API
overrideDefaultDevice No Booleano

Si el usuario del Bot Runner está asignado a un dispositivo por defecto y desea especificar un grupo de dispositivos, establezca este parámetro como true.

Si lo implementa a un dispositivo predeterminado, establezca este parámetro como false.

Procedimiento

  1. Añade el token de autenticación a la cabecera de la solicitud.
  2. Use the POST method and endpoint URL: <control_room_url>/v1/schedule/automations.
    Request body:
    This example request body contains the required parameters to schedule a bot to run one time.
    {
       "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",
       "status":"ACTIVE"
       }
    This example request body contains the required parameters to schedule a bot to run on a recurring basis.
    {
       "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",
       "status":"ACTIVE"
    }
  3. Envíe la solicitud.
    Response body: The two example responses include the following information about the automation:
    • id: el valor numérico que identifica la automatización. Utiliza este parámetro en el Actualizar automatizaciones o en Eliminar automatizaciones APIs.
    • zonedNextRunDateTime: the date and time of the next time the bot is scheduled to run.
    This is an example response for a bot scheduled to run one time.
    {
        "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
    }
    This is an example response for a bot scheduled to run on a recurring basis.
    {
        "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
    } 
    La API REST responde a cada solicitud con un código de respuesta HTTP.Para los códigos de respues