Edit Parser Templates

Request

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

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

Here, 

  • your-zephyr is the IP address or host name 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: 

{ "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: 

{ "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 – Used internally. 

  • 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

You are not allowed to modify pre-configured templates. 

See Also

Create, Edit and Delete Parser Templates

Parser Templates

Parser Template Syntax