Get List of Available Parser Templates

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: 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 [ { "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. 

See Also

Create, Edit and Delete Parser Templates

Parser Templates

Parser Template Syntax