This is a simple set of Postman collections for testing the OT-2's HTTP API. We intend to move this collection from a Gist to something way more useful very soon!
Import Robot Server Testing.postman_collection.json
into Postman to get started!
This collection includes a set of variables that will can be used to modify the behavior of the requests as well as affect subsequent requests
variable | default | automatically set by |
---|---|---|
hostname |
localhost |
N/A |
http_api_version |
* |
N/A |
protocol_id |
N/A | GET /protocols , POST /protocols |
run_id |
N/A | GET /runs , POST /runs |
command_id |
N/A | GET /runs/:id , GET /runs/:id/commands , POST /runs/:id/commands |
- Set
hostname
in your Postman environment to point the collection atlocalhost
for a local development environment or the IP address of an actual robot. - Set
http_api_version
to request a specific HTTP API version. The default of*
means "give me the latest version." - The
protocol_id
variable will be set when you create or fetch protocols.- If multiple protocols exist, the variable will be set to the most recent protocol.
- It will be used for any subsequent
GET /protocols/:id
requests - It will also be used in the body of the
POST /runs
request to create a protocol run
- The
run_id
variable will be set when you create or fetch runs.- If multiple runs exist, the variable will be set to the most recent run.
- It will be used for any subsequent
GET /runs/:id/...
requests
- The
command_id
variable will be set when you create or fetch commands.- If multiple commands exist in a run, the variable will be set to the most recent command.
- It will be used for any subsequent
GET /runs/:run_id/command/:command_id...
requests