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

Applies to QAComplete 12.90 SaaS & On-Premises, last modified on September 09, 2021

Updates the specified fields of an automation attachment in QAComplete.

Use this operation to update individual fields of an existing automation attachment in QAComplete test.

To add a new attachment, use the …/tests/{TestId}/automations/{Agent}/attachment (POST) operation.

To update the whole attachment, use the …/tests/{TestId}/automations/{Agent}/attachment (PUT) 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 attachment, send a PATCH request to the following URL:

http://{server}/rest-api/service/api/v2/projects/{ProjectId}/tests/{TestId}/automations/{Agent}/attachment?Link={link}&Comments={comments}
URL parameters

ProjectId  :  integer, required

The ID of the project.

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.

Link  :  string

The URL or UNC path to the attachment.

Comment  :  string

Comment to the attachment. Can include HTML markup.

File  :  

The file to attach.

Body parameters

In the request body, pass the RequestAutomationAttachmentPatch JSON object that specifies the attachment’s fields to update:

{
"FileName": "string",
"FileFormatCode": "string",
"DateCreated": "Date",
"DateUpdated": "Date",
"UpdateUserId": "int",
"UserName": "string"
}

FileName  :  string

The name of the attachment file.

FileFormatCode  :  string

The file format code for the attachment file.

DateCreated  :  dateTime

The date and time when the attachment was created.

DateUpdated  :  dateTime

The date and time the attachment was last updated.

UpdateUserId  :  integer

The ID of the user who updated the attachment last time.

UserName  :  string

The name of the user who updated the attachment last time.

A sample request:

PATCH http://yourserver.com/rest-api/service/api/v2/projects/11953/tests/2696/nunit/attachment?http%3A%2F%2Fexample.com%2samples%2Forders.zip HTTP/1.1
Host: yourserver.com
Connection: keep-alive
Content-Type: application/json
Accept: application/json
Authorization: Basic am9obkBleGFtcGxlLmNvbTpwQHNzd29yZA==
Content-Length: 37

{
"FileName": "OrdersListTest.zip"
}

A sample request made by using cURL:

curl -u john@example.com:p@ssword -d {"FileName": "OrdersListTest.zip"} -H "Content-Type: application/json" -H "Accept: application/json" http://yourserver.com/service/api/v2/projects/11953/tests/2696/nunit/attachment

Response Format

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

A sample response:

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


{
        "file_name": "OrdersListTest.zip",
        "link": "http%3A%2F%2Fexample.com%2samples%2Forders.zip",
        "file_format_code": "PKZip File",
        "date_created": "2016-07-14T12:10:34.3070000",
        "date_updated": "2016-07-14T12:10:34.3070000",
        "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.

If the test with the specified Id does not exist, the operation returns the File or directory not found error.

See Also

Automation Attachments Resources

Highlight search results