Skip to content
API
/
Files

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

Get the file validation status.

Request

Security
Bearer
Query
methodFilePathstring

Method file path to validate.

curl -i -X GET \
  'https://{{your_venus_webapi_ip_address}}/api/vector/v3/files/validation?methodFilePath=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Returns Hamilton.WebAPI.Common.SecurityCOMValidation enum {invalid=0, valid=1, irrelevant=2, validationDisabled=3 }.

Body
integer(int32)(SecurityCOMValidation)

Possible values:

  • 0 - Invalid
  • 1 - Valid
  • 2 - Irrelevant
Enum012
Response
0

Export a single method file collection to package.

Request

Security
Bearer
Body
methodPathstring
filePathstring
exportOriginalFilesboolean
curl -i -X POST \
  'https://{{your_venus_webapi_ip_address}}/api/vector/v3/files/export-method' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; x-api-version=3.0' \
  -d '{
    "methodPath": "string",
    "filePath": "string",
    "exportOriginalFiles": true
  }'

Responses

Returns Hamilton.WebAPI.Common.CmdResult object, Saves export package file.

Body
resultbooleanread-only
messagestringread-only
resetRunExecboolean
Response
{
  "result": true,
  "message": "string",
  "resetRunExec": true
}

Export method files to package.

Request

Security
Bearer
Body
Array [
methodPathstring
filePathstring
exportOriginalFilesboolean
]
curl -i -X POST \
  'https://{{your_venus_webapi_ip_address}}/api/vector/v3/files/export-methods' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; x-api-version=3.0' \
  -d '[
    {
      "methodPath": "string",
      "filePath": "string",
      "exportOriginalFiles": true
    }
  ]'

Responses

Returns Hamilton.WebAPI.Common.CmdResult object, Saves export package file.

Body
resultbooleanread-only
messagestringread-only
resetRunExecboolean
Response
{
  "result": true,
  "message": "string",
  "resetRunExec": true
}

InstrumentData

Operations

RunExecutor

Operations

System

Operations

Users

Operations