Date: Thu, 28 Mar 2024 23:45:58 +0000 (UTC) Message-ID: <533134063.10159.1711669558170@catch-kbase-p> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_10158_1851708490.1711669558170" ------=_Part_10158_1851708490.1711669558170 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Automated Test Assignments collection resource.
Root Relation: AutomatedTestAssignments
This resource supports the following methods: GET, = POST
Retrieves all (or a subset) of automated test assignments that are visib= le associated with the automated test. This method takes a TQL query.
This method supports the TQL query parameters tql, $top, $take and $inli= necount. See TQL Topic for more details.<= /p>
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 is completed successfull= y. |
Retrieves automated test assignments matching a TQL query.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
tql | Name ~ 'Report' | 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": [ { "Id": "3fa6ec13-3939-45b6-beb1-dd03e00a83f9", "AutomatedTestId": "c6173eab-f684-4d35-8ca7-62851b8df0e1", "Name": "Report output paging", "Status": "Not Run", "AssignedTo": "joeb", "AssignedToId": "b2a74983-e374-41d4-bf49-bc3c9a5f0e89", "PackageId": "f6ed1282-bd89-4f8f-8e94-47e344bba905", "Expands": [ "Package" ], "Self": "http://localhost/api/automatedtestassignment/3fa6ec13-3939-4= 5b6-beb1-dd03e00a83f9", "Links": [ { "Href": "http://localhost/api/automatedtestassignment/3fa6ec13-39= 39-45b6-beb1-dd03e00a83f9/allrelationships", "Rel": "AllRelationships" }, { "Href": "http://localhost/api/automatedtest/c6173eab-f684-4d35-8c= a7-62851b8df0e1", "Rel": "AutomatedTest" }, { "Href": "http://localhost/api/executionpackage/f6ed1282-bd89-4f8f= -8e94-47e344bba905", "Rel": "ExecutionPackage" }, { "Href": "http://localhost/api/automatedtestassignment/3fa6ec13-39= 39-45b6-beb1-dd03e00a83f9/relationships", "Rel": "Relationships" }, { "Href": "http://localhost/api/automatedtestassignment/3fa6ec13-39= 39-45b6-beb1-dd03e00a83f9/runs", "Rel": "Runs" } ] } ], "Self": "http://localhost/api/api/automatedtestassignments?tql=3DName~'Re= port'" }
Status Code
200 - OK
Retrieves all automated test assignments, across all projects.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "Skip": 0, "Top": 25, "Total": 2, "Items": [ { "Id": "3fa6ec13-3939-45b6-beb1-dd03e00a83f9", "AutomatedTestId": "c6173eab-f684-4d35-8ca7-62851b8df0e1", "Name": "Report output paging", "Status": "Not Run", "AssignedTo": "joeb", "AssignedToId": "b2a74983-e374-41d4-bf49-bc3c9a5f0e89", "PackageId": "f6ed1282-bd89-4f8f-8e94-47e344bba905", "Expands": [ "Package" ], "Self": "http://localhost/api/automatedtestassignment/3fa6ec13-3939-4= 5b6-beb1-dd03e00a83f9", "Links": [ { "Href": "http://localhost/api/automatedtestassignment/3fa6ec13-39= 39-45b6-beb1-dd03e00a83f9/allrelationships", "Rel": "AllRelationships" }, { "Href": "http://localhost/api/automatedtest/c6173eab-f684-4d35-8c= a7-62851b8df0e1", "Rel": "AutomatedTest" }, { "Href": "http://localhost/api/executionpackage/f6ed1282-bd89-4f8f= -8e94-47e344bba905", "Rel": "ExecutionPackage" }, { "Href": "http://localhost/api/automatedtestassignment/3fa6ec13-39= 39-45b6-beb1-dd03e00a83f9/relationships", "Rel": "Relationships" }, { "Href": "http://localhost/api/automatedtestassignment/3fa6ec13-39= 39-45b6-beb1-dd03e00a83f9/runs", "Rel": "Runs" } ] }, { "Id": "8be49e2e-590c-485e-a713-ef3e8353e1d5", "AutomatedTestId": "c6173eab-f684-4d35-8ca7-62851b8df0e1", "Name": "Login password minimum length is 6", "Status": "Passed", "AssignedTo": "joeb", "AssignedToId": "b2a74983-e374-41d4-bf49-bc3c9a5f0e89", "PackageId": "f6ed1282-bd89-4f8f-8e94-47e344bba905", "Expands": [ "Package" ], "Self": "http://localhost/api/automatedtestassignment/8be49e2e-590c-4= 85e-a713-ef3e8353e1d5", "Links": [ { "Href": "http://localhost/api/automatedtestassignment/8be49e2e-59= 0c-485e-a713-ef3e8353e1d5/allrelationships", "Rel": "AllRelationships" }, { "Href": "http://localhost/api/automatedtest/c6173eab-f684-4d35-8c= a7-62851b8df0e1", "Rel": "AutomatedTest" }, { "Href": "http://localhost/api/executionpackage/f6ed1282-bd89-4f8f= -8e94-47e344bba905", "Rel": "ExecutionPackage" }, { "Href": "http://localhost/api/automatedtestassignment/8be49e2e-59= 0c-485e-a713-ef3e8353e1d5/relationships", "Rel": "Relationships" }, { "Href": "http://localhost/api/automatedtestassignment/8be49e2e-59= 0c-485e-a713-ef3e8353e1d5/runs", "Rel": "Runs" } ] } ] }
Status Code
200 - OK
Creates a new automated test assignment.
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 |
---|---|
201 - Created | Returned if the automated test assignment is cre= ated successfully. |
403 - Forbidden | Returned if the request could not be completed s= uccessfuly (normally due to lack of permissions or validation failure). |
Create a new automated test assignment, with no assignee.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Body
{ "PackageId": "f6ed1282-bd89-4f8f-8e94-47e344bba905", "AutomatedTestId": "5ef6c545-6ef8-472e-bae7-b1cc3d3fbab0" }
Response Headers
Key | Value | Description |
---|---|---|
Location | http://localhost/api/automatedtestassignme= nt/4bb709c2-e0e7-4af3-9f60-a045016a9610 | |
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610", "AutomatedTestId": "5ef6c545-6ef8-472e-bae7-b1cc3d3fbab0", "Name": "My Test", "Status": "Not Run", "AssignedTo": null, "AssignedToId": null, "PackageId": "f6ed1282-bd89-4f8f-8e94-47e344bba905", "Expands": [ "Package" ], "Self": "http://localhost/api/automatedtestassignment/4bb709c2-e0e7-4af3-= 9f60-a045016a9610", "Links": [ { "Href": "http://localhost/api/automatedtestassignment/4bb709c2-e0e7-4= af3-9f60-a045016a9610/allrelationships", "Rel": "AllRelationships" }, { "Href": "http://localhost/api/automatedtest/5ef6c545-6ef8-472e-bae7-b= 1cc3d3fbab0", "Rel": "AutomatedTest" }, { "Href": "http://localhost/api/executionpackage/f6ed1282-bd89-4f8f-8e9= 4-47e344bba905", "Rel": "ExecutionPackage" }, { "Href": "http://localhost/api/automatedtestassignment/4bb709c2-e0e7-4= af3-9f60-a045016a9610/relationships", "Rel": "Relationships" }, { "Href": "http://localhost/api/automatedtestassignment/4bb709c2-e0e7-4= af3-9f60-a045016a9610/runs", "Rel": "Runs" } ] }
Status Code
201 - Created
Create a new automated test assignment, with the assignee set.
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Body
{ "PackageId": "f6ed1282-bd89-4f8f-8e94-47e344bba905", "AssignedToId": "5bb78013-222a-45a8-b639-ac0ce0a8a505", "AutomatedTestId": "5ef6c545-6ef8-472e-bae7-b1cc3d3fbab0" }
Response Headers
Key | Value | Description |
---|---|---|
Location | http://localhost/api/automatedtestassignme= nt/4bb709c2-e0e7-4af3-9f60-a045016a9610 | |
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "Id": "4bb709c2-e0e7-4af3-9f60-a045016a9610", "AutomatedTestId": "5ef6c545-6ef8-472e-bae7-b1cc3d3fbab0", "Name": "My Test", "Status": "Not Run", "AssignedTo": "joeb", "AssignedToId": "5bb78013-222a-45a8-b639-ac0ce0a8a505", "PackageId": "f6ed1282-bd89-4f8f-8e94-47e344bba905", "Expands": [ "Package" ], "Self": "http://localhost/api/automatedtestassignment/4bb709c2-e0e7-4af3-= 9f60-a045016a9610", "Links": [ { "Href": "http://localhost/api/automatedtestassignment/4bb709c2-e0e7-4= af3-9f60-a045016a9610/allrelationships", "Rel": "AllRelationships" }, { "Href": "http://localhost/api/automatedtest/5ef6c545-6ef8-472e-bae7-b= 1cc3d3fbab0", "Rel": "AutomatedTest" }, { "Href": "http://localhost/api/executionpackage/f6ed1282-bd89-4f8f-8e9= 4-47e344bba905", "Rel": "ExecutionPackage" }, { "Href": "http://localhost/api/automatedtestassignment/4bb709c2-e0e7-4= af3-9f60-a045016a9610/relationships", "Rel": "Relationships" }, { "Href": "http://localhost/api/automatedtestassignment/4bb709c2-e0e7-4= af3-9f60-a045016a9610/runs", "Rel": "Runs" } ] }
Status Code
201 - Created