Resource: Grid Widget States ( /api/gridwidgethost/{hostId}/project/{projectId}/positions )

Grid widget states allow the retrieval of state information for all widgets associated with a Widget host ID.

Methods

GET

Retrieves the states of all widgets associated with a widget host for the current user and selected project.

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.
404 - NotFoundReturned if project does not exist.

Example - GET

Retrieves the states of all widgets associated with a widget host.

Request Headers

KeyValueDescription
Content-typeapplication/json
Acceptapplication/json

Request Parameters

KeyValueDescription
{hostId}automated_test_run_summaryID of the host for the set of grid widgets.
{projectId}cdd1a0cf-2cd1-4f9a-8513-a9a2fc74d133Unique ID of project the grid widgets are being displayed for.

Response Headers

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

Response Body

{
  "HostId": "automated_test_run_summary",
  "Positions": {
    "left": {
      "Position": "left",
      "WidgetType": "RunStatusOverTime",
      "Data": {
        "selections": [
          "ScriptRun",
          "AgileRun"
        ]
      },
      "Self": "http://localhost/api/gridwidgethost/automated_test_run_summary/project/cdd1a0cf-2cd1-4f9a-8513-a9a2fc74d133/position/left"
    },
    "right": {
      "Position": "right",
      "WidgetType": "RunStatusesGroupedByFieldForAutomatedRuns",
      "Data": {
        "groupingType": "Field",
        "groupingField": "RunNumber"
      },
      "Self": "http://localhost/api/gridwidgethost/automated_test_run_summary/project/cdd1a0cf-2cd1-4f9a-8513-a9a2fc74d133/position/right"
    }
  },
  "Self": "http://localhost/api/gridwidgethost/automated_test_run_summary/project/cdd1a0cf-2cd1-4f9a-8513-a9a2fc74d133/positions"
}

Status Code

200 - OK

  • No labels