Punto final de Tarea API bajo demanda

Llame a Tareas API instantáneamente con un punto final. Esto lanza y ejecuta Tareas API 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.

Beneficios clave

  • Despliegue programático: Despliegue una Tarea API 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 Tarea API, lo cual impulsa la concurrencia y le permite gestionar más solicitudes de Tarea API 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 Tarea API 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 Tarea API 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 Tarea API reciba estos valores asignados correctamente. Además, el nombre de la variable en la Tarea API 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í

ID de la automatización que se implementará.
automationName Cadena No Nombre de la automatización que se implementará. Puede ingresar un nombre para identificar fácilmente su automatización. Por ejemplo, SAMPLE_APITASK, FIRST_API_TASK, apitask-on-demand.
Descripción Cadena No Descripción de la automatización que se implementará. Por ejemplo: My first API Task deploy using api
botLabel Cadena No Etiqueta para la automatización que se implementará.
executionType Cadena No Tipo de ejecución asociado al bot.
automationPriority Cadena No La prioridad de automatización. Está configurada como PRIORITY_MEDIUM de forma predeterminada. Algunos valores para automationPriority pueden ser los siguientes: PRIORITY_MEDIUM, PRIORITY_HIGH y PRIORITY_LOW.
Objeto headlessRequest.
numberOfExecutions Entero No Número de ejecuciones para una determinada solicitud bajo demanda (sin supervisión).
queueOnSlotsExhaustion booleano No Especifica si la implementación debe estar o no en una lista de prioridad.
sharedRunAsUserId Entero No El apitaskrunner para establecer el contexto RunAsUser para Tareas API. Para obtener más información sobre apitaskrunner, consulte Usuario de ejecución para la tarea de API (apitaskrunner).
Nota: Este RunAsUser no requiere una licencia de Bot Runner.
Objeto botInput
tipo Cualquiera No Por defecto es STRING. Algunos valores posibles para tipo son los siguientes: 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, and WORKITEM.:
Respuesta 
{
  "deploymentId": "320a2149-aa44-41ab-af9b-f9343ae2581b",
  "automationName": "SAMPLE_APITASK"
}
Parámetros de respuesta
Parámetro Tipo Descripción
deploymentId Cadena La ID de la implementación creado.
automationName Cadena Nombre de la automatización implementada. Si no se proporciona este nombre en la solicitud, se asigna 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 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-Tarea-Actividad-página

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