Home
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.
postProcessingScript resource
Resources for working with post processing scripts.
Get information about a post processing script
This command returns a JSON representation of a post processing script.

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.
    - 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.
      - Add a post processing script to a team
      - Create a post processing script from a JSON file
      - Delete a post processing script.
        Used to remove processing scripts.
      - Get a list of post processing scripts.
        Get information about post processing scripts.
      - Get information about a post processing script
        This command returns a JSON representation of a post processing script.
      - Get information about a post processing script
        This command returns a JSON representation of a post processing script.
    - 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.

Get information about a post processing script

This command returns a JSON representation of a post processing script.

Request

GET https://{hostname}:{port}
    /cli/postProcessingScript/script?{parameters}
Accept: application/json

Table 1. Request parameters
Parameter	Type	Required	Description
script	string	true	Name/ID of the script

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

Related CLI command: getPostProcessingScript.