Welcome
HCL Workload Automation
Welcome to the HCL Workload Automation documentation, where you can find information about how to install, maintain, and use HCL Workload Automation. The documentation has been updated for HCL Workload Automation Version 10.2.6.
Driving HCL Workload Automation
Driving HCL Workload Automation with REST APIs
REST API - setting a job stream in draft
Use REST APIs to change the status of a job stream to draft.

Product requirements
This section contains links to the HCL Workload Automation Product Requirements.
Product Library in PDF format
This section contains links to the PDF versions of all the publications provided in Product Documentation for HCL Workload Automation.
Overview
Mobile Applications Userʼs Guide
Dynamic Workload Console User's Guide
AI Data Advisor (AIDA) User's Guide
HCL Workload Automation
Welcome to the HCL Workload Automation documentation, where you can find information about how to install, maintain, and use HCL Workload Automation. The documentation has been updated for HCL Workload Automation Version 10.2.6.
- Planning and Installation
- User's Guide and Reference
- Administration Guide
- Scheduling with the Agent for z/OS
- Database Views
- High Availability Cluster Environment
- Driving HCL Workload Automation
  - About this guide
    Provides an overview of the guide, with information about changes made to it since the last release, and who should read it. It also supplies information about obtaining resources and support from HCL.
  - Introduction
    Provides an overview of the entire publication.
  - Driving HCL Workload Automation with REST APIs
    - REST API - creating job definition in the database
      Use REST APIs to add a new job definition to the database.
    - REST API - setting a job stream in draft
      Use REST APIs to change the status of a job stream to draft.
    - REST API - submitting a job stream in the current plan
      Use REST APIs to submit a job stream in the plan.
    - REST API - setting a workstation fence
      Use REST APIs to change the fence value of a workstation in the plan.
    - REST API - submitting a job with dependencies
      Use REST APIs to submit a job with a single dependency in the plan.
    - REST API - submitting an ad-hoc job
      Use REST APIs to submit an ad-hoc job.
    - REST API - retrieving job stream predecessors in plan
      Use REST APIs to retrieve the list of a job stream predecessors.
    - REST API - retrieving job stream successors in plan
      Use REST APIs to retrieve the list of a job stream successors.
    - REST API - managing job stream dependencies in plan
      Use REST APIs to list the dependencies of a job stream and then release or remove them.
    - REST API - retrieving job stream predecessors from the database
      Use REST APIs to retrieve the list of a job stream predecessors from the database.
HCL Workload Automation for Z
Welcome to the HCL Workload Automation for Z documentation, where you can find information about how to install, maintain, and use the product. The documentation has been updated for version 10.2 Fix Pack 3.
Messages and Codes
Glossary
Notices

REST API - setting a job stream in draft

Use REST APIs to change the status of a job stream to draft.

About this task

This process involves retrieving the job stream current data through a GET REST API and then submitting an updated version through a POST REST API.

Procedure

First, you need to get the unique ID and the current configuration (payload) of the job stream you want to modify. Use the GET/twsd//api/v2/model/jobstream endpoint to find the job stream.
1. In the Swagger UI, expand the endpoint, select Filter by exact name and matching folder and sort results in name descending order in the oql string parameter field, enter the name of the job stream in the name field, and click Execute.
2. From the API response, copy and save the following two items: the job stream ID in the response header and the entire JSON payload from the response body. Example of a response payload:
```
{
 "count": 1,
 "results": [
   {
     "kind": "JobStream",
     "key": "/WA_FTA_XA#/FINAL",
     "def": {
       "id": "9254f5da-181a-3be8-a1f1-8c978848c261",
       "abstractId": "61918471-ce1b-3d21-bb66-6dd4d9e3a5ba",
       "folderId": "742ba6a6-31aa-3051-b810-3ced4fc624b4",
       "folder": "/",
       "name": "FINAL",
       "workstationId": "9819daa5-1a2a-385b-b238-cfa7309c65d2",
       "workstation": "/WA_FTA_XA",

...
}
```
Now, use the information you just retrieved to send an update request. Use the PUT/twsd/api/v2/model/jobstream/{jobStream_id} endpoint to update the job stream.
1. In the Swagger UI, expand the endpoint and paste the Job Stream ID you copied in the previous step in the ID parameter field.
2. In the Request body field, paste the entire JSON payload you copied.
3. In the JSON you just pasted, find the options parameter and include the draft parameter in the options list:
```
...
  
"validTo": "2025-09-23T09:44:10.278Z",
    "timeZone": "string",
    "description": "This is a test job stream.",
    "documentation": "string",
    "options": [
      "draft"
    ],
...
```
4. Click Execute. The API returns a success message, and your job stream is now in draft mode.
To confirm the job stream is now in draft mode, run the GET/twsd//api/v2/model/jobstream API call again and check that the draft value is present in the option list.