Llame a API Tasks instantáneamente con un punto final. Esto lanza y ejecuta API Tasks bajo demanda dinámicamente por medio de la API de implementación junto con la solicitud bajo demanda. Este enfoque agiliza los flujos de trabajo y mejora la eficiencia de los recursos en comparación con las implementaciones estáticas tradicionales.

Nota: API Tasks no admite formularios interactivos.

Beneficios clave

  • Despliegue programático: Despliegue una API Task desde cualquier lugar bajo demanda mediante su cliente API preferido.
  • Procesamiento:
    • Las automatizaciones se activan solo cuando es necesario, lo que garantiza una utilización óptima de los recursos. Esto significa que no están constantemente desplegados en la nube, reservando recursos. En cambio, se cargan y ejecutan en cada solicitud.
    • Durante los períodos de gran volumen, las automatizaciones se colocan en la lista de prioridad y se ejecutan tan pronto como los dispositivos están disponibles, lo que garantiza un funcionamiento fluido incluso bajo grandes cargas. Puede ver el progreso de las automatizaciones en la página Actividad.
    • La licencia prémium ayuda a aumentar la escala de su automatización y brinda acceso a un conjunto más grande de recursos en la nube que pueden ejecutar varias instancias de su API Task, lo cual impulsa la concurrencia y le permite gestionar más solicitudes de API Task simultáneamente.
  • Casos de uso ideales:
    • Tareas de procesamiento por lotes (como analizar datos de ventas, generar informes)
    • Tareas programadas
    • Situaciones en las que la respuesta inmediata no es crítica
Nota: Para habilitar la implementación de la API Task a petición dentro de un proceso, genere una Clave de registro en Administración > Configuración > Instalación masiva del agente de Bot > Generar una clave nueva y haga clic en Guardar cambios.

Autenticar

Adquiera las credenciales de autenticación necesarias para interactuar con la API de implementación. Esto suele implicar tokens de acceso o claves de API. El siguiente ejemplo implementa una API Task bajo demanda en un dispositivo en la nube. También puede pasar variables a bots cuando se implementen.

POST https://{{ControlRoomURL}}/v4/automations/deploy

Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<b
earer token>>

Todas las llamadas a la API deben contener un token de autenticación de la API de autenticación (genera un token web JSON) o un token de portador de los servicios OAuth. No se pueden utilizar ambos a la vez en una API.

Redacte la solicitud bajo demanda

Solicitud:
{
  "botId": 121,
  "automationName": "SAMPLE_APITASK",
  "description": "My first API Task deploy using api",
  "botLabel": "string",
  "executionType": "RUN_NOW",
  "automationPriority": "PRIORITY_MEDIUM",
  "headlessRequest": {
    "numberOfExecutions": 1,
    "queueOnSlotsExhaustion": false,
    "sharedRunAsUserId": 12
  },
  "botInput": {
    "inputVar": {
      "type": "STRING",
      "string": "PassingString"
    }
  }
}
Nota:

Las solicitudes de implementación de automatizaciones se pueden hacer sin ningún campo de entrada. Si especifica entradas, asegúrese de que la variable de la automatización esté marcada como entrada para que la API Task reciba estos valores asignados correctamente. Además, el nombre de la variable en la API Task tiene que coincidir con el valor que se está asignando en el cuerpo de la solicitud.

Parámetros de solicitud
Parámetro Tipo Obligatorio Descripción
botId Entero Sí Ingrese el ID de la automatización que se implementará. El ID es visible en la barra de direcciones cuando se abre la automatización en un editor.
automationName String No Ingrese el nombre que utilizó cuando creó la automatización.
descripción String No Ingrese la descripción que utilizó cuando creó la automatización.
botLabel String No Ingrese la etiqueta que aplicó cuando registró la automatización. Puede ingresar Producción o N/A.
executionType String No Ingrese el tipo de ejecución asociado con el bot. Puede ingresar uno de los siguientes tipos de ejecución:
  • RUN_NOW
  • RUN_WITH_QUEUE
  • RUN_WITH_EVENT_TRIGGERS
automationPriority String No Ingrese la prioridad de ejecución de la automatización. Puede ingresar una de las siguientes prioridades:
  • PRIORITY_MEDIUM
  • PRIORITY_HIGH
  • PRIORITY_LOW
La prioridad predeterminada se configura como PRIORITY_MEDIUM.
Objeto headlessRequest.
numberOfExecutions Entero No Ingrese el número de ejecuciones para una determinada solicitud bajo demanda (sin supervisión).
queueOnSlotsExhaustion booleano No Ingrese Verdadero o Falso para especificar si la implementación debe ponerse en cola.
sharedRunAsUserId Entero No Ingrese el ID del usuario apitaskrunner para establecer el contexto RunAsUser para las API Tasks.

El ID de usuario es visible en la barra de direcciones cuando se editan los detalles del usuario en la página Editar usuario.

Para obtener más información sobre apitaskrunner, consulte Función ejecutar como usuario para API Task (apitaskrunner).
Nota: Este RunAsUser no requiere una licencia de Bot Runner.
Objeto botInput
tipo Cualquiera No Ingrese el tipo de la variable de entrada.

Puede ingresar uno de los siguientes tipos de variables: STRING, NUMBER, BOOLEAN, FILE, ITERATOR, LIST, DICTIONARY, TABLE, VARIABLE, CONDITIONAL, WINDOW, TASKBOT, DATETIME, UIOBJECT, RECORD, EXCEPTION, CREDENTIAL, COORDINATE, IMAGE, REGION, PROPERTIES, TRIGGER, CONDITIONALGROUP, FORM, FORMELEMENT, HOTKEY y WORKITEM.
string String No Ingrese la string que debe utilizarse como entrada para la variable STRING.
Respuesta 
{
  "deploymentId": "320a2149-aa44-41ab-af9b-f9343ae2581b",
  "automationName": "SAMPLE_APITASK"
}
Parámetros de respuesta
Parámetro Tipo Descripción
deploymentId String El ID de implementación que se genera durante la implementación de bots.
automationName String El nombre de la automatización implementada. Si no incluye el nombre de la automatización en la solicitud, se asignará un nombre aleatorio a la automatización implementada.
Puede probar este punto final en la interfaz Swagger, que se incluye en todas sus instancias de Control Room.
Consejo: Para acceder a Swagger, vaya a su instancia de la Control Room y agregue /swagger/ al final de la URL.https://{{ControlRoomURL}}/swagger/

Vea la página de actividad en su Control Room para realizar un seguimiento del progreso de su ejecución bajo demanda (sin supervisión) desde En lista de prioridad >> En curso >> Completado.

API-Task-Activity-page

Para obtener más detalles sobre la implementación de API, consulte API de implementación de bots (V4).