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. REST APIs let you easily integrate our workload scheduling capabilities with heterogeneous third party environments into complex automated systems. The same product functionalities covered by J2EE APIs are available with REST APIs. REST APIs use an independent programming language and enable easier network configuration and firewall traversal. The following are some examples or scenarios where APIs can be implemented:
  • You can develop your own graphical interface to create and modify scheduling definitions and update items in the plan.
  • You can update definitions in the database or items in the plan 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 jobs to 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 is monitored together with the rest of the processes from a single point of control.

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

REST API V2
REST API V2 have been implemented and are easier to configure, more powerful and flexible. It is highly recommended to use them for any future integration.
Accessing REST APIs
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 API on Swagger Docs by connecting to https://MDM_IP_address:tdwbport/twsd/. There, 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.