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.
component resource
Get the value of a property on a component

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
      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
    - approval/task resource
      Resources for creating, editing, and deleting agents.
    - authenticationRealm resource
    - blueprint resource
    - calendar resource
    - component resource
      - Add a component to a team
      - Add a tag to a component
      - Create a component
      - Create a component environment property
      - Create a component resource property definition
      - Delete a component
      - Delete a component environment property
      - Delete a component resource property definition
      - Delete a tag from a component
      - Export a component to a json file.
      - Get a list of all components using this template
        This command returns a JSON representation of a list of components.
      - Get information about a component
        This command returns a JSON representation of a component.
      - Get information about all components on the server
        This command returns a JSON representation of all components on the server.
      - Get the value of a property on a component
      - Get the versions of a component
      - Get values for component properties
        This command returns all component properties.
      - Import component from json file.
      - Import new component versions
        This command polls the source configuration for new component versions. Add property name/value pairs as necessary - this can be used to add specific versions.
      - Remove a component from a team
      - Return all tags on a component
      - Set a property on a component
      - Set a version property for a component
        Component version properties are available to each version of the component.
      - Update a component environment property
      - Update a component resource property definition
      - Update the basic settings of a component
    - componentProcess resource
      Resources for working with component processes.
    - componentProcessRequest resource
    - componentTemplate resource
      Resources for working with component templates.
    - deploymentTrigger resource
    - environment resource
      Resources for creating, editing, and provisioning environments.
    - environmentTemplate resource
    - frontendServer resource
      Resources for viewing and deleting frontend servers.
    - 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
    - team resource
    - teamsecurity resource
    - user resource
    - vault/appRole resource
    - version resource
      Resources for manipulating component versions.
    - webhookTemplate resource
    - workflowTrace resource
- 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 the value of a property on a component

Request

GET https://{hostname}:{port}
    /cli/component/getProperty?{parameters}
Accept: text/plain

Property names can be prefixed to specify which set of properties will be searched. Unprefixed properties searches custom 'Component Properties' on a component, while a property named such as template/propertyName searches the properties inherited from a component templates property definitions.

Table 1. Request parameters
Parameter	Type	Required	Description
component	string	true	Name or ID of the component
name	string	true	Name of the property.

Table 2. Header parameters
Parameter	Type	Required	Description
Accept	`text/plain`	true

Related CLI command: getComponentProperty.