Help Contents

 

Automated Test Run

Resource: Automated Test Run ( /api/automatedtestrun/{id} )

Automated Test Run resource

This resource supports the following methods: DELETE, GET

Methods

DELETE


Deletes an automated test run by its unique identifier.

Required Permissions

  • TestManagement/ManageExecutions/Delete

Status Codes

These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
200 - OKReturned if request completed successfully.
403 - ForbiddenReturned if the required permissions to delete this automated test run have not been met.
404 - NotFoundReturned if no automated test run with the specified identifier exists.

Example - DELETE

An example of deleting a automated test run.

Request Parameters

KeyValueDescription
{id}4bb709c2-e0e7-4af3-9f60-a045016a9610The unique identifier of the automated test run to delete.

Status Code

200 - OK

GET


Retrieves an automated test run by ID.

This method supports the TQL query parameters tql, $top, $take and $inlinecount. See TQL Topic for more details.

Required Permissions

  • TestManagement/ManageExecutions/View

Supported Expansions

For more details on expansions, please see the Expand help topic.

Status Codes

These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
200 - OKReturned if the request was completed successfully.
403 - ForbiddenReturned if ET could not complete request (normally due to a validation failure or you don't have the necessary permissions to complete the request).

Example - GET

Retrieves automated test run by identifier.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
id02cbe373-a042-4f7b-8ba3-e03b1588dbfaThe unique identifier of the automated test run.

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

{
  "RunByDisplayName": "joeb",
  "RunBy": "joeb",
  "RunById": "191375f2-ae6e-4b52-8bed-4192e34b6486",
  "AssignmentId": "979ce5f8-efb7-432d-8848-c9cdf3151977",
  "Id": "02cbe373-a042-4f7b-8ba3-e03b1588dbfa",
  "Status": "Passed",
  "ImportedAt": "2013-01-16T16:15:00Z",
  "StartedAt": "2013-01-16T15:05:06Z",
  "FinishedAt": "2013-01-15T16:00:00Z",
  "Expands": [
    "Assignment",
    "Totals"
  ],
  "Self": "http://localhost/api/automatedtestrun/02cbe373-a042-4f7b-8ba3-e03b1588dbfa"
}

Status Code

200 - OK

Example - GET (expand Totals)

Retrieves an automated test run with the Totals included.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
id02cbe373-a042-4f7b-8ba3-e03b1588dbfaThe unique identifier of the automated test run.
$expandTotals

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

{
  "RunByDisplayName": "joeb",
  "RunBy": "joeb",
  "RunById": "191375f2-ae6e-4b52-8bed-4192e34b6486",
  "AssignmentId": "979ce5f8-efb7-432d-8848-c9cdf3151977",
  "Id": "02cbe373-a042-4f7b-8ba3-e03b1588dbfa",
  "Status": "Passed",
  "ImportedAt": "2013-01-16T16:15:00Z",
  "StartedAt": "2013-01-16T15:05:06Z",
  "FinishedAt": "2013-01-15T16:00:00Z",
  "Expands": [
    "Assignment"
  ],
  "Totals": {
    "Errors": 0,
    "Failed": 0,
    "Iterations": 0,
    "NotRun": 0,
    "Passed": 10,
    "Skipped": 0,
    "Warnings": 0,
    "Done": 0,
    "Infos": 0,
    "TotalNodes": 10,
    "TotalResults": 10
  },
  "Self": "http://localhost/api/automatedtestrun/02cbe373-a042-4f7b-8ba3-e03b1588dbfa"
}

Status Code

200 - OK