API - Panels

Panels 

GET <qbench-url>/qbench/api/v1/panel/{panelId}

Will retrieve a panel by its ID.

Example request: 

GET  /qbench/api/v1/panel/1 HTTP/1.1
Authorization: Bearer 63ff42c5-49e6-42e2-bc3f-04fbfc22bbcb
Host: <qbench-url>

Example response: 

{
  "id": 1,
  "title": "Example Panel",
  "description": null,
  "assays": [
    {
      "default_technician_id": 1,
      "duration": 7,
      "id": 2,
      "tags": [],
      "title": "Example Assay 2",
    },
    {
      "default_technician_id": null,
      "duration": 1,
      "id": 3,
      "tags": [],
      "title": "Item1",
    }
  ]
}

GET <qbench-url>/qbench/api/v1/panel?page_num={pageNum}&page_size={pageSize}  

Will retrieve a paginated list of panels. Maximum page size is 50.

Example request:

GET  /qbench/api/v1/panel?page_num=1&page_size=50 HTTP/1.1
Authorization: Bearer 63ff42c5-49e6-42e2-bc3f-04fbfc22bbcb
Host: <qbench-url>

Example response: 

{
  "total_count": 75,
  "total_pages": 2,
  "data": [
    {
      "description": null,
      "id": 1,
      "title": "Example Panel"
    },
    {
      "description": null,
      "id": 1,
      "title": "Example Panel 2"
    },
    ...
  ]
}

POST <qbench-url>/qbench/api/v1/panel 

Will create a new panel. Panel title is required. When creating a panel, you can also include a list of assays. Each assay must already have been created in QBench and the assay ID must be included in each assay JSON body. You can optionally update any assay at this time by including additional assay fields in the JSON body.

Example request:

POST  /qbench/api/v1/panel HTTP/1.1
Authorization: Bearer 63ff42c5-49e6-42e2-bc3f-04fbfc22bbcb
Host: <qbench-url>
Content-Type: application/json

{
  "title": "Example Panel 3",
  "assays":[  
    {
      "description": "Example description",
      "id": 1,
      "title": "Example Assay"
    },
    {
      "description": null,
      "id": 2,
      "title": "Example Assay 2"
    }
  ]
}

Example response: 

{"id":3}

PUT <qbench-url>/qbench/api/v1/panel/{panelId} 

Will update an existing panel. Panel title cannot be null. When updating a panel, you can also include a list of assays. Each assay must already have been created in QBench and the assay ID must be included in each assay JSON body. You can optionally update any assay at this time by including additional assay fields in the JSON body. Updating the assay list will overwrite any previous assays that were associated with the panel.

Example request:

PUT  /qbench/api/v1/panel/1 HTTP/1.1
Authorization: Bearer 63ff42c5-49e6-42e2-bc3f-04fbfc22bbcb
Host: <qbench-url>
Content-Type: application/json

{
  "description": "Example Description 3",
  "assays":[  
    {
      "description": null,
      "id": 1,
      "title": "Example Assay"
    },
    {
      "description": null,
      "id": 2,
      "title": "Example Assay 2"
    }
  ]
}

Example response: 

{"message":"OK"}

DELETE <qbench-url>/qbench/api/v1/panel/{panelId}  

Will delete a panel. 

Example request:

DELETE  /qbench/api/v1/panel/1 HTTP/1.1
Authorization: Bearer 63ff42c5-49e6-42e2-bc3f-04fbfc22bbcb
Host: <qbench-url>

Example response: 

{"message":"OK"}