Skip to content
API
/
ProtocolRun
/
Complete the loading for the run

ML Prep API (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server

http://{{your_prep_ip_address}}/

Authenticate

Operations

Backups

Operations

Calibration

Operations

Camera

Operations

Configuration

Operations

Credentials

Operations

Deck

Operations

Diagnostics

Operations

Enclosure

Operations

Environment

Operations

Errors

Operations

HepaUv

Operations

Instruments

Operations

Labware

Operations

LabwareCategories

Operations

LabwareSignature

Operations

Lighting

Operations

LiquidClass

Operations

Maintenance

Operations

NetworkConfiguration

Operations

Power

Operations

ProtocolRun

Operations

Retrieve the re-load instructions

Request

Load instructions are only returned if RunState = 'Loading'

Security
Bearer
curl -i -X GET \
  'http://{{your_prep_ip_address}}/api/v1/protocol-run/reload-instructions' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The re-loading instructions for each deck position

Bodyapplication/jsonArray [
One of:

Deck position information

positionNamestring or null

The deck position name

deckPositioninteger(int32)

The numbered deck position on the ML Prep

labwarePositioninteger(int32)

The position of the labware within a carrier

labwareClassificationinteger(int32)(LabwareClassification)
Enum"Unknown""Plate""SampleTube""TubeRack""Trough""TipRack""Carrier""MicroTubeRack""MicroTube""Container"
]
Response
application/json
[
  {
    "positionName": "string",
    "deckPosition": 0,
    "labwarePosition": 0,
    "labwareClassification": "Unknown"
  }
]

Complete the loading for the run

Request

Begins execution of a run after loading is complete.

Security
Bearer
Bodyapplication/json
protocolIdinteger(int32)

The database id of the protocol

simulateboolean

Flag indicating a simulated run

loadCompleteActioninteger(int32)(LoadCompleteAction)
Enum"Run""Abort"
residualTipsArray of objects or null(ResidualTipItemDto)

The set of tips used

barcodesArray of objects or null(BarcodeTargetDto)

The barcodes for barcoded positions

liquidVolumesArray of objects or null(LoadPositionVolumeDto)

The inventory of liquids

curl -i -X PUT \
  'http://{{your_prep_ip_address}}/api/v1/protocol-run/load-complete' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "protocolId": 0,
    "simulate": true,
    "loadCompleteAction": "Run",
    "residualTips": [
      {
        "deckPosition": 0,
        "residualTipData": {
          "useAllAddresses": true,
          "addresses": [
            {
              "row": 1,
              "column": 1
            }
          ]
        }
      }
    ],
    "barcodes": [
      {
        "deckPosition": 0,
        "address": {
          "row": 0,
          "column": 0
        },
        "barcodeValue": "string"
      }
    ],
    "liquidVolumes": [
      {
        "deckPosition": 0,
        "positionOnSite": 0,
        "row": 0,
        "column": 0,
        "volume": 0.1
      }
    ]
  }'

Responses

Loading completed successfully

Response
No content

Abort the current run

Request

Security
Bearer
curl -i -X PUT \
  'http://{{your_prep_ip_address}}/api/v1/protocol-run/abort' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Run was aborted successfully

Bodyapplication/json
hasErrorboolean
errorstring or null
Response
application/json
{
  "hasError": true,
  "error": "string"
}

Protocols

Operations

ProtocolSteps

Operations

ProtocolSupport

Operations

ProtocolVerification

Operations

Repair

Operations

Report

Operations

Roles

Operations

RunData

Operations

Screenshots

Operations

ServiceSoftwareApi

Operations

Settings

Operations

SoftwareVersions

Operations

SystemReady

Operations

SystemTime

Operations

ThermalDevice

Operations

Traces

Operations

UserKba

Operations

Users

Operations

Verification

Operations

VerificationResult

Operations