Starting October 11, 2024 (Zephyr Enterprise 8.2), the Zephyr Enterprise documentation moved from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise documentation page. Please see: Get List of Available Parser Templates | Zephyr Enterprise Documentation

Request

To get a list of available parser templates, send the following API request to your Zephyr server:

GET http(s)://{your-zephyr}/flex/services/rest/latest/parsertemplate

where your-zephyr is the host name or IP address of your Zephyr server.

You can use this request, for example, if you forget the ID of a template you created.

Response

Zephyr will reply with an array that has information about templates existing in your Zephyr instance. This array includes both pre-configured and custom templates:

[
  {
    "id": 1, 
    "name": "Selenium",
    "jsonTemplate": "[{
      ... 
    }]",
    "isDeleted": false, 
    "isDefault": false, 
    "isSbAutomationTool": false,
    "createdBy": 1,
  },
  {
    "id": 2, 
    "name": "UFT",
    "jsonTemplate": "[{
      ... 
    }]",
    "isDeleted": false, 
    "isDefault": false, 
    "isSbAutomationTool": false,
    "createdBy": 1,
  },
  ... ,
  {
    "id": 101, 
    "name": "My custom parser",
    "jsonTemplate": "[{
      ... 
    }]",
    "isDeleted": false, 
    "isDefault": false, 
    "isSbAutomationTool": false,
    "createdBy": 1,
  },
  ...
]

Here --

id – An identifier that Zephyr assigned to the template.
Note: Identifiers of pre-configured templates are less than 100. Identifiers of user-defined templates start from 101.
jsonTemplate – The template contents (see Parser Template Syntax).
isDeleted – Indicates whether the template has been deleted or not.
isDefault – true if a template is a pre-configured request, or false if it is a user-defined request.
isSbAutomationTool – Reserved for internal use.
createdBy – The ID of the user who created the template.

Zephyr Enterprise 8.1.0

Get List of Available Parser Templates

Request

Response

See Also