Skip to content
API
/
Files
/
Get available (or filtered) runtime file information.

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

Export diagnostic data for a method execution instance.

Request

Output file is created with a .zip extension.

Security
Bearer
Body
methodPathstring
runGuidstring
filePathstring
exportMethodboolean
exportCommTraceboolean
exportVenusLogsboolean
curl -i -X POST \
  'https://{{your_venus_webapi_ip_address}}/api/vector/v3/files/export-diagnostic-files' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; x-api-version=3.0' \
  -d '{
    "methodPath": "string",
    "runGuid": "string",
    "filePath": "string",
    "exportMethod": true,
    "exportCommTrace": true,
    "exportVenusLogs": 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
}

Get available (or filtered) runtime file information.

Request

Potentially obviated (deprecated) by M:Hamilton.WebAPI.Host.Controllers.V3.FilesController.GetRunHistoryData(System.String,Hamilton.WebAPI.Common.Ordering,System.Int32,System.Int32,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.String).

Security
Bearer
Query
filterboolean

Boolean flag to filter date range, if true; otherwise all available runtime file information is returned.

fromDatestring(date-time)

Start date/time if filter = true.

toDatestring(date-time)

End date/time if filter = true.

curl -i -X GET \
  'https://{{your_venus_webapi_ip_address}}/api/vector/v3/files/runtime-data?filter=true&fromDate=2019-08-24T14%3A15%3A22Z&toDate=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Returns Hamilton.WebAPI.Common.RuntimeFileList object.

Body
filesArray of objects(ICollection<RuntimeInfo>)read-only
Response
{
  "files": [
    { … }
  ]
}

Get detailed runtime information for a single method execution.

Request

Potentially obviated (deprecated) by M:Hamilton.WebAPI.Host.Controllers.V3.FilesController.GetRunHistoryData(System.String,Hamilton.WebAPI.Common.Ordering,System.Int32,System.Int32,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.String).

Security
Bearer
Path
runtimeGuidstringrequired

unique runtime identifier

curl -i -X GET \
  'https://{{your_venus_webapi_ip_address}}/api/vector/v3/files/detailed-run-data/{runtimeGuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Returns Hamilton.WebAPI.Common.DetailedRuntimeInfo object.

Bodyapplication/json; x-api-version=3.0
methodNamestring
dbFileNamestring
runGuidstring
startTimestring(date-time)
endTimestring(date-time)
computerNamestring
runStatestring
durationnumber(double)read-only
userNamestring
instrumentsArray of objects(IList<InstrumentInfo>)
Response
application/json; x-api-version=3.0
{
  "methodName": "string",
  "dbFileName": "string",
  "runGuid": "string",
  "startTime": "2025-07-17T21:40:15.402Z",
  "endTime": "2025-07-17T21:40:15.402Z",
  "computerName": "string",
  "runState": "string",
  "duration": 0,
  "userName": "string",
  "instruments": [
    { … }
  ]
}

InstrumentData

Operations

RunExecutor

Operations

System

Operations

Users

Operations