API - Protocol Step Worksheets

Protocol Steps Worksheet

[PATCH] <qbench_url>/qbench/api/v1/batch/<batch_id>/protocolstep/<protocol_step_id>

Updates a Batch Protocol Step worksheet json

Expects a dictionary with the format:

{
  "date_completed": "01/05/2020",
  "date_started": "01/01/2020",
  "make_step_current": false,
  "worksheet_json": '{
    "input_1":{
       "value": 20
       },
    "input_2": {
       "value": 30
       }
     }'
 }

Notice that the "worksheet_json" value is a string, not a dictionary

Response:

{"message": "OK"}

[PATCH] <qbench_url>/qbench/api/v1/test/<int:test_id>/protocolstep/<int:protocol_step_id>

Updates a Test Protocol Step worksheet json
Expects a dictionary with the format:

{
  "date_completed": "01/05/2020",
  "date_started": "01/01/2020",
  "make_step_current": false,
  "worksheet_json": '{
   "input_1": {
      "value": 20
     },
   "input_2": {
     "value": 30
     }
   }'
 }

Notice that the "worksheet_json" value is a string, not a dictionary

Response:

{"message": "OK"}

Patch Worksheet Data (Test)

PATCH <qbench-url>/qbench/api/v1/test/{test_id}/protocolstep/{object_protocol_step_id}/worksheet

Will patch the worksheet data on the Object Protocol Step referenced by the object_protocol_step_id in the URL.

Example request: 

PATCH  /qbench/api/v1/test/123/protocolstep/1/worksheet HTTP/1.1
Authorization: Bearer 63ff42c5-49e6-42e2-bc3f-04fbfc22bbcb
Host: <qbench-url>
Content-Type: application/json
{
  "data": {
    "input_1": "Updated Value",
    "input_2": "Another Updated Value"
  }
}

Example response: 

 {"message":"OK"}

If your worksheet requires a reason for updating, the reason can be included in the payload like so:

{
  "data": {
    "input_1": "Updated Value",
    "input_2": "Another Updated Value"
  },
  "qbench_update_reason": "These values need to be updated!"
}

Notes

• If you are updating a Spreadsheet Worksheet type, you can use the named cell value instead of the Cell name if a named cell has been defined.

Patch Worksheet Data (Batch)

PATCH <qbench-url>/qbench/api/v1/batch/{batch_id}/protocolstep/{object_protocol_step_id}/worksheet

Will patch the worksheet data on the Object Protocol Step referenced by the object_protocol_step_id in the URL.

Example request: 

PATCH  /qbench/api/v1/test/123/protocolstep/1/worksheet HTTP/1.1
Authorization: Bearer 63ff42c5-49e6-42e2-bc3f-04fbfc22bbcb
Host: <qbench-url>
Content-Type: application/json
{
  "data": {
    "input_1": "Updated Value",
    "input_2": "Another Updated Value"
  }
}

Example response: 

 {"message":"OK"}

If your worksheet requires a reason for updating, the reason can be included in the payload like so:

{
  "data": {
    "input_1": "Updated Value",
    "input_2": "Another Updated Value"
  },
  "qbench_update_reason": "These values need to be updated!"
}

Notes

• If you are updating a Spreadsheet Worksheet type, you can use the named cell value instead of the Cell name if a named cell has been defined.