Skip to content
Recipes
/
Create a Prep protocol
Last updated

Create a Prep protocol

Get labware information

The labware used in a protocol is obtained using the Get method and the labware {name}. The deck information, consisting of the labware information and what positions they occupy on the deck, are passed in the time of creating the protocol. The {name} is displayed in the Labware's Details info card.

labware-name

Get the tips to be used in the protocol

Labware: 300 µL tip rack (Nested Conductive No Filter)

Name: 235950

curl -i -X GET \
  'http://{{your_prep_ip_address}}/api/v1/labware/by-name/{name}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response
application/json
{
  "id": 0,
  "name": "string",
  "containerName": "string",
  "rows": 0,
  "columns": 0,
  "volume": 0.1,
  "displayName": "string",
  "partNumbers": "string",
  "categories": [
    { … }
  ],
  "classification": "string",
  "siteAlignments": [
    "string"
  ],
  "isFavorite": true,
  "parts": [
    { … }
  ]
}

Get the plate to be used in the protocol

This uses the same call as in Get the tips to be used in the protocol, but with different labware:

Labware: Hamilton, Deep Well, U-Bottom, 2.2mL, Clear

Name: DW96w2200jjxsqHAM

curl -i -X GET \
  'http://{{your_prep_ip_address}}/api/v1/labware/by-name/{name}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response
application/json
{
  "id": 0,
  "name": "string",
  "containerName": "string",
  "rows": 0,
  "columns": 0,
  "volume": 0.1,
  "displayName": "string",
  "partNumbers": "string",
  "categories": [
    { … }
  ],
  "classification": "string",
  "siteAlignments": [
    "string"
  ],
  "isFavorite": true,
  "parts": [
    { … }
  ]
}

Create new protocol and pass deck info

Pass everything the protocol needs here.

curl -i -X POST \
  'http://{{your_prep_ip_address}}/api/v1/protocols' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "id": 0,
    "name": "string",
    "makeNameUnique": true,
    "skipValidation": true,
    "createdByUserName": "string",
    "deck": {
      "id": 0,
      "positions": [
        {
          "position": 0,
          "labwarePositions": [
            {
              "row": 0,
              "column": 0,
              "id": 0,
              "positionName": "string",
              "labwareGroup": {
                "labwareId": 0,
                "id": 0,
                "groupName": "string",
                "reuseTipsBetweenSteps": true,
                "liquidName": "string",
                "liquidType": "string",
                "liquidVolumeOptions": "string"
              },
              "liquidVolume": 0.1
            }
          ],
          "id": 0,
          "positionName": "string",
          "labwareGroup": {
            "labwareId": 0,
            "id": 0,
            "groupName": "string",
            "reuseTipsBetweenSteps": true,
            "liquidName": "string",
            "liquidType": "string",
            "liquidVolumeOptions": "string"
          },
          "liquidVolume": 0.1
        }
      ]
    }
  }'
Response
application/json
{
  "isValid": true,
  "validationErrors": [
    "string"
  ]
}

API call body example

{ 
  "id": 0, 
  "name": "create protocol",
   "makeNameUnique": true, 
  "skipValidation": true, 
  "createdByUserName": "adminsys", 
  "deck": {
     "positions": [       { 
        "id": 0, 
        "position": 1,
         "positionName": "", 
        "liquidVolume": 0 
      }, 
      {
         "id": 0, 
        "position": 2, 
        "positionName": "Tip Rack",
         "liquidVolume": 0, 
        "labwareGroupId": 0, 
        "labwareGroup": {
           "groupName": "235950", 
          "labwareId": "{{tipId}}",
           "liquidName": "", 
          "liquidType": "",
           "reuseTipsBetweenSteps": false 
        }       }, 
      {
         "id": 0, 
        "position": 3, 
        "positionName": "",
         "liquidVolume": 0 
      }, 
      { 
        "id": 0,
         "position": 4, 
        "positionName": "", 
        "liquidVolume": 0 
      },
       {         "id": 0, 
        "position": 5, 
        "positionName": "",
         "liquidVolume": 0 
      }, 
      {         "id": 0,
         "position": 6, 
        "positionName": "Plate", 
        "labwareGroupId": 0,
         "liquidVolume": 0, 
        "labwareGroup": { 
          "id": 0,
           "groupName": "DW96w2200jjxsqHAM", 
          "labwareId": "{{hamiltonPlate}}",
           "liquidVolume": "", 
          "liquidType": "",
           "reuseTipsBetweenSteps": false 
        }       }, 
      {
         "id": 0, 
        "position": 7, 
        "positionName": "",
         "liquidVolume": 0 
      }, 
      {         "id": 0,
         "position": 8, 
        "positionName": "", 
        "liquidVolume": 0 
      }
     ] 
  } }

Add step to the protocol

Go to Add a Transfer Samples step to an existing protocol to add a step to the newly created protocol.

Previous page
Next page