Edit this page on GitHub

Home > docs > api > Template

Template

Templates allows sharing of common elements and process.

The REST API provides support for a number of operations:

Create a New Template Alias

Creates a new or updates existing template alias.

  • Permissions template:manage
  • URI /api/v1/template/alias
  • Method POST
  • Headers Authorization, Content-Type: application/json
  • Body
      {
        "alias": "my-template",
        "url": "http://host/path/my-template.jar"
      }
    
  • Success response
      Content-Type: application/json
    
      {
        "ok": true
      }
    

List Template Aliases

Lists existing template aliases.

  • Permissions template:manage
  • URI /api/v1/template/alias
  • Method GET
  • Body none
  • Success response
      Content-Type: application/json
    
      [
        { "alias": "my-template", "url": "http://host/port/my-template.jar"},
        { "alias": "...", "url": "..."}
      ]
    

<a name=”delete-template-alias”

Delete a Template Alias

Removes an existing template alias.

  • Permissions template:manage
  • URI /api/v1/template/alias/${alias}
  • Method DELETE
  • Headers Authorization
  • Body none
  • Success response
      Content-Type: application/json
    
      {
        "ok": true
      }