Date: Fri, 29 Mar 2024 16:01:12 +0000 (UTC) Message-ID: <1016593762.12795.1711728072319@catch-kbase-p> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_12794_582544270.1711728072318" ------=_Part_12794_582544270.1711728072318 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Automated Test Runs collection resource.
Root Relation: AutomatedTestRuns
This resource supports the following methods: GET
Retrieves all (or a subset) of automated test runs that are visible to t= he user.
This method supports the TQL query parameters tql, $top, $take and $inli= necount. See TQL Topic for more details.=
For more details on expansions, please see the Expand help topic.
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successful= ly. |
403 - Forbidden | Returned if ET would not complete request (norma= lly due to a validation failure or you don't have the necessary permissions= to complete the request). |
Retrieves automated test runs matching a TQL query.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
tql | Status =3D Passed | The TQL query to execute. |
$top | 5 | The maximum number of results to return (default= s to 25). |
$skip | 0 | The number of results to skip before return the = $top number of results matching the query. |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "Skip": 0, "Top": 5, "Total": 1, "Items": [ { "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-8ba= 3-e03b1588dbfa" } ], "Self": "http://localhost/api/api/automatedtestruns?tql=3DStatus=3DPassed= &$top=3D5&$skip=3D0" }
Status Code
200 - OK
Retrieves all automated test runs
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
$top | 5 | The maximum number of results to return (default= s to 25). |
$skip | 0 | The number of results to skip before return the = $top number of results matching the query. |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "Skip": 0, "Top": 5, "Total": 2, "Items": [ { "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-8ba= 3-e03b1588dbfa" }, { "RunByDisplayName": "joeb", "RunBy": "joeb", "RunById": "191375f2-ae6e-4b52-8bed-4192e34b6486", "AssignmentId": "979ce5f8-efb7-432d-8848-c9cdf3151977", "Id": "02cbe373-a042-4f7b-8ba3-e03b1588dbfa", "Status": "Failed", "ImportedAt": "2013-01-17T16:15:00Z", "StartedAt": "2013-01-17T15:05:06Z", "FinishedAt": "2013-01-17T16:06:00Z", "Expands": [ "Assignment", "Totals" ], "Self": "http://localhost/api/automatedtestrun/02cbe373-a042-4f7b-8ba= 3-e03b1588dbfa" } ], "Self": "http://localhost/api/api/automatedtestruns?$top=3D5&$skip=3D= 0" }
Status Code
200 - OK
Retrieves all automated test runs, including Totals
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
$top | 5 | The maximum number of results to return (default= s to 25). |
$skip | 0 | The number of results to skip before return the = $top number of results matching the query. |
$expand | Totals |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "Skip": 0, "Top": 5, "Total": 2, "Items": [ { "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-8ba= 3-e03b1588dbfa" }, { "RunByDisplayName": "joeb", "RunBy": "joeb", "RunById": "191375f2-ae6e-4b52-8bed-4192e34b6486", "AssignmentId": "979ce5f8-efb7-432d-8848-c9cdf3151977", "Id": "02cbe373-a042-4f7b-8ba3-e03b1588dbfa", "Status": "Failed", "ImportedAt": "2013-01-17T16:15:00Z", "StartedAt": "2013-01-17T15:05:06Z", "FinishedAt": "2013-01-17T16:06:00Z", "Expands": [ "Assignment" ], "Totals": { "Errors": 2, "Failed": 0, "Iterations": 0, "NotRun": 0, "Passed": 0, "Skipped": 8, "Warnings": 0, "Done": 0, "Infos": 0, "TotalNodes": 10, "TotalResults": 10 }, "Self": "http://localhost/api/automatedtestrun/02cbe373-a042-4f7b-8ba= 3-e03b1588dbfa" } ], "Self": "http://localhost/api/api/automatedtestruns?$expand=3DTotals&= $top=3D5&$skip=3D0" }
Status Code
200 - OK