Skip to content
API
/
Devices

WebAPI.Host (3.0)

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

https://{{your_venus_webapi_ip_address}}/

Cameras

Operations

Devices

Operations

Get deck layout for the loaded method.

Request

Security
Bearer
Path
deviceIdinteger(int32)required

Device Id returned from OnDeviceCreated event.

curl -i -X GET \
  'https://{{your_venus_webapi_ip_address}}/api/vector/v3/devices/deck-layout/{deviceId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Returns Hamilton.WebAPI.Common.DeckLayoutData.

Bodyapplication/json; x-api-version=3.0
deckobject(TemplateDefinition)
labwareArray of objects(IList<LabwareWrapper>)
deckLayersArray of objects(IList<DeckLayerData>)
Response
application/json; x-api-version=3.0
{
  "deck": {
    "id": "string",
    "parentId": "string",
    "anchor": { … },
    "dimension": { … },
    "rotation": 0,
    "model": "string",
    "modelOffset": { … },
    "bitmap": "string",
    "visible": true,
    "originOffset": { … }
  },
  "labware": [
    { … }
  ],
  "deckLayers": [
    { … }
  ]
}

Get instrument configuration data.

Request

Security
Bearer
Body

Hamilton.WebAPI.Common.DeviceConfigurationData.

deviceIDinteger(int32)

Device ID

dataDefinitionstring

Data definition in instrument configuration file

dataInstancestring

Data instance (for definition)

configKeysArray of strings(IList<String>)

List of required configuration keys

curl -i -X POST \
  'https://{{your_venus_webapi_ip_address}}/api/vector/v3/devices/instrument-configuration' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; x-api-version=3.0' \
  -d '{
    "deviceID": 0,
    "dataDefinition": "string",
    "dataInstance": "string",
    "configKeys": [
      "string"
    ]
  }'

Responses

Returns Hamilton.WebAPI.Common.DeviceConfigurationData.

Body
deviceIDinteger(int32)
dataDefinitionstring
dataInstancestring
configKeysArray of strings(IList<String>)
configValuesArray of strings(IList<String>)
Response
{
  "deviceID": 0,
  "dataDefinition": "string",
  "dataInstance": "string",
  "configKeys": [
    "string"
  ],
  "configValues": [
    "string"
  ]
}

Gets a set of registered devices.

Request

Security
Bearer
curl -i -X GET \
  'https://{{your_venus_webapi_ip_address}}/api/vector/v3/devices/registered' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Returns a set of registered devices.

Body
Array [
deviceNamestring
deviceDisplayNamestring
imageFilestring
hasDeckLayoutboolean
]
Response
[
  {
    "deviceName": "string",
    "deviceDisplayName": "string",
    "imageFile": "string",
    "hasDeckLayout": true
  }
]

Gets a set of devices used in currently loaded method (runtime devices).

Request

Security
Bearer
curl -i -X GET \
  'https://{{your_venus_webapi_ip_address}}/api/vector/v3/devices/runtime' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Returns a set of runtime devices.

Bodyapplication/json; x-api-version=3.0
deviceNamestring
deviceDisplayNamestring
imageFilestring
hasDeckLayoutboolean
deviceIdinteger(int32)
simulationboolean
controlPanelSupportinteger(int32)(ControlPanelSupport)

Possible values:

  • 0 - None
  • 1 - Idle
  • 2 - Pause
  • 3 - Run
Enum0123
windowHandleinteger(int32)
Response
application/json; x-api-version=3.0
{
  "deviceId": 12345,
  "simulation": true,
  "controlPanelSupport": 1,
  "windowHandle": 12345,
  "deviceName": "Example_Device",
  "deviceDisplayName": "Example Device Display",
  "imageFile": "example_device.png",
  "hasDeckLayout": true
}

Opens the Control Panel for a Vector device defined in runtime (on method load).

Request

Security
Bearer
Body

Object containing the device Id. Hamilton.WebAPI.Common.RuntimeDeviceInput

deviceIdinteger(int32)
curl -i -X POST \
  'https://{{your_venus_webapi_ip_address}}/api/vector/v3/devices/control-panel/runtime' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; x-api-version=3.0' \
  -d '{
    "deviceId": 0
  }'

Responses

Open dialog request issued to Vector.

Body
boolean
Response
true

Opens the Control Panel for a Vector device found in Windows registry.

Request

Security
Bearer
Body

Object containing device name and main window handle. Hamilton.WebAPI.Common.RegisteredDeviceInput

deviceNamestring
windowHandleinteger(int32)
curl -i -X POST \
  'https://{{your_venus_webapi_ip_address}}/api/vector/v3/devices/control-panel/registered' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; x-api-version=3.0' \
  -d '{
    "deviceName": "string",
    "windowHandle": 0
  }'

Responses

Open dialog request issued to Vector.

Body
boolean
Response
true

ErrorHandler

Operations

Files

Operations

InstrumentData

Operations

RunExecutor

Operations

System

Operations

Users

Operations