Skip to content
API
/
InstrumentData

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

ErrorHandler

Operations

Files

Operations

InstrumentData

Operations

Gets all saved instrument data.

Request

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

Responses

Returns a list of Hamilton.WebAPI.Common.InstrumentDataContract objects.

Body
Array [
namestring
defaultNamestring
platformstring
descriptionstring
imagestring
idinteger(int32)
]
Response
[
  {
    "name": "string",
    "defaultName": "string",
    "platform": "string",
    "description": "string",
    "image": "string",
    "id": 0
  }
]

Saves new instrument data.

Request

Security
Bearer
Body

A new Hamilton.WebAPI.Common.InstrumentData object.

namestring
defaultNamestring
platformstring
descriptionstring
imagestring
curl -i -X POST \
  'https://{{your_venus_webapi_ip_address}}/api/vector/v3/instrumentdata' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; x-api-version=3.0' \
  -d '{
    "name": "string",
    "defaultName": "string",
    "platform": "string",
    "description": "string",
    "image": "string"
  }'

Responses

Returns a new Hamilton.WebAPI.Common.InstrumentDataContract object.

Body
namestring
defaultNamestring
platformstring
descriptionstring
imagestring
idinteger(int32)
Response
{
  "name": "string",
  "defaultName": "string",
  "platform": "string",
  "description": "string",
  "image": "string",
  "id": 0
}

Updates existing instrument data.

Request

Security
Bearer
Path
instrumentIdinteger(int32)required

Id of the instrument to update.

Body

An updated Hamilton.WebAPI.Common.InstrumentData object.

namestring
defaultNamestring
platformstring
descriptionstring
imagestring
curl -i -X PUT \
  'https://{{your_venus_webapi_ip_address}}/api/vector/v3/instrumentdata/{instrumentId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; x-api-version=3.0' \
  -d '{
    "name": "string",
    "defaultName": "string",
    "platform": "string",
    "description": "string",
    "image": "string"
  }'

Responses

Returns an updated Hamilton.WebAPI.Common.InstrumentDataContract object.

Body
namestring
defaultNamestring
platformstring
descriptionstring
imagestring
idinteger(int32)
Response
{
  "name": "string",
  "defaultName": "string",
  "platform": "string",
  "description": "string",
  "image": "string",
  "id": 0
}

Deletes an existing instrument data resource.

Request

Security
Bearer
Path
instrumentIdinteger(int32)required

Id of the instrument to delete.

curl -i -X DELETE \
  'https://{{your_venus_webapi_ip_address}}/api/vector/v3/instrumentdata/{instrumentId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Resource successfully deleted.

Response
No content

RunExecutor

Operations

System

Operations

Users

Operations