Documentation Powered by ReDoc

AITRIOS | Console (1.7.0)

Download OpenAPI specification:Download

Provisioning

GetQrCodeForProvisioning

Generate the service QR code information used for device provisioning.
Return a base64-encoded PNG image.

query Parameters
ntp
required
string (Ntp)

NTP. *Max. 64 characters.

auto
boolean (Auto)
Default: false

Connection state.

  • Value definition
    true: Generate QR code for auto enrollment.
    false: Generate QR code for manual enrollment.
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.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS",
  • "contents": "string"
}

Certificate

EnrollDevice

Register a device.
Assumptions and Notes:
・Registration certificate: X.509 primary certificate (.pem file or .cer file or .crt file)

Request Body schema: application/json
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.

Responses

Request samples

Content type
application/json
{
  • "device_name": "string",
  • "primary_certificate": "string"
}

Response samples

Content type
application/json
{
  • "result": "string",
  • "id": "string"
}

DeleteDevice

Delete a specified device.

path Parameters
device_id
required
string (Device Id)

Device ID

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetDeviceCertificates

Get the device certificate list information.

Responses

Response samples

Content type
application/json
{
  • "certificates":
    [
    ]
}

GetDeviceCertificate

Get the device certificate information for a specified device.

path Parameters
device_id
required
string (Device Id)

Device ID.

Responses

Response samples

Content type
application/json
{
  • "device_id": "string",
  • "internal_device_id": "string",
  • "device_name": "string",
  • "credentials_id_object": "string",
  • "credentials_type": "string",
  • "expiration_date": "string",
  • "created_time": "string"
}

UpdateDeviceCertificate

Update the device certificate information for a specified device.

path Parameters
device_id
required
string (Device Id)

Device ID

Request Body schema: application/json
primary_certificate
required
string (Primary Certificate)

Device certificate X.509 primary certificate
(.pem file or .cer file)

*Specify the following certificate without the leading and trailing signatures
-----BEGIN CERTIFICATE-----

-----END CERTIFICATE-----
Also, do not include line breaks.

Responses

Request samples

Content type
application/json
{
  • "primary_certificate": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Manage Devices

GetDevices

Get the device list information.

query Parameters
connectionState
string (Connection state)
Default: ""

Connection state.

  • Value definition
    Connected
    Disconnected
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.

  • Value definition
    full : Return full parameters
    minimal : Return minimal parameters *fast response speed

Responses

Response samples

Content type
application/json
{
  • "devices":
    [
    ]
}

GetDevice

Get the information for a specified device.

path Parameters
device_id
required
string (Device Id)

Device ID.

Responses

Response samples

Content type
application/json
{
  • "device_id": "string",
  • "place": "string",
  • "comment": "string",
  • "property":
    {
    },
  • "device_type": "string",
  • "display_device_type": "string",
  • "ins_id": "string",
  • "ins_date": "string",
  • "upd_id": "string",
  • "upd_date": "string",
  • "connectionState": "string",
  • "lastActivityTime": "string",
  • "models":
    [
    ],
  • "device_groups":
    [
    ],
  • "configuration": { },
  • "state": { },
  • "command_results":
    [
    ],
  • "apps":
    [
    ]
}

SetPermission

Set whether to allow or deny execution of factory reset for a specified device.

path Parameters
device_id
required
string (Device Id)

Device ID.

query Parameters
factory_reset
required
string (Factory Reset)

Set whether to allow or deny execution of factory reset for a specified device.

  • Value definition
    true: Permit
    false: Prohibit

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetDeviceGroups

Get the device group information list.

query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "device_groups":
    [
    ]
}

CreateDeviceGroup

Register a device group.

query Parameters
device_group_id
required
string (Device Group Id)

Device Group ID
Single-byte characters, max. 100 characters, no single-byte commas.

comment
string (Comment)
Default: ""

Description. Max. 100 characters.

device_id
string (Device Id)
Default: ""

Affiliated device ID.
When there are multiple,

  • use comma separation
  • the same value cannot be specified
del_from_dgroup
string (Dell flg from device group)
Default: "0"

Specify whether to delete the specified device affiliation from the default group

  • Value definition 0: Do not delete
    1: Delete

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetDeviceGroup

Get the information for a specified device group.

path Parameters
device_group_id
required
string (Device Group Id)

Device group ID.

Responses

Response samples

Content type
application/json
{
  • "device_group_id": "string",
  • "device_type": "string",
  • "comment": "string",
  • "ins_id": "string",
  • "ins_date": "string",
  • "upd_id": "string",
  • "upd_date": "string",
  • "devices":
    [
    ]
}

DeleteDeviceGroup

Delete a specified device group.

path Parameters
device_group_id
required
string (Device Group Id)

Device group ID to be deleted.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

UpdateDeviceGroup

Update a specified device group.

path Parameters
device_group_id
required
string (Device Group Id)

Device group ID to be updated.

query Parameters
comment
string (Comment)
Default: ""

Description. Max. 100 characters.

device_id
string (Device Id)
Default: ""

Affiliated device ID to be replaced.
When updating to an unaffiliated device ID, specify @@nullupdate.
When there are multiple,

  • use comma separation
  • the same value cannot be specified

*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.

  • Value definition 0: Do not delete
    1: Delete
  • When both comment and del_from_dgroup are not specified, an error occurs

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Device Command

StartUploadInferenceResult

Implement instructions to a specified device to start to get the inference result metadata (Output Tensor) and image (Input image).

path Parameters
device_id
required
string (Device Id)

Device ID.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS",
  • "outputSubDirectory": "string",
  • "outputSubDirectoryIR": "string"
}

StopUploadInferenceResult

Implement instructions to a specified device to stop getting the inference result metadata (Output Tensor) and image (Input image).

path Parameters
device_id
required
string (Device Id)

Device ID.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Reboot

Reboot a specified device.

path Parameters
device_id
required
string (Device Id)

Device ID.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

ResetDevice

Implement the following for a specified device to initialize the settings.

  • Factory reset
  • Delete device information from the service
    *However, the inference result metadata and image data are not deleted
path Parameters
device_id
required
string (Device Id)

Device ID.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

SetDeviceLog

DO NOT USE THIS API. Change the log settings of a specified device.

path Parameters
device_id
required
string (Device Id)

Device ID

query Parameters
level
string (Level)
Default: "Error"

Log level.

  • Value definition *Not case sensitive
    Error
    Warn
    Info
    Debug
    Verbose
destination
string (Destination)
Default: "UART"

By output destination type

  • Value definition *Not case sensitive
    UART
    Cloud
    Both
SensorRegister
string (Sensorregister)
Default: false

Sensor register.

  • Value definition
    true
    false

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

SetDeviceAppLog

Enable device app logging for a specified devices.

path Parameters
device_id
required
string (Device Id)

Device ID

Request Body schema: application/json
enable
boolean (Log Enable)
Default: true

Set logging enable/disable.

  • Value definition
    true : enable
    false : disable

Responses

Request samples

Content type
application/json
{
  • "enable": true
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

SetImageConfiguration

Set the frame rate or drive mode of image. Frame rate or drive mode must be set.

path Parameters
device_id
required
string (Device Id)

Device ID

Request Body schema: application/json
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).

  • Value definition
    99
    499
    999
    1248
    1498
    1998
    2497
    2997
drive_mode
integer (Drive Mode)
Default: 1

Set the drive mode.

  • Value definition
    1 2
    3 4
  • Drive mode spec
    Mode Binning Scale Crop Raw Size Max Frame Rate
    1 On - - 2028x1520 30(29.97)fps
    2 Off On - 2028x1520 20(19.98)fps
    3 Off Off On 2028x1520 20(19.98)fps
    4 Off Off Off 4056x3040 10(9.99)fps

Responses

Request samples

Content type
application/json
{
  • "frame_rate": 2997,
  • "drive_mode": 1
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetDirectImage

Get the image of a specified device in real-time.
This API is for pseudo-streaming.

path Parameters
device_id
required
string (Device Id)

Device ID.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS",
  • "contents": "string"
}

ChangePassword

Update the following password for a specified device:

  • Proxy
path Parameters
device_id
required
string (Device Id)

Device ID.

Request Body schema: application/json
password
required
string (Password)

Plaintext and max. *Max. 32 characters.

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

SetDeviceConfiguration

Set the Device Configuration of a specified device.

path Parameters
device_id
required
string (Device Id)

Device ID

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "payload":
    {
    }
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Command Parameter File

GetCommandParameterFile

Get the command parameter file list information..

Responses

Response samples

Content type
application/json
{
  • "parameter_list":
    [
    ]
}

RegistCommandParameterFile

Register CommandParameterFile.

This API can be used to register the following API parameters in advance:

  • StartUploadInferenceData API

The following are the APIs for file management and application to the device:

< Parameter file management >

  • RegistCommandParameterFile API
  • GetCommandParameterFile API
  • UpdateCommandParameterFile API
  • DeleteCommandParameterFile API

< Bind to/Unbind from device >

  • BindCommandParameterFileToDevice API
  • UnbindCommandParameterFile API

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:

  • SetDefaultCommandParameterFile API
Request Body schema: application/json
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.

Responses

Request samples

Content type
application/json
{
  • "file_name": "string",
  • "parameter": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

UpdateCommandParameterFile

Update command parameter file.

path Parameters
file_name
required
string (File Name)

Filename.

Request Body schema: application/json
parameter
required
string (Parameter)

Command parameter content in base64 encoding. *See manual for detailed format

comment
string (Comment)

Comment.

Responses

Request samples

Content type
application/json
{
  • "parameter": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

DeleteCommandParameterFile

Delete command parameter file.

path Parameters
file_name
required
string (File Name)

Filename.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

ExportCommandParameterFile

Export the information for a specified command parameter file.

path Parameters
file_name
required
string (File Name)

Filename.

Responses

Response samples

Content type
application/json
{
  • "contents": "string",
  • "file_name": "string"
}

SetDefaultCommandParameterFile

Set the default file of command parameter file.

path Parameters
file_name
required
string (File Name)

Filename.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

BindCommandParameterFileToDevice

Bind command parameter file to device.

path Parameters
file_name
required
string (File Name)

Filename.

Request Body schema: application/json
device_ids
required
string (Device Ids)

Specify multiple device IDs separated by commas.

Responses

Request samples

Content type
application/json
{
  • "device_ids": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

UnbindCommandParameterFile

Unbind command parameter file.

path Parameters
file_name
required
string (File Name)

Filename.

Request Body schema: application/json
device_ids
required
string (Device Ids)

Specify multiple device IDs separated by commas.

Responses

Request samples

Content type
application/json
{
  • "device_ids": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Deploy

GetDeployConfigurations

Get the deploy config list.

Responses

Response samples

Content type
application/json
{
  • "deploy_configurations":
    [
    ]
}

CreateDeployConfiguration

Register the deploy config information to deploy to the following devices.

  • Firmware
  • AI model
query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetDeployConfiguration

Get the information of the specified deployment config.

path Parameters
config_id
required
string (Config Id)

Deploy Config ID

Responses

Response samples

Content type
application/json
{
  • "config_id": "string",
  • "device_type": "string",
  • "config_comment": "string",
  • "running_cnt": 0,
  • "success_cnt": 0,
  • "fail_cnt": 0,
  • "firmware":
    {
    },
  • "model":
    {
    },
  • "ins_id": "string",
  • "ins_date": "string",
  • "upd_id": "string",
  • "upd_date": "string"
}

DeployByConfiguration

Provide a function for deploying the following to devices specified with deploy config.

  • Firmware
  • AI model
path Parameters
config_id
required
string (Config Id)

Setting ID.

query Parameters
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.
*If the model with the specified model ID does not exist in the database, treat the entered value as the network_id and process it.

comment
string (Comment)
Default: ""

Max. 100 characters

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS",
  • "deploy_id": 12345
}

DeleteDeployConfiguration

Delete the information for a specified deploy config.

path Parameters
config_id
required
string (Config Id)

Config ID

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

CancelDeployment

Force cancellation of the device deployment status.

path Parameters
device_id
required
string (Device Id)

Device ID

deploy_id
required
integer (Deploy Id)

Deploy ID

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetDeployHistory

Get the deploy history for a specified device.

path Parameters
device_id
required
string (Device Id)

Device ID

Responses

Response samples

Content type
application/json
{
  • "deploys":
    [
    ]
}

GetDeployStatusHistory

Get deploy history status list in deployment layer

query Parameters
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.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

GetDeployStatus

Get deploy status by deploy id.

path Parameters
deploy_id
required
integer (Deployment ID)

Deployment ID

deploy_type
required
string (deploy_type)

Deploy type

  • Value definition
    config
    app

Responses

Response samples

Content type
application/json
{
  • "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":
    [
    ]
}

DeployDeviceModel

Deploy a device model for a specified device..

path Parameters
model_id
required
string (Model Id)

Model ID.

device_id
required
string (Device Id)

Device ID.

query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

UndeployModel

Undeploy a DNN Model for a specified device.

path Parameters
device_id
required
string (Device Id)

Device ID.

model_id
required
string (Model Id)

Model ID.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Train Model

GetTrainingKits

Get the specified training kit information list.

query Parameters
order_by
string (Order By)
Default: "asc"

Sort order: Sorted by date training kit was created.
Value range: desc, asc

Responses

Response samples

Content type
application/json
{
  • "training_kits":
    [
    ]
}

GetProjects

Get the project list information.

query Parameters
project_name
string (Project Name)

Project name. *partial position search

model_platform
string (Model Platform)

Model Platform.

  • Value definition
    0 : Custom Vision
    1 : Non Custom Vision
project_type
string (Project Type)

Project Type.

  • Value definition
    0 : Base model
    1 : Device model
device_id
string (Device Id)

Device Id.

include_training_flg
string (Include Training Flg)
Default: "0"

Specify true to get the project property.

Responses

Response samples

Content type
application/json
{
  • "model_projects":
    [
    ]
}

CreateBaseProject

Create the project for the base model.

query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

CreateDeviceProject

Create a project for the device model based on the base model of the specified model.

query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetProject

Get the specified project information.

path Parameters
project_name
required
string (Project Name)

Project name.

query Parameters
include_training_flg
string (Include Training Flg)
Default: "0"

Specify true to get the project property.

Responses

Response samples

Content type
application/json
{
  • "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":
    {
    },
  • "model":
    {
    }
}

DeleteProject

Delete the specified project.
*If the project has already saved the model, delete it with DeleteModel API.

path Parameters
project_name
required
string (Project Name)

Project name.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

SaveModel

Export and save the pre-conversion model from the base or device project.

path Parameters
project_name
required
string (Project Name)

Project name.

query Parameters
model_id
string (Model Id)

Model Id. Max. 20 single characters, single-byte characters only.
*Specify only when registering a new base model.

initial_version_number
integer (Initial Version Number)
Default: "1"

Initial Version Number.
*Specify only when registering a new base model.

  • Value range : 1 to 99
functionality
string (Functionality)

Functionality. Max. 100 characters.
*Specify only when registering a new base model.

vendor_name
string (Vendor Name)

Vendor Name. Max. 100 characters.
*Specify only when registering a new base model.

comment
string (Comment)

Description. Max. 100 characters.
*When saving new, it is set as a description of the model and version.
*When saving version-up, it is set as a description of the version.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetRelearnStatus

Get the relearning status of the specified project.

path Parameters
project_name
required
string (Project Name)

Project name.

Responses

Response samples

Content type
application/json
{
  • "result": "string",
  • "status": "string"
}

Relearn

Relearn the specified project.

path Parameters
project_name
required
string (Project Name)

Project name.

query Parameters
training_type
string (Training Type)
Default: "Regular"

Training type. *Specify only for Custom Vision projects.

  • Value definition
    Regular : Quick training.
    Advanced : Advanced training. *Specify the reserved budget (in hours) in the reserved_budget_in_hours parameter.
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.

Responses

Response samples

Content type
application/json
{
  • "result": "string",
  • "iteration_id": "string",
  • "iteration_name": "string"
}

ImportImagesFromFiles

Import the image file used for re-learning into the project.

path Parameters
project_name
required
string (Project Name)

Project name.

Request Body schema: application/json
required
Array of objects (Images)
tags_name
Array of any (Tags Name)
Default: []

Set the label *Specify for classification. Supports only 1 tag.

Responses

Request samples

Content type
application/json
{
  • "images":
    [
    ],
  • "tags_name": [ ]
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

ImportImagesFromScblob

Import the image file used for retraining into the project via Azure Blob Storage.

path Parameters
project_name
required
string (Project Name)
Request Body schema: application/json
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.

Responses

Request samples

Content type
application/json
{
  • "container_url": "string",
  • "tags_name": [ ]
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetProjectIterations

Get the Iterations information list of the specified project.

path Parameters
project_id
required
string (Project Id)

Project ID.

query Parameters
overlap_threshold
string (Overlap Threshold)
Default: "0.3"

Overlap threshold.

threshold
string (Threshold)
Default: "0.5"

threshold.

Responses

Response samples

Content type
application/json
{
  • "iterations":
    [
    ]
}

GetProjectImages

Get the image list of the specified project.

path Parameters
project_id
required
string (Project Id)

Project ID.

query Parameters
iteration_id
string (Iteration Id)

Iteration ID.

order_by
string (Order By)
Default: "newest"

Sort order: Sorted by date image was created.
Value range: newest, oldest

number_of_images
string (Number Of Images)
Default: 50

Number Of images.
Value range: 0 to 256

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.

  • Value definition
    resized
    thumbnail
    original

Responses

Response samples

Content type
application/json
{
  • "total_image_count": 0,
  • "images":
    [
    ]
}

DeleteProjectImages

Delete images from a project by image ID.

path Parameters
project_id
required
string (Project Id)

Project ID.

query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetProjectImagesById

Get the image list of the specified project with image ID as a condition.

path Parameters
project_id
required
string (Project Id)

Project ID.

query Parameters
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.

  • Value definition
    resized
    thumbnail
    original

Responses

Response samples

Content type
application/json
{
  • "images":
    [
    ]
}

GetImageRegionProposals

Get the regison proposal (inference result) of object detection for the image with the specified image ID.

path Parameters
project_id
required
string (Project Id)

Project ID.

image_id
required
string (Image Id)

Image ID.

Responses

Response samples

Content type
application/json
{
  • "project_id": "string",
  • "image_id": "string",
  • "proposals":
    [
    ]
}

CreateProjectImageRegions

Sets the tag for the images in the specified project.

path Parameters
project_id
required
string (Project Id)

Project ID.

Request Body schema: application/json
Array of objects (Regions)

Responses

Request samples

Content type
application/json
{
  • "regions":
    [
    ]
}

Response samples

Content type
application/json
{
  • "created":
    [
    ],
  • "duplicated":
    [
    ],
  • "exceeded":
    [
    ]
}

UpdateProjectImageRegions

Updates tags for images in the specified project.

path Parameters
project_id
required
string (Project Id)

Description.

Request Body schema: application/json
Array of objects (Regions)

Responses

Request samples

Content type
application/json
{
  • "regions":
    [
    ]
}

Response samples

Content type
application/json
{
  • "updated":
    [
    ]
}

DeleteProjectImageRegions

Remove tags from images in the specified project.

path Parameters
project_id
required
string (Project Id)

Project id.

region_id
required
string (Region Id)

Region id.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetProjectTags

Get project tag list.

path Parameters
project_id
required
string (Project Id)

project ID

query Parameters
iteration_id
string (Iteration Id)

Iteration ID

order_by
string (Order By)
Default: "asc"

Sort order: Sorted by date tag was created.
Value range: asc, desc

Responses

Response samples

Content type
application/json
{
  • "tags":
    [
    ]
}

CreateProjectTag

Create a new tag in the specified project.

path Parameters
project_id
required
string (Project Id)

Project ID

query Parameters
tag_name
required
string (Tag Name)

tag name.

description
string (Description)

Description.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "type": "string",
  • "image_count": "string"
}

DeleteProjectTag

Remove tags for the specified project. api.

path Parameters
project_id
required
string (Project Id)

Project ID.

tag_id
required
string (Tag Id)

tag ID.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

UpdateProjectTag

Update tags for the specified project.

path Parameters
project_id
required
string (Project Id)

Project ID

tag_id
required
string (Tag Id)

tag ID.

Request Body schema: application/json
name
required
string (Name)

Name.

description
string (Description)

Description.

type
required
string (Type)

type. *Specify Regular as fixed.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "type": "string",
  • "image_count": "string"
}

GetProjectTaggedImages

Get tagged image information for the specified project.

path Parameters
project_id
required
string (Project Id)

Project ID.

query Parameters
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..
Value range: 0 to 256

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.
Value range: newest, oldest

image_size_type
string (Image Size Type)
Default: "resized"

Image size type. *Specify if the project is Custom Vision.

  • Value definition
    resized
    thumbnail
    original

Responses

Response samples

Content type
application/json
{
  • "total_image_count": 0,
  • "tagged_images":
    [
    ],
  • "blank_tags":
    [
    ]
}

GetProjectUntaggedImages

Get untagged image information for the specified project.

path Parameters
project_id
required
string (Project Id)

Project ID.

query Parameters
iteration_id
string (Iteration Id)

Iteration ID.

number_of_images
integer (Number Of Images)
Default: 50

Number of images to fetch..
Value range: 0 to 256

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.
Value range: newest, oldest

image_size_type
string (Image Size Type)
Default: "resized"

Image size type. *Specify if the project is Custom Vision.

  • Value definition
    resized
    thumbnail
    original

Responses

Response samples

Content type
application/json
{
  • "total_image_count": 0,
  • "untagged_images":
    [
    ]
}

GetModels

Get the model list information.

query Parameters
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.

  • Value definition
    0 : Custom Vision
    1 : Non Custom Vision
project_type
string (Project Type)

Project Type.

  • Value definition
    0 : Base model
    1 : Device model
device_id
string (Device Id)

Device Id.

latest_type
string (Latest Type)
Default: "1"

Latest version type..

  • Value definition
    0: Latest published version
    1: Latest version (latest including model version being converted/published)

Responses

Response samples

Content type
application/json
{
  • "models":
    [
    ]
}

ImportBaseModel

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.

Request Body schema: application/json
One of
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.
*Usage: Packager conversion information (image format information).
*The json format is an array of objects. Each object contains the following values.
 ・ordinal: Order of DNN input to converter (value range: 0 to 2)
 ・format: Format ("RGB" or "BGR")
*Example:
 [{      "ordinal": 0,
     "format": "RGB"
 },
 {
     "ordinal": 1,
     "format": "RGB"
 }]

network_config
string (Network Config)

SAS URI or Presigned URI of the network config file.
*Usage: Conversion parameter information of modelconverter. Therefore, it is not necessary to specify when specifying the model before conversion.
*Example:
 {
   "Postprocessor": {
     "params": {
       "background": false,
       "scale_factors": [
         10.0,
         10.0,
         5.0,
         5.0
       ],
       "score_thresh": 0.01,
       "max_size_per_class": 64,
       "max_total_size": 64,
       "clip_window": [
         0,
         0,
         1,
         1
       ],
       "iou_threshold": 0.45
     }
   }
 }

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.
*Specify only when registering a new base model.

comment
string (Comment)

Description. Max. 100 characters.
*When saving new, it is set as a description of the model and version.
*When saving version-up, it is set as a description of the version.

network_type
string (Network Type)
Default: "1"

Specify whether or not application is required for the model.

  • Value definition
    0 : Model required application
    1 : Model do not required application
metadata_format_id
string (Metadata Format ID)

Metadata Format ID. Max. 100 characters.

Responses

Request samples

Content type
application/json
Example
input_model_url
input_model_url
file_id
{
  • "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"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

PublishModel

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.

path Parameters
model_id
required
string (Model Id)

Model ID.

query Parameters
device_id
string (Device Id)

Device ID
*Specify this when the device model is the target.
Do not specify this when the base model is the target.

Responses

Response samples

Content type
application/json
{
  • "result": "string",
  • "import_id": "string"
}

DeleteModel

Deletes the base model, device model, and project associated with the specified model ID.

path Parameters
model_id
required
string (Model Id)

Model ID.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

UpdateModel

Edit the attribute information of the specified model.

path Parameters
model_id
required
string (Model Id)

Model ID. 100 characters.

query Parameters
comment
string (Comment)

Description. 100 characters.

version_number
string (Version Number)

Vendor Name. Max. 100 characters.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetBaseModelStatus

Get the specified base model information.

path Parameters
model_id
required
string (Model Id)

Model ID.

query Parameters
latest_type
string (Latest Type)
Default: "1"

Latest version type..

  • Value definition
    0: Latest published version
    1: Latest version (latest including model version being converted/published)

Responses

Response samples

Content type
application/json
{
  • "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":
    [
    ]
}

GetBaseModelVersions

Get base model the version list information.

path Parameters
model_id
required
string (Model Id)

Model ID.

query Parameters
version_number
string (Version Number)

Version number.

scope
string (Scope)
Default: "full"

Specify the scope of response parameters to return.

  • Value definition
    full : Return full parameters
    minimal : Return minimal parameters *fast response speed

Responses

Response samples

Content type
application/json
{
  • "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":
    [
    ]
}

UpdateBaseModelVersion

Edit the attribute information of the specified base model version.

path Parameters
model_id
required
string (Model Id)

Model ID.

version_number
required
string (Version Number)

Version number.

Request Body schema: application/json
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.
*Usage: Packager conversion information (image format information).
*The json format is an array of objects. Each object contains the following values.
 ・ordinal: Order of DNN input to converter (value range: 0 to 2)
 ・format: Format ("RGB" or "BGR")
*Example:
 [{      "ordinal": 0,
     "format": "RGB"
 },
 {
     "ordinal": 1,
     "format": "RGB"
 }]

network_config
string (Network Config)

SAS URI or Presigned URI of the network config file.
*Usage: Conversion parameter information of modelconverter. Therefore, it is not necessary to specify when specifying the model before conversion.
*Example:
 {
   "Postprocessor": {
     "params": {
       "background": false,
       "scale_factors": [
         10.0,
         10.0,
         5.0,
         5.0
       ],
       "score_thresh": 0.01,
       "max_size_per_class": 64,
       "max_total_size": 64,
       "clip_window": [
         0,
         0,
         1,
         1
       ],
       "iou_threshold": 0.45
     }
   }
 }

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "input_format_param": "string",
  • "network_config": "string"
}

Response samples

Content type
application/json
{
  • "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":
    [
    ]
}

GetDeviceModelStatus

Get the specified device model information.

path Parameters
model_id
required
string (Model Id)

Model ID.

device_id
required
string (Device Id)

Device ID.

query Parameters
latest_type
string (Latest Type)
Default: "1"

Latest version type..

  • Value definition
    0: Latest published version
    1: Latest version (latest including model version being converted/published)

Responses

Response samples

Content type
application/json
{
  • "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":
    [
    ]
}

GetDeviceModelVersions

Get device model version list information.

path Parameters
model_id
required
string (Model Id)

Model ID.

device_id
required
string (Device Id)

Device ID.

query Parameters
scope
string (Scope)
Default: "full"

Specify the scope of response parameters to return.

  • Value definition
    full : Return full parameters
    minimal : Return minimal parameters *fast response speed
version_number
string (Version Number)

Version number.

Responses

Response samples

Content type
application/json
{
  • "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":
    [
    ]
}

UpdateDeviceModelVersion

Edit the attribute information of the model version for the specified device.

path Parameters
model_id
required
string (Model Id)

Model ID.

device_id
required
string (Device Id)

Device ID.

version_number
required
string (Version Number)

Version number.

Request Body schema: application/json
comment
required
string (Comment)

Description of version.

Responses

Request samples

Content type
application/json
{
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetDnnParams

Get dnn_params information of the specified model.

path Parameters
model_id
required
string (Model Id)

Model ID.

query Parameters
version_number
string (Version Number)
Default: "latest"

Version number.

device_id
string (Device Id)

Device ID
*Specify this when the device model is the target.
Do not specify this when the base model is the target.

Responses

Response samples

Content type
application/json
{
  • "contents": "string"
}

Firmware

GetFirmwares

Get the firmware information list.

query Parameters
firmware_type
string (Firmware Type)

Firmware type ID .

  • Value definition
    00: MCU(AppFw)
    01: IMX500(Sensor)
    02: IMX500(SensorLoader)

Responses

Response samples

Content type
application/json
{
  • "firmwares":
    [
    ]
}

CreateFirmware

Register the firmware.

Request Body schema: application/json
firmware_type
required
string (Firmware Type)

Firmware type ID.

  • Value definition
    00: MCU(AppFw)
    01: IMX500(Sensor)
    02: IMX500(SensorLoader)
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).

Responses

Request samples

Content type
application/json
{
  • "firmware_type": "string",
  • "version_number": "string",
  • "comment": "",
  • "file_name": "string",
  • "file_content": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetFirmware

Get the information of a specified firmware.

path Parameters
firmware_type
required
string (Firmware Type)

Firmware type ID

  • Value definition
    00: MCU(AppFw)
    01: IMX500(Sensor)
    02: IMX500(SensorLoader)
version_number
required
string (Version Number)

Firmware version number.

Responses

Response samples

Content type
application/json
{
  • "firmware_id": "string",
  • "firmware_type": "string",
  • "comment": "string",
  • "ins_id": "string",
  • "ins_date": "string",
  • "upd_id": "string",
  • "upd_date": "string",
  • "versions":
    [
    ]
}

DeleteFirmware

Delete the specified firmware.

path Parameters
firmware_type
required
string (Firmware Type)

Firmware type ID

  • Value definition
    00: MCU(AppFw)
    01: IMX500(Sensor)
    02: IMX500(SensorLoader)
version_number
required
string (Version Number)

Firmware version number

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Device App

GetDeviceApps

Get the device app list information.

Responses

Response samples

Content type
application/json
{
  • "apps":
    [
    ]
}

ImportDeviceApp

Import Device app.

Request Body schema: application/json
compiled_flg
required
string (Compiled Flg)

Set the compiled flg.

  • Value definition
    0 : Specified App is not compiled
    1 : Specified App is compiled
entry_point
string (Entry Point)
Default: "ppl"

App entry point.

app_name
required
string (App Name)

App name.
*Allow only the following characters.
Alphanumeric characters
Under bar
Dot
*The maximum number of characters is app_name + version_number <=31.

version_number
required
string (Version Number)

App version number.
*Allow only the following characters.
Alphanumeric characters
Under bar
Dot
*The maximum number of characters is app_name + version_number <=31.

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.

Responses

Request samples

Content type
application/json
{
  • "compiled_flg": "string",
  • "entry_point": "ppl",
  • "app_name": "string",
  • "version_number": "string",
  • "comment": "string",
  • "file_name": "string",
  • "file_content": "string",
  • "schema_info":
    {
    }
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetDeviceApp

Get the information for a specified device app.

path Parameters
app_name
required
string (App Name)

App name.

version_number
required
string (Version Number)

App version number.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "create_by": "string",
  • "package_id": "string",
  • "product_id": "string",
  • "schema_info":
    {
    },
  • "version": "string",
  • "compiled_flg": "string",
  • "status": "string",
  • "comment": "string",
  • "deploy_count": { },
  • "ins_id": "string",
  • "ins_date": "string",
  • "upd_id": "string",
  • "upd_date": "string"
}

DeleteDeviceApp

Delete device app.

path Parameters
app_name
required
string (App Name)

App name.

version_number
required
string (Version Number)

App version number.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

ExportDeviceApp

Export the information for a specified device app.

path Parameters
app_name
required
string (App Name)

App name

version_number
required
string (Version Number)

App version number

Responses

Response samples

Content type
application/json
{
  • "contents": "string",
  • "file_name": "string"
}

GetDeviceAppDeploys

Get Device App Deploys.

path Parameters
app_name
required
string (App Name)

App name

version_number
required
string (Version Number)

App version number

Responses

Response samples

Content type
application/json
{
  • "deploys":
    [
    ]
}

GetAppDevices

Get the device list with device app deployed information.

path Parameters
app_name
required
string (App Name)

App name.

version_number
required
string (Version Number)

App version number.

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

DeployDeviceApp

Deploy device app.

Request Body schema: application/json
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.

Responses

Request samples

Content type
application/json
{
  • "app_name": "string",
  • "version_number": "string",
  • "device_ids": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "result": "string",
  • "app_deploy_id": 0
}

UndeployDeviceApp

Undeploy device app.

query Parameters
device_ids
required
string (Device Ids)

Device IDs

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Insight

ExportImages

Get the URL to export the images of specified conditions in zip file format.
*For encrypted images for learning in other environments

[Prerequisites]

  • A zip file containing the target images can be downloaded by accessing a URL.
    Each image is encrypted using the method described hereafter.
  • The image is encrypted with the shared key issued randomly by the API. This shared key is used to decrypt the image.
  • The image encryption method is AES128, MODE_CBC
  • The iv (1) and encrypted data(2) are stored in a zip file.
    *1. The first 16 bytes are the initial vector(iv). When decrypting, this will be used for iv.
    *2. The image starts from the 17th byte and is padded using the pkcs7 algorithm with the AES block size (16 bytes). When decrypting, decrypt and unpad the data after 17 bytes excluding iv.
  • The shared key can be obtained by decrypting the key responded by the API(*3) with the secret key.
    *3. The key responded to by the API is encrypted on RSA and the OAEP padding. It is also base64 encoded. When decrypting, base64 decode and decrypt.

[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-----

query Parameters
key
required
string (Key)

Public key.
*Base64-encoded format of the entire pem file contents of the public key

from_datetime
string (From Datetime)
Default: ""

Date and time (From).

  • Format: yyyyMMddhhmm
to_datetime
string (To Datetime)
Default: ""

Date and time (To).

  • Format: yyyyMMddhhmm
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.

  • Value definition
    JPG
    BMP

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "url": "string"
}

GetImageDirectories

Get the image save directory list of the devices for each device group.

query Parameters
device_id
string (Device Id)

Device ID.
If this is specified, return an image directory list linked to the specified device ID.

include_deleted_device
boolean (Include deleted devices)
Default: false

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GetImages

Get the (saved) images for a specified device.
*Application: Use to display an image in a UI

path Parameters
device_id
required
string (Device Id)

Device ID.

sub_directory_name
required
string (Sub Directory Name)

Directory name.

query Parameters
order_by
string (Order By)
Default: "ASC"

Sort order: Sorted by date image was created.
Value range: DESC, ASC

number_of_images
integer (Number Of Images)
Default: 50

Number of images to fetch.
Value range: 0 to 256

skip
integer (Skip)
Default: 0

Number of images to skip fetching.

from_datetime
string (From Datetime)
Default: ""

Date and time (From).

  • Format: yyyyMMddhhmm
to_datetime
string (To Datetime)
Default: ""

Date and time (To).

  • Format: yyyyMMddhhmm
include_deleted_device
boolean (Include deleted devices)
Default: false

Responses

Response samples

Content type
application/json
{
  • "total_image_count": 0,
  • "images":
    [
    ]
}

DeleteImages

delete the (saved) images for a specified device.
*There is a way to specify files or a directorie

path Parameters
device_id
required
string (Device Id)

Device ID.

sub_directory_name
required
string (Sub Directory Name)

Directory name.

Request Body schema: application/json
filenames
Array of strings
directory_deletion
string
Default: "0"

Set the directory deletion flg.

  • Value definition
    0 : Delete by specifying a file 1 : Delete by specifying a directory

Responses

Request samples

Content type
application/json
{
  • "filenames":
    [
    ],
  • "directory_deletion": "0"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetImages Stable

Get the (saved) images for a specified device. *Application: Use to display an image in a UI

path Parameters
device_id
required
string

A unique ID of the edge device.

sub_directory_name
required
string

Directory name.

query Parameters
limit
integer
Default: 50

Number of images to fetch.
Value range: 1 to 256

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

Responses

Response samples

Content type
application/json
{
  • "continuation_token": "string",
  • "data":
    [
    ]
}

DeleteImages Stable

Deletes the (saved) images for a specified device. *There is a way to specify files or a directory

path Parameters
device_id
required
string

A unique ID of the edge device.

sub_directory_name
required
string

Directory name.

Request Body schema: application/json
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.

  • Value definition
    0 : Delete by specifying a file 1 : Delete files by specifying a directory

Responses

Request samples

Content type
application/json
{
  • "filenames":
    [
    ],
  • "limit": 10000,
  • "directory_deletion": "0"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

GetInferenceResult

Get the (saved) inference result metadata information for a specified device.

path Parameters
device_id
required
string (Device Id)

Device ID.

id
required
string (Id)

Inference result metadata ID.

Responses

Response samples

Content type
application/json
{
  • "DeviceID": "string",
  • "ModelID": "string",
  • "Image": true,
  • "Inferences":
    [
    ],
  • "id": "string",
  • "ttl": 0,
  • "_rid": "string",
  • "_self": "string",
  • "_etag": "string",
  • "_attachments": "string",
  • "_ts": 0
}

GetInferenceResults

Get the (saved) inference result metadata list information for a specified device.

path Parameters
device_id
required
string (Device Id)

Device ID.

query Parameters
NumberOfInferenceresults
integer (Numberofinferenceresults)
Default: 20

Number of cases to get.
Return the latest record of the specified number of cases. *Maximum value: 10000

filter
string (Filter)
Default: ""

Search filter
*The specifications are the same except for those of CosmosDB UI of the Azure portal and those listed below.

  • A where string does not need to be added to the heading.
  • deviceID does not need to be added.

Example:

  • Filter by model ID
    c.ModelID = "0201020001790103"
  • Filter by Cosmos time stamp
    c._ts > 1606897951
raw
integer (Raw)
Default: 0

If 1 is specified, add a record stored to CosmosDB and return it.

  • Value definition
    0: Do not add
    1: Add
time
string (Time)
Default: ""

When this value is specified, extract the inference result metadata within the following range.

  • Extraction range
    (time - threshold) <= T *Time in inference result metadata < (time + threshold)

    • threshold = 5 msec

  • Value definition
    yyyy: 4-digit year string
    MM: 2-digit month string
    dd: 2-digit day string
    HH: 2-digit hour string
    mm: 2-digit minute string
    ss: 2-digit second string
    fff: 3-digit millisecond string

include_deleted_device
boolean (Include deleted devices)
Default: false

Responses

Response samples

Content type
application/json
[
  • {
    }
]

DeleteInferenceResults

Delete the (saved) inference result metadata list information for a specified device.

path Parameters
device_id
required
string
query Parameters
item_ids
required
string
Example: item_ids=1,2,3,5
include_deleted_device
boolean (Include deleted devices)
Default: false

Responses

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Connector

UpdateIRHubConnector

Update the inference result hub connector. Set the destination Azure Event Hubs for the inference result streamed by the device using this API.

Request Body schema: application/json
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.

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

UpdateStorageConnector

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.

Request Body schema: application/json
One of
type
string (Type)
Default: "AZURE"

Set the storage service type. Specify “AZURE” as the value.

  • Value definition
    AZURE
mode
integer (Mode)
Default: 0

Set the mode. Specifies the input image, inferences result or both to be streamed.

  • Value definition
    0 : input image only
    1 : input image and inference result
    2 : inference result only
endpoint
string (Endpoint)

Destination Azure Blob Storage endpoint.
*Do not specify “endpoint”, “connection_string”, or “container_name” when returning to the initial value. In the case of the initial value when input image is specified in “mode”, it will be streamed within this service and then when inference result is specified in “mode”, The settings for inference are deleted.

connection_string
string (Connection String)

Connection string for Azure Blob Storage.
*When initializing, see the description of “endpoint”.

container_name
string (Container Name)

Container name of Azure Blob Storage.
*When initializing, see the description of “endpoint”.

Responses

Request samples

Content type
application/json
Example
Azure
Azure
AWS
{
  • "type": "AZURE",
  • "mode": 0,
  • "endpoint": "string",
  • "connection_string": "string",
  • "container_name": "string"
}

Response samples

Content type
application/json
{
  • "result": "SUCCESS"
}

Utility

UploadFile

Upload a file. The responded 'file_info.id' can be used for file_id parameters in the following APIs.

  • ImportBaseModel
Request Body schema: multipart/form-data
type_code
string
Enum: "NonConverted" "Converted" "InputFormatParam" "NetworkConfig"

File type code.

file
string <binary>

File contents.

Responses

Response samples

Content type
application/json
{
  • "result": "string",
  • "file_info":
    {
    }
}