IBM Workload Automation 9.5 Developer's Guide: Driving Workload Automation with REST APIs

The IBM Workload Automation Developer's Guide provides information on how to use REST APIs to drive IBM Workload Automation products.


IBM Workload Automation 9.5 Developer's Guide: Driving Workload Automation with REST APIs - cover page
Brand
IBM
Category
Other software
Document type
Programming Manual
Language
English
Pages
13
File format
PDF
File size
417 KB
Published
29 November, 2023
Updated
29 November, 2023
MD5 checksum
ABBF34C4DE7A1BB061800D7A7C159CEE

About this manual

This developer's guide introduces the application programming interfaces that let you drive IBM Workload Automation products from your own applications. It applies to version 9, release 5, modification level 0 of IBM Workload Scheduler (program number 5698-WSH) and covers the REST API, which is implemented on Representational State Transfer services and is programming language independent.

The guide explains that the REST API lets you create your own graphical or command-line interface to perform the functions of composer, conman and planman and the Dynamic Workload Console, including modifying objects in the database, submitting workload, monitoring the plan and performing actions on the plan. It also lists example scenarios for integration with external products and shows how to reach the REST API services and the Swagger Docs page used to try out operations.

What's inside

  • Preface: About this guide
  • What is new in this release
  • Accessibility
  • Technical training
  • Support information
  • Introduction to driving IBM Workload Automation
  • Driving IBM Workload Scheduler with REST API
  • Notices
  • Trademarks
  • Terms and conditions for product documentation

Specifications

Product versionVersion 9, release 5, modification level 0
Program number5698-WSH
Default HTTPS port31116
REST API service URLhttps://hostname:port_number/twsd
Swagger Docs URLhttps://start.wa.ibmserviceengage.com/twsd/

Frequently asked questions

How do I access the IBM Workload Scheduler REST API services?

After installing your master domain manager or backup master domain manager, connect to https://hostname:port_number/twsd, where hostname is the master or backup master domain manager and port_number is its HTTPS port.

What is the default HTTPS port?

The default HTTPS port number of the master domain manager or backup domain manager is 31116.

Can I try out the REST API operations?

Yes. Connect to Swagger Docs at https://start.wa.ibmserviceengage.com/twsd/, click List Operations, then Expand Operations, and use the Try it out! button.

What tasks can I perform with the REST API?

In IBM Workload Scheduler and IBM Z Workload Scheduler you can modify objects in the database, submit workload, monitor the plan, and perform actions on the plan such as remedial actions when a job fails.

Download PDF (417 KB)

More IBM Manuals


View all IBM manuals →