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.
version resource
Create a component version
Do not use the keywords latest, latestVersion, or newest as the version name.

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
    - application resource
    - applicationProcess resource
      Resources for editing and creating application processes.
    - applicationProcessRequest resource
    - approval/task resource
    - authenticationRealm resource
    - blueprint resource
    - component resource
    - componentProcess resource
      Resources for working with component processes.
    - componentProcessRequest resource
    - componentTemplate resource
    - deploymentTrigger resource
    - environment resource
    - frontendServer resource
    - group resource
    - patternIntegrationProviderCLI resource
    - process resource
    - processRequest resource
    - relay resource
    - resource resource
    - resourceTemplate resource
    - snapshot resource
    - sshInstallAgent resource
    - status resource
      Resources for creating and retrieving statuses.
    - systemConfiguration resource
    - team resource
      Resources for creating, editing, and deleting teams.
    - teamsecurity resource
    - user resource
    - version resource
      - Add a link on a version
        This command adds an external link on the specified component version.
      - Add a status to a version
      - Archive the given versions of a component
      - Copy a component version with all of its properties
        Do not use the keywords latest, latestVersion, or newest as the version name.
      - Create a component version
        Do not use the keywords latest, latestVersion, or newest as the version name.
      - Create multiple component versions
        Do not use the keywords latest, latestVersion, or newest as the version name.
      - Delete a component version property
      - Delete a version from a component
      - Download the artifacts of a component version
        This command exports the artifacts of a component version into an archive file.
      - Get a link on a component version
      - Get a version ID
      - Get the list of artifacts for a version
      - List links on a version
        This command lists all links that are associated with a specified component version.
      - List the properties on a component version
      - List the version property definitions for a component
        These properties are available to each version of the component.
      - Mark a version as completed importing
        Mark a version as completed importing so it is available for use in deployments
      - Remove a link from a version
      - Remove a status from a version
      - Set a property on a component version
    - 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.

Create a component version

Do not use the keywords latest, latestVersion, or newest as the version name.

Request

POST https://{hostname}:{port}
    /cli/version/createVersion?{parameters}
Accept: application/json

Table 1. Request parameters
Parameter	Type	Required	Description
component	string	true	Name or ID of the component
name	string	true	Name of the new version
description	string	false	Description of the new version
type	string	false	Type to use for the new version (incremental or full) - full is the default.
sourceConfigExecutionRecordId	string	false	A system parameter. This should not be provided by the user or by user scripts.
importing	boolean	false	Whether or not to mark this version as importing. Version marked as importing cannot be used in deployments. Default false

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

Example response

{
  "id": "c0198aaf-6f4b-4d2e-b103-a7f6a257f580",
  "name": "1.2",
  "type": "FULL",
  "created": 1390572847946,
  "active": true,
  "archived": false
}

Related CLI command: createVersion.