Zephyr Enterprise Ideas Portal

To understand how we select ideas for development, please read about our Product Development Process.

New API to retrieve custom fields details, including list of dropdown values

As a customer working on automating the creation of Zephyr projects and onboard of new users, I need the ability to retrieve all details for a specific custom field.

This should include all custom field details (as below) as well as the list of values for fields like picklist and multi-select.

"displayName": "Project Admin",

"fieldId": 1132,

"fieldName": "zcf_1132"

  • Surekha Verma
  • Aug 31 2021
  • Gathering Interest
API
  • Attach files
  • Vishnu Vasudevan commented
    11 Jan 04:42pm

    Hi - Was there any update on this? An API to retrieve the list of custom field values for a particular custom field will be of great help.

  • Surekha Verma commented
    9 Sep, 2021 11:21am

    Hi Fernando,

    Thanks for the update!

    Regards,
    Surekha.

  • Admin
    Fernando Mattos commented
    9 Sep, 2021 11:06am

    Hi Surekha,

    I've accepted this feature request, but updated the title and description slightly, and merged the other similar idea you had created.

    I'll discuss with Govind if this info can already be provided or if we need to develop a new API.

    Regards,

    Fernando

  • Surekha Verma commented
    9 Sep, 2021 09:56am

    Hi Govind,

    I did not find any endpoint to fetch these details.
    For example, https://staging-build-ingka-ikea.yourzephyr.com/flex/services/rest/latest/role returns roles list in Zephyr.
    I was looking for an endpoint similar to above which would return me the custom fields which are created in Zephyr. A possibility to filter further based in "displayName"

    Let me know if more details are required.

    Regards,
    Surekha.

  • Admin
    govind drolia commented
    9 Sep, 2021 07:45am

    Hello Surekha,

    we do include the detail that you are asking on the API. Could you help me with the endpoint you are using to get those detail


    Thanks

    Govind

  • Surekha Verma commented
    4 Sep, 2021 06:06pm

    Looping in Bharti,

    Regards,
    Surekha.

  • Surekha Verma commented
    2 Sep, 2021 07:42pm

    Hi Govind,

    Thanks for your mail.
    When sending a Project update PUT request, we need to send custom field values and details in the request payload.

    Below is a sample of the custom field's details.
    "fieldId": 1003,
    "fieldName": "zcf_1003",
    "displayName": "Project Lead",
    "fieldTypeMetadata": 1,
    "id": 555

    So, a rest API which would return above information when searched by "displayName" would be helpful when we switch between different Zephyr instances.

    Regards,
    Surekha.

  • Admin
    govind drolia commented
    2 Sep, 2021 04:29pm

    Hello Surekha,

    Thank you for submitting the Idea.

    Could you Please let me know what API you are using for this detail?


    Thanks

    Govind