Updates the specified test run item in the specified test set.
Use the operation to update the test run item.
Authentication
Basic authentication using a user’s login and password. See Authentication for details.
Security Rights
The authenticating user must belong to a security group that has the Update privilege for Test Library.
Request Format
To update the test run item, send a PATCH request to the following URL:
URL parameters
ProjectId : integer, required
The ID of the project, to which the test run belongs.
Id : integer, required
The ID of the test run, whose item you want to update.
ItemId : integer, required
The ID of the test run item, which you want to update.
Body parameters
In the request body, pass the RequestTestRunItemPatch JSON object that describes the test set item to be updated:
{
"Critical": "boolean",
"RunTime": "int",
"RunByUserId": "int",
"RunByHostId": "int",
"SaveToTestLibrary": "boolean",
"StatusCode": "string",
"Steps": [
{
"Seq": "int",
"StepName": "string",
"StatusCode": "string",
"TestStepId": "int",
"TestRunResultId": "int",
"ExpectedResult": "string",
"ActualResult": "string",
"Critical": "boolean"
}
]
}
Some string property values (for example, StatusCode) are based on the choice lists defined in your QAComplete project. You can find these values on the Test Management > Test Library > Tools > Manage Choice Lists panel in QAComplete.
Critical : boolean
Defines whether the test run item is critical.
RunTime : integer
The total test run item run time (in seconds).
RunByUserId : integer
Specifies the ID of the user who ran the test run item.
RunByHostId : integer
Specifies the ID of the host used to run the test run item.
StatusCode : string, required
Specifies the status code of the test run item.
Steps : array of objects
An array of TestStepItem objects that describe test step items to be added to the test run.
 |
That field is not required, but if you will use it to add objects, these must have values specified in required fields (see below). |
Seq : integer
Specifies new test step item’s sequence number.
StepName : string, required
The name of the new test step item.
StatusCode : string, required
The status code of the new test step item.
TestStepId : integer
The ID of the test step corresponding to the new test run item.
TestRunResultId : integer, required
The ID of the test run result for the new test run item.
ExpectedResult : string, required
The new test run item’s expected result.
ActualResult : string, required
The new test run item’s actual result.
Critical : boolean
Defines if the new test run item is critical.
A sample request:
PATCH http://yourserver.com/rest-api/service/api/v2/projects/11946/testruns/2316/items/13003 HTTP/1.1
Host: yourserver.com
Connection: keep-alive
Content-Type: application/json
Accept: application/json
Authorization: Basic am9obkBleGFtcGxlLmNvbTpwQHNzd29yZA==
Content-Length: 74
{
"RunTime": 220,
"StatusCode": "New"
}
A sample request made by using cURL:
curl -u [email protected]:p@ssword -d @testrunitem.txt -H "Content-Type: application/json" -H "Accept: application/json" http://yourserver.com/service/api/v2/projects/11946/testruns/2316/items/13003
Response Format
If successful, the operation returns an empty response with HTTP status code 200.
Error responses
If the operation fails, it returns the appropriate status code and (optionally) the error description in the response body.
If the project with the specified ProjectId does not exist or the authenticating user does not have rights to access the project, the operation returns the Access is denied error.