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

Applies to QAComplete 12.70 SaaS, last modified on January 11, 2021

Returns the information on automation assigned to a test.

Use the operation to get the information on the automation specified by the agent name, the ID of the test, to which it is assigned, and the project, to which the test belongs.

To get information on all automations the QAComplete project contains, use the …/tests/{TestId}/automations (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 Test Library.

Request Format

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

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

ProjectId  :  integer, required

The ID of the project to which the test belongs.

TestId  :  integer, required

The ID of the 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 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

Response Format

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

A sample response:

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


{
        "agent": "TestComplete/TestExecute",
        "title": "TCProjectSuite\\Orders_Project\\Script\\Orders\\addRecord",
        "timeout": 60,
        "run_mode": 0,
        "params": {
          "entry_point": "Orders_Projects\\Script\\Orders\\addRecord"
        }
  }

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

Automations Resources

Highlight search results