ML Prep API (v1)
http://{{your_prep_ip_address}}/
Request
In order to run any protocol, it must first be validated. The validation process verifies that the data provided is correct and that the protocol can run successfully. If the protocol is not valid, the errors returned should show which parameters or steps are incorrect or will cause runtime problems.
- Mock server
http://{{your_prep_ip_address}}/api/v1/protocols/validate/{protocolId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'http://{{your_prep_ip_address}}/api/v1/protocols/validate/{protocolId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "isValid": true, "validationErrors": [ "string" ] }
- Mock server
http://{{your_prep_ip_address}}/api/v1/protocols/rename/{protocolId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'http://{{your_prep_ip_address}}/api/v1/protocols/rename/{protocolId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"newName": "string"
}'Whether the PDF report should be saved to the specified path upon protocol completion.
Whether the Json report data should be saved to the specified path upon protocol completion.
Whether the pipetting csv data should be saved to the specified path upon protocol completion.
Whether the pipetting data should be split into separate csv files per step.
- Mock server
http://{{your_prep_ip_address}}/api/v1/protocols/report-settings/{protocolId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'http://{{your_prep_ip_address}}/api/v1/protocols/report-settings/{protocolId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"savePdf": true,
"saveJson": true,
"savePipettingCsv": true,
"pipettingCsvPerStep": true,
"reportPath": "string"
}'