Custom fields for Zephyr Scale Cloud

[nassauwinter]

There is no data in the official Zephyr Scale Cloud API documents about managing custom fields of tests, test plans, etc.

Though a user can add/modify/delete custom fields via UI. And these actions also use same API as documented endpoints. I.e. POST to https://app.tm4j.smartbear.com/backend/rest/tests/2.0/customfield/testcase

I will investigate if it is possible to add this undocumented api endpoints for cloud API wrapper.

[nassauwinter]

I've contacted Smartbear support and this is their response about managing custom fields with API:

Thank you for reaching out to Zephyr Scale cloud Support. Would like to inform you that we do not have an API Endpoint to create a Custom fields in the UI. Initially, it is required to create the Custom Fields in Zephyr Scale from the UI : Customizing Fields for Test Cases, Cycles, Plans, Steps, and Executions | Zephyr Scale Cloud Documentation Once the same are created, you can make use of the below API’s to add/update the Custom fields for Test Cases, Test Cycles (Zephyr Scale for Jira Cloud API ) Method : POST ( Creating a new testcase with the Custom field values) API Endpoint : https://api.zephyrscale.smartbear.com/v2/testcases Method : PUT (To update Custom fields in the existing Test Case) API Endpoint : https://api.zephyrscale.smartbear.com/v2/testcases/{testCaseKey} Method : POST (Creating a new Test Cycle with the Custom field values) API Endpoint : https://api.zephyrscale.smartbear.com/v2/testcycles Method : PUT (To update custom fields in the existing Test Cycle) API Endpoint : https://api.zephyrscale.smartbear.com/v2/testcycles/{testCycleIdOrKey} We do not have an PUT/Update Endpoint for Test Plans and Test Executions. Method : POST (Creating a new Test Plan with the Custom field values) API Endpoint : https://api.zephyrscale.smartbear.com/v2/testplans Method : POST (Creating a new Test Execution with the Custom field values) API Endpoint : https://api.zephyrscale.smartbear.com/v2/testexecutions Note : The API Endpoint that you have provided is a Private API which is subject to change at any time and we do not recommend it using . The mentioned above API’s are public and recommended to use.

Since the API of creating and modifying custom fields is private and is not recommended to use, I think the best solution would be:

• use the custom field managing functionality as stated via GUI;
• support public API wrappers for adding/updating custom fields for test cases, test plans, etc.