IoT Connectivity Engine Backend API

Version: 1.2

BasePath:/api/v1

Access

Methods

[ Jump to Models ]

DataAccessIF

delete /backend/event_data

(deleteData)

データ削除

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

partition (optional)

Query Parameter — パーティションを指定

filter (optional)

Query Parameter — 検索条件

Return type

DeleteResponse

Example data

Content-Type: application/json

{
  "count" : 0
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

削除件数 DeleteResponse

default

エラー ErrorResponse

delete /backend/event_data/{data_type}

(deleteDataType)

データ削除

Path parameters

data_type (required)

Path Parameter — データ種別

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

partition (optional)

Query Parameter — パーティションを指定

filter (optional)

Query Parameter — 検索条件

Return type

DeleteResponse

Example data

Content-Type: application/json

{
  "count" : 0
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

削除件数 DeleteResponse

default

エラー ErrorResponse

get /backend/event_data

(searchData)

データ取得

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

partition (optional)

Query Parameter — パーティションを指定

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

marked (optional)

Query Parameter — 既読フラグ付与

Return type

DataResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "payload" : "{}",
    "flow_id" : "aeiou",
    "data_type" : "aeiou",
    "edge_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou",
    "object_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したデータ DataResponse

default

エラー ErrorResponse

get /backend/event_data/{data_type}

(searchDataType)

データ取得

Path parameters

data_type (required)

Path Parameter — データ種別

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

partition (optional)

Query Parameter — パーティションを指定

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

marked (optional)

Query Parameter — 既読フラグ付与

Return type

DataResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "payload" : "{}",
    "flow_id" : "aeiou",
    "data_type" : "aeiou",
    "edge_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou",
    "object_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したデータ DataResponse

default

エラー ErrorResponse

EntityAbstractionIF

put /edge/{edge_id}/device_adapter/{object_id}

(operationDeviceAdapterId)

オペレーション実行

Path parameters

edge_id (required)

Path Parameter — エッジID

object_id (required)

Path Parameter — オブジェクトID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body OperationMessage (required)

Body Parameter — デバイスアダプタへの指示内容

Query parameters

group (optional)

Query Parameter — グループ名(edge_id=0の時に指定)

op_type (required)

Query Parameter — オペレーションタイプ

Return type

OperationInfo

Example data

Content-Type: application/json

{
  "updated_at" : "aeiou",
  "op_data" : {
    "method" : "aeiou",
    "op_type" : "aeiou",
    "body" : "{}",
    "url" : "aeiou",
    "target" : {
      "app_type" : "aeiou",
      "object_type" : "aeiou",
      "edge_id" : [ "aeiou" ],
      "object_id" : "aeiou",
      "group" : "aeiou"
    }
  },
  "op_id" : "aeiou",
  "_id" : "aeiou"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

202

オペレーションID OperationInfo

default

エラー ErrorResponse

put /edge/{edge_id}/device/{object_id}

(operationDeviceId)

オペレーション実行

Path parameters

edge_id (required)

Path Parameter — エッジID

object_id (required)

Path Parameter — オブジェクトID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body OperationMessage (required)

Body Parameter — デバイスへの指示内容

Query parameters

group (optional)

Query Parameter — グループ名(edge_id=0の時に指定)

op_type (required)

Query Parameter — オペレーションタイプ

Return type

OperationInfo

Example data

Content-Type: application/json

{
  "updated_at" : "aeiou",
  "op_data" : {
    "method" : "aeiou",
    "op_type" : "aeiou",
    "body" : "{}",
    "url" : "aeiou",
    "target" : {
      "app_type" : "aeiou",
      "object_type" : "aeiou",
      "edge_id" : [ "aeiou" ],
      "object_id" : "aeiou",
      "group" : "aeiou"
    }
  },
  "op_id" : "aeiou",
  "_id" : "aeiou"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

202

オペレーションID OperationInfo

default

エラー ErrorResponse

put /edge/{edge_id}/edge_application/{object_id}

(operationEdgeApplicationId)

オペレーション実行

Path parameters

edge_id (required)

Path Parameter — エッジID

object_id (required)

Path Parameter — オブジェクトID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body OperationMessage (required)

Body Parameter — エッジアプリケーションへの指示内容

Query parameters

group (optional)

Query Parameter — グループ名(edge_id=0の時に指定)

op_type (required)

Query Parameter — オペレーションタイプ

Return type

OperationInfo

Example data

Content-Type: application/json

{
  "updated_at" : "aeiou",
  "op_data" : {
    "method" : "aeiou",
    "op_type" : "aeiou",
    "body" : "{}",
    "url" : "aeiou",
    "target" : {
      "app_type" : "aeiou",
      "object_type" : "aeiou",
      "edge_id" : [ "aeiou" ],
      "object_id" : "aeiou",
      "group" : "aeiou"
    }
  },
  "op_id" : "aeiou",
  "_id" : "aeiou"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

202

オペレーションID OperationInfo

default

エラー ErrorResponse

put /edge/{edge_id}/lwm2m

(operationLwm2m)

オペレーション実行

Path parameters

edge_id (required)

Path Parameter — エッジID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

group (optional)

Query Parameter — グループ名(edge_id=0の時に指定)

op_type (required)

Query Parameter — オペレーションタイプ

Return type

OperationInfo

Example data

Content-Type: application/json

{
  "updated_at" : "aeiou",
  "op_data" : {
    "method" : "aeiou",
    "op_type" : "aeiou",
    "body" : "{}",
    "url" : "aeiou",
    "target" : {
      "app_type" : "aeiou",
      "object_type" : "aeiou",
      "edge_id" : [ "aeiou" ],
      "object_id" : "aeiou",
      "group" : "aeiou"
    }
  },
  "op_id" : "aeiou",
  "_id" : "aeiou"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

202

オペレーションID OperationInfo

default

エラー ErrorResponse

put /edge/{edge_id}/lwm2m/{object_id}

(operationLwm2mId)

オペレーション実行

Path parameters

edge_id (required)

Path Parameter — エッジID

object_id (required)

Path Parameter — オブジェクトID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body OperationMessage (required)

Body Parameter — デバイスへの指示内容

Query parameters

group (optional)

Query Parameter — グループ名(edge_id=0の時に指定)

op_type (required)

Query Parameter — オペレーションタイプ

Return type

OperationInfo

Example data

Content-Type: application/json

{
  "updated_at" : "aeiou",
  "op_data" : {
    "method" : "aeiou",
    "op_type" : "aeiou",
    "body" : "{}",
    "url" : "aeiou",
    "target" : {
      "app_type" : "aeiou",
      "object_type" : "aeiou",
      "edge_id" : [ "aeiou" ],
      "object_id" : "aeiou",
      "group" : "aeiou"
    }
  },
  "op_id" : "aeiou",
  "_id" : "aeiou"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

202

オペレーションID OperationInfo

default

エラー ErrorResponse

get /edge/{edge_id}/context

(searchContext)

コンテキストの情報を取得

Path parameters

edge_id (required)

Path Parameter — エッジID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

Return type

ContextFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "object_type" : "aeiou",
    "payload" : "{}",
    "flow_id" : "aeiou",
    "edge_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou",
    "object_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したコンテキスト情報 ContextFindResponse

default

エラー ErrorResponse

get /edge/{edge_id}/device

(searchDevice)

デバイスの情報を取得

Path parameters

edge_id (required)

Path Parameter — エッジID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

Return type

DeviceFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "object_type" : "aeiou",
    "payload" : "{}",
    "flow_id" : "aeiou",
    "edge_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou",
    "object_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したデバイス情報 DeviceFindResponse

default

エラー ErrorResponse

get /edge/{edge_id}/device_adapter

(searchDeviceAdapter)

デバイスアダプタの情報を取得

Path parameters

edge_id (required)

Path Parameter — エッジID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

Return type

DeviceAdapterFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "object_type" : "aeiou",
    "payload" : "{}",
    "flow_id" : "aeiou",
    "edge_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou",
    "object_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したデバイスアダプタ情報 DeviceAdapterFindResponse

default

エラー ErrorResponse

get /edge/{edge_id}/device_adapter/{object_id}

(searchDeviceAdapterId)

デバイスアダプタの情報を取得

Path parameters

edge_id (required)

Path Parameter — エッジID

object_id (required)

Path Parameter — オブジェクトID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

Return type

DeviceAdapterFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "object_type" : "aeiou",
    "payload" : "{}",
    "flow_id" : "aeiou",
    "edge_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou",
    "object_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したデバイスアダプタ情報 DeviceAdapterFindResponse

default

エラー ErrorResponse

get /edge/{edge_id}/device/{object_id}

(searchDeviceId)

デバイスの情報を取得

Path parameters

edge_id (required)

Path Parameter — エッジID

object_id (required)

Path Parameter — オブジェクトID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

Return type

DeviceFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "object_type" : "aeiou",
    "payload" : "{}",
    "flow_id" : "aeiou",
    "edge_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou",
    "object_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したデバイス情報 DeviceFindResponse

default

エラー ErrorResponse

get /edge

(searchEdge)

エッジ情報を取得

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

Return type

EdgeFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "payload" : "{}",
    "flow_id" : "aeiou",
    "edge_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したエッジ情報 EdgeFindResponse

default

エラー ErrorResponse

get /edge/{edge_id}/edge_application

(searchEdgeApplication)

エッジアプリケーションの情報を取得

Path parameters

edge_id (required)

Path Parameter — エッジID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

Return type

EdgeApplicationFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "object_type" : "aeiou",
    "payload" : "{}",
    "flow_id" : "aeiou",
    "edge_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou",
    "object_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したエッジアプリケーション情報 EdgeApplicationFindResponse

default

エラー ErrorResponse

get /edge/{edge_id}/edge_application/{object_id}

(searchEdgeApplicationId)

エッジアプリケーションの情報を取得

Path parameters

edge_id (required)

Path Parameter — エッジID

object_id (required)

Path Parameter — オブジェクトID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

Return type

EdgeApplicationFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "object_type" : "aeiou",
    "payload" : "{}",
    "flow_id" : "aeiou",
    "edge_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou",
    "object_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したエッジアプリケーション情報 EdgeApplicationFindResponse

default

エラー ErrorResponse

get /edge/{edge_id}

(searchEdgeId)

エッジ情報を取得

Path parameters

edge_id (required)

Path Parameter — エッジID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

fields (optional)

Query Parameter — フィールド条件

Return type

EdgeFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "payload" : "{}",
    "flow_id" : "aeiou",
    "edge_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したエッジ情報 EdgeFindResponse

default

エラー ErrorResponse

get /edge/{edge_id}/lwm2m

(searchLwm2m)

LwM2Mデバイスの情報を取得

Path parameters

edge_id (required)

Path Parameter — エッジID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

Return type

Lwm2mFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "object_type" : "aeiou",
    "payload" : "{}",
    "flow_id" : "aeiou",
    "edge_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou",
    "object_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したLwM2Mデバイス情報 Lwm2mFindResponse

default

エラー ErrorResponse

get /edge/{edge_id}/lwm2m/{object_id}

(searchLwm2mId)

LwM2Mデバイスの情報を取得

Path parameters

edge_id (required)

Path Parameter — エッジID

object_id (required)

Path Parameter — オブジェクトID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

Return type

Lwm2mFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "object_type" : "aeiou",
    "payload" : "{}",
    "flow_id" : "aeiou",
    "edge_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou",
    "object_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したLwM2Mデバイス情報 Lwm2mFindResponse

default

エラー ErrorResponse

get /edge/{edge_id}/processor

(searchProcessor)

プロセッサの情報を取得

Path parameters

edge_id (required)

Path Parameter — エッジID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

Return type

ProcessorFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "object_type" : "aeiou",
    "payload" : "{}",
    "flow_id" : "aeiou",
    "edge_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou",
    "object_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したプロセッサ情報 ProcessorFindResponse

default

エラー ErrorResponse

get /edge/{edge_id}/processor/{object_id}

(searchProcessorId)

プロセッサの情報を取得

Path parameters

edge_id (required)

Path Parameter — エッジID

object_id (required)

Path Parameter — オブジェクトID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

Return type

ProcessorFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "object_type" : "aeiou",
    "payload" : "{}",
    "flow_id" : "aeiou",
    "edge_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou",
    "object_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したプロセッサ情報 ProcessorFindResponse

default

エラー ErrorResponse

get /edge/{edge_id}/topology

(searchTopology)

プロセッサの情報を取得

Path parameters

edge_id (required)

Path Parameter — エッジID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

Return type

TopologyFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "object_type" : "aeiou",
    "payload" : "{}",
    "flow_id" : "aeiou",
    "edge_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou",
    "object_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

202

取得したトポロジ情報 TopologyFindResponse

default

エラー ErrorResponse

get /edge/{edge_id}/topology/{object_id}

(searchTopologyId)

トポロジの情報を取得

Path parameters

edge_id (required)

Path Parameter — エッジID

object_id (required)

Path Parameter — オブジェクトID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

Return type

TopologyFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "object_type" : "aeiou",
    "payload" : "{}",
    "flow_id" : "aeiou",
    "edge_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou",
    "object_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したトポロジ情報 TopologyFindResponse

default

エラー ErrorResponse

FileManagementIF

post /backend/file/collection

(collectFile)

ファイル登録

Consumes

This API call consumes the following media types via the Content-Type request header:

multipart/form-data

Form parameters

file (required)

Form Parameter —

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204

Success

default

エラー ErrorResponse

delete /backend/file/delivery

(deleteFile)

ファイル削除

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204

Success

default

エラー ErrorResponse

delete /backend/file/delivery/{file_id}

(deleteFileId)

ファイル削除

Path parameters

file_id (required)

Path Parameter — ファイルID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204

Success

default

エラー ErrorResponse

get /backend/file/delivery

(searchFile)

ファイル情報取得

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

Return type

FileFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "updated_at" : "aeiou",
    "file_name" : "aeiou",
    "file_id" : "aeiou",
    "_id" : "aeiou",
    "url" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したファイル情報 FileFindResponse

default

エラー ErrorResponse

get /backend/file/delivery/{file_id}

(searchFileId)

ファイル情報取得

Path parameters

file_id (required)

Path Parameter — ファイルID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

fields (optional)

Query Parameter — フィールド条件

Return type

FileFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "updated_at" : "aeiou",
    "file_name" : "aeiou",
    "file_id" : "aeiou",
    "_id" : "aeiou",
    "url" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したファイル情報 FileFindResponse

default

エラー ErrorResponse

post /backend/file/delivery

(uploadFile)

ファイル登録

Consumes

This API call consumes the following media types via the Content-Type request header:

multipart/form-data

Form parameters

file (required)

Form Parameter —

Return type

FileInfo

Example data

Content-Type: application/json

{
  "updated_at" : "aeiou",
  "file_name" : "aeiou",
  "file_id" : "aeiou",
  "_id" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

201

登録したファイルの情報 FileInfo

default

エラー ErrorResponse

ManagementApplicationIF

delete /backend/ma/event_data

(deleteMaData)

データ削除

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

partition (optional)

Query Parameter — パーティションを指定

filter (optional)

Query Parameter — 検索条件

Return type

DeleteResponse

Example data

Content-Type: application/json

{
  "count" : 0
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

削除件数 DeleteResponse

default

エラー ErrorResponse

delete /backend/ma/event_data/{data_type}

(deleteMaDataType)

データ削除

Path parameters

data_type (required)

Path Parameter — データ種別

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

partition (optional)

Query Parameter — パーティションを指定

filter (optional)

Query Parameter — 検索条件

Return type

DeleteResponse

Example data

Content-Type: application/json

{
  "count" : 0
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

削除件数 DeleteResponse

default

エラー ErrorResponse

delete /backend/ma/op_info

(deleteMaOperation)

オペレーション情報削除

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

Return type

DeleteResponse

Example data

Content-Type: application/json

{
  "count" : 0
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

削除件数 DeleteResponse

default

エラー ErrorResponse

delete /backend/ma/op_info/{op_id}

(deleteMaOperationId)

オペレーション情報削除

Path parameters

op_id (required)

Path Parameter — オペレーションID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Return type

DeleteResponse

Example data

Content-Type: application/json

{
  "count" : 0
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

削除件数 DeleteResponse

default

エラー ErrorResponse

delete /backend/ma/op_result

(deleteMaOperationResult)

オペレーション実行結果削除

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

Return type

DeleteResponse

Example data

Content-Type: application/json

{
  "count" : 0
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

削除件数 DeleteResponse

default

エラー ErrorResponse

delete /backend/ma/op_result/{op_id}

(deleteMaOperationResultId)

オペレーション実行結果削除

Path parameters

op_id (required)

Path Parameter — オペレーションID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

Return type

DeleteResponse

Example data

Content-Type: application/json

{
  "count" : 0
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

削除件数 DeleteResponse

default

エラー ErrorResponse

put /edge/{edge_id}/ma

(operationMa)

オペレーション実行

Path parameters

edge_id (required)

Path Parameter — エッジID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body OperationMessage (required)

Body Parameter — 指示内容

Query parameters

group (optional)

Query Parameter — グループ名(edge_id=0の時に指定)

Return type

OperationInfo

Example data

Content-Type: application/json

{
  "updated_at" : "aeiou",
  "op_data" : {
    "method" : "aeiou",
    "op_type" : "aeiou",
    "body" : "{}",
    "url" : "aeiou",
    "target" : {
      "app_type" : "aeiou",
      "object_type" : "aeiou",
      "edge_id" : [ "aeiou" ],
      "object_id" : "aeiou",
      "group" : "aeiou"
    }
  },
  "op_id" : "aeiou",
  "_id" : "aeiou"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

202

オペレーションID OperationInfo

default

エラー ErrorResponse

put /edge/{edge_id}/ma/{object_id}

(operationMaId)

オペレーション実行

Path parameters

edge_id (required)

Path Parameter — エッジID

object_id (required)

Path Parameter — オブジェクトID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body OperationMessage (required)

Body Parameter — 指示内容

Query parameters

group (optional)

Query Parameter — グループ名(edge_id=0の時に指定)

op_type (required)

Query Parameter — オペレーションタイプ

Return type

OperationInfo

Example data

Content-Type: application/json

{
  "updated_at" : "aeiou",
  "op_data" : {
    "method" : "aeiou",
    "op_type" : "aeiou",
    "body" : "{}",
    "url" : "aeiou",
    "target" : {
      "app_type" : "aeiou",
      "object_type" : "aeiou",
      "edge_id" : [ "aeiou" ],
      "object_id" : "aeiou",
      "group" : "aeiou"
    }
  },
  "op_id" : "aeiou",
  "_id" : "aeiou"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

202

オペレーションID OperationInfo

default

エラー ErrorResponse

get /edge/{edge_id}/ma

(searchMa)

管理アプリケーションの情報を取得

Path parameters

edge_id (required)

Path Parameter — エッジID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

Return type

ManagementApplicationFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "object_type" : "aeiou",
    "payload" : "{}",
    "flow_id" : "aeiou",
    "edge_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou",
    "object_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得した管理アプリケーション情報 ManagementApplicationFindResponse

default

エラー ErrorResponse

get /backend/ma/event_data

(searchMaData)

データ取得

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

partition (optional)

Query Parameter — パーティションを指定

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

marked (optional)

Query Parameter — 既読フラグ付与

Return type

DataResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "payload" : "{}",
    "flow_id" : "aeiou",
    "data_type" : "aeiou",
    "edge_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou",
    "object_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したデータ DataResponse

default

エラー ErrorResponse

get /backend/ma/event_data/{data_type}

(searchMaDataType)

データ取得

Path parameters

data_type (required)

Path Parameter — データ種別

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

partition (optional)

Query Parameter — パーティションを指定

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

marked (optional)

Query Parameter — 既読フラグ付与

Return type

DataResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "payload" : "{}",
    "flow_id" : "aeiou",
    "data_type" : "aeiou",
    "edge_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou",
    "object_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したデータ DataResponse

default

エラー ErrorResponse

get /edge/{edge_id}/ma/{object_id}

(searchMaId)

管理アプリケーションの情報を取得

Path parameters

edge_id (required)

Path Parameter — エッジID

object_id (required)

Path Parameter — オブジェクトID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

Return type

ManagementApplicationFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "object_type" : "aeiou",
    "payload" : "{}",
    "flow_id" : "aeiou",
    "edge_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou",
    "object_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得した管理アプリケーション情報 ManagementApplicationFindResponse

default

エラー ErrorResponse

get /backend/ma/op_info

(searchMaOperation)

オペレーション情報取得

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

Return type

OperationFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "updated_at" : "aeiou",
    "op_data" : {
      "method" : "aeiou",
      "op_type" : "aeiou",
      "body" : "{}",
      "url" : "aeiou",
      "target" : {
        "app_type" : "aeiou",
        "object_type" : "aeiou",
        "edge_id" : [ "aeiou" ],
        "object_id" : "aeiou",
        "group" : "aeiou"
      }
    },
    "op_id" : "aeiou",
    "_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したオペレーション情報 OperationFindResponse

default

エラー ErrorResponse

get /backend/ma/op_info/{op_id}

(searchMaOperationId)

オペレーション情報取得

Path parameters

op_id (required)

Path Parameter — オペレーションID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

fields (optional)

Query Parameter — フィールド条件

Return type

OperationFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "updated_at" : "aeiou",
    "op_data" : {
      "method" : "aeiou",
      "op_type" : "aeiou",
      "body" : "{}",
      "url" : "aeiou",
      "target" : {
        "app_type" : "aeiou",
        "object_type" : "aeiou",
        "edge_id" : [ "aeiou" ],
        "object_id" : "aeiou",
        "group" : "aeiou"
      }
    },
    "op_id" : "aeiou",
    "_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したオペレーション情報 OperationFindResponse

default

エラー ErrorResponse

get /backend/ma/op_result

(searchMaOperationResult)

オペレーション実行結果取得

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

marked (optional)

Query Parameter — 既読フラグ付与

Return type

OperationResultFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "payload" : {
      "success" : true
    },
    "flow_id" : "aeiou",
    "edge_id" : "aeiou",
    "op_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou",
    "object_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したオペレーション実行結果 OperationResultFindResponse

default

エラー ErrorResponse

get /backend/ma/op_result/{op_id}

(searchMaOperationResultId)

オペレーション実行結果取得

Path parameters

op_id (required)

Path Parameter — オペレーションID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

marked (optional)

Query Parameter — 既読フラグ付与

Return type

OperationResultFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "payload" : {
      "success" : true
    },
    "flow_id" : "aeiou",
    "edge_id" : "aeiou",
    "op_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou",
    "object_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したオペレーション実行結果 OperationResultFindResponse

default

エラー ErrorResponse

OperationManagementIF

delete /backend/op_info

(deleteOperation)

オペレーション情報削除

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

Return type

DeleteResponse

Example data

Content-Type: application/json

{
  "count" : 0
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

削除件数 DeleteResponse

default

エラー ErrorResponse

delete /backend/op_info/{op_id}

(deleteOperationId)

オペレーション情報削除

Path parameters

op_id (required)

Path Parameter — オペレーションID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Return type

DeleteResponse

Example data

Content-Type: application/json

{
  "count" : 0
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

削除件数 DeleteResponse

default

エラー ErrorResponse

delete /backend/op_result

(deleteOperationResult)

オペレーション実行結果削除

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

Return type

DeleteResponse

Example data

Content-Type: application/json

{
  "count" : 0
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

削除件数 DeleteResponse

default

エラー ErrorResponse

delete /backend/op_result/{op_id}

(deleteOperationResultId)

オペレーション実行結果削除

Path parameters

op_id (required)

Path Parameter — オペレーションID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

Return type

DeleteResponse

Example data

Content-Type: application/json

{
  "count" : 0
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

削除件数 DeleteResponse

default

エラー ErrorResponse

get /backend/op_info

(searchOperation)

オペレーション情報取得

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

Return type

OperationFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "updated_at" : "aeiou",
    "op_data" : {
      "method" : "aeiou",
      "op_type" : "aeiou",
      "body" : "{}",
      "url" : "aeiou",
      "target" : {
        "app_type" : "aeiou",
        "object_type" : "aeiou",
        "edge_id" : [ "aeiou" ],
        "object_id" : "aeiou",
        "group" : "aeiou"
      }
    },
    "op_id" : "aeiou",
    "_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したオペレーション情報 OperationFindResponse

default

エラー ErrorResponse

get /backend/op_info/{op_id}

(searchOperationId)

オペレーション情報取得

Path parameters

op_id (required)

Path Parameter — オペレーションID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

fields (optional)

Query Parameter — フィールド条件

Return type

OperationFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "updated_at" : "aeiou",
    "op_data" : {
      "method" : "aeiou",
      "op_type" : "aeiou",
      "body" : "{}",
      "url" : "aeiou",
      "target" : {
        "app_type" : "aeiou",
        "object_type" : "aeiou",
        "edge_id" : [ "aeiou" ],
        "object_id" : "aeiou",
        "group" : "aeiou"
      }
    },
    "op_id" : "aeiou",
    "_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したオペレーション情報 OperationFindResponse

default

エラー ErrorResponse

get /backend/op_result

(searchOperationResult)

オペレーション実行結果取得

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

marked (optional)

Query Parameter — 既読フラグ付与

Return type

OperationResultFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "payload" : {
      "success" : true
    },
    "flow_id" : "aeiou",
    "edge_id" : "aeiou",
    "op_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou",
    "object_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したオペレーション実行結果 OperationResultFindResponse

default

エラー ErrorResponse

get /backend/op_result/{op_id}

(searchOperationResultId)

オペレーション実行結果取得

Path parameters

op_id (required)

Path Parameter — オペレーションID

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

filter (optional)

Query Parameter — 検索条件

fields (optional)

Query Parameter — フィールド条件

sort (optional)

Query Parameter — ソート条件

offset (optional)

Query Parameter — 開始位置

limit (optional)

Query Parameter — 取得件数

marked (optional)

Query Parameter — 既読フラグ付与

Return type

OperationResultFindResponse

Example data

Content-Type: application/json

{
  "count" : 0,
  "results" : [ {
    "marked" : true,
    "updated_at" : "aeiou",
    "payload" : {
      "success" : true
    },
    "flow_id" : "aeiou",
    "edge_id" : "aeiou",
    "op_id" : "aeiou",
    "_id" : "aeiou",
    "type" : "aeiou",
    "object_id" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

取得したオペレーション実行結果 OperationResultFindResponse

default

エラー ErrorResponse

Models

[ Jump to Methods ]

ContextFindResponse -
DataInfo -
DataResponse -
DeleteResponse -
DeviceAdapterFindResponse -
DeviceFindResponse -
EdgeApplicationFindResponse -
EdgeFindResponse -
EdgeInfo -
ErrorInfo -
ErrorResponse -
FileFindResponse -
FileInfo -
Lwm2mFindResponse -
ManagementApplicationFindResponse -
ObjectInfo -
OperationFindResponse -
OperationInfo -
OperationInfo_op_data -
OperationInfo_op_data_target -
OperationMessage -
OperationResult -
OperationResultFindResponse -
OperationResult_payload -
ProcessorFindResponse -
TopologyFindResponse -

`ContextFindResponse` - Up

results (optional)

array[ObjectInfo]

count (optional)

Integer 取得件数

`DataInfo` - Up

_id (optional)

String データベースが自動で付与するID

edge_id (optional)

String エッジID

object_id (optional)

String オブジェクトID

flow_id (optional)

String データ送信したフローのID

data_type (optional)

String イベントデータのデータタイプ

type (optional)

String データの処理タイプ

payload (optional)

Object イベントデータ本体

marked (optional)

Boolean 既読フラグ

updated_at (optional)

String 最終更新日時

`DataResponse` - Up

results (optional)

array[DataInfo]

count (optional)

_id (optional)

String データベースが自動で付与するID

edge_id (optional)

String エッジID

flow_id (optional)

String データ送信したフローのID

type (optional)

String データの処理タイプ

payload (optional)

Object プロファイル

marked (optional)

Boolean 既読フラグ

updated_at (optional)

String 最終更新日時

`ErrorInfo` - Up

name (optional)

String 処理失敗時のエラー名

message (optional)

String 処理失敗時のエラーメッセージ

reason (optional)

String 処理失敗の理由

`ErrorResponse` - Up

error (optional)

ErrorInfo

`FileFindResponse` - Up

results (optional)

array[FileInfo]

count (optional)

Integer 取得件数

`FileInfo` - Up

_id (optional)

String データベースが自動で付与するID

file_id (optional)

String ファイルのID

file_name (optional)

String ファイル名

url (optional)

String ファイルのURL

updated_at (optional)

String 最終更新日時

`Lwm2mFindResponse` - Up

results (optional)

array[ObjectInfo]

count (optional)

Integer 取得件数

`ManagementApplicationFindResponse` - Up

results (optional)

array[ObjectInfo]

count (optional)

Integer 取得件数

`ObjectInfo` - Up

_id (optional)

String データベースが自動で付与するID

edge_id (optional)

String エッジID

flow_id (optional)

String データ送信したフローのID

object_id (optional)

String オブジェクトID

object_type (optional)

String オブジェクト種別

type (optional)

String データの処理タイプ

payload (optional)

Object プロファイル

marked (optional)

Boolean 既読フラグ

updated_at (optional)

String 最終更新日時

`OperationFindResponse` - Up

results (optional)

array[OperationInfo]

count (optional)

Integer 取得件数

`OperationInfo` - Up

_id (optional)

String データベースが自動で付与するID

op_id (optional)

String オペレーションID

updated_at (optional)

String 最終更新日時

op_data (optional)

OperationInfo_op_data

`OperationInfo_op_data` - Up

オペレーションの内容

url (optional)

String REST APIのURL

method (optional)

String REST APIのメソッド

op_type (optional)

String オペレーションタイプ

body (optional)

Object リクエストのボディ

target (optional)

OperationInfo_op_data_target

`OperationInfo_op_data_target` - Up

オペレーションの対象

edge_id (optional)

array[String] オペレーションの対象となるエッジID

object_type (optional)

String オブジェクト種別

object_id (optional)

String オブジェクトID

app_type (optional)

String アプリケーション種別

group (optional)

String オペレーションの対象となるグループ

`OperationMessage` - Up

`OperationResult` - Up

_id (optional)

String データベースが自動で付与するID

edge_id (optional)

String エッジID

object_id (optional)

String オブジェクトID

flow_id (optional)

String データ送信したフローのID

op_id (optional)

String オペレーションID

type (optional)

String データの処理タイプ

payload (optional)

OperationResult_payload

marked (optional)

Boolean 既読フラグ

updated_at (optional)

String 最終更新日時

`OperationResultFindResponse` - Up

results (optional)

array[OperationResult]

count (optional)

Integer 取得件数

`OperationResult_payload` - Up

オペレーションの実行結果

success (optional)

Boolean 成功/失敗のフラグ

`ProcessorFindResponse` - Up

results (optional)

array[ObjectInfo]

count (optional)

Integer 取得件数

`TopologyFindResponse` - Up

results (optional)

array[ObjectInfo]

count (optional)

Integer 取得件数

IoT Connectivity Engine Backend API

Access

Table of Contents

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

default

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

default

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

default

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

default

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

202

default

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

202

default

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

202

default

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

202

default

Path parameters

Consumes

Request body

Query parameters