Home
Extending Product Function
Learn how to extend the function of HCL DevOps Deploy (Deploy).
REST API reference
You can use these REST interfaces to automate tasks.
REST commands for the DevOps Deploy server
The following list shows the commands that are available for the HCL DevOps Deploy (Deploy) server.
resourceTemplate resource
Get a resource template

Extending Product Function
Learn how to extend the function of HCL DevOps Deploy (Deploy).
- 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.
  - REST commands for the DevOps Deploy server
    The following list shows the commands that are available for the HCL DevOps Deploy (Deploy) 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
    - applicationTemplate resource
    - approval/task resource
    - authenticationRealm resource
    - blueprint resource
    - calendar resource
    - component resource
    - componentProcess resource
    - componentProcessRequest resource
    - componentTemplate resource
    - deploymentTrigger resource
    - diagnostics/latency resource
    - environment resource
    - environmentTemplate resource
    - frontendServer resource
    - group resource
    - inventory resource
    - javaPackage resource
    - login resource
    - postProcessingScript resource
    - process resource
    - processRequest resource
    - relay resource
    - resource resource
    - resourceTemplate resource
      - Create a resource template from a JSON file
        This method supports importing a resource template from a cloud system.
      - Create a resource template with agent prototypes from a JSON file
        This method supports creating a resource template with multiple agent prototypes
      - Get a resource template
      - Get all agent prototypes with this resource template as their ancestor
      - Get all children or descendants of a resource template
        Results include the base resource and resources inherited from ancestors of this template.
      - Update a resource template from a JSON file
        To update a resource template with this command, you must specify all of the existing data for the resource template as defined in the JSON data template, except 'teamMappings' which is optional.
    - secretstore resource
    - snapshot resource
    - sshInstallAgent resource
    - status resource
    - systemConfiguration resource
    - tags resource
    - team resource
      Resources for creating, editing, and deleting teams.
    - teamsecurity resource
      Resources for adding users and groups to teams and for creating authorization tokens.
    - user resource
    - vault/appRole resource
    - version resource
    - webhookTemplate resource
    - workflowTrace resource
      Resources for manipulating workflows.
    - zInventory resource
- Command-line client (CLI) reference
  CLI is a command-line interface that provides access to the HCL DevOps Deploy (Deploy) 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 a resource template

Request

GET https://{hostname}:{port}
    /cli/resourceTemplate?{parameters}
Accept: {contentType}

Table 1. Request parameters
Parameter	Type	Required	Description
template	string	true	Name or ID of resource template

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

Example

curl -k -u jsmith:passwd 
   
  "https://deployserver.example.com:8443/cli/
  resourceTemplate?template=MyResourceTemplate"

Example response

{
  "propDefs": [],
  "security": {
    "read": true,
    "Create Resource Templates": true,
    "Delete": true,
    "Edit Basic Settings": true,
    "Manage Resources": true,
    "Manage Teams": true,
    "View Resource Templates": true
  },
  "propSheetDef": {
    "id": "27c709ec-07d8-49b2-bf20-639b07e625d5",
    "versioned": false,
    "resolveHttpValuesUrl": "property/propSheetDef/27c709ec-07d8-49b2-bf20-639b07e625d5/resolveHttpValues"
  },
  "propSheet": {
    "id": "4d0b0d8c-8405-44de-a8a9-4fe7ffb36c19",
    "versioned": false
  },
  "extendedSecurity": {
    "read": true,
    "Create Resource Templates": true,
    "Delete": true,
    "Edit Basic Settings": true,
    "Manage Resources": true,
    "Manage Teams": true,
    "View Resource Templates": true,
    "teams": []
  },
  "id": "95583b93-13e3-484c-b444-480008e5083d",
  "securityResourceId": "ed438378-f215-4fd0-92d0-1cfcce26e621",
  "name": "MyResourceTemplate",
  "description": "",
  "deleted": false
}

Related CLI command: getResourceTemplate.