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 workstation fence
Use REST APIs to change the fence value of a workstation in the plan.

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 workstation fence

Use REST APIs to change the fence value of a workstation in the plan.

About this task

This process outlines the steps required to modify a workstation fence value within the current plan. The fence value plays a crucial role in job scheduling management, as jobs are not initiated on a workstation if their priorities are at or below the job fence value.

Procedure

To change the fence value of a workstation in the plan, use the POST/twsd/api/v2/plan/workstation/action/update-fence endpoint. In the Swagger UI, expand the endpoint, identify the workstation you want to modify by querying with plan filters or OQL, modify the Fence parameter with the desired fence value, and then click Execute.
If the command is successful, a response with the ID of the modified workstation in the plan is displayed, as shown in the following example:
```
{
  "successfulResourceResponses": [
    {
      "id": "75196d79-50b0-345c-9308-ee4d69efe147",
      "error": false
    }
  ],
  "failedResourceResponses": []
}
```
To verify that the fence value was updated, run the GET/twsd/api/v2/plan/workstation API call and check that the Fence value in the response is equal to the value you previously set.