Returns the history of the specified item.
Use the operation to get the history of the item specified by its ID it has in the specified project.
Authentication
Basic authentication using a user’s login and password. See Authentication for details.
Security Rights
The authenticating user must have the Read privilege for the entity (defects, tests and so on).
Request Format
To get the item history, send a GET request to the following URL:
Offset : integer
The number of audits to skip before counting the returned audits.
Limit : integer
The maximum number of audits to return.
ProjectId : integer, required
The ID of the project the item belongs to.
EntityCode : string, required
The type of the item whose history you want to get. Possible values:
- Releases
- Bugs (defects)
- FunctionalSpecs (requirements)
- Tests
- TestSets
- TestSteps
EntityId : integer, required
The ID of the item whose history you want to get.
Filter : string
The filter expression to apply to the list of audits.
A sample request:
GET http://yourserver.com/rest-api/service/api/v2/projects/11873/tests/2 HTTP/1.1
Host: yourserver.com
Connection: keep-alive
Accept: application/json
Authorization: Basic am9obkBleGFtcGxlLmNvbTpwQHNzd29yZA==
A sample request made by using cURL:
curl -u [email protected]:p@ssword -H "Accept: application/json" http://yourserver.com/service/api/v2/projects/11873/tests/2
Response Format
On success,the operation responds with HTTP status code 200 and returns a JSON object with information on the item history.
A sample response:
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 406
{
"metadata": {
"result_set": {
"count": 2,
"offset": 0,
"limit": 25,
"total": 2
},
"permissions": {
"acl": 0
}
},
"results": [
{
"title": "Updated Description",
"old_value": "N/A",
"new_value": "361",
"update_user": "Smith, John"
"date_created": "2020-06-05T17:11:27.3000000"
},
{
"title": "Updated Version",
"old_value": "1",
"new_value": "2",
"update_user": "Smith, John",
"date_created": "2020-06-05T17:11:26.9900000",
},
]
}
Metadata about the audit list.
Pagination information on the result set. (See Paging Through Results Using Offset and Limit.)
The number of returned items.
The offset of the first item requested.
The maximum number of items requested.
The total number of items.
The authenticating user’s rights for the returned items.
Access rights:
- 0 - None
- 1 - Read
- 2 - Update
- 3 - Read and update
- 4 - Delete
- 5 - Read and delete
- 7 - Full access
An array of audits.
The name of the item.
The old value of the item.
The new value of the item.
The ID of the user who last updated the item.
The date and time when the record about the item was created.
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.