API docs by Redocly

Bind Vison API 仕様書 (1.0.0)

Download OpenAPI specification:Download

Bind Vison 仕様書

authentication

ログインを行う

path Parameters
tenantId
required
string
Example: a123

テナントID

Request Body schema: application/json
user
required
string

ユーザー

password
required
string

パスワード

Responses

Request samples

Content type
application/json
{
  • "user": "ABCCDE",
  • "password": "password"
}

Response samples

Content type
application/json
Example
{
  • "firstLogin": true,
  • "session": "ALSDJFALFASLJDF"
}

ログアウトを行う

Authorizations:
ApiLambdaAuthorizer
path Parameters
tenantId
required
string
Example: a123

テナントID

Request Body schema: application/json
accessToken
required
string

アクセストークン

Responses

Request samples

Content type
application/json
{
  • "accessToken": "ABCCDE"
}

Response samples

Content type
application/json
null

data

データを追加する

Authorizations:
ApiLambdaAuthorizer
path Parameters
tenantId
required
string
Example: a123

テナントID

dataStoreId
required
string
Example: a12301001

データID

Request Body schema: application/json
imagePathId
string

データに紐づく画像パスID

observedAt
required
string

時刻 フォーマット(yyyy-mm-ddThh:mm:ss)

value
required
number <float>

値

Responses

Request samples

Content type
application/json
{
  • "imagePathId": "16896661398112354",
  • "observedAt": "2023-01-01T00:00:00",
  • "value": "10.5"
}

Response samples

Content type
application/json
{
  • "imagePathId": "16896661398112354",
  • "observedAt": "2023-01-01T00:00:00",
  • "value": 0.8
}

データを取得する

Authorizations:
ApiLambdaAuthorizer
path Parameters
tenantId
required
string
Example: a123

テナントID

dataStoreId
required
string
Example: a12301001

データID

query Parameters
next
string

時刻 フォーマット(yyyy-mm-ddThh:mm:ss), 一度実行した後のlastパラメータを指定すると前回の続きが検出できる

start_time
required
string
Example: start_time=2023-01-01T00:00:00

開始時刻 フォーマット(yyyy-mm-ddThh:mm:ss)

end_time
required
string
Example: end_time=2023-01-01T03:00:00

終了時刻 フォーマット(yyyy-mm-ddThh:mm:ss)

sort
string
Default: "asc"
Enum: "asc" "desc"
Example: sort=desc

ソート順

interval
string
Default: "5m"
Enum: "1s" "1m" "5m" "10m" "30m" "1h" "6h" "12h" "1d"
Example: interval=5

間隔

limit
integer [ 1 .. 10000 ]
Default: 10000
Example: limit=5

最大返却個数

Responses

Response samples

Content type
application/json
{
  • "itemsCount": 2,
  • "items": [
    ],
  • "last": "2023-01-01T00:10:00"
}

image

画像を追加する

Authorizations:
ApiLambdaAuthorizer
path Parameters
tenantId
required
string
Example: a123

テナントID

imageStoreId
required
string
Example: a12301001

画像ID

Request Body schema: application/json
image
required
string

画像をBase64形式で追加する。画像は圧縮率を上げて登録するため、取得時は画質は下がります。

capturedAt
required
string

キャプチャ時刻

Responses

Request samples

Content type
application/json
{
  • "image": "ASFASDFASDFASDFASDFASf.....",
  • "capturedAt": "2023-01-01T1:00:00"
}

Response samples

Content type
application/json
{
  • "imagePathId": "16896661398112354",
  • "capturedAt": "2023-01-01T1:00:00"
}

画像を取得する

Authorizations:
ApiLambdaAuthorizer
path Parameters
tenantId
required
string
Example: a123

テナントID

imageStoreId
required
string
Example: a12301001

画像ID

imagePathId
required
string
Example: 16896661398112354

画像パスID

query Parameters
scaling_size
integer <float> [ 0.1 .. 1 ]
Default: 1

画像の縮小サイズ

Responses

Response samples

Content type
application/json
{
  • "capturedAt": "2023-01-01T00:00:00",
  • "image": "OJlajlejlajfa;sf"
}

画像を削除する

Authorizations:
ApiLambdaAuthorizer
path Parameters
tenantId
required
string
Example: a123

テナントID

imageStoreId
required
string
Example: a12301001

画像ID

imagePathId
required
string
Example: 16896661398112354

画像パスID

Responses

Response samples

Content type
application/json
null

smokes

煙検出する

Authorizations:
ApiLambdaAuthorizer
path Parameters
tenantId
required
string
Example: a123

テナントID

smokeId
required
string
Example: a12305001

煙検出ID

Request Body schema: application/json
required
object
Array of objects

関心領域

Responses

Request samples

Content type
application/json
{
  • "image": {
    },
  • "roi": [
    ]
}

Response samples

Content type
application/json
{
  • "imagePathId": "16896661398112354",
  • "capturedAt": "2023-01-01T1:00:00"
}