Skip to content

ML Prep API (v1)

Download OpenAPI description
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

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

Gets Instinct traces

Request

Note that sources come from the GetSources method below and are case sensitive. For example, to retrieve the first 1,000 traces (the limit per call) starting from the beginning for sources ANE and SYE, the call looks like this: localhost:4601/api/traces?offset=0&limit=1000&sources=ANE,SYE

Security
Bearer
Query
offsetinteger(int32)
limitinteger(int32)
sourcesstring
startTimestring(date-time)

Optional start time. Send in the following format using local time of the server PC, it will be converted to UTC when sending to Instinct: 2020-02-24 03:55 PM which is February 24, 2020 at 3:55 PM. When sent to Instinct this date will become 2020-02-24T23:55:00

endTimestring(date-time)

Optional end time. Same format as start time.

curl -i -X GET \
  'http://{{your_prep_ip_address}}/api/v1/traces?offset=0&limit=0&sources=string&startTime=2019-08-24T14%3A15%3A22Z&endTime=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The traces

Bodyapplication/json
totalItemCountinteger(int32)
currentOffsetinteger(int32)
itemsArray of objects or null(InstinctTrace)
Response
application/json
{ "totalItemCount": 0, "currentOffset": 0, "items": [ {} ] }

Exports all traces for a given time interval (also includes diagnostics)

Request

Security
Bearer
Query
startTimestring(date-time)
endTimestring(date-time)
curl -i -X GET \
  'http://{{your_prep_ip_address}}/api/v1/traces/export?startTime=2019-08-24T14%3A15%3A22Z&endTime=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The export file

Bodyapplication/json
string(binary)
Response
application/json
"string"

Get sources of the traces

Request

Security
Bearer
curl -i -X GET \
  'http://{{your_prep_ip_address}}/api/v1/traces/sources' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

An error occurred while getting the trace sources

Bodyapplication/json
string
Response
application/json
"string"

UserKba

Operations

Users

Operations

Verification

Operations

VerificationResult

Operations