REST API - "testSteps[0] is not a valid testSteps row value" Error When Trying to Add Test Steps

Description

When trying to update the test steps for a test case through Legacy REST API (v1), for example,

PUT  [http://localhost:8080/rest/item/]

{
    "uri": "/item/1001",
    "testSteps": [
        [
            "My Action",
            "My Expected Result",
            false,
            null
        ]
    ]
}

the server returns the following error:

{
    "exception": "IllegalArgumentException",
    "message": "\"testSteps[0]\" is not a valid \"testSteps row\" value."
}

Observed on

• Codebeamer 22.10-LTS (GINA)

Solution

We recommend to use the latest and supported Swagger V3 instead. See a sample request below:

PUT /v3/items/{itemId}/fields


{
  "tableValues": [
    {
      "fieldId": 1000000,
      "name": "Test Steps",
      "values": [
        [
          {
            "fieldId": 1000001,
            "name": "Action",
            "value": "Swagger Action",
            "sharedFieldNames": [],
            "type": "WikiTextFieldValue"
          },
          {
            "fieldId": 1000002,
            "name": "Expected result",
            "value": "Swagger Expected Result",
            "sharedFieldNames": [],
            "type": "WikiTextFieldValue"
          },
          {
            "fieldId": 1000003,
            "name": "Critical",
            "value": false,
            "sharedFieldNames": [],
            "type": "BoolFieldValue"
          }
        ]
      ],
      "type": "TableFieldValue"
    }
  ]
}

In case of using the legacy Legacy REST API (v1), the JSON request should always account for all the columns under the Test Steps field.

1. Go to Configuration ► Fields
2. Select the Show hidden fields checkbox at the top
3. Observe the Test Steps table.

For example, on Codebeamer release 22.10-LTS (GINA), Test Step Reuse is added by default:
Therefore, a working request is:

PUT  [http://localhost:8080/rest/item/]

{
    "uri": "/item/1001",
    "testSteps": [
        [
            "My Action",
            "My Expected Result",
            false,
            null,
            ""
        ]
    ]
}

Additional Information

• Test Case tracker
• Modifying a specific field on a tracker item
• Edit an existing item

For any other Support options, questions, or inputs, visit: https://intland.com/technical-support/.