Welcome
Extending product function
Learn how to extend the function of HCL Launch.
REST API reference
You can use these REST interfaces to automate tasks.
REST commands for the HCL Launch server
The following list shows the commands that are available for the HCL Launch server.
workflowTrace resource
Pause a workflow in progress

Welcome
Welcome to the HCL Launch 7.2.3 documentation, where you can find information about how to install, maintain, and use HCL Launch.
Release information
Overview
This section provides overview and getting started information.
Learning
Tutorials and instructions for all experience levels.
Installing
An HCL Launch installation consists of the HCL Launch server, a database, and at least one agent.
Upgrading and migrating
Learn how to upgrade HCL Launch elements, including the server, agents, and how to migrate data.
Uninstalling
Learn how to uninstall an HCL Launch server, or agent.
Integrating
HCL Launch supports integrations with other IBM® products, products from others, and certain cloud systems.
Administering
Learn how to administer settings in HCL Launch elements and communication between the elements.
Managing security
HCL Launch uses a flexible team-based and role-based security model that maps to your organizational structure.
Modeling software deployment
Modeling software deployment in HCL Launch includes configuring components and component processes and adding those components to applications. Then, you use processes to deploy the components to environments.
Deploying
Learn how to deploy applications in HCL Launch.
Reporting
provides several different deployment and security reports.
Extending product function
Learn how to extend the function of HCL Launch.
- Plug-ins
  The HCL plug-ins provide tools for creating component processes and integrations. HCL plug-ins provides plug-ins for several common deployment processes, and others are available to integrate with a wide variety of tools, such as middleware tools, databases, and servers.
- Creating notification templates
  Notification templates are the basis for emails that the server sends to users after an event occurs on the server. You can create customized notification templates by modifying the default templates provided, or by creating new templates of your own.
- REST API reference
  You can use these REST interfaces to automate tasks.
  - Running REST commands
    Many different programs can run REST commands. To run the command, you call a method on a REST resource and pass parameters or a request in JSON format.
  - Examples of REST API commands
    Many REST and command-line client commands have examples in their help topics. A few more examples using various programming languages and scenarios are provided here. The commands are similar for the server.
  - Authenticating for REST commands
    The way that you authenticate to run REST commands depends on how the server is set up and the tool that you are using to run the commands.
  - Deploying applications by using REST commands: An example
    The following example describes how to use the REST commands to deploy an application.
  - REST commands for the HCL Launch server
    The following list shows the commands that are available for the HCL Launch server.
    - agentCLI resource
    - agentPool resource
    - application resource
    - applicationProcess resource
      Resources for editing and creating application processes.
    - applicationProcessRequest resource
      Resources for requesting application processes.
    - applicationTemplate resource
    - approval/task resource
      Resources for creating, editing, and deleting agents.
    - authenticationRealm resource
    - calendar resource
    - component resource
    - componentProcess resource
    - componentProcessRequest resource
      Resources for working with component processes.
    - componentTemplate resource
      Resources for working with component templates.
    - deploymentTrigger resource
    - environment resource
    - environmentTemplate resource
    - frontendServer resource
    - group resource
    - inventory resource
    - javaPackage resource
    - login resource
    - postProcessingScript resource
    - process resource
      Resources for editing and creating generic processes.
    - processRequest resource
      Resources for working with generic process requests.
    - relay resource
    - resource resource
    - resourceTemplate resource
    - secretstore resource
    - snapshot resource
    - sshInstallAgent resource
    - status resource
    - systemConfiguration resource
    - tags resource
      Resources for listing tags.
    - team resource
    - teamsecurity resource
    - user resource
    - vault/appRole resource
    - version resource
    - webhookTemplate resource
    - workflowTrace resource
      - Cancel a workflow in progress
      - Force cancel a workflow in progress
      - Pause a workflow in progress
      - Resume a workflow in progress
      - Get information about all running workflow activities
        This command returns all child workflows of a parent request id, if specified, else returns all running workflow activities.
      - Get full workflow trace with execution logs
        This command returns full workflow trace with execution logs as a zip file in the current directory. If the underlying workflow is not complete, an HTTP 412 response is returned.
- Command-line client (CLI) reference
  CLI is a command-line interface that provides access to the HCL Launch server. It can be used to find or set properties and to run numerous functions.
- Process-as-code feature
  Programmatically manage processes with PAC language.
Troubleshooting and support
Learn how to troubleshoot some common issues with HCL Launch.

Pause a workflow in progress

Request

PUT https://{hostname}:{port}
    /cli/workflowTrace/pause?{parameters}
Accept: application/json

Table 1. Request parameters
Parameter	Type	Required	Description
workflow	string	true	ID of the workflow to pause.

Table 2. Header parameters
Parameter	Type	Required	Description
Accept	`application/json`	true

Related CLI command: pauseWorkflow.