Download OpenAPI specification:Download
Generate the service QR code information used for device provisioning.
Return a base64-encoded PNG image.
ntp required | string (Ntp) NTP. *Max. 64 characters. |
auto | boolean (Auto) Default: false Connection state.
|
wifi_ssid | string (Wifi Ssid) WIFI SSID. |
wifi_pass | string (Wifi Pass) WIFI Password. |
proxy_url | string (Proxy Url) Proxy URL. |
proxy_port | string (Proxy Port) Proxy port. |
proxy_user_name | string (Proxy User Name) Proxy user name. |
proxy_pass | string (Proxy Pass) Proxy password. |
ip_address | string (Ip Address) IP Address. *Max. 39 characters. |
subnet_mask | string (Subnet Mask) Subnet Mask. *Max. 39 characters. |
gateway | string (Gateway) Gateway. *Max. 39 characters. |
dns | string (Dns) DNS. *Max. 39 characters. |
{- "result": "SUCCESS",
- "contents": "string"
}
Register a device.
Assumptions and Notes:
・Registration certificate: X.509 primary certificate (.pem file or .cer file or .crt file)
device_name required | string (Device Name) Device name. *Max. 255 characters |
primary_certificate required | string (Primary Certificate) X.509 primary certificate (.pem file or .cer file or .crt file) . *Specify the following certificate without the leading and trailing signatures. -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- Also, do not include line breaks. |
{- "device_name": "string",
- "primary_certificate": "string"
}
{- "result": "string",
- "id": "string"
}
{- "certificates": [
- {
- "device_id": "string",
- "internal_device_id": "string",
- "device_name": "string",
- "credentials_id_object": "string",
- "credentials_type": "string",
- "expiration_date": "string",
- "created_time": "string"
}
]
}
Get the device certificate information for a specified device.
device_id required | string (Device Id) Device ID. |
{- "device_id": "string",
- "internal_device_id": "string",
- "device_name": "string",
- "credentials_id_object": "string",
- "credentials_type": "string",
- "expiration_date": "string",
- "created_time": "string"
}
Update the device certificate information for a specified device.
device_id required | string (Device Id) Device ID |
primary_certificate required | string (Primary Certificate) Device certificate X.509 primary certificate *Specify the following certificate without the leading and trailing signatures -----END CERTIFICATE----- |
{- "primary_certificate": "string"
}
{- "result": "SUCCESS"
}
Get the device list information.
connectionState | string (Connection state) Default: "" Connection state.
|
device_name | string (Device Name) Default: "" Device name. *Partial match search |
device_id | string (Device Id) Default: "" Device ID. *Partial match search |
device_group_id | string (Device Group Id) Default: "" Device group ID. |
device_ids | string (Device IDs) Default: "" Specify multiple device IDs separated by commas. |
scope | string (Scope) Default: "full" Specify the scope of response parameters to return.
|
{- "devices": [
- {
- "device_id": "string",
- "place": "string",
- "comment": "string",
- "property": {
- "device_name": "string",
- "internal_device_id": "string"
}, - "device_type": "string",
- "display_device_type": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string",
- "connectionState": "string",
- "lastActivityTime": "string",
- "models": [
- {
- "model_version_id": "string"
}
], - "configuration": { },
- "state": { },
- "device_groups": [
- {
- "device_group_id": "string",
- "device_type": "string",
- "comment": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}
]
}
]
}
Get the information for a specified device.
device_id required | string (Device Id) Device ID. |
{- "device_id": "string",
- "place": "string",
- "comment": "string",
- "property": {
- "device_name": "string",
- "internal_device_id": "string"
}, - "device_type": "string",
- "display_device_type": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string",
- "connectionState": "string",
- "lastActivityTime": "string",
- "models": [
- {
- "model_version_id": "string"
}
], - "device_groups": [
- {
- "device_group_id": "string",
- "device_type": "string",
- "comment": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}
], - "configuration": { },
- "state": { },
- "command_results": [
- {
- "command_name": "string",
- "result": "string",
- "execute_time": "string"
}
], - "apps": [
- {
- "name": "string",
- "version": "string",
- "comment": "string"
}
]
}
Set whether to allow or deny execution of factory reset for a specified device.
device_id required | string (Device Id) Device ID. |
factory_reset required | string (Factory Reset) Set whether to allow or deny execution of factory reset for a specified device.
|
{- "result": "SUCCESS"
}
Get the device group information list.
device_group_id | string (Device Group Id) Default: "" Device Group ID. *partial position search |
comment | string (Comment) Default: "" Description. *partial position search |
device_id | string (Device Id) Default: "" Device ID of device to which it belongs. List the device group to which the specified device ID belongs. |
{- "device_groups": [
- {
- "device_group_id": "string",
- "device_type": "string",
- "comment": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string",
- "devices": [
- {
- "device_id": "string",
- "property": {
- "device_name": "string",
- "internal_device_id": "string"
}, - "device_type": "string",
- "display_device_type": "string",
- "place": "string",
- "comment": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}
]
}
]
}
Register a device group.
device_group_id required | string (Device Group Id) Device Group ID |
comment | string (Comment) Default: "" Description. Max. 100 characters. |
device_id | string (Device Id) Default: "" Affiliated device ID.
|
del_from_dgroup | string (Dell flg from device group) Default: "0" Specify whether to delete the specified device affiliation from the default group
|
{- "result": "SUCCESS"
}
Get the information for a specified device group.
device_group_id required | string (Device Group Id) Device group ID. |
{- "device_group_id": "string",
- "device_type": "string",
- "comment": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string",
- "devices": [
- {
- "device_id": "string",
- "property": {
- "device_name": "string",
- "internal_device_id": "string"
}, - "device_type": "string",
- "display_device_type": "string",
- "place": "string",
- "comment": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}
]
}
Update a specified device group.
device_group_id required | string (Device Group Id) Device group ID to be updated. |
comment | string (Comment) Default: "" Description. Max. 100 characters. |
device_id | string (Device Id) Default: "" Affiliated device ID to be replaced.
*When both comment and del_from_dgroup are not specified, an error occurs |
del_from_dgroup | string (Dell From device group) Default: "0" Specify whether to delete the specified device affiliation from the default group.
|
{- "result": "SUCCESS"
}
Implement instructions to a specified device to start to get the inference result metadata (Output Tensor) and image (Input image).
device_id required | string (Device Id) Device ID. |
{- "result": "SUCCESS",
- "outputSubDirectory": "string",
- "outputSubDirectoryIR": "string"
}
Implement instructions to a specified device to stop getting the inference result metadata (Output Tensor) and image (Input image).
device_id required | string (Device Id) Device ID. |
{- "result": "SUCCESS"
}
Implement the following for a specified device to initialize the settings.
device_id required | string (Device Id) Device ID. |
{- "result": "SUCCESS"
}
DO NOT USE THIS API. Change the log settings of a specified device.
device_id required | string (Device Id) Device ID |
level | string (Level) Default: "Error" Log level.
|
destination | string (Destination) Default: "UART" By output destination type
|
SensorRegister | string (Sensorregister) Default: false Sensor register.
|
{- "result": "SUCCESS"
}
Enable device app logging for a specified devices.
device_id required | string (Device Id) Device ID |
enable | boolean (Log Enable) Default: true Set logging enable/disable.
|
{- "enable": true
}
{- "result": "SUCCESS"
}
Set the frame rate or drive mode of image. Frame rate or drive mode must be set.
device_id required | string (Device Id) Device ID |
frame_rate | integer (Frame Rate) Default: 2997 Set the frame rate. *Set an integer value multiplied by 100 for the frame rate that comes up from the sensor. The maximum value of the frame rate depends on the value of DriveMode (see the Drive mode spec of drive_mode parameters for details).
| ||||||||||||||||||||||||||||||
drive_mode | integer (Drive Mode) Default: 1 Set the drive mode.
|
{- "frame_rate": 2997,
- "drive_mode": 1
}
{- "result": "SUCCESS"
}
Update the following password for a specified device:
device_id required | string (Device Id) Device ID. |
password required | string (Password) Plaintext and max. *Max. 32 characters. |
{- "password": "string"
}
{- "result": "SUCCESS"
}
Set the Device Configuration of a specified device.
device_id required | string (Device Id) Device ID |
object |
{- "payload": {
- "FWOperation": {
- "OperatingMode": "Manual",
- "ErrorHandling": "ManualReset",
- "PeriodicParameter": {
- "NetworkParameter": "Save",
- "PrimaryInterval": {
- "ConfigInterval": 0,
- "CaptureInterval": 0,
- "BaseTime": "string",
- "UploadCount": 1
}, - "SecondaryInterval": {
- "ConfigInterval": 0,
- "CaptureInterval": 0,
- "BaseTime": "string",
- "UploadCount": 0
}, - "UploadInferenceParameter": {
- "UploadMethodIR": "BlobStorage",
- "StorageNameIR": "string",
- "StorageSubDirectoryPathIR": "string",
- "PPLParameter": "string",
- "CropHOffset": 0,
- "CropVOffset": 0,
- "CropHSize": 4056,
- "CropVSize": 3040,
- "NetworkId": "string"
}
}
}, - "Direction": {
- "Vertical": "Normal",
- "Horizontal": "Normal"
}
}
}
{- "result": "SUCCESS"
}
{- "parameter_list": [
- {
- "parameter": {
- "commands": [
- {
- "command_name": "string",
- "parameters": {
- "Mode": 0,
- "UploadMethod": "string",
- "FileFormat": "string",
- "UploadMethodIR": "string",
- "CropHOffset": 0,
- "CropVOffset": 0,
- "CropHSize": 0,
- "CropVSize": 0,
- "NumberOfImages": 0,
- "UploadInterval": 0,
- "NumberOfInferencesPerMessage": 0,
- "MaxDetectionsPerFrame": 0,
- "ModelId": "string",
- "PPLParameter": { }
}
}
]
}, - "file_name": "string",
- "comment": "string",
- "isdefault": "string",
- "device_ids": [
- "string"
], - "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}
]
}
Register CommandParameterFile.
This API can be used to register the following API parameters in advance:
The following are the APIs for file management and application to the device:
< Parameter file management >
< Bind to/Unbind from device >
If the parameter file is not applied to the device, operate using the default value.
APIs with required parameters will result in an error when the API is executed.
The default file can be specified using the following API:
file_name required | string (File Name) Filename. Max. 100 characters. |
parameter required | string (Parameter) Command parameter content in base64 encoding. *See manual for detailed format |
comment | string (Comment) Comment details. |
{- "file_name": "string",
- "parameter": "string",
- "comment": "string"
}
{- "result": "SUCCESS"
}
Update command parameter file.
file_name required | string (File Name) Filename. |
parameter required | string (Parameter) Command parameter content in base64 encoding. *See manual for detailed format |
comment | string (Comment) Comment. |
{- "parameter": "string",
- "comment": "string"
}
{- "result": "SUCCESS"
}
Bind command parameter file to device.
file_name required | string (File Name) Filename. |
device_ids required | string (Device Ids) Specify multiple device IDs separated by commas. |
{- "device_ids": "string"
}
{- "result": "SUCCESS"
}
Unbind command parameter file.
file_name required | string (File Name) Filename. |
device_ids required | string (Device Ids) Specify multiple device IDs separated by commas. |
{- "device_ids": "string"
}
{- "result": "SUCCESS"
}
{- "deploy_configurations": [
- {
- "config_id": "string",
- "device_type": "string",
- "config_comment": "string",
- "running_cnt": 0,
- "success_cnt": 0,
- "fail_cnt": 0,
- "firmware": {
- "sensor_loader_file_name": "string",
- "sensor_loader_version_number": "string",
- "sensor_loader_firmware_comment": "string",
- "sensor_file_name": "string",
- "sensor_version_number": "string",
- "sensor_firmware_comment": "string",
- "apfw_file_name": "string",
- "apfw_version_number": "string",
- "apfw_firmware_comment": "string"
}, - "model": {
- "model_id": "string",
- "model_version_number": "string",
- "model_comment": "string",
- "model_version_comment": "string"
}, - "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}
]
}
Register the deploy config information to deploy to the following devices.
config_id required | string (Config Id) Max. 20 single characters, single-byte characters only. |
comment | string (Comment) Default: "" Max. 100 characters. |
sensor_loader_version_number | string (Sensor Loader Version Number) Default: "" Sensor loader version number. |
sensor_version_number | string (Sensor Version Number) Default: "" Sensor version number. |
model_id | string (Model Id) Default: "" Model ID. |
model_version_number | string (Model Version Number) Default: "Latest" Model version number. |
ap_fw_version_number | string (Ap Fw Version Number) Default: "" AppFw version number. |
{- "result": "SUCCESS"
}
Get the information of the specified deployment config.
config_id required | string (Config Id) Deploy Config ID |
{- "config_id": "string",
- "device_type": "string",
- "config_comment": "string",
- "running_cnt": 0,
- "success_cnt": 0,
- "fail_cnt": 0,
- "firmware": {
- "sensor_loader_file_name": "string",
- "sensor_loader_version_number": "string",
- "sensor_loader_firmware_comment": "string",
- "sensor_file_name": "string",
- "sensor_version_number": "string",
- "sensor_firmware_comment": "string",
- "apfw_file_name": "string",
- "apfw_version_number": "string",
- "apfw_firmware_comment": "string"
}, - "model": {
- "model_id": "string",
- "model_version_number": "string",
- "model_comment": "string",
- "model_version_comment": "string"
}, - "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}
Provide a function for deploying the following to devices specified with deploy config.
config_id required | string (Config Id) Setting ID. |
device_ids required | string (Device Ids) Specify multiple device IDs separated by commas. |
replace_model_id | string (Replace Model Id) Default: "" Specify the model ID or network_id. |
comment | string (Comment) Default: "" Max. 100 characters |
{- "result": "SUCCESS",
- "deploy_id": 12345
}
Get the deploy history for a specified device.
device_id required | string (Device Id) Device ID |
{- "deploys": [
- {
- "id": 0,
- "deploy_type": "string",
- "deploy_status": "string",
- "update_progress": "string",
- "deploy_comment": "string",
- "config_id": "string",
- "replace_network_id": "string",
- "current_target": "string",
- "total_status": "string",
- "app_name": "string",
- "version_number": "string",
- "firmware": {
- "sensor_loader_target_flg": "string",
- "sensor_loader_status": "string",
- "sensor_loader_retry_count": "string",
- "sensor_loader_start_date": "string",
- "sensor_loader_end_date": "string",
- "sensor_loader_version_number": "string",
- "sensor_loader_version_comment": "string",
- "sensor_target_flg": "string",
- "sensor_status": "string",
- "sensor_retry_count": "string",
- "sensor_start_date": "string",
- "sensor_end_date": "string",
- "sensor_version_number": "string",
- "sensor_version_comment": "string",
- "apfw_target_flg": "string",
- "apfw_status": "string",
- "apfw_retry_count": "string",
- "apfw_start_date": "string",
- "apfw_end_date": "string",
- "apfw_version_number": "string",
- "apfw_version_comment": "string"
}, - "model": {
- "model_target_flg": "string",
- "model_status": "string",
- "model_retry_count": "string",
- "model_start_date": "string",
- "model_end_date": "string",
- "model_id": "string",
- "model_version_number": "string",
- "model_comment": "string"
}
}
]
}
Get deploy history status list in deployment layer
deploy_id | integer (Deployment ID) Deployment ID. |
app_deploy_id | integer (App Deployment ID) App Deployment ID. |
from_datetime | string (Deployment start date and time) Deployment start date and time, format 'yyyyMMddhhmm', should not later than now. |
to_datetime | string (Deployment End date and time) Deployment end date and time, format 'yyyyMMddhhmm', should not later than now, should not earlier than from_datetime. |
top required | number (Top) Default: 20 Number of records to get. If 100 is specified, 100 records will be response. |
skip required | number (Skip) Default: 0 Number of skips. If 100 is specified, records from the 101st will be response. |
[- {
- "deploy_id": 10,
- "from_datetime": "2023-09-06T13:50:07.930666+00:00",
- "deploy_type": "1",
- "running_cnt": 3,
- "success_cnt": 5,
- "fail_cnt": 3,
- "config_id": "config_230812",
- "dnn_model": "zonedection_20230824_v1.0",
- "dnn_model_version": "1.00",
- "device_firmware": "D70004",
- "device_sensor": "910701",
- "device_sensor_loader": "920301"
}, - {
- "deploy_id": 11,
- "from_datetime": "2023-09-06T13:50:07.930666+00:00",
- "deploy_type": "App",
- "running_cnt": 3,
- "success_cnt": 5,
- "fail_cnt": 3,
- "app_name": "OD_FF19.12",
- "app_version": "1",
- "app_description": "FF19.12"
}
]
Get deploy status by deploy id.
deploy_id required | integer (Deployment ID) Deployment ID |
deploy_type required | string (deploy_type) Deploy type
|
{- "deploy_id": 10,
- "from_datetime": "2023-09-06T13:50:07.930666+00:00",
- "deploy_type": "1",
- "running_cnt": 3,
- "success_cnt": 5,
- "fail_cnt": 3,
- "config_id": "config_230812",
- "dnn_model": "zonedection_20230824_v1.0",
- "dnn_model_version": "1.00",
- "device_firmware": "D70004",
- "device_sensor": "910701",
- "device_sensor_loader": "920301",
- "devices": [
- {
- "device_id": "sid_2023082401",
- "device_name": "sid_2023082401",
- "deploy_status": "1",
- "update_progress": "100%"
}, - {
- "device_id": "sid_2023082402",
- "device_name": "sid_2023082402",
- "deploy_status": "2",
- "update_progress": "100%"
}, - {
- "device_id": "sid_2023082403",
- "device_name": "sid_2023082403",
- "deploy_status": "0",
- "update_progress": "30%"
}
]
}
Deploy a device model for a specified device..
model_id required | string (Model Id) Model ID. |
device_id required | string (Device Id) Device ID. |
version_number | string (Version Number) Default: "" Version number. |
replace_model_id | string (Replace Model Id) Default: "" Replace model ID. |
comment | string (Comment) Default: "" Description. *Max. 100 characters. |
{- "result": "SUCCESS"
}
Get the specified training kit information list.
order_by | string (Order By) Default: "asc" Sort order: Sorted by date training kit was created. |
{- "training_kits": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "created_on": "string",
- "status": "string",
- "training_kit_type": "string",
- "default_dataset_split_percentage": 0,
- "framework": {
- "name": "string",
- "version": "string"
}, - "owner": "string",
- "is_public": true
}
]
}
Get the project list information.
project_name | string (Project Name) Project name. *partial position search |
model_platform | string (Model Platform) Model Platform.
|
project_type | string (Project Type) Project Type.
|
device_id | string (Device Id) Device Id. |
include_training_flg | string (Include Training Flg) Default: "0" Specify true to get the project property. |
{- "model_projects": [
- {
- "model_project_name": "string",
- "model_project_id": "string",
- "model_platform": "string",
- "model_type": "string",
- "project_type": "string",
- "device_id": "string",
- "project_model_file_name": "string",
- "project_model_accuracy": "string",
- "project_comment": "string",
- "project": {
- "training_kit_id": "string",
- "training_kit_name": "string",
- "description": "string",
- "iteration_id": "string",
- "iteration_name": "string",
- "last_modified": "string"
}, - "model": {
- "model_id": "string",
- "model_type": "string",
- "functionality": "string",
- "vendor_name": "string",
- "model_comment": "string",
- "create_by": "string",
- "package_id": "string",
- "product_id": "string",
- "metadata_format_id": "string",
- "latest_version": {
- "version_number": "string",
- "iteration_id": "string",
- "iteration_name": "string",
- "accuracy": "string",
- "model_performances": { },
- "latest_flg": "string",
- "publish_latest_flg": "string",
- "version_status": "string",
- "org_file_name": "string",
- "org_file_size": 0,
- "publish_file_name": "string",
- "publish_file_size": 0,
- "model_file_size": 0,
- "model_framework": "string",
- "conv_id": "string",
- "labels": [
- "string"
], - "stage": "string",
- "result": "string",
- "kpi": { }
}
}
}
]
}
Create the project for the base model.
project_name required | string (Project Name) Project name. Max. 50 characters. |
training_kit required | string (Training Kit ID) Training Kit ID. |
comment | string (Comment) Description. Max. 100 characters. |
{- "result": "SUCCESS"
}
Create a project for the device model based on the base model of the specified model.
project_name required | string (Project Name) Project name. Max. 50 characters. |
model_id required | string (Model Id) Model Id. |
device_id required | string (Device Id) Device Id. |
version_number | string (Version Number) Version number. Default is latest version. |
comment | string (Comment) Description. Max. 100 characters. |
{- "result": "SUCCESS"
}
Get the specified project information.
project_name required | string (Project Name) Project name. |
include_training_flg | string (Include Training Flg) Default: "0" Specify true to get the project property. |
{- "model_project_name": "string",
- "model_project_id": "string",
- "model_platform": "string",
- "model_type": "string",
- "project_type": "string",
- "device_id": "string",
- "project_model_file_name": "string",
- "project_model_accuracy": "string",
- "project_comment": "string",
- "project": {
- "training_kit_id": "string",
- "training_kit_name": "string",
- "description": "string",
- "iteration_id": "string",
- "iteration_name": "string",
- "last_modified": "string"
}, - "model": {
- "model_id": "string",
- "model_type": "string",
- "functionality": "string",
- "vendor_name": "string",
- "model_comment": "string",
- "create_by": "string",
- "package_id": "string",
- "product_id": "string",
- "metadata_format_id": "string",
- "latest_version": {
- "version_number": "string",
- "iteration_id": "string",
- "iteration_name": "string",
- "accuracy": "string",
- "model_performances": { },
- "latest_flg": "string",
- "publish_latest_flg": "string",
- "version_status": "string",
- "org_file_name": "string",
- "org_file_size": 0,
- "publish_file_name": "string",
- "publish_file_size": 0,
- "model_file_size": 0,
- "model_framework": "string",
- "conv_id": "string",
- "labels": [
- "string"
], - "stage": "string",
- "result": "string",
- "kpi": { },
- "converter_log": [
- { }
], - "convert_start_date": "string",
- "convert_end_date": "string",
- "publish_start_date": "string",
- "publish_end_date": "string",
- "version_comment": "string",
- "version_ins_date": "string",
- "version_upd_date": "string"
}
}
}
Export and save the pre-conversion model from the base or device project.
project_name required | string (Project Name) Project name. |
model_id | string (Model Id) Model Id. Max. 20 single characters, single-byte characters only. |
initial_version_number | integer (Initial Version Number) Default: "1" Initial Version Number.
|
functionality | string (Functionality) Functionality. Max. 100 characters. |
vendor_name | string (Vendor Name) Vendor Name. Max. 100 characters. |
comment | string (Comment) Description. Max. 100 characters. |
{- "result": "SUCCESS"
}
Relearn the specified project.
project_name required | string (Project Name) Project name. |
training_type | string (Training Type) Default: "Regular" Training type. *Specify only for Custom Vision projects.
|
reserved_budget_in_hours | string (Reserved Budget In Hours) Default: "1" Reserved Budget In Hours. *This parameter is specified when training_type is Advanced for Custom Vision project. |
{- "result": "string",
- "iteration_id": "string",
- "iteration_name": "string"
}
Import the image file used for re-learning into the project.
project_name required | string (Project Name) Project name. |
required | Array of objects (Images) |
tags_name | Array of any (Tags Name) Default: [] Set the label *Specify for classification. Supports only 1 tag. |
{- "images": [
- {
- "file_name": "string",
- "contents": "string"
}
], - "tags_name": [ ]
}
{- "result": "SUCCESS"
}
Import the image file used for retraining into the project via Azure Blob Storage.
project_name required | string (Project Name) |
container_url required | string (Container Url) Set the SAS URI of Blob Storage Container. *Read and List permissions required |
tags_name | Array of any (Tags Name) Default: [] Set the label *Specify for classification. Supports only 1 tag. |
{- "container_url": "string",
- "tags_name": [ ]
}
{- "result": "SUCCESS"
}
Get the Iterations information list of the specified project.
project_id required | string (Project Id) Project ID. |
overlap_threshold | string (Overlap Threshold) Default: "0.3" Overlap threshold. |
threshold | string (Threshold) Default: "0.5" threshold. |
{- "iterations": [
- { }
]
}
Get the image list of the specified project.
project_id required | string (Project Id) Project ID. |
iteration_id | string (Iteration Id) Iteration ID. |
order_by | string (Order By) Default: "newest" Sort order: Sorted by date image was created. |
number_of_images | string (Number Of Images) Default: 50 Number Of images. |
skip | string (Skip) Default: 0 Number of images to skip fetching. |
image_size_type | string (Image Size Type) Default: "resized" Image size type. *Specify if the project is Custom Vision.
|
{- "total_image_count": 0,
- "images": [
- {
- "id": "string",
- "created": "string",
- "width": 0,
- "height": 0,
- "image": "string",
- "tags": [
- {
- "tag_id": "string",
- "tag_name": "string",
- "created": "string"
}
], - "regions": [
- {
- "region_id": "string",
- "tag_id": "string",
- "tag_name": "string",
- "created": "string",
- "left": 0,
- "top": 0,
- "width": 0,
- "height": 0
}
]
}
]
}
Delete images from a project by image ID.
project_id required | string (Project Id) Project ID. |
image_ids required | string (Image Ids) Specify the image ID. *If you specify more than one, separate them with commas. Specify 1 to 256 image IDs. |
{- "result": "SUCCESS"
}
Get the image list of the specified project with image ID as a condition.
project_id required | string (Project Id) Project ID. |
image_ids required | string (Image Ids) Specify the image ID. *If you specify more than one, separate them with commas. Specify 1 to 256 image IDs. |
iteration_id | string (Iteration Id) Iteration ID. |
image_size_type | string (Image Size Type) Default: "resized" Image size type. *Specify if the project is Custom Vision.
|
{- "images": [
- {
- "id": "string",
- "created": "string",
- "width": 0,
- "height": 0,
- "image": "string",
- "tags": [
- {
- "tag_id": "string",
- "tag_name": "string",
- "created": "string"
}
], - "regions": [
- {
- "region_id": "string",
- "tag_id": "string",
- "tag_name": "string",
- "created": "string",
- "left": 0,
- "top": 0,
- "width": 0,
- "height": 0
}
]
}
]
}
Get the regison proposal (inference result) of object detection for the image with the specified image ID.
project_id required | string (Project Id) Project ID. |
image_id required | string (Image Id) Image ID. |
{- "project_id": "string",
- "image_id": "string",
- "proposals": [
- {
- "confidence": "string",
- "bounding_box": {
- "left": 0,
- "top": 0,
- "width": 0,
- "height": 0
}
}
]
}
Sets the tag for the images in the specified project.
project_id required | string (Project Id) Project ID. |
Array of objects (Regions) |
{- "regions": [
- {
- "image_id": "string",
- "tag_id": "string",
- "tag_name": "string",
- "left": 0,
- "top": 0,
- "width": 0,
- "height": 0
}
]
}
{- "created": [
- {
- "region_id": "string",
- "tag_id": "string",
- "tag_name": "string",
- "created": "string",
- "left": 0,
- "top": 0,
- "width": 0,
- "height": 0
}
], - "duplicated": [
- {
- "region_id": "string",
- "tag_id": "string",
- "tag_name": "string",
- "created": "string",
- "left": 0,
- "top": 0,
- "width": 0,
- "height": 0
}
], - "exceeded": [
- {
- "region_id": "string",
- "tag_id": "string",
- "tag_name": "string",
- "created": "string",
- "left": 0,
- "top": 0,
- "width": 0,
- "height": 0
}
]
}
Updates tags for images in the specified project.
project_id required | string (Project Id) Description. |
Array of objects (Regions) |
{- "regions": [
- {
- "image_id": "string",
- "tag_id": "string",
- "tag_name": "string",
- "left": 0,
- "top": 0,
- "width": 0,
- "height": 0
}
]
}
{- "updated": [
- {
- "region_id": "string",
- "tag_id": "string",
- "tag_name": "string",
- "created": "string",
- "left": 0,
- "top": 0,
- "width": 0,
- "height": 0
}
]
}
Create a new tag in the specified project.
project_id required | string (Project Id) Project ID |
tag_name required | string (Tag Name) tag name. |
description | string (Description) Description. |
{- "id": "string",
- "name": "string",
- "description": "string",
- "type": "string",
- "image_count": "string"
}
Update tags for the specified project.
project_id required | string (Project Id) Project ID |
tag_id required | string (Tag Id) tag ID. |
name required | string (Name) Name. |
description | string (Description) Description. |
type required | string (Type) type. *Specify Regular as fixed. |
{- "name": "string",
- "description": "string",
- "type": "string"
}
{- "id": "string",
- "name": "string",
- "description": "string",
- "type": "string",
- "image_count": "string"
}
Get tagged image information for the specified project.
project_id required | string (Project Id) Project ID. |
tag_ids | string (Tag Ids) Specify the tag ID. *If you specify more than one, separate them with commas. |
iteration_id | string (Iteration Id) Iteration ID. |
number_of_images | integer (Number Of Images) Default: 50 Number of images to fetch.. |
skip | integer (Skip) Default: 0 Number of images to skip fetching. |
order_by | string (Order By) Default: "newest" Sort order: Sorted by date image was created. |
image_size_type | string (Image Size Type) Default: "resized" Image size type. *Specify if the project is Custom Vision.
|
{- "total_image_count": 0,
- "tagged_images": [
- {
- "id": "string",
- "created": "string",
- "width": 0,
- "height": 0,
- "image": "string",
- "tags": [
- {
- "tag_id": "string",
- "tag_name": "string",
- "created": "string"
}
], - "regions": [
- {
- "region_id": "string",
- "tag_id": "string",
- "tag_name": "string",
- "created": "string",
- "left": 0,
- "top": 0,
- "width": 0,
- "height": 0
}
]
}
], - "blank_tags": [
- {
- "tag_id": "string",
- "tag_name": "string",
- "description": "string",
- "type": "string"
}
]
}
Get untagged image information for the specified project.
project_id required | string (Project Id) Project ID. |
iteration_id | string (Iteration Id) Iteration ID. |
number_of_images | integer (Number Of Images) Default: 50 Number of images to fetch.. |
skip | integer (Skip) Default: 0 Number of images to skip fetching. |
order_by | string (Order By) Default: "newest" Sort order: Sorted by date image was created. |
image_size_type | string (Image Size Type) Default: "resized" Image size type. *Specify if the project is Custom Vision.
|
{- "total_image_count": 0,
- "untagged_images": [
- {
- "id": "string",
- "created": "string",
- "width": 0,
- "height": 0,
- "image": "string"
}
]
}
Get the model list information.
model_id | string (Model Id) Model ID. *Partial match search |
comment | string (Comment) Model description. *Partial match search |
project_name | string (Project Name) Project name. *Partial match search |
model_platform | string (Model Platform) Model Platform.
|
project_type | string (Project Type) Project Type.
|
device_id | string (Device Id) Device Id. |
latest_type | string (Latest Type) Default: "1" Latest version type..
|
{- "models": [
- {
- "model_id": "string",
- "model_type": "string",
- "functionality": "string",
- "vendor_name": "string",
- "model_comment": "string",
- "network_type": "string",
- "create_by": "string",
- "package_id": "string",
- "product_id": "string",
- "metadata_format_id": "string",
- "projects": [
- {
- "model_project_name": "string",
- "model_project_id": "string",
- "model_platform": "string",
- "model_type": "string",
- "project_type": "string",
- "device_id": "string",
- "versions": [
- {
- "version_number": "string",
- "iteration_id": "string",
- "iteration_name": "string",
- "accuracy": "string",
- "model_performances": { },
- "latest_flg": "string",
- "publish_latest_flg": "string",
- "version_status": "string",
- "org_file_name": "string",
- "org_file_size": 0,
- "publish_file_name": "string",
- "publish_file_size": 0,
- "model_file_size": 0,
- "model_framework": "string",
- "conv_id": "string",
- "labels": [
- "string"
], - "stage": "string",
- "result": "string",
- "kpi": { }
}
]
}
]
}
]
}
Import the base model. In addition, in the case of a new model ID, it is newly saved. If you specify a model ID that has already been registered in the system, the version will be upgraded.
model required | string (Model) SAS URI or Presigned URI of the model file. |
input_format_param | string (Network Parameter) SAS URI or Presigned URI of the input format param file. |
network_config | string (Network Config) SAS URI or Presigned URI of the network config file. |
model_id required | string (Model Id) Model ID for new registration or version upgrade. Max. 100 characters. |
converted | boolean (Converted) Default: false Specify whether to convert the specified model file. |
vendor_name | string (Vendor Name) Vendor Name. Max. 100 characters. |
comment | string (Comment) Description. Max. 100 characters. |
network_type | string (Network Type) Default: "1" Specify whether or not application is required for the model.
|
metadata_format_id | string (Metadata Format ID) Metadata Format ID. Max. 100 characters. |
{- "model": "string",
- "input_format_param": "string",
- "network_config": "string",
- "model_id": "string",
- "converted": false,
- "vendor_name": "string",
- "comment": "string",
- "network_type": "1",
- "metadata_format_id": "string"
}
{- "result": "SUCCESS"
}
Provide a function to publish a conversion model.
As model publishing takes time, this is performed asynchronously.
*Check the processing status in the result of the GetBaseModelStatus API or GetDeviceModelStatus API response. If the result is 'Import completed', the process is completed.
model_id required | string (Model Id) Model ID. |
device_id | string (Device Id) Device ID |
{- "result": "string",
- "import_id": "string"
}
Edit the attribute information of the specified model.
model_id required | string (Model Id) Model ID. 100 characters. |
comment | string (Comment) Description. 100 characters. |
version_number | string (Version Number) Vendor Name. Max. 100 characters. |
{- "result": "SUCCESS"
}
Get the specified base model information.
model_id required | string (Model Id) Model ID. |
latest_type | string (Latest Type) Default: "1" Latest version type..
|
{- "model_id": "string",
- "model_type": "string",
- "functionality": "string",
- "vendor_name": "string",
- "model_comment": "string",
- "network_type": "string",
- "create_by": "string",
- "package_id": "string",
- "product_id": "string",
- "metadata_format_id": "string",
- "projects": [
- {
- "model_project_name": "string",
- "model_project_id": "string",
- "model_platform": "string",
- "model_type": "string",
- "project_type": "string",
- "device_id": "string",
- "versions": [
- {
- "version_number": "string",
- "iteration_id": "string",
- "iteration_name": "string",
- "accuracy": "string",
- "model_performances": { },
- "latest_flg": "string",
- "publish_latest_flg": "string",
- "version_status": "string",
- "org_file_name": "string",
- "org_file_size": 0,
- "publish_file_name": "string",
- "publish_file_size": 0,
- "model_file_size": 0,
- "model_framework": "string",
- "conv_id": "string",
- "labels": [
- "string"
], - "stage": "string",
- "result": "string",
- "kpi": { },
- "converter_log": [
- { }
], - "convert_start_date": "string",
- "convert_end_date": "string",
- "publish_start_date": "string",
- "publish_end_date": "string",
- "version_comment": "string",
- "version_ins_date": "string",
- "version_upd_date": "string"
}
]
}
]
}
Get base model the version list information.
model_id required | string (Model Id) Model ID. |
version_number | string (Version Number) Version number. |
scope | string (Scope) Default: "full" Specify the scope of response parameters to return.
|
{- "model_id": "string",
- "model_type": "string",
- "functionality": "string",
- "vendor_name": "string",
- "model_comment": "string",
- "network_type": "string",
- "create_by": "string",
- "package_id": "string",
- "product_id": "string",
- "metadata_format_id": "string",
- "projects": [
- {
- "model_project_name": "string",
- "model_project_id": "string",
- "model_platform": "string",
- "model_type": "string",
- "project_type": "string",
- "device_id": "string",
- "versions": [
- {
- "version_number": "string",
- "iteration_id": "string",
- "iteration_name": "string",
- "accuracy": "string",
- "model_performances": { },
- "latest_flg": "string",
- "publish_latest_flg": "string",
- "version_status": "string",
- "org_file_name": "string",
- "org_file_size": 0,
- "publish_file_name": "string",
- "publish_file_size": 0,
- "model_file_size": 0,
- "model_framework": "string",
- "conv_id": "string",
- "labels": [
- "string"
], - "stage": "string",
- "result": "string",
- "kpi": { },
- "converter_log": [
- { }
], - "convert_start_date": "string",
- "convert_end_date": "string",
- "publish_start_date": "string",
- "publish_end_date": "string",
- "version_comment": "string",
- "version_ins_date": "string",
- "version_upd_date": "string"
}
]
}
]
}
Edit the attribute information of the specified base model version.
model_id required | string (Model Id) Model ID. |
version_number required | string (Version Number) Version number. |
comment | string (Comment) Description of version. Max. 100 characters. |
input_format_param | string (Network Parameter) SAS URI or Presigned URI of the input format param file. |
network_config | string (Network Config) SAS URI or Presigned URI of the network config file. |
{- "comment": "string",
- "input_format_param": "string",
- "network_config": "string"
}
{- "model_id": "string",
- "model_type": "string",
- "functionality": "string",
- "vendor_name": "string",
- "model_comment": "string",
- "network_type": "string",
- "create_by": "string",
- "package_id": "string",
- "product_id": "string",
- "metadata_format_id": "string",
- "projects": [
- {
- "model_project_name": "string",
- "model_project_id": "string",
- "model_platform": "string",
- "model_type": "string",
- "project_type": "string",
- "device_id": "string",
- "versions": [
- {
- "version_number": "string",
- "iteration_id": "string",
- "iteration_name": "string",
- "accuracy": "string",
- "model_performances": { },
- "latest_flg": "string",
- "publish_latest_flg": "string",
- "version_status": "string",
- "org_file_name": "string",
- "org_file_size": 0,
- "publish_file_name": "string",
- "publish_file_size": 0,
- "model_file_size": 0,
- "model_framework": "string",
- "conv_id": "string",
- "labels": [
- "string"
], - "stage": "string",
- "result": "string",
- "kpi": { }
}
]
}
]
}
Get the specified device model information.
model_id required | string (Model Id) Model ID. |
device_id required | string (Device Id) Device ID. |
latest_type | string (Latest Type) Default: "1" Latest version type..
|
{- "model_id": "string",
- "model_type": "string",
- "functionality": "string",
- "vendor_name": "string",
- "model_comment": "string",
- "network_type": "string",
- "create_by": "string",
- "package_id": "string",
- "product_id": "string",
- "metadata_format_id": "string",
- "projects": [
- {
- "model_project_name": "string",
- "model_project_id": "string",
- "model_platform": "string",
- "model_type": "string",
- "project_type": "string",
- "device_id": "string",
- "versions": [
- {
- "version_number": "string",
- "iteration_id": "string",
- "iteration_name": "string",
- "accuracy": "string",
- "model_performances": { },
- "latest_flg": "string",
- "publish_latest_flg": "string",
- "version_status": "string",
- "org_file_name": "string",
- "org_file_size": 0,
- "publish_file_name": "string",
- "publish_file_size": 0,
- "model_file_size": 0,
- "model_framework": "string",
- "conv_id": "string",
- "labels": [
- "string"
], - "stage": "string",
- "result": "string",
- "kpi": { },
- "converter_log": [
- { }
], - "convert_start_date": "string",
- "convert_end_date": "string",
- "publish_start_date": "string",
- "publish_end_date": "string",
- "version_comment": "string",
- "version_ins_date": "string",
- "version_upd_date": "string"
}
]
}
]
}
Get device model version list information.
model_id required | string (Model Id) Model ID. |
device_id required | string (Device Id) Device ID. |
scope | string (Scope) Default: "full" Specify the scope of response parameters to return.
|
version_number | string (Version Number) Version number. |
{- "model_id": "string",
- "model_type": "string",
- "functionality": "string",
- "vendor_name": "string",
- "model_comment": "string",
- "network_type": "string",
- "create_by": "string",
- "package_id": "string",
- "product_id": "string",
- "metadata_format_id": "string",
- "projects": [
- {
- "model_project_name": "string",
- "model_project_id": "string",
- "model_platform": "string",
- "model_type": "string",
- "project_type": "string",
- "device_id": "string",
- "versions": [
- {
- "version_number": "string",
- "iteration_id": "string",
- "iteration_name": "string",
- "accuracy": "string",
- "model_performances": { },
- "latest_flg": "string",
- "publish_latest_flg": "string",
- "version_status": "string",
- "org_file_name": "string",
- "org_file_size": 0,
- "publish_file_name": "string",
- "publish_file_size": 0,
- "model_file_size": 0,
- "model_framework": "string",
- "conv_id": "string",
- "labels": [
- "string"
], - "stage": "string",
- "result": "string",
- "kpi": { },
- "converter_log": [
- { }
], - "convert_start_date": "string",
- "convert_end_date": "string",
- "publish_start_date": "string",
- "publish_end_date": "string",
- "version_comment": "string",
- "version_ins_date": "string",
- "version_upd_date": "string"
}
]
}
]
}
Edit the attribute information of the model version for the specified device.
model_id required | string (Model Id) Model ID. |
device_id required | string (Device Id) Device ID. |
version_number required | string (Version Number) Version number. |
comment required | string (Comment) Description of version. |
{- "comment": "string"
}
{- "result": "SUCCESS"
}
Get dnn_params information of the specified model.
model_id required | string (Model Id) Model ID. |
version_number | string (Version Number) Default: "latest" Version number. |
device_id | string (Device Id) Device ID |
{- "contents": "string"
}
Get the firmware information list.
firmware_type | string (Firmware Type) Firmware type ID .
|
{- "firmwares": [
- {
- "firmware_id": "string",
- "firmware_type": "string",
- "comment": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string",
- "versions": [
- {
- "file_name": "string",
- "version_number": "string",
- "ppl": "string",
- "stored_type": "string",
- "stored_uri": "string",
- "comment": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}
]
}
]
}
Register the firmware.
firmware_type required | string (Firmware Type) Firmware type ID.
|
version_number required | string (Version Number) Firmware version number. |
comment | string (Comment) Default: "" Comment. *Max. 100 characters. |
file_name required | string (File Name) Firmware filename |
file_content required | string (File Content) Firmware File (BASE64 encoding). |
{- "firmware_type": "string",
- "version_number": "string",
- "comment": "",
- "file_name": "string",
- "file_content": "string"
}
{- "result": "SUCCESS"
}
Get the information of a specified firmware.
firmware_type required | string (Firmware Type) Firmware type ID
|
version_number required | string (Version Number) Firmware version number. |
{- "firmware_id": "string",
- "firmware_type": "string",
- "comment": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string",
- "versions": [
- {
- "file_name": "string",
- "version_number": "string",
- "ppl": "string",
- "stored_type": "string",
- "stored_uri": "string",
- "comment": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}
]
}
Delete the specified firmware.
firmware_type required | string (Firmware Type) Firmware type ID
|
version_number required | string (Version Number) Firmware version number |
{- "result": "SUCCESS"
}
{- "apps": [
- {
- "name": "string",
- "create_by": "string",
- "package_id": "string",
- "product_id": "string",
- "schema_info": {
- "VnSAppId": "string",
- "version": "string",
- "interfaces": {
- "in": [
- {
- "metadataFormatId": "string"
}
]
}
}, - "versions": [
- {
- "version": "string",
- "compiled_flg": "string",
- "status": "string",
- "comment": "string",
- "deploy_count": { },
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}
]
}
]
}
Import Device app.
compiled_flg required | string (Compiled Flg) Set the compiled flg.
|
entry_point | string (Entry Point) Default: "ppl" App entry point. |
app_name required | string (App Name) App name. |
version_number required | string (Version Number) App version number. |
comment | string (Comment) Comment. *Max. 100 characters. |
file_name required | string (File Name) filename. |
file_content required | string (File Content) App file content in base64 encoding. |
object (Schema Info) Schema info. |
{- "compiled_flg": "string",
- "entry_point": "ppl",
- "app_name": "string",
- "version_number": "string",
- "comment": "string",
- "file_name": "string",
- "file_content": "string",
- "schema_info": {
- "interfaces": {
- "in": [
- {
- "metadataFormatId": "string"
}
]
}
}
}
{- "result": "SUCCESS"
}
Get the information for a specified device app.
app_name required | string (App Name) App name. |
version_number required | string (Version Number) App version number. |
{- "name": "string",
- "create_by": "string",
- "package_id": "string",
- "product_id": "string",
- "schema_info": {
- "VnSAppId": "string",
- "version": "string",
- "interfaces": {
- "in": [
- {
- "metadataFormatId": "string"
}
]
}
}, - "version": "string",
- "compiled_flg": "string",
- "status": "string",
- "comment": "string",
- "deploy_count": { },
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}
Export the information for a specified device app.
app_name required | string (App Name) App name |
version_number required | string (Version Number) App version number |
{- "contents": "string",
- "file_name": "string"
}
Get Device App Deploys.
app_name required | string (App Name) App name |
version_number required | string (Version Number) App version number |
{- "deploys": [
- {
- "id": "string",
- "total_status": "string",
- "deploy_parameter": "string",
- "devices": [
- {
- "device_id": "string",
- "status": "string",
- "latest_deployment_flg": "string",
- "ins_id": "string",
- "ins_date": "string",
- "upd_id": "string",
- "upd_date": "string"
}
]
}
]
}
Get the device list with device app deployed information.
app_name required | string (App Name) App name. |
version_number required | string (Version Number) App version number. |
{- "result": "SUCCESS"
}
Deploy device app.
app_name required | string (App Name) App name. |
version_number required | string (Version Number) App version number. |
device_ids required | string (Device Ids) Specify multiple device IDs separated by commas. |
comment | string (Comment) Comment. *Max. 100 characters. |
{- "app_name": "string",
- "version_number": "string",
- "device_ids": "string",
- "comment": "string"
}
{- "result": "string",
- "app_deploy_id": 0
}
Get the URL to export the images of specified conditions in zip file format.
*For encrypted images for learning in other environments
[Prerequisites]
[Generating a Key]
The public and private keys are issued by Sier itself.
The public and private keys are issued with a length of 1024 or 2048.
The public key (key) specified to the parameter of this API passes the pem file content of the public key in a base64 encoded format.
Example: Base64 encode the entire string as follows:
-----BEGIN PUBLIC KEY-----
MIGfMA0GCSqGSIb3DQEBAQUAA4GNADC
...
-----END PUBLIC KEY-----
key required | string (Key) Public key. |
from_datetime | string (From Datetime) Default: "" Date and time (From).
|
to_datetime | string (To Datetime) Default: "" Date and time (To).
|
device_id | string (Device Id) Default: "" Device ID. |
file_format | string (File Format) Default: "" Image file format. If this is not specified, there is no filtering.
|
{- "key": "string",
- "url": "string"
}
Get the image save directory list of the devices for each device group.
device_id | string (Device Id) Device ID. |
include_deleted_device | boolean (Include deleted devices) Default: false |
[- {
- "group_id": "string",
- "devices": [
- {
- "device_id": "string",
- "device_name": "string",
- "Image": [
- "string"
]
}
]
}
]
Get the (saved) images for a specified device.
*Application: Use to display an image in a UI
device_id required | string (Device Id) Device ID. |
sub_directory_name required | string (Sub Directory Name) Directory name. |
order_by | string (Order By) Default: "ASC" Sort order: Sorted by date image was created. |
number_of_images | integer (Number Of Images) Default: 50 Number of images to fetch. |
skip | integer (Skip) Default: 0 Number of images to skip fetching. |
from_datetime | string (From Datetime) Default: "" Date and time (From).
|
to_datetime | string (To Datetime) Default: "" Date and time (To).
|
include_deleted_device | boolean (Include deleted devices) Default: false |
{- "total_image_count": 0,
- "images": [
- {
- "name": "string",
- "contents": "string"
}
]
}
delete the (saved) images for a specified device.
*There is a way to specify files or a directorie
device_id required | string (Device Id) Device ID. |
sub_directory_name required | string (Sub Directory Name) Directory name. |
filenames | Array of strings |
directory_deletion | string Default: "0" Set the directory deletion flg.
|
{- "filenames": [
- "string"
], - "directory_deletion": "0"
}
{- "result": "SUCCESS"
}
Get the (saved) images for a specified device. *Application: Use to display an image in a UI
device_id required | string A unique ID of the edge device. |
sub_directory_name required | string Directory name. |
limit | integer Default: 50 Number of images to fetch. |
starting_after | string A token to use in pagination. starting_after is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo to fetch the next page of the list. |
name_starts_with | string Default: "" Return only objects that forward match the input string |
{- "continuation_token": "string",
- "data": [
- {
- "name": "string",
- "sas_url": "string"
}
]
}
Deletes the (saved) images for a specified device. *There is a way to specify files or a directory
device_id required | string A unique ID of the edge device. |
sub_directory_name required | string Directory name. |
filenames | Array of strings |
limit | integer Default: 10000 Number of images to be deleted. The oldest stored items are deleted first. |
directory_deletion | string Default: "0" Set the directory deletion flg.
|
{- "filenames": [
- "string"
], - "limit": 10000,
- "directory_deletion": "0"
}
{- "result": "SUCCESS"
}
Get the (saved) inference result metadata information for a specified device.
device_id required | string (Device Id) Device ID. |
id required | string (Id) Inference result metadata ID. |
{- "DeviceID": "string",
- "ModelID": "string",
- "Image": true,
- "Inferences": [
- {
- "T": "string",
- "O": "string"
}
], - "id": "string",
- "ttl": 0,
- "_rid": "string",
- "_self": "string",
- "_etag": "string",
- "_attachments": "string",
- "_ts": 0
}
Get the (saved) inference result metadata list information for a specified device.
device_id required | string (Device Id) Device ID. |
NumberOfInferenceresults | integer (Numberofinferenceresults) Default: 20 Number of cases to get. |
filter | string (Filter) Default: "" Search filter
Example:
|
raw | integer (Raw) Default: 0 If 1 is specified, add a record stored to CosmosDB and return it.
|
time | string (Time) Default: "" When this value is specified, extract the inference result metadata within the following range.
|
include_deleted_device | boolean (Include deleted devices) Default: false |
[- {
- "id": "string",
- "device_id": "string",
- "model_id": "string",
- "version_number": "string",
- "model_version_id": "string",
- "model_type": "string",
- "training_kit_name": "string",
- "_ts": 0,
- "inference_result": {
- "DeviceID": "string",
- "ModelID": "string",
- "Image": true,
- "Inferences": [
- {
- "T": "string",
- "O": "string"
}
], - "id": "string",
- "ttl": 0,
- "_rid": "string",
- "_self": "string",
- "_etag": "string",
- "_attachments": "string",
- "_ts": 0
}, - "inferences": [
- {
- "T": "string",
- "O": "string"
}
]
}
]
Delete the (saved) inference result metadata list information for a specified device.
device_id required | string |
item_ids required | string Example: item_ids=1,2,3,5 |
include_deleted_device | boolean (Include deleted devices) Default: false |
{- "result": "SUCCESS"
}
Update the inference result hub connector. Set the destination Azure Event Hubs for the inference result streamed by the device using this API.
url | string (Url) Connection string for Azure Event Hubs forwarding inference result. *Do not specify when returning to the initial value. In the case of the initial value, it will be streamed within this service. |
name | string (Name) Azure Event Hubs namespace. *Do not specify when returning to the initial value. In the case of the initial value, it will be streamed within this service. |
{- "url": "string",
- "name": "string"
}
{- "result": "SUCCESS"
}
Update the storage hub connector. Set the Azure Blob storage container or AWS S3 bucket as the destination for input image and inference result streamed by the device using this API.
type | string (Type) Default: "AZURE" Set the storage service type. Specify “AZURE” as the value.
|
mode | integer (Mode) Default: 0 Set the mode. Specifies the input image, inferences result or both to be streamed.
|
endpoint | string (Endpoint) Destination Azure Blob Storage endpoint. |
connection_string | string (Connection String) Connection string for Azure Blob Storage. |
container_name | string (Container Name) Container name of Azure Blob Storage. |
{- "type": "AZURE",
- "mode": 0,
- "endpoint": "string",
- "connection_string": "string",
- "container_name": "string"
}
{- "result": "SUCCESS"
}
Upload a file. The responded 'file_info.id' can be used for file_id parameters in the following APIs.
type_code | string Enum: "NonConverted" "Converted" "InputFormatParam" "NetworkConfig" File type code. |
file | string <binary> File contents. |
{- "result": "string",
- "file_info": {
- "id": "10dd852a-a9b5-460a-a2a8-e89657f83c01",
- "name": "object_detection.tflite",
- "type_code": "NonConverted",
- "size": 489813
}
}