データモデル
User
プロジェクトの登録済みエンドユーザー。
Type | Description | Mutable |
---|---|---|
id integer |
作成時に割り当てられる固有のユーザーID。 | No |
projectId integer |
このユーザーが属するプロジェクト。 | No |
creationTime string |
ユーザー登録時のタイムスタンプ。 | No |
phoneNumber string |
国番号を含む有効な電話番号。ユーザーを一意に識別するために電話番号を使用するプロジェクトの場合に存在します。 | No |
email string |
有効なメールアドレス。ユーザーを一意的に識別するためにメールアドレスを使用するプロジェクトの場合に存在します。 | No |
password string |
メール/パスワードによってログインするユーザーを作成または更新する場合にのみ使用されます。 | Yes |
name string |
ユーザーの表示名。 | Yes |
verified boolean |
アカウントが確認済みかどうか。 | No |
Home
デバイスを含み、1人以上のユーザーによって管理されるホームを表します。
Type | Description | Mutable |
---|---|---|
id integer |
作成時に割り当てられる固有のID。 | No |
projectId integer |
このホームが属するプロジェクト。 | No |
creationTime string |
ホーム作成時のタイムスタンプ。 | No |
name string |
ホームの表示名。 | Yes |
timezone string |
(推奨されていません。新しいプロジェクトでは使用しないでください。) tzdataで使用されるタイムゾーン名。 | Yes |
Deactivated boolean |
プロジェクトの管理者によってホームが無効化されている場合は、true。 | Yes |
Example:
{
"id":9,
"projectId":11,
"creationTime":"2016-09-21T00:16:22.381Z",
"name":"My Home"
}
Home Member
ホームのメンバー。
Type | Description | Mutable |
---|---|---|
userId integer |
ホームメンバーのユーザーID。 | No |
creationTime string |
メンバーがホームに追加されたときのタイムスタンプ。 | No |
name string |
メンバーの表示名。 | No |
phoneNumber string |
メンバーによって使用される電話番号。 | No |
email string |
メンバーのメールアドレス。 | No |
verified boolean |
メンバーが確認済みユーザーの場合はtrue。 | No |
Example:
{
"userId":1,
"creationTime":"2016-09-22T19:49:26.245Z",
"name":"Hideyasu Ichikaku",
"phoneNumber":"+16501234567",
"verified":true
}
Smart Module
プロジェクトで使用するスマートモジュールの定義。
Type | Description | Mutable |
---|---|---|
id string |
スマートモジュールID。プロジェクト内で固有であることが必要です。 | No |
moduleType string |
スマートモジュールのタイプ。 | Yes |
creationTime string |
エントリー作成時のタイムスタンプ。 | No |
description string |
スマートモジュールの簡単な説明。 | Yes |
suspended boolean |
このスマートモジュールを無効にする場合にtrueに設定します。 | Yes |
subscribedEvents array |
スマートモジュールがサブスクライブするイベントタイプのリスト。 | Yes |
configData object |
設定データ。スマートモジュールの作成/更新時に使用されます。 | Yes |
Device
プロジェクトで作成したデバイスを表します。
Type | Description | Mutable |
---|---|---|
id integer |
固有のデバイスID。 | No |
projectId integer |
このデバイスが属するプロジェクトID。 | No |
creationTime string |
デバイスレコード作成時のタイムスタンプ。 | No |
name string |
デバイスの表示名。 | Yes |
tag string |
デバイスに関連付けられたオプション/情報のタグ。例えば、シリアル番号の保管に使用できます。 | Yes |
deviceClass string |
プロジェクトによって定義されたデバイスクラスID。 | No |
homeId integer |
デバイスが属するホームID。デバイスがホームに属する場合に存在します。 | Yes |
apiKey string |
デバイスに割り当てられたAPIアクセスキー。特権クライアントの場合を除き、通常は非表示です。ただし、オンデマンドデバイスプロビジョニング処理時にも存在します。 | No |
claimCode string |
デバイスに割り当てられたクレームコード。特権クライアントの場合を除き、非表示です。 | Yes |
claimTime string |
デバイスがユーザーによってクレームされたときのタイムスタンプ。 | No |
claimExpirationTime string |
デバイスのクレーム可能状態の有効期限。 | No |
lastConnectTime string |
デバイスが最後にクラウドに接続された時刻。 | No |
lastDisconnectTime string |
デバイスが最後にクラウドから切断された時刻。 | No |
lastCommandTime string |
コマンドが最後にデバイスに正常に送信された時刻。 | No |
lastEventTime string |
デバイスが最後にイベントを発行した時刻。 | No |
Device Command
デバイスに送信するコマンドを表します。
Type | Description | Mutable |
---|---|---|
action string |
デバイスによって実行されるアクション。 | Yes |
parameters object |
アクション固有のパラメーター。 | Yes |
deviceId integer |
このコマンドが対象とするデバイスのID。コマンドがハブ経由でルーティングされる場合は必須。 | Yes |
Event
デバイスまたはスマートモジュールから他のリスナーに伝搬されるイベントを表します。
Type | Description | Mutable |
---|---|---|
eventType string |
イベントタイプID。プロジェクト開発者が任意のイベントIDを定義できます。 | Yes |
eventData object |
JSONハッシュとしてのイベント固有のデータ。 | Yes |
timestamp string |
イベントがトリガーされた時刻。リスナーへのイベント配信時にIoTデバイスハブによって追加されます。デバイス側で追加する必要はありません。 | No |
homeId integer |
このイベントに関連付けられたホームID。リスナーへのイベント配信時にIoTデバイスハブによって追加されます。デバイス側で追加する必要はありません。 | No |
originDeviceId integer |
イベントがデバイスから発行された場合、発行元のデバイスIDになります。リスナーへのイベント配信時にIoTデバイスハブによって追加されます。 | No |
originDeviceClass string |
イベントがデバイスから発行された場合、発行元のデバイスのクラスIDになります。リスナーへのイベント配信時にIoTデバイスハブによって追加されます。 | No |
originDeviceIp string |
イベントがデバイスから発行された場合、発行元のデバイスのIPアドレスになります。リスナーへのイベント配信時にIoTデバイスハブによって追加されます。 | No |
Example:
{
"eventType": "sprinkler-status",
"eventData": {
"zones": [0,0,0,0,0,0,0,1],
"serial": 12,
"timestamp": 1402313424,
"appSerial": 14,
"appTimestamp": 14243423423
}
Client Authentication
正常に実行されたクライアント認証リクエストの結果を含みます。
Type | Description | Mutable |
---|---|---|
token string |
以後のAPIリクエスト時にHTTP Authorizationヘッダーで使用されるアクセストークン。 | No |
userId integer |
このプロパティは、トークンがユーザーに関連付けられている場合に存在します。 | No |
Authentication Info
APIクライアントの現在の認証状況を検査するためのものです。
Type | Description | Mutable |
---|---|---|
type
|
クライアントエンティティーのタイプ。クライアントが認証されていない場合は'nobody'です。 | No |
userId integer |
このプロパティは、トークンがユーザーに関連付けられている場合に存在します。 | No |
appId string |
使用されるアプリID。このプロパティはアプリによって認証されたユーザーにトークンが関連付けられている場合に存在します。 | No |
deviceId integer |
このプロパティは、トークンがデバイスに関連付けられている場合に存在します。 | No |
projectKeyName string |
このプロパティは、トークンがプロジェクトのAPIキーに関連付けられている場合に存在します。 | No |
projectId integer |
このプロパティは、トークンがプロジェクトに関連付けられている場合に存在します。 | No |
SMS Message Receipt
発信SMSメッセージに関する情報。デバッグ目的のみに使用します。
Type | Description | Mutable |
---|---|---|
recipient string |
SMSメッセージを受信する電話番号。 | No |
Example:
{
"recipient": "+16501234567"
}
Error
APIエラーの報告用です。
Type | Description | Mutable |
---|---|---|
reason string |
エラーの理由。 | No |
data object |
エラーに関連した任意のデータ。 | No |
Registration State Response
デバイスインスタンスのクレームモードを変更するリクエストの結果です。
Type | Description | Mutable |
---|---|---|
claimExpirationTime string |
クレーム有効期限タイムスタンプ。 | No |
Example:
{"claimExpirationTime":"2016-09-26T09:36:25.191274242Z"}
User Session Info
現在アクティブなユーザーセッションに関する情報。
Type | Description | Mutable |
---|---|---|
userId integer |
このセッションに関連付けられたユーザーのID。 | No |
appId string |
このセッションの開始に使用されたアプリ。 | No |
projectId integer |
このセッションに関連付けられたプロジェクト。 | No |
creationTime string |
セッションが開始された時刻。 | No |
Device Provisioning Token
オンデマンドデバイスのプロビジョニングを完了するためのデバイスのトークン。
Type | Description | Mutable |
---|---|---|
token string |
プロビジョニングトークン。 | No |
expirationTime string |
トークンの有効期限。 | No |
Key-Value Pair
ホームに保存されたキーバリューペア。
Type | Description | Mutable |
---|---|---|
key string |
各ホーム内で一意である必要があります。英数字・アンダースコア('_')、ハイフン('-')を含むことができますが、最初と最後の文字は英数字である必要があります。 | No |
value boolean,string,number,array,object |
キーに対して割り当てられた任意のデータ。 | Yes |
modificationTime string |
作成または最後に更新された時間のタイムスタンプ。 | No |