Creación de un servicio REST

Puede crear un servicio REST que exponga a sistemas externos para que puedan acceder a las prestaciones desde una automatización de flujo de trabajo.

Procedimiento

Para crear el servicio REST:

  1. Abra el diseñador.
  2. En la biblioteca, seleccione Servicios de automatización expuestos > + > Servicio REST.
  3. Asigne un nombre al servicio REST.
    Se abre el editor de servicios REST.
  4. Añada una operación para cada función de negocio que desee exponer. Para añadir una operación, pulse Añadir.
    En los detalles de la operación, nombre la operación y especifique el flujo de servicio o proceso que proporciona la implementación para la operación. Para la implementación, puede:
    • Cree un nuevo flujo o proceso de servicio haciendo clic en Nuevo.
    • Seleccione un flujo o proceso de servicio existente haciendo clic en Seleccionar.
    Para obtener más información sobre los flujos de servicios y cómo crearlos, consulte Creación de un flujo de servicios. Para más información sobre procesos y cómo crearlos, consulta Crear un proceso.

    Las entradas y salidas pueden utilizar los tipos simples que se incluyen con el producto, como String, Integer, Boolean, Decimal, Date, Time o JSONObject, del kit de herramientas System Data o objetos de negocio personalizados. Los tipos de otros kits de herramientas del sistema no están soportados.
    Sugerencia: Asegúrese de que no haya varios objetos de negocio con el mismo nombre en la cadena de dependencias del servicio de automatización REST expuesto y su interfaz.
    Nota: Sólo se permiten caracteres ASCII en lo siguiente:
    • El nombre de una operación
    • Los nombres de los objetos de negocio a los que hacen referencia las entradas o salidas de la implementación del servicio de automatización (por ejemplo, flujo de servicio y proceso )
    Justificación: A partir de la definición de servicio de automatización REST expuesta, se genera una definición de OpenAPI válida que se ajusta a las especificaciones respectivas.
    Después de editar el servicio REST, pulse Guardar o Finalizar edición.

Resultados

Para invocar un servicio REST, se debe activar la instantánea adecuada.

En el entorno de desarrollo, el servicio REST en la sugerencia o en la pista predeterminada se puede invocar directamente. Asegúrese de hacer de la pista el valor predeterminado para abrir directamente el URL de definición de OpenAPI en el servicio REST.

En un entorno de prueba, de transición o de ejecución de producción, el consumidor puede invocar el servicio de automatización REST desde la instantánea predeterminada o consumir el servicio de automatización REST desde una instantánea dedicada.

Puede obtener la definición OpenAPI para su servicio REST en un entorno de ejecución desde la siguiente URL :
http://host_name[:port]/[custom_prefix/]automationservices/rest/process_app_acronym/[snapshot_acronym/]rest_service_name/docs
donde:
  • host_name es el nombre de host.
  • port es el número de puerto opcional.
  • custom_prefix es un prefijo personalizado opcional
  • process_app_acronym es el acrónimo de la aplicación de proceso
  • snapshot_acronym es el acrónimo de instantánea opcional que, si no se especifica, se resuelve en la punta de la rama predeterminada en el entorno de desarrollo o en la instantánea predeterminada en un entorno de ejecución.
  • rest_service_name es el nombre del servicio REST.
Nota: La prestación que ha expuesto aquí como un servicio de automatización REST se puede publicar y, a continuación, consumir por aplicaciones y automatizaciones en Business Automation Studio.
Nota: Las propiedades avanzadas y las propiedades de parámetros avanzadas definidas para objetos de negocio utilizados en servicios REST no se incluyen en la especificación OpenAPI ni se validan en tiempo de ejecución.