Returns the list of linked items for the specified item (a defect, requirement, and so on) in QAComplete.
Use the operation to get a list of linked items for the specified item (a defect, requirement, and so on). To specify the item, the linked items of which you need to get, use the item’s ID and entity code (item type), as well as the ID of the project, to which the item belongs.
In QAComplete, you can view linked items on the Edit form for the needed item.
To get the data for a specific link, use the …/linkeditems/{Id} (GET) 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 Read privilege for the entity (Defects, Tests, and so on) that includes linked items.
Request Format
To get information on linked items, send a GET request to the following URL:
ProjectId : integer, required
The ID of the project, to which the item belongs.
EntityCode : string, required
The type of the item, which links you need to get. Possible values:
- Releases
- Bugs (defects)
- FunctionalSpecs (requirements)
- Tests
- TestSets
- TestSteps
EntityId : integer, required
The ID of the item (a defect, requirement, and so on) that contains linked items.
offset : integer, default: 0
The number of linked items to skip before counting the returned links. The default value is 0, which is the offset of the first item. For details, see Paging Through Results Using Offset and Limit.
limit : integer, default: 25
The maximum number of linked items to return in the response.
A sample request:
GET http://yourserver.com/rest-api/service/api/v1/projects/11873/FunctionalSpecs/1663742/linkeditems 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/v1/projects/11873/FunctionalSpecs/1663742/linkeditems
Response Format
If successful, the operation responds with HTTP status code 200 and returns a JSON object with the information on links.
A sample response:
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 617
{
"metadata": {
"result_set": {
"count": 1,
"offset": 0,
"limit": 25,
"total": 1
},
"permissions": {
"acl": 7
}
},
"results": [
{
"link_id": 3277941,
"entity_code": "FunctionalSpecs",
"entity_id": 1663742,
"linked_entity_code": "Releases",
"linked_entity_id": 145908,
"title": "Test",
"is_active": true,
"status": "In Progress",
"date_updated": "2017-04-06T07:33:01.5600000",
"update_user_id": 135027,
"updated_user_name": "Smith, John"
}
]
}
Metadata on the list of linked items.
Pagination information about the list of linked items. (See Paging Through Results Using Offset and Limit).
The number of returned linked items.
The offset of the first linked item requested.
The maximum number of linked items requested.
The total number of the item’s links.
The authenticating user’s rights to access linked 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 linked items.
The link’s ID.
The type of the link’s target item.
The ID of the link’s target item.
The type of an item being linked.
The ID of an item being linked.
The title of an item being linked.
Defines if the link is active.
The status of an item being linked.
The date and time of the link’s last update.
The ID of a user, who updated the link last time.
The name of a user, who updated the link last time.
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.
If an item with the specified EntityCode or EntityId does not exist, the operation returns the File or directory not found error.