REST Services Planner

Owned by Onesait Platform
Last updated: 22/09/23
3 min read

 

Este servicio integrado en el Panel de Plataforma permite planificar de forma sencilla la llamada a servicios REST.

Se encuentra disponible para usuarios con rol administrador, developer o analytics.

Se accede a través la opción de menú DESARROLLO:

Primero, se listan todos los planificadores creados por el usuario, indicando su URL. Desde aquí se permite modificar, borrar y poner en ejecución planificadores definidos, según la frecuencia establecida o ejecutarlo de manera asíncrona.

First you´ll see a list with all planners defined by user. From here you can edit, delete, and start defined planners:

Para crear un nuevo planificador REST, se debe especificar:

  • Identification: Nombre.

  • Description: Descripción.

  • CRON: Expresión CRON (la frecuencia con la que se va a ejecutar).

  • URL: URL a invocar.

  • HTTP Method: Método HTTP para invocar la URL.

  • Activated from and to: Fechas de inicio y fin de la tarea son opcionales, pudiendo dejarse en blanco.

Para simplificar la creación de la expresión CRON, el usuario puede usar esta interfaz en que es define la expresión de una manera más intuitiva, escogiéndola a partir de un pop-up.

Al definir la URL, se puede utilizar la palabra reservada “${ENV}”, que el planificador sustituirá por la URL del entorno actual:

Además, el planificador permite añadir cabeceras y propiedades, que se pasan a la URL de invocación como parámetros.

En caso de querer ejecutar asíncronamente el servicio, se debe pulsar el botón Execute del servicio REST.

El resultado aparecerá en los logs del Control Panel.

Para poner la tarea a ejecutarse según lo establecido en el CRON, se debe pulsar el botón Play.

Automáticamente la página se recargará, apareciendo el icono de Stop e iniciando la tarea REST.

Los logs de los resultados se pueden observar en el módulo rest-planner.