API - Assay

Assays

GET <qbench-url>/qbench/api/v1/assay/{assayId}

Will retrieve an assay by its ID.

Example request:

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

Example response: 

{
  "default_technician_id": 1,
  "duration": 5,
  "id": 1,
  "tags": [],
  "title": "Example Assay"
}

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

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

Example request:

GET  /qbench/api/v1/assay?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": [
    {
      "duration": 5,
      "default_technician_id": 1,
      "tags": [],
      "id": 1,
      "title": "Example Assay"
    },
    {
      "duration": 7,
      "default_technician_id": 1,
      "tags": [],
      "id": 2,
      "title": "Example Assay 2"
    },
    ...
  ],
}

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

Will create a new assay. Title and duration are required.

Example request:

POST  /qbench/api/v1/assay HTTP/1.1
Authorization: Bearer 63ff42c5-49e6-42e2-bc3f-04fbfc22bbcb
Host: <qbench-url>
Content-Type: application/json
{
  "duration": 5,
  "title": "Example Assay 3"
}

Example response: 

 {"id":9}

POST <qbench-url>/qbench/api/v1/assay/{assayId} 

Will update an existing assay. Title and duration cannot be null.

Example request:

POST  /qbench/api/v1/assay/1 HTTP/1.1
Authorization: Bearer 63ff42c5-49e6-42e2-bc3f-04fbfc22bbcb
Host: <qbench-url>
Content-Type: application/json
{
  "duration":10
}

Example response:  

{"message":"OK"}