Driving HCL Universal Orchestrator with REST API

HCL Universal Orchestrator provides a set of fully functional APIs that are implemented based on the Representational State Transfer (REST) services. The REST API helps you easily integrate workload scheduling capabilities with external products and solutions. The same product functionality covered by the existing J2EE API is available with the REST API. The REST API is programming language independent and favors easier network configuration and firewall traversal. With the APIs, you can exploit heterogeneous environments and provide new automation opportunities with direct impact on productivity. The following are few key caracteristics of REST APIs:
  • Enhanced filtering opportunities.
  • Improved payloads for easier consumption.
  • Introduction of efficient multi-item endpoints.
  • Easy communication with external apps.

HCL Universal Orchestrator provides REST APIs V2, which are based on the REST APIs of Workload Automation, but they are quicker and simpler and help you perform the actions much faster.

REST APIs V2 provide several services to administer engines, workload modelling, plans, and security.

The following are some examples or scenarios where the APIs can be implemented:
  • Create your own graphical interface to create and modify scheduling definitions, and update items in the plan.
  • Update definitions or plan items within a script for integration or automation.
  • In a managed file transfer solution, when a specific file arrives, you can submit one or more job flows that elaborate the file, closing the loop on your business process, whether it be bank transactions, a payroll process, or report generation. Your external managed file transfer product starts the business process and HCL Universal Orchestrator takes care of the processing, assuring that it be monitored with the rest of the processes from a single point of control and eventually linked with other processes.
  • Customize your environment to improve your business. For example, see the following business scenario: HCL Universal Orchestrator business scenario.
After you installed the engine, you can access the available REST API services by connecting to the following URL:
https://hostname:port_number/q/swagger-ui/#/
where,
hostname
The hostname of the gateway microservice.
port_number
The valid port exposed for API gateway. The default port is 8442.