Support

Expand all | Collapse all

{REST API} Update test run custom field

  • 1.  {REST API} Update test run custom field

    Posted 12-07-2020 04:55

    Hello,

    I'm trying to update custom field in test run via REST API. Currently without success. What I tried:

    PATCH operation in both ways (when it was already populated or was empty):

    {
    "op": "replace",
    "path": "/fields/setup_id$89",
    "value": "XXX-10"
    }

    and 

    {
    	"op": "add",
    	"path": "/fields/setup_id$89",
    	"value": "XXX-10"
    }

    Also I tried PUT operation with copying all "fields" items and changing only desired field.

    On all tries I had "OK" response from JAMA server, but value wasn't updated.



    ------------------------------
    Michal Stanczyk

    ------------------------------


  • 2.  RE: {REST API} Update test run custom field

    Posted 12-10-2020 16:18
    Hi Michal,

    Thanks for reaching out! The PUT and PATCH does not allow this on our API. 


    You can only change the execution results field, but no other fields can be updated with our API. 

    Please let me know if you have any questions. 

    ------------------------------
    Decoteau Wilkerson
    Jama Software
    OR
    ------------------------------



  • 3.  RE: {REST API} Update test run custom field

    Posted 12-11-2020 00:06
    Hi,

    Are you going to fix this? or there is any other rest method which can be used to update custom fields in the test run? It looks like a bug to be honest.

    It's possible to update custom field via GUI so I do not understand why it's not possible to do this via REST API?

    Thanks in advance,
    Bartek

    ------------------------------
    Bartek LastName
    S3 Group
    ------------------------------



  • 4.  RE: {REST API} Update test run custom field

    Posted 12-11-2020 15:33
    Hi Bartek,

    That's a good catch. I had thought we could update test run custom fields via the API, but I missed confirming that in the requirements. I've added it to our backlog to take a look at adding this capability in soon.

    Best,
    Robin

    ------------------------------
    Robin Calhoun
    Product Manager
    Jama Software
    ------------------------------



  • 5.  RE: {REST API} Update test run custom field

    Posted 09-13-2021 12:17
    Hello Robin,

    Is there a place I can watch to see if or when this will be implemented into the Jama REST API? Thank you.

    Sincerely,
    Michael Riegert

    ------------------------------
    Michael Riegert
    ------------------------------



  • 6.  RE: {REST API} Update test run custom field

    Posted 09-13-2021 14:50

    Hi Michael,

    Thanks for reaching out! It looks like this feature was release in 8.62.

    From the 8.62 Release Notes:

    REST API updates

    The REST API now supports PUT and PATCH for custom fields in a test run to align with recent updates in UI. These options are available with /v1 and were previously available only within /labs.


    Please let me know if this works or if you have questions! 



    ------------------------------
    Decoteau Wilkerson
    Jama Software
    OR
    ------------------------------



  • 7.  RE: {REST API} Update test run custom field

    Posted 09-14-2021 10:49
    Hello Decoteau,

    Thank you! That's exactly what I was looking for. It does say this feature was available through the `/labs` endpoint in previous versions of Jama, and I've tested it and it works. Are there any downsides or pitfalls I could run into using the `/labs` endpoint? Thank you.


    ------------------------------
    Michael Riegert
    ------------------------------



  • 8.  RE: {REST API} Update test run custom field

    Posted 09-14-2021 16:33
    Hi Michael,



    ------------------------------
    Decoteau Wilkerson
    Jama Software
    OR
    ------------------------------