Join Wintertainment 2021 to share your stories, have fun, earn community badges, and more!

GET/projects/{ProjectId}/{EntityCode}/{EntityId}/linkeditems/{Id}

Applies to QAComplete 12.94 SaaS, last modified on December 06, 2021

Gets information on a linked item from QAComplete.

Use the operation to get information on a linked item specified by the link’s ID and by the ID and entity code of the item to which the link is added.

To get a list of all items linked to an item, use the /projects/{ProjectId}/{EntityCode}/{EntityId}/linkeditems operation.

In QAComplete, you can view linked items on the Edit form for the needed 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 Read privilege for the entity (Defects, Tests, and so on) that contains the linked item.

Request Format

To get information on a linked item, send a GET request to the following URL:

http://{server}/rest-api/service/api/v1/projects/{ProjectId}/{EntityCode}/{EntityId}/linkeditems/{Id}

ProjectId  :  integer, required

The ID of the project, to which the item belongs.

EntityCode  :  string, required

The type of an item being linked. Possible values:

  • Releases
  • Bugs (defects)
  • FunctionalSpecs (requirements)
  • Tests
  • TestSets
  • TestSteps

EntityId  :  integer, required

The ID of an item being linked.

Id  :  integer, required

The ID of the link that you want to get.

A sample request:

GET http://yourserver.com/rest-api/service/api/v1/projects/11873/FunctionalSpecs/1663742/linkeditems/3277942 HTTP/1.1
Host: yourserver.com
Connection: keep-alive
Accept: application/json
Authorization: Basic am9obkBleGFtcGxlLmNvbTpwQHNzd29yZA==

A sample request made by using cURL:

curl -u john@example.com:p@ssword -H "Accept: application:json" http://yourserver.com/service/api/v1/projects/11873/functionalspecs/1663742/linkeditems/3277942

Response Format

If successful, the operation responds with HTTP status code 200 and returns a JSON object with the link information.

A sample response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 388



{
  "link_id": 3277942,
  "entity_code": "Bugs",
  "entity_id": 3714539,
  "linked_entity_code": "FunctionalSpecs",
  "linked_entity_id": 1663742,
  "title": "Sample Requirement",
  "is_active": true,
  "status": "Active",
  "date_updated": "2017-04-10T12:16:26.7730000",
  "update_user_id": 135027,
  "updated_user_name": "Smith, John"
}

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, or a linked item with the specified Id does not exist, the operation returns the File or directory not found error.

See Also

Linked Items Resources

Highlight search results