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.
applicationProcessRequest resource
Resources for requesting application processes.
Get information about a specific application process request
This command retrieves a specific application process request by id.

Welcome
Welcome to the HCL Launch 7.3.2 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
      Resources for creating, editing, and deleting agents.
    - agentPool resource
    - application resource
      Resources for working with applications, including manipulating the components and environments that are associated with applications.
    - applicationPipeline resource
    - applicationProcess resource
    - applicationProcessRequest resource
      Resources for requesting application processes.
      - Get application process request properties
      - Count all application process requests
        This command returns the total number of application process requests for all applications.
      - Get an application process request's activity trace.
      - Get information about a specific application process request
        This command retrieves a specific application process request by id.
      - Get information about all application process requests on the server
        This command returns a JSON representation of all application process requests, up to a maximum of 100.
      - Repeat an application process request
      - Request the status of an application process request
        Will return both the status of the request (which indicates if it is still running) and the request result (which indicates the result of the process if it completed).
      - Run an application process
        A version may be set to 'latest' to deploy the latest version of that component.
    - applicationTemplate resource
      Resources for working with application templates.
    - approval/task resource
    - authenticationRealm resource
      Resources for editing authentication realms.
    - blueprint resource
      Resources for working with application blueprints, which map application components to resource templates.
    - calendar resource
    - component resource
      Resources for working with components and for retrieving new component versions.
    - componentProcess resource
    - componentProcessRequest resource
    - componentTemplate resource
    - deploymentTrigger resource
    - diagnostics/latency resource
    - environment resource
    - environmentTemplate resource
      Resources for working with environment templates.
    - frontendServer resource
      Resources for viewing and deleting frontend servers.
    - group resource
    - inventory resource
    - javaPackage resource
    - postProcessingScript resource
      Resources for working with post processing scripts.
    - process resource
    - processRequest resource
    - relay resource
    - resource resource
    - resourceTemplate resource
    - secretstore resource
    - snapshot resource
    - sshInstallAgent resource
    - status resource
      Resources for creating and retrieving statuses.
    - systemConfiguration resource
    - tags resource
      Resources for listing tags.
    - team resource
    - teamsecurity resource
    - user resource
    - vault/appRole resource
    - version resource
    - webhookTemplate resource
    - workflowTrace resource
      Resources for manipulating workflows.
    - zInventory resource
      Resources for manipulating Z inventory.
- 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.
Glossary

Get information about a specific application process request

This command retrieves a specific application process request by id.

Request

GET https://{hostname}:{port}
    /cli/applicationProcessRequest/info/{requestID}
Accept: application/json

Table 1. URL parameters
Parameter	Type	Required	Description
requestID	string	true	The ID of the application process request.

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

Example

curl -k -u jsmith:passwd 
   
  "https://myserver.example.com:8443/cli/applicationProcessRequest/info/{appReqId}"

Related CLI command: getApplicationProcessRequest.