Machine Cloud API

Overview

本APIはMachine Cloudサービスにおける各種情報の取得を行うことができます。
ご利用いただくためには「Machine Cloud」のご契約が必要になります。
NTT Com IoT Platformサービス概要はこちら

Resource URL

グローバル共通ドメインの利用、または個別リージョンドメインをご利用ください。
グローバル共通ドメインを利用する場合、お客様のご利用箇所の状況に応じて、一番近いAPIゲートウェイに接続します。

1. Base Path(Global Load Balance)

https://api.ntt.com/v1/machine-cloud

2.Base Path(Region)

https://{region}.api.ntt.com/v1/machine-cloud
  • region is jp|us|uk
  • e.g. https://us.api.ntt.com/v1/machine-cloud
  • 指定できるregionは、将来拡充予定

Resource Information

Key Value
レスポンス フォーマット JSON
認証(OAuth) Yes
帯域制御#1 Yes
  • #1 お客さま接続単位で適切な流量制限を実施

機器一覧取得API

GET /v1/machine-cloud/devices

Machine Cloudに登録されている機器情報の一覧を取得します。

Request Parameters

Name Description Type Mandatory
page ページ番号(1〜10, default: 1) int False
pageSize 1ページの行数(1〜100, default: 20) int False
sort ソート順。降順にする場合は"-"を付与 String False

Example Request

GET /v1/machine-cloud/devices?sort=-sid

Response Parameters

Name Description Type
sid 識別子 int
id 通信する際のID int
name 名称 String
versionNo バージョン番号 String
serialNo シリアル番号 String
modelSid 型番の識別子 int
positionGetClass 位置取得区分 String
positionInfo 位置情報(緯度、経度) String
address 住所 String
timezoneCd タイムゾーンCD String
operationStatus 稼働状態(手動の場合のみ使用) String
subInformation 付帯情報 String
deleteFlag 削除フラグ boolean

Example Result

{
    "data": {
        "0": {
         "address": "", 
         "deleteFlag": false, 
         "deviceId": "device1", 
         "modelSid": 2, 
         "name": "device_1", 
         "operationStatus": "1", 
         "positionGetClass": "1", 
         "positionInfo": "", 
         "serialNo": "ser1", 
         "sid": 4, 
         "subInformation": null, 
         "timezoneCd": "Asia/Tokyo", 
         "versionNo": "ver1"
        }
    }, 
    "detail": "", 
    "status": "success", 
    "ver": "1.0.0"
}

型番情報取得API

GET /v1/machine-cloud/models

型番情報を取得します。

Request Parameters

Name Description Type Mandatory
modelSid 型番の識別子 int True

Example Request

GET /v1/machine-cloud/models?modelSid=1

Response Parameters

Name Description type
id 型番ID String
name 型番名 String
sid 型番識別子 int
mstCommand コマンド -
profileName 通信プロファイル名 String
sid コマンドの識別子 int
commandName コマンド名 String
commandCode コマンドの識別子 String
mstDataPoint データポイント -
sid データポイントの識別子 int
communicationInvalidFlag 通信無効フラグ int
dataEffectTime 有効期限(秒) int
dataPointCd データポイントコード String
dataType データ型 String
deleteFlag 削除フラグ boolean
maxValue 最大値 String
minValue 最小値 String
valueReceiveFormat 受信フォーマット int
saveKind 保存種別 String

Example Result

{
    "data": {
     "0": {
         "defaultProfile": {
             "mstCommand": {
                 "0": {
                     "commandCd": 4096, 
                     "commandName": "command01", 
                     "mstDataPoint": {
                         "0": {
                             "communicationInvalidFlag": "0", 
                             "dataEffectTime": 1, 
                             "dataPointCd": "data1", 
                             "dataType": "02", 
                             "deleteFlag": false, 
                             "maxValue": null, 
                             "minValue": null, 
                             "saveKind": "1", 
                             "sid": 18, 
                             "valueReceiveFormat": null
                         }
                     }, 
                     "sid": 9
                 }
             }, 
             "profileName": "profile01"
         }, 
         "id": "sample01", 
         "name": "sample01", 
         "sid": 3
     }
 }, 
 "detail": "", 
 "status": "success", 
 "ver": "1.0.0"
}

収集データ情報取得API

GET /v1/machine-cloud/rawData

指定した機器、データポイント、期間の収集データを取得します。

Request Parameters

Name Description Type Mandatory
deviceSid 機器の識別子 int True
dataPointSid データポイントの識別子(複数指定可。","区切り) int True
startDate 開始日時(yyyyMMddHHmmss) String True
endDate 終了日時(yyyyMMddHHmmss) String True
page ページ番号(1〜10, default: 1) int False
pageSize 1ページの行数(1〜100, default: 20) int False
sort ソート順。降順にする場合は"-"を付与 String False
maxPage 最大ページ数(1〜10, default: 10) String False

Example Request

GET /v1/machine-cloud/rawData?deviceSid=214&dataPointSid=223,224&startDate=20160731000000&endDate=20160803000000&pageSize=5

Response Parameters

Name Description type
data データ -
measureDatetime 計測日時(yyyyMMddHHmmss) String
value_XXX 値(各データポイント。XXXはデータポイントの識別子を表す。) String

Example Result

{
 "data": {
     "0": {
         "measureDatetime": "2016/07/31 00:01:11", 
         "value_223": 29, 
         "value_224": 39
     }, 
     "1": {
         "measureDatetime": "2016/07/31 00:02:02", 
         "value_223": 29, 
         "value_224": 40
     }, 
     "2": {
         "measureDatetime": "2016/07/31 00:03:02", 
         "value_223": 29, 
         "value_224": 38
     }, 
     "3": {
         "measureDatetime": "2016/07/31 00:04:02", 
         "value_223": 29, 
         "value_224": 38
     }, 
     "4": {
         "measureDatetime": "2016/07/31 00:05:02", 
         "value_223": 29, 
         "value_224": 38
     }
 }, 
 "detail": "", 
 "status": "success", 
 "ver": "1.0.0"
}