GET/projects/{ProjectId}/tests/{TestId}/automations/{Agent}/attachment

Applies to QAComplete 12.84 SaaS, last modified on July 19, 2021

Returns information on a specified automation attachment.

Use this operation to get information on the attachment of the automation (test files to run), specified by the name of the agent that will run the automation, the ID of the test to which the automation is assigned, and the project, to which the test belongs.

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 Test Library.

Request Format

To get information on an attachment, send a GET request to the following URL:

http://{server}/rest-api/service/api/v2/projects/{ProjectId}/tests/{TestId}/automations/{Agent}/attachment

ProjectId  :  integer, required

The ID of the project to which the test belongs.

TestId  :  integer, required

The ID of the needed test.

Agent  :  string, required

The URL-encoded or the short name of the automation agent (test runner).

Currently, REST API supports the following agents:

Agent URL-encoded Name Short Name
TestComplete/TestExecute TestComplete%2FTestExecute testcomplete
JUnit (Selenium) JUnit%20%28Selenium%29 junit
NUnit (Selenium) NUnit%20%28Selenium%29 nunit
TestNG (Selenium) TestNG%20%28Selenium%29 testng
ReadyAPI / SoapUI OS ReadyAPI+%2F+SoapUI+OS readyapi

The agent names are case-insensitive.

A sample request:

GET http://yourserver.com/rest-api/service/api/v2/projects/11953/tests/2693/automations/testcomplete/attachment 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/v2/projects/11953/tests/2693/automations/testcomplete/attachment

Response Format

If successful, 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: 201


{
        "file_name": "Orders.zip",
        "file_format_code": "PKZip File",
        "date_created": "2012-07-14T12:10:34.3070000",
        "date_updated": "2012-07-29T15:15:14.2580000",
        "update_user_id: 24561,
        "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.

See Also

Automation Attachments Resources

Highlight search results