Home
Extending product function
Learn how to extend the function of HCL Launch.
REST API reference
The HCL Launch server and blueprint design server each have a separate REST interface. You can use these REST interfaces to automate tasks on those servers.
REST commands for the HCL Launch server
The following list shows the commands that are available for the HCL Launch server.
applicationProcess resource
Resources for editing and creating application processes.
List properties that must be specified for a process
If a snapshot name or ID is specified, results include any component process steps which have some properties marked to receive values later for a specific version based on the snapshot.

Extending product function
Learn how to extend the function of HCL Launch.
- Plug-ins
  UrbanCode plug-ins provide tools for creating component processes and integrations. IBM UrbanCode 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
  The HCL Launch server and blueprint design server each have a separate REST interface. You can use these REST interfaces to automate tasks on those servers.
  - 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 and for the blueprint design 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
      Resources for working with agent pools.
    - application resource
      Resources for working with applications, including manipulating the components and environments that are associated with applications.
    - applicationProcess resource
      Resources for editing and creating application processes.
      - Create an application process
      - Get all application processes of an application
        Returns a JSON representation of all application processes for a specific application.
      - Get information about an application process
        Returns a JSON representation of an application process.
      - List properties that must be specified for a process
        If a snapshot name or ID is specified, results include any component process steps which have some properties marked to receive values later for a specific version based on the snapshot.
    - applicationProcessRequest resource
    - applicationTemplate resource
    - approval/task resource
      Resources for creating, editing, and deleting agents.
    - authenticationRealm resource
    - blueprint resource
      Resources for working with application blueprints, which map application components to resource templates.
    - component resource
    - componentProcess resource
      Resources for working with component processes.
    - componentProcessRequest resource
      Resources for working with component processes.
    - componentTemplate resource
      Resources for working with component templates.
    - deploymentTrigger resource
      Resources for reading, creating, and deleting deployment triggers.
    - environment resource
      Resources for creating, editing, and provisioning environments.
    - environmentTemplate resource
      Resources for working with environment templates.
    - frontendServer resource
      Resources for viewing and deleting frontend servers.
    - group resource
    - inventory resource
      Resource for managing inventory.
    - process resource
    - processRequest resource
      Resources for working with generic process requests.
    - relay resource
      Resource for relay cli
    - resource resource
    - resourceTemplate resource
    - snapshot resource
    - sshInstallAgent resource
    - status resource
    - systemConfiguration resource
      Resources for changing system properties and for updating system configuration settings.
    - tags resource
    - team resource
    - teamsecurity resource
      Resources for adding users and groups to teams and for creating authorization tokens.
    - user resource
    - version resource
      Resources for manipulating component versions.
    - workflowTrace resource
      Resources for manipulating workflows.
- 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.

List properties that must be specified for a process

If a snapshot name or ID is specified, results include any component process steps which have some properties marked to receive values later for a specific version based on the snapshot.

Request

GET https://{hostname}:{port}
    /cli/applicationProcess/unfilledProperties?{parameters}
Accept: application/json

Table 1. Request parameters
Parameter	Type	Required	Description
application	string	true	Name or ID of the application
processName	string	true	Name of the application process
snapshot	string	false	Name or ID of the snapshot (optional)
environment	string	false	Get the properties based on if they were deployed to the specified environment (optional)

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

Example

curl -k -u jsmith:passwd 
   
  "https://myserver.example.com:8443/cli/
  applicationProcess/unfilledProperties?application=MyApplication&processName=deploy"

Example response

[
  {
    "id": "decc3570-17ae-4b46-b640-6a7180edafa9",
    "name": "MyProperty",
    "label": "MyProperty",
    "pattern": "",
    "type": "TEXT",
    "value": "",
    "required": false,
    "description": "",
    "placeholder": ""
  }
]

Related CLI command: getApplicationProcessUnfilledProperties.