Gets information on an attachment from QAComplete.
Use the operation to get information on an attachment (a file, URL or UNC path) by its ID and by the ID and type of the item to which the attachment belongs.
In QAComplete, you can view attachments on the Files tab of 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 attachment.
Request Format
To get information on an attachment, 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, whose attachment you want 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 has attachment.
Id : integer, required
The ID of the attachment you want to get.
A sample request:
GET http://yourserver.com/rest-api/service/api/v1/projects/11873/Bugs/12/files/2013 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/Bugs/12/files/2013
Response Format
On success, the operation responds with HTTP status code 200 and returns a JSON object with information about the attachment.
A sample response:
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 293
{
"attachment_type_code": "File",
"file_name": "data.txt",
"title": "data.txt",
"comments": "comment 1",
"date_created": "2015-06-29T11:41:55.3970000",
"date_updated": "2015-06-29T11:41:55.3970000",
"entity_code": "Bugs",
"entity_id": 0,
"update_user_id": 24663,
"user_name": "Smith, John"
}
The type of the attachment. Always File.
For files, this is the file name of the zipped attachment in the QAComplete database.
For web links (URLs) and UNC paths, this is the same value as file_name.
The user-friendly name (title) of the attachment. In QAComplete, you can enter the title manually when adding the attachment, or QAComplete will set the title automatically using the file name, URL or UNC path.
Comments for the attachment. Can include HTML markup.
The date and time the attachment was created.
The date and time the attachment was last updated.
The ID of the user who last updated the attachment.
The name of the user who last updated the attachment (in the LastName, FirstName format).
The ID of the QAComplete item (a requirement, defect and so on) that contains the attachment.
The type of the item to which the file is attached:
- Releases
- Bugs (defects)
- FunctionalSpecs (requirements)
- Tests
- TestSets
- TestSteps
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 an attachment with the specified Id does not exist, the operation returns the File or directory not found error.