Date: Fri, 29 Mar 2024 09:54:47 +0000 (UTC) Message-ID: <1960280827.11779.1711706087461@catch-kbase-p> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_11778_326074713.1711706087460" ------=_Part_11778_326074713.1711706087460 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Allows retrieval of state information for a grid widget at a specified p= osition within a widget host for the combination of current user and a spec= ific project.
This resource supports the following methods: GET, PUT
Retrieves the states of a widget at a specified position associated with= a widget host for the current user and selected project.
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 a position was not specified. |
404 - NotFound | Returned if project or position does not exist.<= /td> |
Retrieve state of widget at specific position.
Request Headers
Key | Value | Description |
---|---|---|
Content-type | application/json | |
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{hostId} | automated_test_run_summary | ID of the host for the set of grid widgets. |
{projectId} | cdd1a0cf-2cd1-4f9a-8513-a9a2fc74d133 | Unique ID of project the grid widgets are being = displayed for. |
{position} | right | The position of the widget within the grid widge= t host (current valid values are 'left' and 'right'). |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "Position": "right", "WidgetType": "RunStatusesGroupedByFieldForAutomatedRuns", "Data": { "groupingType": "Field", "groupingField": "RunNumber" }, "Self": "http://localhost/api/gridwidgethost/automated_test_run_summary/p= roject/cdd1a0cf-2cd1-4f9a-8513-a9a2fc74d133/position/right" }
Status Code
200 - OK
Sets the state of a widget at a specified position associated with a wid= get host for the current user and selected project.
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 a position was not specified. |
404 - NotFound | Returned if widget type was invalid. |
Update state of widget at specific position.
Request Headers
Key | Value | Description |
---|---|---|
Content-type | application/json | |
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{hostId} | automated_test_run_summary | ID of the host for the set of grid widgets. |
{projectId} | cdd1a0cf-2cd1-4f9a-8513-a9a2fc74d133 | Unique ID of project the grid widgets are being = displayed for. |
{position} | right | The position of the widget within the grid widge= t host (current valid values are 'left' and 'right'). |
Request Body
{ "Position": null, "WidgetType": "RunStatusesGroupedByFieldForAutomatedRuns", "Data": { "groupingType": "Field", "groupingField": "RunNumber" } }
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "Position": "right", "WidgetType": "RunStatusesGroupedByFieldForAutomatedRuns", "Data": { "groupingType": "Field", "groupingField": "RunNumber" }, "Self": "http://localhost/api/gridwidgethost/automated_test_run_summary/p= roject/cdd1a0cf-2cd1-4f9a-8513-a9a2fc74d133/position/right" }
Status Code
200 - OK