Updates the fields of a test set item specified by its position in a test set.
Use the operation to update individual fields of an existing test set item specified by its position in the test set.
To add a new test set item, use the …/testsets/{Id}/items/{Seq} (POST) operation.
To update all the fields of a test, use the …/testsets/{Id}/items/{Seq} (PUT) operation.
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 Sets.
Request Format
To update the test set item, send a PATCH request to the following URL:
URL parameters
Id : integer, required
The ID of the test set whose item you want to update.
ProjectId : integer, required
The ID of the project to which the test set belongs.
Seq : integer, required
The ordinal number of the test set item you want to update.
Body parameters
In the request body, pass the RequestTestSetItemBySeqPatch JSON object that specifies the test set item’s fields to be updated:
"IsActive": "boolean",
"IsStoppedOnFail": "boolean",
"AssigneeUserId": "int",
"DefaultHostId": "int"
}
The property values you do not specify remain unchanged.
IsActive : boolean
Specifies whether the test set item is enabled (active).
IsStoppedOnFail : boolean
Specifies whether the test set run will stop when the item fails.
AssigneeUserId : integer
The ID of the user to whom the item is assigned. 0 if the item is not assigned to anyone.
DefaultHostId : integer
The ID of the host to which the item is assigned. 0 if the item is not assigned to any host.
A sample request:
PATCH http://yourserver.com/rest-api/service/api/v1/projects/11873/testsets/182/items/2 HTTP/1.1
Host: yourserver.com
Connection: keep-alive
Content-Type: application/json
Accept: application/json
Authorization: Basic am9obkBleGFtcGxlLmNvbTpwQHNzd29yZA==
Content-Length: 49
{
"AssigneeUserId": 0,
"DefaultHostId": 177
}
A sample request made by using cURL:
curl -u [email protected]:p@ssword -d {"AssigneeUserId": "0", "DefaultHostId": "177"} -H "Content-Type: application/json" -H "Accept: application/json" http://yourserver.com/service/api/v1/projects/11873/testsets/182/items/2
Response Format
If successful, the operation responds with HTTP status code 200 and returns a JSON object with the updated information on the test set item.
A sample response:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 377
{
"id": 1513,
"project_id": 11873,
"test_set_id": 182,
"test_id": 2678,
"seq": 2,
"is_active": true,
"is_stopped_on_fail": true,
"assignee_user_id": 0,
"default_host_id": 177,
"date_created": "2015-07-31T10:19:10.5870000",
"date_updated": "2015-08-09T09:27:45.6700000",
"create_user_id": 24714,
"update_user_id": 24714,
"title": "Test input data",
"nbr_steps": 0,
"nbr_files": 0,
"nbr_notes": 0
}
The ID of the project to which the test set item belongs.
The unique identifier of the item.
The ID of the test to which the item corresponds.
The ordinal number of the item in the test set.
The ID of the host to which the item is assigned.
The date when the test set item was created.
The date when the test set item was last modified.
The ID of the user who created the test set item.
The ID of the last user who modified the test set item.
The number of files attached to the test set item.
The ID of the test set to which the item belongs.
Specifies whether the test set item is enabled (active).
The ID of the user to whom the item is assigned. 0 if the item is not assigned to anyone.
The title (name) of the test to which the test set item corresponds.
The number of notes attached to the test set.
The number of steps the test set item has.
Specifies whether the test set run will stop when the item fails.
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.