Driving HCL Workload Automation with REST API

HCL Workload Automation provides a set of fully functional APIs that are implemented based on 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 some examples or scenarios where the APIs can be implemented:
  • Create your own graphical interface to create and modify scheduling definitions and update objects in the plan.
  • Update definitions or plan objects within a script for integration or automation.
  • When a specific event occurs within an external product, you can automatically submit a batch workload through HCL Workload 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 Workload Automation 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.

The HCL Workload Automation REST API provides several services to administer engines, event rules, workload modelling, plans, and security.

After installing your master domain manager or backup master domain manager, you can access the available REST API services by connecting to the following URL:
https://hostname:port_number/twsd
where,
hostname
The hostname of the master domain manager or the backup master domain manager.
port_number
The HTTPS port number of the master domain manager or backup domain manager. The default is 31116.

You can try out the REST API services and the operations available for each on Swagger Docs by connecting to: https://start.wa.ibmserviceengage.com/twsd/. Click List Operations to view the operations available with the service, and then click Expand Operations to view details such as, the implementation notes, parameters, and response messages for each method. At the end of the details you can find a Try it out! button to see the operation in action.

You can also access some HCL Workload Automation REST API samples here: REST API samples.