Edit Parser Templates

Request

To change a parser template, use the following API operation of your Zephyr server: 

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

Here, 

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

  • template-id is the ID of the desired template. You get this ID when you create a template. 

Use the payload like this: 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 { "name": "Updated custom parser", "jsonTemplate": "[{ \"status\": \"${testsuite.testcase.failure}\", \"stepText\": \"${testsuite.testcase.failure}${testsuite.testcase.system-out}\", \"statusExistPass\": false, \"statusString\": null, \"statusFailAttachmentText\": \"${testsuite.testcase.failure:message}\", \"statusPassAttachmentText\": \"classname: ${testsuite.testcase:classname} name: ${testsuite.testcase:name} time: ${testsuite.testcase:time}\", \"packageName\": \"${testsuite.testcase:classname}\", \"skipTestcaseNames\": \"\", \"testcase\" : { \"name\": \"${testsuite.testcase:name}\" }, \"requirements\": [ {\"id\": \"${testsuite.testcase.requirements.requirement}\"} ], \"attachments\": [ {\"filePath\": \"${testsuite.testcase.attachments.attachment}\"} ] }]" }

The payload has two top-level properties: 

  • name – The name of a test tool or framework. 

Response

Zephyr’s response will be like this: 

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 { "id": 101, "name": "Updated custom parser", "jsonTemplate": "[{ \"status\": \"${testsuite.testcase.failure}\", \"stepText\": \"${testsuite.testcase.failure}${testsuite.testcase.system-out}\", \"statusExistPass\": false, \"statusString\": null, \"statusFailAttachmentText\": \"${testsuite.testcase.failure:message}\", \"statusPassAttachmentText\": \"classname: ${testsuite.testcase:classname} name: ${testsuite.testcase:name} time: ${testsuite.testcase:time}\", \"packageName\": \"${testsuite.testcase:classname}\", \"skipTestcaseNames\": \"\", \"testcase\" : { \"name\": \"${testsuite.testcase:name}\" }, \"requirements\": [ {\"id\": \"${testsuite.testcase.requirements.requirement}\"} ], \"attachments\": [ {\"filePath\": \"${testsuite.testcase.attachments.attachment}\"} ] }]", "isDeleted": false, "isDefault": false, "isSbAutomationTool": false, "createdBy": 1, "modifiedBy": 1, "createdOn": 1581580704000, "modifiedOn": 1581581761418 }

Response fields: 

  • id – The template ID in Zephyr. It’s the same ID that you specify in the request URL. 

  • 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. 

  • createdOn – The creation timestamp. 

  • modifiedBy – The ID of the user who modified the template. 

  • modifiedOn – The timestamp of the update. 

Note

Pre-configured templates cannot be modified. 

See Also

Create, Edit and Delete Parser Templates

Parser Templates

Parser Template Syntax