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

Applies to QAComplete 12.92 SaaS, last modified on October 13, 2021

Updates the specified automation in a QAComplete test.

Use the operation to replace the contents of the existing automation in QAComplete with new contents.

To update individual fields of the existing automation, use the …/tests/{TestId}/automations/{Agent} (PATCH) operation.

To add new automation, use the …/tests/{TestId}/automations/{Agent} (POST) 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 Update privilege for Test Library.

Request Format

To update the test, send a PUT request to the following URL:

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

ProjectId  :  integer, required

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

Id  :  integer, required

The ID of the test the needed automation belongs to.

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.

Body parameters

Link  :  string, required

The URL or UNC path to the attachment.

Comment  :  string

Comment to the attachment. Can include HTML markup.

File  :  

The file to attach.

A sample request:

PUT http://yourserver.com/rest-api/service/api/v2/projects/11873/tests/2693/automations/nunit HTTP/1.1
Host: yourserver.com
Connection: keep-alive
Content-Type: application/json
Accept: application/json
Authorization: Basic am9obkBleGFtcGxlLmNvbTpwQHNzd29yZA==
Content-Length: 63

{
"Title": "TheAutomatedTest",
"RunMode": 1,
"Timeout": 60
}

A sample request made by using cURL:

curl -u john@example.com:p@ssword -d @automations.txt -H "Content-Type: application/json" -H "Accept: application/json" http://yourserver.com/service/api/v2/projects/11873/tests/2693/automations/nunit

Response Format

If successful, the operation responds with HTTP status code 200. The response is a JSON object with information on the updated automation.

A sample response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 119


{
  "agent": "ReadyAPI / SoapUI OS",
  "title": "TheAutomatedTest",
  "timeout": 60,
  "run_mode": 1,
  "params": {
    "report_type": CSV
  }
}

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

See Also

Automations Resources

Highlight search results