The Application Programming Interface (API)

This chapter explains how you use the IBM Z Workload Scheduler application programming interface (API) to communicate with IBM Z Workload Scheduler. Through the API you can:
  • Extract information about the current plan (GET request)
  • Update or add current-plan operations (PUT request)
  • Delete operations in the current plan (DEL request)
  • Report events to IBM Z Workload Scheduler (CREATE request).

IBM Z Workload Scheduler uses the services of APPC to communicate with an application transaction program (ATP). Before you can use the API, IBM Z Workload Scheduler support for APPC must be active. For details, see IBM® Z Workload Scheduler: Planning and Installation.

This chapter describes CPI-C verbs that are supported by IBM Z Workload Scheduler. ATPs that use CPI-C are more easily integrated and transported across supported environments. For more information about CPI-C verbs, refer to CPI-C Communications Reference.

Samples are provided with IBM Z Workload Scheduler to help you set up and use the API. For a description of these samples, see Sample library (SEQQSAMP).