ML Prep API (v1)
http://{{your_prep_ip_address}}/
- Mock server
http://{{your_prep_ip_address}}/api/v1/diagnostics
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'http://{{your_prep_ip_address}}/api/v1/diagnostics' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
http://{{your_prep_ip_address}}/api/v1/diagnostics/protocols/{protocolId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'http://{{your_prep_ip_address}}/api/v1/diagnostics/protocols/{protocolId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
http://{{your_prep_ip_address}}/api/v1/diagnostics/protocol/demo
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'http://{{your_prep_ip_address}}/api/v1/diagnostics/protocol/demo' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"protocolName": "DemoProtocol",
"systemName": "HHS_System",
"simulate": true
}'- Mock server
http://{{your_prep_ip_address}}/api/v1/diagnostics/instrument/transport
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'http://{{your_prep_ip_address}}/api/v1/diagnostics/instrument/transport' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"plateLabwareId": 1
}'- Mock server
http://{{your_prep_ip_address}}/api/v1/diagnostics/instrument/hhs
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'http://{{your_prep_ip_address}}/api/v1/diagnostics/instrument/hhs' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"heat": true,
"shake": true,
"heatValue": 75,
"shakeValue": 200,
"duration": 1,
"plateLabwareId": 1
}'The channels used to perform the pressure diagnostic. Possible values are OneChannel, TwoChannel, EightChannel, or Unknown
- Mock server
http://{{your_prep_ip_address}}/api/v1/diagnostics/instrument/tip-pickup
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'http://{{your_prep_ip_address}}/api/v1/diagnostics/instrument/tip-pickup' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"channelSelection": "OneChannel",
"tipLabwareId": 1,
"deckPosition": 2,
"ejectToWaste": true
}'The channels used to perform the drip diagnostic. Possible values are OneChannel, TwoChannel, EightChannel, or Unknown
- Mock server
http://{{your_prep_ip_address}}/api/v1/diagnostics/instrument/drip
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'http://{{your_prep_ip_address}}/api/v1/diagnostics/instrument/drip' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"channelSelection": "OneChannel",
"tipLabwareId": 1,
"troughLabwareId": 2,
"tipPosition": 9,
"troughPosition": 3
}'- Mock server
http://{{your_prep_ip_address}}/api/v1/diagnostics/instrument/pressure
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'http://{{your_prep_ip_address}}/api/v1/diagnostics/instrument/pressure' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
http://{{your_prep_ip_address}}/api/v1/diagnostics/camera
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'http://{{your_prep_ip_address}}/api/v1/diagnostics/camera' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'"string"
- Mock server
http://{{your_prep_ip_address}}/api/v1/diagnostics/network
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'http://{{your_prep_ip_address}}/api/v1/diagnostics/network' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'"string"
- Mock server
http://{{your_prep_ip_address}}/api/v1/diagnostics/instrument/motor-diagnostics
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'http://{{your_prep_ip_address}}/api/v1/diagnostics/instrument/motor-diagnostics' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"displayName": "Y-Axis Rear, Rear Channel",
"motor": 1,
"channel": 2,
"mphOnly": true,
"runtimeInSeconds": 60
}'- Mock server
http://{{your_prep_ip_address}}/api/v1/diagnostics/instrument/cancel-motor-diagnostics
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'http://{{your_prep_ip_address}}/api/v1/diagnostics/instrument/cancel-motor-diagnostics' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
http://{{your_prep_ip_address}}/api/v1/diagnostics/close-view
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'http://{{your_prep_ip_address}}/api/v1/diagnostics/close-view' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json-patch+json' \
-d '{
"viewId": "5854c6bfedba41cba94560861b0075d8",
"viewResult": "Ok",
"viewInput": "ViewInput1;ViewInput2"
}'- Mock server
http://{{your_prep_ip_address}}/api/v1/diagnostics/submit-client-log-entry
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'http://{{your_prep_ip_address}}/api/v1/diagnostics/submit-client-log-entry' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"logEntry": "Unable to complete action.",
"logType": "ERROR",
"logTime": "Tue Sep 21 2021 09:52:53 GMT-0700 (Pacific Daylight Time)"
}'