ia-cloud Specification

Web API Version 2.07β

July 17^th, 2018
Hiro Hashimukai　　@bridge consulting

ia-cloud Project,
Industrial Automation Forum　
MSTC Japan

目的

本仕様書の目的は、産業オートメーション（ IA ）分野において、オートメーションのフィールドにおける様々な情報を収集蓄積している IA 関連の設備・機器・システムと、これら情報の統合・連携・分析などを行うクラウドサービスとの API、つまり情報交換の通信プロトコールと共通的なデータオブジェクトフォーマットに関する仕様を、ia-cloud Web API 仕様として定義することにある。

概要

ia-cloud のデータ収集サービス API の概要を下図に示す。ia-cloud API は、IA システムがファイアーウォール（ F/W ）の内側から、Web サービスを利用し、SaaS 型のクラウドサービスであるデータ収集サービスへ接続するための API で、

REST-full な HTTPS を利用したプロトコールと、WebSocket による JSON メッセージ交換仕様
JSON 表現の収集データオブジェクトモデル仕様

を規定する。

HTTPS の POST メソッドあるいは WebSocket のメッセージを利用し、JSON で記述されたサービスコマンドとデータオブジェクトを送出する。クラウドサービスからの応答は、HTTPS の場合は Response Body に格納された JSON で、WebSocket の場合は WebSocket メッセージのレスポンスとして返される。

ia-cloud フィールドデータサーバ（ FDS ）

フィールドデータ収集機能を持ち、センサやコントローラの持つ非構造化データを解釈評価し構造化データに変換し、それを表示したり、一時的な蓄積を行ったりする機器やシステムであり、その構造化データを ia-cloud API にしたがって、クラウドサービスへ送出する機能を、ia-cloud フィールドデータサーバ（ FDS ）と称する。

具体的には、SCADA ソフトウエアや操作表示器、DCS の OI やデータベースシステム、工作機械やロボットのモニタリングソフトウェアなどを想定している。PLC やセンサを接続したゲートウエイ機器がフィールドデータサーバとして ia-cloud Web API を実装することも可能である。

一般に、PLC やセンサなどの非構造化データを構造化されたデータオブジェクトに変換するためのマッピングツールを提供することが必要である。

ia-cloud センターサーバ（ CCS ）

ia-cloud Web API に従い、フィールドデータサーバ（ FDS ）からのデータオブジェクトを受信し、データベースに格納するクラウドサービスの機能を ia-cloud センターサーバ（ CCS ）と呼ぶ。

注：格納するデータベースの形態や構造、データベースに格納したデータオブジェクトのロールアップや統計処理などの付加機能は、本プロジェクトのスコープ外である。また、データベースに格納したデータオブジェクトをブラウズする Web アプリケーション（ SaaS ）を提供する機能や、ユーザが独自の監視画面などを定義できるエンドユーザコンピューティング環境を提供などが必要となるが、これも本プロジェクトのスコープではない。

Web サービスプロトコール

フィールドデータサーバ（ FDS ）とセンターサーバ（ CCS ）との間で使用される通信プロトコールは、HTTPS と WSS を使用する。

HTTPS（ REST ）

ia-cloud の REST サービスは、全て FDS 側からのサービスリクエストから開始される。

FDS は後述する CCS の url に対し、サービス内容に応じた JSON リクエストボディを付け、HTTPS POST リクエストを送出する。

ia-cloud サービスの url

ia-cloud データサービスは、以下の url に対する HTTPS POST リクエストによってなされるものとする。CCS は GET など、他の HTTPS リクエストコマンドをサポートしてもよいが、ia-cloud Web API で使用するのは POST のみである。

リクエストコマンド	url
POST	https:// hostname.domain /…/ ia-cloud-rest / v#

項目	値	説明	Notes
hostname.domain / ..	string	サービスプロバイダー任意。
/ ia-cloud-rest / v#	string	/ ia-cloud-rest /（固定）とサポートする ia-cloud API 仕様のバージョン番号。本仕様書のバージョンでは、/ ia-cloud-rest / v2 とする。

認証とHTTPS

各 FDS は、ia-cloud サービスを提供している CCS に対し、HTTPS（ポート番号 443 ）で接続するものとする。

CCS は TLS1.2 に対応しなければならない。FDS 側は、TLS1.2 の範囲内でセキュリティレベルと実装のしやすさを考慮した署名や暗号化アルゴリズムを選択できるものとする。ただし、クラウドサービスプロバイダーとしてのセキュリティポリシーを設定し、FDS の SSL/TLS 実装レベルを規定することは、各プロバイダーの事業方針にゆだねられる。

また、接続に際しては Basic 認証を使用する。FDS は、Basic 認証のクライアントを実装しなければならない。下記は、Basic 認証を使用した HTTP Header の例である。（ userID = "ia-cloudUserID", Password = "Passcode", base64 encoding ）

FDS は認証を維持するために、常に HTTP Header に Basic 認証ヘッダを挿入して構わないが、CCS は認証後のセッションを維持するため、Cookie を使用することができる。したがって、FDS は、Cookie を実装する必要がある。
Cookie の有効期間（ expires ）は FDS の実装に依存する。また、CCS は認証のセッション維持以外の目的に Cookie を利用しても構わない。

Cookie をセットされた FDS は認証後のすべての HTTP Request Header に Cookie を挿入する。

FDS は、CCS からレスポンスコード 401（ unauthorized ）が返された時は、再度、Request Header に ID とパスワードを入れた Authorization Header を挿入し、認証を試みる。

プロキシサーバの利用

FDS は、プロキシサーバ経由のアクセスに対応できること。

手動による固定プロキシサーバを指定する方法
PAC スクリプトファイルの指定による方法
WPAD による自動設定

のいずれか一つは、実装しなければならない。

HTTP(S)エラー処理

エラー処理は、HTTP の仕様 RFC7231 に基づく。

本仕様書で定義する JSON の構造や内容に関するエラーが発生した場合は、CCS はレスポンスヘッダーのステータスコードに 400 Bad Request を挿入する。また、ia-cloud オブジェクトの章 及び ia-cloud データモデルの章 に定義する後述の iaCloudErrorStatus を格納した iaCloudObject を生成し DB に格納すること。
このオブジェクトは、DB のコンソール機能や標準的な API で読み出せるほか、後述の retrieve サービスコマンドで FDS が読み出すことができる。
ia-cloud データモデルの章 に定義する後述の iaCloudErrorStatus に格納するプロパティ ErrorCode、ErrorDescription は以下の定義に従うこと。

ErrorCode	ErrorDescription	エラーの内容
840	API command error	APIコマンドエラー
841	Invalid ServiceID	無効なServiceID
842	object format error	JSONフォーマットエラー
850	CCS Error	CCS側での何らかのエラー

WebSocket

ia-cloud の WebSocket によるサービスは、全て FDS 側からの HTTPS リクエストによる、WeSocket へのアップグレード要求から開始される。

プロトコール規約は RFC6455 に準ずるものとする。
アップグレードに際しての認証と暗号化に関する方針は以下に示す。

アップグレードを要求する HTTPS リクエスト自体 Basic 認証を必要とする
アップグレードするプロトコールは TLS を使用し、転送データを暗号化する（ WSS を使用する）

アップグレード後は、サービス内容に応じた JSON 文字列を WSS のペイロードとして送受信する。 WebSocket の設定として、次の制限を設けることを推奨する。

WebSocket 接続のアイドル・タイムアウト時間
CCS が受信できるメッセージの最大サイズ
CCS に接続する最大コネクション数

WebSocket コネクションの確立

WebSocket へのアップグレード要求は、以下の url に対する HTTPS POST リクエストによってなされるものとする。

リクエストコマンド	url
POST	https:// hostname.domain /…/ ia-cloud-ws / v#

Property	値	説明	Notes
hostname.domain / ..	string	サービスプロバイダー任意。
/ ia-cloud-ws / v#	string	/ ia-cloud-ws /（固定）とサポートする ia-cloud API 仕様のバージョン番号。本仕様書のバージョンでは、/ ia-cloud-ws / v2 とする。

コネクション確立のために、FDS から HTTP GET によるハンドシェイク・リクエストを CCS に送信する。CCS はハンドシェイク・リクエストが有効な場合、ハンドシェイク・レスポンスを FDS に送信し、コネクション確立とする。

以下に、ハンドシェイクのサンプルを記載する。（ SSL/TLS は事前に確立済みとする）

ハンドシェイク・リクエスト（ FDS → CCS ）

GET /iaCloudWss/rev2.0 HTTP/1.1
Host: hostname.domain
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ== Origin: http://example.com
Sec-WebSocket-Protocol: chat, superchat Sec-WebSocket-Version: 13

ハンドシェイク・レスポンス（ CCS → FDS ）

HTTP/1.1 101 Switching Protocols
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=

プロキシサーバの仕様やエラー処理など、アップグレード前の HTTPS 関連の仕様・振舞に関しては、REST（HTTPS）の章 に準ずるものとする。

サービスのリクエスト

概要

ia-cloud Web API におけるサービスのリクエストは、

REST API： HTTPS の POST リクエストボディ
WebSocket API： WSS のペイロード

に格納した JSON 文字列で記述されたオブジェクトで記述される。

JSON リクエストボディによるサービスリクエストの種類は、

No	サービス	サービスコマンド	REST	WSS上り	WSS下り
1	接続の開始	connect	〇	〇
2	接続の確認・再設定	getstatus	〇	〇
3	データオブジェクトインスタンスの格納	store	〇	〇	△（実装は任意）
4	データオブジェクトインスタンスの取得	retrieve	〇	〇	〇
5	接続の終了	terminate	〇	〇
6	各種工業系通信プロトコールの搬送	convey		〇	〇

が規定されている。

接続の開始

FDS は、CCS への接続に際し必要な userID と FDSKey を付与されていなければならない。userID 、FDSkey を付与する方法などについては ia-cloud では規定しない。各サービスプロバイダーが仕様を自由に決定してよい。

FDS は、各種のサービスの利用に先立って、CCS との接続を確立する必要がある。レスポンスボディで戻された serviceID を使って、その後のサービスを利用する。

Request json

{
    // User 情報、FDS 情報
    "request" : "connect",
    "userID" : { string },
    "Authorization" : { string },
    "FDSKey" : { string },
    "FDSType" : "iaCloudFDS",
    "timestamp" : { string },
    "comment" : { string }
}

Property	値	説明	Notes
request	string	"connect"	固定
userID	string	サービスプロバイダーから支給された CCS へアクセスするための userID	HTTPSの場合のみ必須
Authorization	string	サービスプロバイダーから支給された CCS へアクセスするための userID と Password を HTTP の Basic 認証に倣って設定する。 "Basic SUFfY2xvdWRVc2VySUQ6UGFzc2NvZGU=" （ userID = "ia-cloudUserID" , Password = "Passcode" , base64 encoding ）	WSSの場合のみ必須
FDSKey	string	この FDS のユニークな Key。
FDSType	string	"iaCloudFDS"	固定
timestamp	string	サービスへ接続する時点でのタイムスタンプ。 ISO8601 に規定される[拡張表記]文字列。　例： 2014-08-15T13:43:28.123456+9:00
comment	string	FDS と接続に関する任意の説明。取り扱いは、CCS 側に依存する。	省略可

Response json

{
    "userID" : { string },
    "FDSKey" : { string },
    "FDSType" : "iaCloudFDS",
    "serviceID" : { string }
}

Property	値	説明	Notes
userID	string	サービスプロバイダーから支給されたサービスを受ける userID。 Request userIDのコピーあるいは、AuthorizationをデコードしたuserID
FDSKey	string	この FDS のユニークな Key。 connect Request のコピー。
FDSType	string	"iaCloudFDS"	固定
serviceID	string	FDS が CCS にデータを格納するため等に使用する serviceID。 userID 、FDSKey 、timestamp などから生成された Hash 値等を使用する。

データオブジェクトインスタンスの格納

FDS がデータの格納サービスを利用する際のリクエスト。

CCS は、受け取ったオブジェクトを、objectKey と timestamp をキーにデータベース（ DB ）へ格納する。DB は、Key Value Store（ KVS ）などの NoSQL DB を想定しているが、実装は CCS サービスプロバイダーに依存する。

本仕様では、"dataObject" が iaCloudObjectArry の場合、CCS は Arry を、各 iaCloudObject 要素に分解し、それぞれの iaCloudObject を DB に格納することを想定している。しかし、実際にどう実装するかについては、各 CCS サービスプロバイダーに依存する。

Request json

{
    "request" : "store"
    "serviceID" : { string },
    "dataObject" : { iaCloudObject }    //  ia-cloud オブジェクトで詳細記述
}

Property	値	説明	Notes
request	string	"store"	固定
serviceID	string	接続時あるいは直前の Response Body で返された serviceID。
dataObject	object	CCS に格納すべき iaCloudObject モデル、もしくはその拡張モデルのインスタンス。

Response json

{
    "FDSKey" : { string },
    "serviceID" : { string },
    "newServiceID" : { string },
    "optionalMessage" : { object }
}

Property	値	説明	Notes
serviceID	string	store Request で使用された serviceID。 store Request のコピー。
status	string	store Request の実行結果 { "ok" / "ng" }
newServiceID	string	次回の store Request で使用されるべき serviceID。変更の必要がなければ、同一の serviceID が返される。
optionalMessage	object	FDS へ送付する任意の JSON オブジェクトメッセージ。 FDS は解釈できない optionnalMessage を読み飛ばさなければならない。	省略可

データオブジェクトインスタンスの取得

FDS が CCS からデータを取得するサービスを利用する際のリクエスト。
CCS は、該当する objecyKey と timestamp をキーに DB を検索し、該当する iaCloudObject をレスポンスとして JSON で返す。 timestamp と instanceKey のいずれも "" の場合、CCS は保持する最新のインスタンスを返す。
指定された timestamp のオブジェクトが存在しない場合は、その timestamp 以前の最も新しいオブジェクトを返す。

Request json

{
    "request" : "retrieve",
    "serviceID" : { string },
    "retrieveObject : {
        "objectKey" : { string },
        "timestamp" : { string },
        "instanceKey" : { string }
    }
}

Property	値	説明	Notes
request	string	"retrieve"	固定
serviceID	string	接続時あるいは直前の Response Body で返された serviceID。
objectKey	string	取得する ia-cloud オブジェクトの Key。
timestamp	string	取得する ia-cloud オブジェクトインスタンスのタイムスタンプ。 ISO8601 に規定される文字列。　例：2014-08-15T13:43:28.123456+9:00 timestamp と instanceKey のいずれも "" の場合、CCS は保持する最新のインスタンスを返す。指定された timestamp のオブジェクトが存在しない場合は、その timestamp 以前の最も新しいオブジェクトを返す。
instanceKey	string	取得する ia-cloud オブジェクトインスタンスのユニーク ID。 objectKey + timestamp and/or instanceKey をもって、個々のインスタンスのユニークキーとなる。 timestamp と instanceKey のいずれも "" の場合、 CCS は保持する最新のインスタンスを返す。	省略可

Response json

{
    "serviceID" : { string },           // サービスID
    "status" : { string },
    "newServiceID" : { string },
    "dataObject" : { iaCloudObject }    //  ia-cloud オブジェクトで詳細記述
}

Property	値	説明
serviceID	string	retrieve Request で使用された serviceID。 retrieve Requestのコピー。
status	string	retrieve Request の実行結果 { "ok" / "ng" }
newServiceID	string	次回の格納 Request で使用されるべき serviceID 変更の必要がなければ、同一の serviceID が返される。
dataObject	object	取得された ia-cloud オブジェクト。

データオブジェクトアレーの取得

FDS が CCS から複数のデータオブジェクトをアレーとして取得するサービスを利用する際のリクエスト。
CCS は、該当する objecyKey と timestamp等をキーに DB を検索し、該当する iaCloudObjectArray をレスポンスとして JSON で返す。 timestamp と instanceKey のいずれも "" の場合、CCS は保持する最新のインスタンスから指定の数のアレーを返す。

Request json

{
    "request" : "retrieveArray",
    "serviceID" : { string },
    "retrieveObjects : {
        "objectKey" : { string },
        "query": {
            "type": { string },     // "between" か　"beginWith"　どちらか
            "from": { string },
            "to": { string },
            "begin": { string },    // typeが"beginWith"の時、検索するinstanceKeyの先頭文字列
            "limit": { number },    // 取得するオブジェクトの最大数
        }
    }
}

Property	値	説明	Notes
request	string	"retrieveArray"	固定
serviceID	string	接続時あるいは直前の Response Body で返された serviceID。
objectKey	string	取得する ia-cloud オブジェクトの Key。
type	string	検索の方法。timestampで検索する"between" か instanceKeyで検索する　"beginWith"
from, to	string	取得する ia-cloud オブジェクトインスタンスのタイムスタンプの範囲。 ISO8601 に規定される文字列。　例：2014-08-15T13:43:28.123456+9:00 from と to のいずれかが省略されるか "" の場合、CCS は保持する存在する from か to から limit 数のオブジェクトのインスタンスを返す。 from と to のいずれも省略された場合、最も新しいオブジェクトから limit 数のインスタンスを返す。
bigin	string	instanceKeyに対する検索で、instanceKeyが bigin で始まるものを返す。
limit	number	検索結果の最大数。　最大1000。

Response json

{
    "serviceID" : { string },           // サービスID
    "status" : { string },
    "newServiceID" : { string },
    "dataObjectArray" : { iaCloudObject }    //  ia-cloud オブジェクトアレーで詳細記述
}

Property	値	説明
serviceID	string	retrieve Request で使用された serviceID。 retrieve Requestのコピー。
status	string	retrieve Request の実行結果 { "ok" / "ng" }
newServiceID	string	次回の格納 Request で使用されるべき serviceID 変更の必要がなければ、同一の serviceID が返される。
dataObjectArray	object	取得された ia-cloud オブジェクトアレー。

状態の確認（ serviceID の更新）

FDS 側から何らかの理由で、serviceID の再取得が必要となった場合のサービスリクエスト。
CCS は、新たな serviceID を発行することが期待されているが、それまで使用していた serviceID と異なる serviceID を発行することが必須ではない。

Request json

{
    "request" : "getStatus",
    "serviceID" : { string },
    "timestamp" : { string },
    "comment" : { string }
}

Property	値	説明	Notes
request	string	"getStatus"	固定
serviceID	string	接続時あるいは直前の Response Body で返された serviceID。
timestamp	string	サービスへ接続する時点でのタイムスタンプ。 ISO8601 に規定される文字列。　例：2014-08-15T13:43:28.123456+9:00
comment	string	FDS と接続に関する任意の説明。取り扱いは、CCS 側に依存する。	省略可

Response json

{
    "FDSKey" : { string },
    "serviceID" : { string },
    "newServiceID" : { string },
    "optionalMessage" : { object }
}

Property	値	説明	Notes
FDSKey	string	この FDS のユニークな Key。 connect Request のコピー。
serviceID	string	getStatus Request で使用された serviceID。 getStatus Requestのコピー。
newServiceID	string	次回の格納 Request で使用されるべき serviceID。変更の必要がなければ、同一の serviceID が返される。
optionalMessage	object	FDS へ送付する任意の JSON オブジェクトメッセージ。 FDS は解釈できない optionalMessage を読み飛ばさなければならない。	省略可

接続の終了

FDS 側から接続を終了するサービスリクエスト。
CCS は以降、関連付けられている serviceID によるサービスは受け付けない。（ Invalid serviceID エラー）

Request json

{
    "request" : "terminate",
    "serviceID" : { string }
}

Property	値	説明	Notes
request	string	"terminate"	固定
serviceID	string	接続時あるいは直前の Response Body で返された serviceID。

Response json

{
    "userID" : { string },
    "FDSKey" : { string },
    "serviceID" : { string },
    "message" : { string }
}

Property	値	説明	Notes
userID	string	サービスプロバイダーから支給されたサービスを受ける userID。 connect Request のコピー。
FDSKey	string	この FDS のユニークな Key。connect Request のコピー。
serviceID	string	terminate Request で使用された serviceID。 terminate Request のコピー。
message	string	"disconnected"	固定

他の通信プロトコールの搬送 convey

ia-cloud Web API を利用して、他の工業系通信プロトコールのメッセージを伝送するサービス。
dataObject には、通信電文搬送モデルの章 に示すオブジェクトを格納する。

Request json

{
    "request" : "convey",
    "serviceID" : { string },
    "dataObject" : { object }    //  ia-cloud オブジェクト章で詳細記述
}

Property	値	説明	Notes
request	string	"convey"	固定
serviceID	string	接続時あるいは直前の Response Body で返された serviceID
detaObject	object	convey サービスによって搬送されるデータのオブジェクト通信電文搬送モデルの章の dataContent を格納した iaCloudObject

Response json

{
    "serviceID" : { string },           // サービスID
    "status" : { string },
    "newServiceID" : { string },
    "dataObject" : { iaCloudObject }    //  ia-cloud オブジェクトの章で詳細記述
}

Property	値	説明
serviceID	string	convey Request で使用された serviceID。 convey Request のコピー。
status	string	convey Request の実行結果 { "ok" / "ng" }
newServiceID	string	次回の格納 Request で使用されるべき serviceID。変更の必要がなければ、同一の serviceID が返される。
dataObject	object	convey サービスによって搬送されるデータのオブジェクト通信電文搬送モデルの章の dataContent を格納した iaCloudObject

ia-cloud オブジェクト

FDS と CCS と間でやり取りされる ia-cloud オブジェクトモデルを以下に定義する。
ia-cloud オブジェクトモデルは、基本モデルと、基本モデルの配列を持つオブジェクトアレイモデルの2種類がある。

オブジェクトモデル

ia-cloud オブジェクトは、一つの ia-cloud objectContent を保持するオブジェクトモデルである。

// ******************************************************
// ia-cloud/JSON object Model
// ******************************************************

var iaCloudObject = {

    // metaData
    "objectType" : "iaCloudObject",
    "objectKey" : { string },
    "objectDescription" : { string },
    "timestamp" : { string },
    "instanceKey" : { string },
    "quality" : { string },

    // objectContent
    "objectContent"  : { iaCloudObjectContent }

}

各プロパティの意味と制限

Property	値	説明	Notes
objectType	string	基本モデルは、"iaCloudObject"	固定
objectKey	string	このオブジェクトの Key。 userID 内の名前空間でユニークでなければならない。サービスプロバイダーとユーザとの取り決めに依存する。 uri 表記を使用することを推奨する。　例：com.mydomain.ia-cloud.site.equipment.objectName 　　　com.mydomain.ia-cloud.sitename.fdsname.objectname 省略された場合は、親オブジェクトの "objectKey" を引き継ぐ。	ルートオブジェクト以外は省略可
objectDescription	string	データオブジェクトの説明・名称など。	省略可
timestamp	string	このオブジェクトインスタンスのタイムスタンプ。 ISO8601 に規定される文字列。　例： 2014-08-15T13:43:28.123456+09:00 　　　（秒以下については省略可）省略された場合は、親オブジェクトの "timestamp" を引き継ぐ。	ルートオブジェクト以外は省略可
instanceKey	string	このオブジェクトインスタンスのユニーク ID。製造工番やシリアル番号などを想定している。タイムスタンプとの併用も可。（ objectKey + timestamp ）and/or instanceKey をもって、個々のインスタンスのユニークキーとなる。	省略可
quality	string	以下のobjectContentの品質を表す文字列。以下のいずれかの値を持つ。 "good": 正常な値、 "not good": 正常ではない、 "device error": センサ・計測器等でエラーが発生 "com. error": センサ・計測器等との通信でエラーが発生 "not updated": データが更新されていない。 "@xxxx": ユーザ定義の文字列を使用する場合@から始めることる。なお、"good"以外の場合のobjectContentの内容は、実装依存である。	省略可
objectContent	object	任意の iaCloudObjectContent ia-cloud データモデルの章を参照。

オブジェクトアレイモデル

// ******************************************************
// ia-cloud/JSON object Array Model
// ******************************************************

var iaCloudObjectArray = {

    "objectType" : "iaCloudObjectArray",
    "objectKey" : { string },
    "objectDescription" : { string },
    "timestamp" : { string },
    "instanceKey" : { string },
    "length" : { number},

    // Array of contentDataArray

    "objectArray" : [
        { iaCloudObject },

    /*      .
        one or more any ia-cloud object
            .
            .            */
    ]
}

iaCloudObject の配列オブジェクト。格納される iaCloudObject の timestamp や objectKey などに制約はないが、異なる timestamp の同一 objecyKey のオブジェクトを格納すればヒストリアンやログデータとなり、同一 timestamp の複数の iaCloudObject を格納すれば、同一時点での複数のデータオブジェクトを一度に扱うことができる。

objectArray 配列には、iaCloudObjectArray を格納してはならない。

各プロパティの意味と制限

Property	値	説明	Notes
objectType	string	"iaCloudObjectArray"	固定
length	number	ログデータの配列の大きさ。
objectArray	Array of iaCloudObject	ia-cloud オブジェクトの配列。

他のプロパティは、基本モデルと同じ。

オブジェクトモデルの簡易表現

ia-cloud Web API 仕様で規定しているオブジェクトモデル構造や各プロパティ名称など、標準仕様として名称の重複を避け、検索性や一意性を確保するため、限定された用途においては冗長である場合がある。

アプリケーションが限定されており、データの相互利用性や拡張性が要求されない場合、以下に示すような簡易表現を用いてもよい。ただし、通信やストレージ容量、処理時間などの制約が大きい場合に限る。

iaCloudObject のプロパティ

	プロパティ	簡易名称	説明
1	objectType	基本モデルは省略可	"iaCloudObject" は省略可 "iaCloudObjectArry" の簡易表現は、"array"
2	objectKey	key	簡易表現が可能 userID 内の名前空間でユニークであれば、uri 表記である必要はない
3	objectDescription	省略可	もともと省略可
4	timestamp	ts	timestamp の値の形式も、アプリケーション依存で決定してもよい
5	instanceKey	iKey	簡易表現が可能もともと省略可のケースは省略可能
6	quality	qlty	簡易表現が可能
7	objectContent	cont	簡易表現が可能

ia-cloud データモデル

iaCloudObject に格納される objectContent のデータモデルを定義する。
本章で定義するデータモデルは、ユースケースに応じて随時拡張されるものとする。

基本データモデル

// ******************************************************
// ia-cloud/JSON object Content Model
// ******************************************************

var iaCloudObjectContent = {

    "contentType" = "iaCloudData" ,
    "contentData" = [
        {
            "commonName" : { string },
            "dataName" : { string },
            "unit" : { string },
            "quality" : { string },
            "dataValue" : { primitivedata | nestedobject }
        },

        /*      .
            one or more any contentData objects
                .
                .            */
     ]
}

ia-cloud で最も基本となるデータモデルである。他のモデルはこれを拡張したものである。

各プロパティの意味と制限

Property	値	説明	Notes
contentType	string	"iaCloudData" "contentData" 配列に格納されるオブジェクトにより、この "contentType" が異なる。基本モデルは、"com.ia-cloud.contenttype.iaCloudData" を省略し、"iaCloudData" とする。任意に独自拡張した "contentType" は、フルの uri 表記とする。	固定
contentData	object array	以下に示す一つ以上の JSON オブジェクト配列

contentData object

Property	値	説明	Notes
commonName	string	contentData の共通の名前 contentType 毎に定められている場合は、省略不可	省略可
dataName	string	contentData の任意の名前（各 Locale に基づいた名前） commmonName がある場合は省略可	省略可
unit	string	dataValue が表す数値の単位 ISO1000 、ISO/IEC80000 に準拠した MKS 単位系を使用することを原則とする。 dataValue が時刻を表す場合は "time" を、また、無単位の場合は Null 文字列 "" とすること。	"" の場合は省略可
quality	string	以下のobjectContentの品質を表す文字列。以下のいずれかの値を持つ。 "good": 正常な値、 "not good": 正常ではない、 "device error": センサ・計測器等でエラーが発生 "com. error": センサ・計測器等との通信でエラーが発生 "not updated": データが更新されていない。 "@xxxx": ユーザ定義の文字列を使用する場合@から始めることる。なお、"good"以外の場合のobjectContentの内容は、実装依存である。	省略可
dataValue	JSON primitive or nested JSON object	contentData の値 Null 以外の任意の primitive データ、あるいは任意の object 時刻を表す場合は、ISO8601 に規定される文字列　例：2014-08-15T13:43:28.123456+09:00

データモデルの簡易表現

ia-cloud Web API 仕様で規定しているデータモデル構造や各プロパティ名称など、標準仕様として名称の重複を避け、検索性や一意性を確保するため、限定された用途においては冗長である場合がある。
アプリケーションが限定されており、データの相互利用性や拡張性が要求されない場合、以下に示すような簡易表現を用いてもよい。ただし、通信やストレージ容量、処理時間などの制約が大きい場合に限る。

iaCloudObjectContent のプロパティ

	プロパティ	簡易名称	説明
1	contentType	省略可	objectKey 等からデータの Type が決定できる場合は省略可
2	contentData	data	簡易表現が可能
3	commonName	省略可	異なるアプリケーション間でのデータの相互利用などが想定されない場合は省略可
4	dataName	name	簡易表現が可能
5	unit	省略可	データが無単位でない場合でも objectKey 等からデータの単位が決定できる場合は省略可
6	quality	qlty	簡易表現が可能
7	dataValue	value	簡易表現が可能

生産指図(Production Order) Model

// ******************************************************
// ia-cloud/JSON Production Order Model
// ******************************************************

var iaCloudProductionOrder = {

    "contentType" : "ProductionOrder",
        "contentData" : [
          {
            "commonName" : “orderID”,
            "dataName" : “製造指図番号”,
            "unit" : “” ,
            "dataValue" : “PO12345678”
        },
 	    {
            "commonName" : “status”,
            "dataName" : “進捗状況”,
            "unit" : “” ,
            "dataValue" : “issued”,
        },
	    {
            "commonName" : “productID”,
            "dataName" : “図番”,
            "unit" : “” ,
            "dataValue" : “262557843-001”,
        },
         {
            "commonName" : "Produced Quantity",
            "dataName" : “完成数”,
            "unit" : “” ,
            "dataValue" : “28”,
        },

        /*      .
            one or more any contentData objects
                .
                .            */
    ]
}

製造ラインや製造ワークセル、製造設備などへの、生産指図とその状態を保持するオブジェクトモデルである。

各プロパティの意味と制限

Property	値	説明	Notes
contentType	string	"ProductionOrder"	固定
contentData	JSON object Array	以下に示す一つ以上の JSON オブジェクト配列。（すべてを含む必要はない）

contentData object

Property	値	説明	Notes
commonName	string	"ProductionOrder"　製造指図の状態を表すデータ名称。	固定
dataValue	object	Production Order(P.O.)の実施状態を表すオブジェクト。以下に示す要素を持つ、一つ以上の JSON オブジェクト配列。（すべてを含む必要はない）次の dataValueObject を参照。	hoge

|

contentData object

Property	値	説明	Notes
commonName	string	"Order ID"：製造指図のID	固定

Property	値	説明	Notes
commonName	string	"Status"：製造指図進捗状況値として、状態を表すを表す任意の文字列を使用できるが、以下のいずれかを使用することを推奨する "issed" : 発行済み "ongoing" : 進行中 "completed" : 完了 "pending" : 保留中	固定

Property	値	説明	Notes
commonName	string	"Product ID"：製造される製品のID番号	固定

Property	値	説明	Notes
commonName	string	及び、以下の ISO22400-2 の 5.3 Time model for productionorder および 5.5 Logistical elements で規定される、以下の各 KEI-elements の定義に準じる。 "Planned Order Time" "Planned Order Quantity" "Scrap Quantity" "Planned Scrap Quantity" "Good Quantity" "Rework Quantity" "Produced Quantity" "Raw Materials" "Raw Materials Inventory" "Finished Goods Inventory" "Consumable Inventory" "Consumed Material" "Integrated Good Quantity" "Production Loss" "Storage and Transportation Loss" "Other Loss" "Equipment Production Capacity" のいずれか、一つ以上の組合せを標準とするが、拡張を許す。
dataName	string	contentData の任意の名前。（各 Locale に基づいた名前）	省略可
unit	string	"" か、dataValue の適切な単位。	省略可
dataValue	string or number	上記の各 contentData の値。

生産実績データモデル

// ******************************************************
// ia-cloud/JSON Production Result Data Model
// ******************************************************

var iaCloudProductionResult = {

    "contentType" : "ProductionResult",
    "contentData" : [
        {
            "commonName" : { string },
            "dataName" : { string },
            "unit" : { string } ,
            "dataValue" : { number }
        },
        /*      .
            one or more any contentData objects
                .
                .            */
    ]
}

監視対象の設備装置・生産ラインなどの生産実績を保持するオブジェクトモデルである。

ISO22400 part2（ KPIs for manufacturing operations management ）5.5 Logistical elements で規定される各 elements の定義に準拠する。

各プロパティの意味と制限

Property	値	説明	Notes
contentType	string	"ProductionResult"	固定
contentData	Array	以下に示す要素を持つ、一つ以上の JSON オブジェクト配列。（すべてを含む必要はない）

contentData object

Property	値	説明	Notes
commonName	string	contentData の名前 "OrderID"：製造指図の ID 及び、以下の ISO22400-2 の 5.5 Logistical elements で規定される各 elements の定義に準じる。 "Planned Order Quantity" "Scrap Quantity" "Planned Scrap Quantity" "Good Quantity" "Rework Quantity" "Produced Quantity" "Raw Materials" "Raw Materials Inventory" "Finished Goods Inventory" "Consumable Inventory" "Consumed Material" "Integrated Good Quantity" "Production Loss" "Storage and Transportation Loss" "Other Loss" "Equipment Production Capacity" のいずれか、一つ以上の組合せを標準とするが、拡張を許す。
dataName	string	contentData の任意の名前。（各 Locale に基づいた名前）	省略可
unit	string	"" か、dataValue の適切な単位。	固定
dataValue	number	上記の各 contentData の数量を表す数値。

在庫実績データモデル

// ******************************************************
// ia-cloud/JSON Inventory Data Model
// ******************************************************

var iaCloudInventoryData = {

    "contentType" : "InventoryData",
    "contentData" : [
        {
            "commonName" : "Operation Type",
            "dataName" : { string },
            "unit" : "",
            "dataValue" : { string }
        },
        {
            "commonName" : "Operation Quantity",
            "dataName" : { string },
            "unit" : "",
            "dataValue" : { number }
        },
        {
            "commonName" : "Location Code",
            "dataName" : { string },
            "unit" : "",
            "dataValue" : { string }
        },
    ]
}

製品在庫、部品在庫などを管理するサービスと現場端末などとの情報交換のためのオブジェクトモデルである。

各プロパティの意味と制限

Property	値	説明	Notes
contentType	string	"InventoryData"	固定
contentData	Array	以下に示す一つ以上の JSON オブジェクト配列。（すべてを含む必要はない）

contentData object

Property	値	説明	Notes
commonName	string	"Operation Type" 在庫への操作内容を表す名称。
dataName	string	任意の名前。（各 Locale に基づいた名前）	省略可
dataValue	string	"Inbound" / "Outbound" / "Inventory" のいずれか。
commonName	string	"Operation Quantity" 操作数量の contentData の名前。
dataName	string	任意の名前。（各 Locale に基づいた名前）	省略可
unit	string	"" か Operation Quantity の適切な単位。	省略可
dataValue	number	数量を表す数値。
commonName	string	"Location Code" ロケ―ションを表す contentData の名前。
dataName	string	任意の名前。（各 Locale に基づいた名前）	省略可
dataValue	string	ロケーションを表す文字列。

品質データモデル

// ******************************************************
// ia-cloud/JSON Quality Data Model
// ******************************************************

var iaCloudQualityData = {

    "contentType" : "QualityData",
    "contentData" : [
        {
            "commonName" : { string },
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { number }
        },

        /*      .
            one or more any contentData objects
                .
                .            */
    ]
}

監視対象の設備装置・生産ラインなどの品質実績状態を保持するオブジェクトモデルである。

ISO22400 part2（ KPIs for manufacturing operations management ）5.6 5.7 Quality elements で規定される各 elements の定義に準拠する。

各プロパティの意味と制限

Property	値	説明	Notes
contentType	string	"QualityData"	固定
contentData	Array	以下に示す一つ以上の JSON オブジェクト配列。（すべてを含む必要はない）

contentData object

Property	値	説明	Notes
commonName	string	Quality Element の名前。 ISO22400-2 の 5.6 5.7 Quality elementsの定義に準じる。 "Good Part" "Inspected Part" "Upper Specification Limit" "Lower Specification Limit" "Arithmetic Average" "Average of Average Values" "Estimated Deviation" "Standard Deviation" "Variance" のいずれかを標準とするが、拡張を許す。
dataName	string	任意の名前。（各 Locale に基づいた名前）	省略可
unit	string	"" か Quality Element の適切な単位。	省略可
dataValue	number	数量を表す数値。

装置ステータスモデル

// ******************************************************
// ia-cloud/JSON Equipment Status Data Model
// ******************************************************

var iaCloudEquipmntStatus = {

    "contentType" : "EquipmntStatus",
    "contentData" : [
        {
            "commonName" : "Status",
            "dataName" : { string },
            "dataValue" : { string }
        },
        {
            "commonName" : "Production Order",
            "dataName" : { string },
            "dataValue" : { string }
        },
        {
            "commonName" : "Started Time",
            "dataName" : { string },
            "unit" : "time",
            "dataValue" : { string }
        },
        {
            "commonName" : "Power Consumption",
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { string }
        }
    ]
}

監視対象の設備装置などの稼働状態を保持するオブジェクトモデルである。
commonName "Status" を持つ dataValue は、ISO22400 part2（ KPIs for manufacturing operations management ）5.1 Time elements 及び 5.2-4 の各 Time model と Annex B で規定される Time elements の定義に準拠する。

各プロパティの意味と制限

Property	値	説明	Notes
contentType	string	"EquipmntStatus"	固定
contentData	Array	以下に示す一つ以上の JSON オブジェクト配列。（すべてを含む必要はない）

contentData object

Property	値	説明	Notes
commonName	string	ユーザ定義の状態表現の場合は"Status" ISO22400-2 の 5.１ Time elementsの定義に準じる表現を使用する場合は、そのTime modelの略称名（下表参照）。	固定
dataName	string	任意の名前。（各 Locale に基づいた名前）	省略可
dataValue	string	ユーザ定義の状態表現と、ISO22400-2 の 5.１ Time elements の定義に準じる表現を使用できる。対象とするTime modelは以下としそれぞれのdataValueを下表に示す "Work units" "Work units based on loss time” "Production order" "personnel"

Property	値	説明	Notes
commonName	string	"Production Order"　作業指示を表す名称。	固定
dataName	string	任意の名前。（各 Locale に基づいた名前）	省略可
dataValue	string	作業指示コード。

Property	値	説明	Notes
commonName	string	"Started Time"　作業開始時間を表す名称。	固定
dataName	string	任意の名前。（各 Locale に基づいた名前）	省略可
unit	string	"time"	固定
dataValue	string	作業開始時刻を示す文字列。

Property	値	説明	Notes
commonName	string	"Power Consumption"　消費電力を表す名称。	固定
dataName	string	任意の名前。（各 Locale に基づいた名前）	省略可
unit	string	"W", "KW"等、電力量の単位。
dataValue	number	消費電力を示す数値。

ISO22400-2 5.2time model　の定義に準じた dataValueとcommonName

ISO22400 Time model for	commonName	値(strings)	Notes
Work units	KEI-WU	"AUBT" "ADOT" "AUPT" "ADET" "APT" "AUST"	"Actual unit busy time" "Actual unit down time" "Actual unit processing time" "Actual unit delay time" "Actual production time" "Actual unit setup time"
Work units based on loss time	KEI-WULT	"OPT" "AST" "ADOT" "NOT" "MST" "WT" "VOT" "DPT" "RWT"	"Operating time" "Actual setup time" "Actual unit down time" "Net operating time" "Minor stop time" "Waiting time" "Valued operating time" "Defect production time" "Reworking time"
Production order	KEI-PO	"ATT" "AQT" "AUBT" "AUPT" "ADET" "APT" "AUST"	"Actual transportation time" "Actual queueing time" "Actual unit busy time" "Actual unit processing time" "Actual Delay time" "Actual production time" "Actual unit setup time"
personnel	KEI-PSNL	"APAT" "APWT" "NWT"	"Actual personnel attendance time" "Actual personnel work time" "Not working time, breaks"

エラーステイタスモデル（エラー番号を格納）

// ******************************************************
// ia-cloud/JSON Error Status Model
// ******************************************************

var iaCloudErrorStatus = {

    "contentType" : "ErrorStatus",
    "contentData" : [
        {
            "commonName" : "Error Status",
            "dataName" : { string },
            "dataValue" : { boolean }
        },
        {
            "commonName" : "Error Code",
            "dataName" : { string },
            "dataValue" : { string }
        },
        {
            "commonName" : "Error Description",
            "dataName" : { string },
            "dataValue" : { string }
        }
    ]
}

監視対象の設備装置などの状態を保持するオブジェクトモデルである。

各プロパティの意味と制限

Property	値	説明	Notes
contentType	string	"ErrorStatus"	固定
contentData	JSON object	以下に示す一つ以上の JSON オブジェクト配列。（すべてを含む必要はない）

contentData object

Property	値	説明	Notes
commonName	string	"Error Status"　エラー状態表すデータ名称。	固定
dataName	string	任意の名前。（各 Locale に基づいた名前）	省略可
dataValue	boolean	true / false のいずれか。

Property	値	説明	Notes
commonName	string	"Error Code"　エラーコードを表すデータ名称。	固定
dataName	string	任意の名前。（各 Locale に基づいた名前）	省略可
dataValue	string	エラーコードを表す文字列。

Property	値	説明	Notes
commonName	string	"Error Description"　エラー内容表すデータ名称。	固定
dataName	string	任意の名前。（各 Locale に基づいた名前）	省略可
dataValue	string	エラーの内容を表す文字列。

アラーム＆イベントモデル

// ******************************************************
// ia-cloud/JSON Alarm & Event Status Model
// ******************************************************

var iaCloudAlarm&Event = {

    "contentType" : "Alarm&Event",
    "contentData" : [
        {
            "commonName" : "Alarm&Event",
            "dataValue" : {
                "AnEStatus" : { string },
                "AnECode" : { string },
                "AnEDescription" : { string }
            }
        },

        /*      .
            one or more any contentData objects
                .
                .            */
    ]
}

監視対象の設備装置などの警報やイベント状態を保持するオブジェクトモデルである。

各プロパティの意味と制限

Property	値	説明	Notes
contentType	string	"ErrorStatus"	固定
contentData	JSON object Array	以下に示す一つ以上の JSON オブジェクト配列。（すべてを含む必要はない）

contentData object

Property	値	説明	Notes
commonName	string	"A&EStatus"　エラー状態表すデータ名称。	固定
dataValue	object	Alarm & Event 状態を表すオブジェクト。次の dataValueObject を参照。

dataValueObject

Property	値	説明
AnEStatus	string	"set" : 当該 A&E が発生 "reset" : 当該 A&E が復帰 "on" : 当該 A&E が発生中 "off" : 当該 A&E は発生していないのいずれか。
AnECode	string	エラーコードを表す文字列。
AnEDescription	string	エラーメッセージを表す文字列。

設備運転状態モデル

// ******************************************************
// ia-cloud/JSON Machine Status Model
// ******************************************************

var iaCloudMachineStatus = {

    "contentType" : "MachineStatus",
    "contentData" : [
        {
            "dataName" : { string },
            "dataValue" : { string }
        },

        /*      .
            one or more any contentData objects
                .
                .            */
    ]
}

監視対象の設備装置などの警報やイベント状態を保持するオブジェクトモデルである。

各プロパティの意味と制限

Property	値	説明	Notes
contentType	string	"MachineStatus"	固定
contentData	JSON object Array	以下に示す一つ以上の JSON オブジェクト配列。（すべてを含む必要はない）

contentData object

Property	値	説明	Notes
dataName	string	設備の任意の名前。（各 Locale に基づいた名前）
dataValue	string	"start" : 設備が運転を開始した "stop" : 設備が停止した "on" : 設備は運転中 "off" : 設備は停止中のいずれかの文字列。

コントロールポイントモデル

// ******************************************************
// ia-cloud/JSON Control Point Data Model
// ******************************************************

var iaCloudControlPointData = {

    "contentType" : "ControlPointData",
    "contentData" : [
        {
            "commonName" : "Process Value",
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { number }
        },
        {
            "commonName" : "Set Value",
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { number }
        },
        {
            "commonName" : "Manipulated Value",
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { number }
        },
        {
            "commonName" : "Low Limit",
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { number }
        },
        {
            "commonName" : "High Limit",
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { number }
        },
        {
            "commonName" : "Low-low Limit",
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { number }
        },
        {
            "commonName" : "High-high Limit",
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { number }
        },
        {
            "commonName" : "Low Limit Event",
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { boolean }
        },
        {
            "commonName" : "High Limit Event",
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { boolean }
        },
        {
            "commonName" : "Low-low Limit Event",
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { boolean }
        },
        {
            "commonName" : "High-high Limit Event",
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { boolean }
        }
    ]
}

各プロパティの意味と制限

Property	値	説明	Notes
contentType	string	"ControlPoint"	固定
contentData	Array	以下に示す一つ以上の JSON オブジェクト配列。（すべてを含む必要はない）

contentData object

Property	値	説明	Notes
commonName	string	以下のいずれか。 "ProcessValue" : number, "Set Value" : number, "Low Limit" : number, "High Limit" : number , "Low Low Limit" : number, "High High Limit" : number, "Low Limit Event" : boolean, "High Limit Event" : boolean, "Low Low Limit Event" : boolean, "High High Limit Event" : boolean
dataName	string	任意の名前。（各 Locale に基づいた名前）	省略可
unit	string	システム変数の単位。	"" は省略可
dataValue	number or boolean	システム変数の値。変数の型は commonName の項を参照。

温度調節計モデル

標準的な温度調節計のデータモデル。

// ******************************************************
// ia-cloud/JSON Temperature Controllers Data Model
// ******************************************************

var iaCloudTempContData = {

    "contentType" : "TempContData",
    "contentData" : [
        {
            "commonName" : "Process Value",
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { number }
        },
        {
            "commonName" : "Setting Value",
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { number }
        },
        {
            "commonName" : "Run Mode",
            "dataName" : { string },
            "unit" : "",
            "dataValue" : { boolean }
        },
        {
            "commonName" : "Auto Mode",
            "dataName" : { string },
            "unit" : "",
            "dataValue" : { boolean }
        },
        {
            "commonName" : "Auto Tuning",
            "dataName" : { string },
            "unit" : "",
            "dataValue" : { boolean }
        },
        {
            "commonName" : "Proportional Band",
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { number }
        },
        {
            "commonName" : "Integral Time",
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { number }
        },
        {
            "commonName" : "Derivative Time",
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { number }
        },
        {
            "commonName" : "Error Date",
            "dataName" : { string },
            "unit" : "",
            "dataValue" : { string },
        },
        {
            "commonName" : "Error Message",
            "dataName" : { string },
            "unit" : "",
            "dataValue" : { string }
        }
    ]
}

各プロパティの意味と制限

Property	値	説明	Notes
contentType	string	"TempContData"	固定
contentData	Array	以下に示す一つ以上の JSON オブジェクト配列。（すべてを含む必要はない）

contentData object

Property	値	説明	Notes
commonName	string	標準的な温度調節器の仕様を基に規定したシステム変数名。 "Process Value" : 計測値 "Setting Value" : 設定値 "Run Mode" : 運転モード "Auto Mode" : 自動モード "Auto Tuning" : オートチューニングモード "Proportional Band" : 比例帯 "Integral Time" : 積分時間 "Derivative Time" : 微分時間 "Error Date" : エラー発生時刻 "Error Message" : エラーメッセージ
dataName	string	任意の名前。（各 Locale に基づいた名前）	省略可
unit	string	システム変数の単位。	"" は省略可
dataValue	string , number or boolean	システム変数の値。

アクチュエーターモデル

標準的なアクチュエーターのデータモデル。

// ******************************************************
// ia-cloud/JSON Actuator Data Model
// ******************************************************

var iaCloudActuatorObject = {

    "contentType" : "ActuatorData",
    "contentData" : [
        {
            "commonName" : "Servo On",
            "dataName" : { string },
            "unit" : "",
            "dataValue" : { boolean }
        },
        {
            "commonName" : "Busy Status",
            "dataName" : { string },
            "unit" : "",
            "dataValue" : { boolean }
        },
        {
            "commonName" : "Auto Mode",
            "dataName" : { string },
            "unit" : "",
            "dataValue" : { boolean }
        }
        {
            "commonName" : "Normal Status",
            "dataName" : { string },
            "unit" : "",
            "dataValue" : { boolean }
        },
        {
            "commonName" : "Zero Return",
            "dataName" : { string },
            "unit" : "",
            "dataValue" : { boolean }
        },
        {
            "commonName" : "Emergency Stop",
            "dataName" : { string },
            "unit" : "",
            "dataValue" : { boolean }
        },
        {
            "commonName" : "Current Position",
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { number }
        },
        {
            "commonName" : "Current Speed",
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { number }
        },
        {
            "commonName" : "Error Code",
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { number }
        }
        {
            "commonName" : "Position Objects",
            "dataName" : { string },
            "dataValue" : [
                {
                    "commonName" : "Target Position",
                    "dataName" : { string },
                    "unit" : { string },
                    "dataValue" : { number }
                },
                {
                    "commonName" : "Speed",
                    "dataName" : { string },
                    "unit" : { string },
                    "dataValue" : { number }
                },
                {
                    "commonName" : "Acceleration",
                    "dataName" : { string },
                    "unit" : { string },
                    "dataValue" : { number }
                },
                {
                    "commonName" : "Deceleration",
                    "dataName" : { string },
                    "unit" : { string },
                    "dataValue" : { number }
                }
            ]
        }
    ]
}

各プロパティの意味と制限

Property	値	説明	Notes
contentType	string	"ActuatorData"	固定
contentData	Array	以下に示す一つ以上の JSON オブジェクト配列。（すべてを含む必要はない）

contentData object

Property	値	説明	Notes
commonName	string or object	標準的なアクチュエーターの仕様を基に規定したシステム変数名。 "Servo On" : サーボ ON 状態 "Busy Status" : 移動中 "Auto Mode" : 運転モード "Normal Status" : 運転ステータス "Zero Return" : 原点復帰完了 "Emergency Stop" : 非常停止 "Current Position" : 現在位置 "Current Speed" : 現在速度 "Error Code" : エラーコード "Position Objects" : ポジションデータ（ object 配列、下表参照）
dataName	string	任意の名前。（各 Locale に基づいた名前）	省略可
unit	string	システム変数の単位。	"" は省略可
dataValue	string , number or boolean	システム変数の値。

Position Objects

Property	値	説明	Notes
commonName	string	"Position Objects" : ポジションデータ（配列） "Target Position" : 目標位置 "Speed" : 速度 "Acceleration" : 加速度 "Deceleration" : 減速度
dataName	string	任意の名前。（各 Locale に基づいた名前）	省略可
unit	string	システム変数の単位。	"" は省略可
dataValue	string , number or boolean	システム変数の値。

インバータモデル

標準的なインバータのデータモデル。

// ******************************************************
// ia-cloud/JSON Inverter Controllers Data Model
// ******************************************************

var iaCloudInverterData = {

    "contentType" : "InverterData",
    "contentData" : [
        {
            "commonName" : "Output Frequency",
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { number }
        },
        {
            "commonName" : "Frequency Reference",
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { number }
        },
        {
            "commonName" : "Output Current",
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { number }
        },
        {
            "commonName" : "Accumulated Time",
            "dataName" : { string },
            "unit" : { string },
            "dataValue" : { number }
        },
        {
            "commonName" : "Forward Rotation",
            "dataName" : { string },
            "unit" : "",
            "dataValue" : { boolean }
        },
        {
            "commonName" : "Reverse Rotation",
            "dataName" : { string },
            "unit" : "",
            "dataValue" : { boolean }
        },
        {
            "commonName" : "Error Date",
            "dataName" : { string },
            "unit" : "",
            "dataValue" : { string }
        },
        {
            "commonName" : "Error Message",
            "dataName" : { string },
            "unit" : "",
            "dataValue" : { string }
        }
    ]
}

各プロパティの意味と制限

Property	値	説明	Notes
contentType	string	"InverterData"	固定
contentData	Array	以下に示す一つ以上の JSON オブジェクト配列。（すべてを含む必要はない）

contentData object

Property	値	説明	Notes
commonName	string	標準的なアクチュエーターの仕様を基に規定したシステム変数名。 "Output Frequency" : 出力周波数 "Frequency Reference" : 周波数指令 "Output Current" : 出力電流 "AccumulatedTime" : 累積稼働時間 "Forward Rotation" : 運転中 "Reverse Rotation" : 逆転中 "Error Date" : エラー発生時刻 "Error Message" : エラーメッセージ
dataName	string	任意の名前。（各 Locale に基づいた名前）	省略可
unit	string	システム変数の単位。	"" は省略可
dataValue	string, number or boolean	システム変数の値。

ロボット ORiN データモデル

ORiN 協議会の発行する仕様書「 ORiN2 仕様書」に基づく、ia-cloud との情報連携のための CAO プロバイダーから供給されるデータオブジェクトのデータモデル。

// ******************************************************
// ia-cloud/JSON ORiN Provider Model
// ******************************************************

var iaCloudORiNProviderObject = {

    "contentType" : "ORiNProvider",
    "contentData" : [
        {
            "commonName" : "@OPERATING_TIME",
            "dataName" : { string },
            "unit" : "hour",
            "dataValue" : { number }
        },
        {
            "commonName" : "@BUSY_STATUS",
            "dataName" : { string },
            "unit" : "",
            "dataValue" : { boolean }
        },
        {
            "commonName" : "@WORK_POSITION",
            "dataName" : { string },
            "unit" : { strings },
            "dataValue" : { number | Array }
        },

        /*      .
            one or more any contentData objects
                .
                .            */
    ]
}

各プロパティの意味と制限

Property	値	説明	Notes
contentType	string	"ORiNProvider"	固定
contentData	Array	以下に示す一つ以上の JSON オブジェクト配列。（すべてを含む必要はない） ORiN2 の仕様書に規定される、一つあるいは複数の CAO システム変数からなるもの。

contentData object

Property	値	説明	Notes
commonName	string	ORiN2 で規定される、＠から始まる CAO システム変数の名称。各システム変数については、ORiN2 仕様書を参照のこと。
dataName	string	任意の名前。（各 Locale に基づいた名前）	省略可
unit	string	CAO システム変数の単位。
dataValue	JSON primitive or Array of primitives	CAO システム変数の値。 ORiN2 仕様書で規定される各システム変数の型は、適切に JSON にバインドされていなければならない。

PLC レジスタモデル

// ******************************************************
// ia-cloud/JSON PLC Register Model
// ******************************************************

var iaCloudPLCRegister = {

    "contentType" : "PLCRegister",
    "contentData" : [
        {
            "commonName" : "StartAdress",
            "dataValue" : { string }
        },
        {
            "commonName" : "Length",
            "dataValue" : { number }
        },
        {
            "commonName" : "RegisterData",
            "dataValue" : [
                { string },
                { string },
                { string }
            ]

        /*      .
            one or more any contentData objects
                .
                .            */
        }
    ]
}

各プロパティの意味と制限

Property	値	説明	Notes
contentType	string	"PLCRegister"	固定
contentData	Array	以下に示す JSON オブジェクト配列。

contentData objec

Property	値	説明	Notes
commonName	string	"StartAdress"	固定
dataValue	string の配列	PLC 内部レジスター等のベンダー依存のレジスタアドレス文字列。　例：M0123 , D100 , Coil150 , HR430 など
commonName	string	"Length"	固定
dataValue	number	レジスターデータ（ 16 Bit ）の配列の大きさ。
commonName	string	"RegisterData"	固定
dataValue	string の配列	レジスターデータ文字列の lengh 長の配列。 C 言語の 16 進表記。　例 : [ "0x4a6f" , "0xd5c2" , ・・・ ]

ファイルデータモデル

// ******************************************************
// ia-cloud/JSON File Data Model
// ******************************************************

var iaCloudFiledata = {

    "contentType" : "Filedata",
    "contentData" : [
        {
            "commonName" : "File Name",
            "dataValue" : { string }
        },
        {
            "commonName" : "MIME Type",
            "dataValue" : { string }
        },
        {
            "commonName" : "Encoding",
            "dataValue" : { string }
        },
        {
            "commonName" : "Size",
            "dataValue" : { number }
        },
        {
            "commonName" : "Encoded Data",
            "dataValue" : { string }
        }
    ]
}

各プロパティの意味と制限

Property	値	説明	Notes
contentType	string	"Filedata"	固定
contentData	Array	以下に示す JSON オブジェクト配列。

contentData object

Property	値	説明	Notes
commonName	string	"File Name"	固定
dataValue	string	URL encode された File 名。（パスは任意）
commonName	string	"MIME Type"	固定
dataValue	string	ファイルのコンテンツを表す。MIME type。　"text/plain" 、"image/png" 、"video/quicktime" など
commonName	string	"Encoding"	固定
dataValue	string	ファイルデータのエンコードを表す以下の文字列のいずれか。　"ascii" 、"utf-8" 、"base64"
commonName	string	"Size"	固定
dataValue	number	エンコードされたファイルの大きさ。（バイト数）
commonName	string	"Encoded Data"	固定
dataValue	string	エンコードされたファイルデータ。（最大 256 KB ）

このデータモデルを受け取った時のCCSの動作（実装例）

このファイルデータモデル以外のデータは、No-SQLタイプのデータベースにオブジェクトを格納することを想定しているが、ファイルデータモデルのデータは、ファイルデータそのものはファイルデータ格納サービスに格納し、ファイルデータに関する情報とその格納場所を含むオブジェクトをNo-SQLデータベースに格納することを想定している。なお、base64エンコードされたバイナリーファイルはデコードし格納される。したがって、格納される contentData には以下のエントリーが追加される。

Property	値	説明	Notes
commonName	string	"accessPath"	固定
dataValue	string	格納したファイルデータを取得するためのアクセスパス。例： https://file.store.com/objectKey/fileName.xxx このURLに対するAPI（http GETやPOST、）は各実装依存とする。（例はGETを想定したものであるが、これである必要はない。）

ファイル情報モデル

// ******************************************************
// ia-cloud/JSON File Info Model
// ******************************************************

以下のデータモデルを追加。

var iaCloudFileinfo = {

    "contentType" : "Fileinfo",
    "contentData" : [
        {
            "commonName" : "File Name",
            "dataValue" : { string }
        },
        {
            "commonName" : "MIME Type",
            "dataValue" : { string }
        },
        {
            "commonName" : "Encoding",
            "dataValue" : { string }
        },
        {
            "commonName" : "Storage Service",
            "dataValue" : { string }
        }
    ]
}

各プロパティの意味と制限

Property	値	説明	Notes
contentType	string	"Filedata"	固定
contentData	Array	以下に示す JSON オブジェクト配列。

contentData object

Property	値	説明	Notes
commonName	string	"File Name"	固定
dataValue	string	URL encode された File 名。（パスは任意）
commonName	string	"MIME Type"	固定
dataValue	string	ファイルのコンテンツを表す。MIME type。　"text/plain" 、"image/png" 、"video/quicktime" など
commonName	string	"Encoding"	固定
dataValue	string	ファイルデータのエンコードを表す以下の文字列のいずれか。　"ascii" 、"utf-8" 、"base64"
commonName	string	"Size"	固定
dataValue	number	エンコードされたファイルの大きさ。（バイト数）
commonName	string	"Encoded Data"	固定
dataValue	string	エンコードされたファイルデータ。（最大 256 KB ）

このデータモデルを受け取った時のCCSの動作（実装例）

このファイルデータモデル以外のデータは、No-SQLタイプのデータベースにオブジェクトを格納することを想定しているが、ファイルデータモデルのデータは、ファイルデータそのものはファイルデータ格納サービスに格納し、ファイルデータに関する情報とその格納場所を含むオブジェクトをNo-SQLデータベースに格納することを想定している。なお、base64エンコードされたバイナリーファイルはデコードし格納される。したがって、格納される contentData には以下のエントリーが追加される。

Property	値	説明	Notes
commonName	string	"accessPath"	固定
dataValue	string	格納したファイルデータを取得するためのアクセスパス。例： https://file.store.com/objectKey/fileName.xxx このURLに対するAPI（http GETやPOST、）は各実装依存とする。（例はGETを想定したものであるが、これである必要はない。）

Blob データ

データ構造を持たないデータモデル。

// ******************************************************
// ia-cloud/JSON Blob object Content Model
// ******************************************************

var iaCloudObjectContent = {

    "contentType" :  "iaCloudBlobData",
    "contentData" : [
        {
          "dataName" : { string },
          "dataValue" : { string }
        },

        /*      .
            one or more any contentData objects
                .
                .            */
     ]
}

各プロパティの意味と制限

Property	値	説明	Notes
contentType	string	"iaCloudBlobData"	固定
contentData	Array	以下に示す一つ以上の JSON オブジェクト配列。

contentData object

Property	値	説明	Notes
commonName	string	"Blob Data"	固定
dataName	string	格納されるデータの任意の名前。（各 Locale に基づいた名前）	省略可
dataValue	string	Blob Data の値。 Base64 エンコードされたデータ列。（最大 256 KB ）

通信電文搬送モデル

ia-cloud WebSocket API を利用して、他の通信プロトコールの電文を搬送するためのデータモデル。
PLC 各社の独自のシリアル通信プロトコール・TCP 通信プロトコールや、Modbus / TCP、OPC-UA などの搬送を想定している。

// ******************************************************
// ia-cloud/JSON Conveyed Message Content Model
// ******************************************************

var iaCloudObjectContent = {

    "contentType" : "iaCloudConveyedMsg",
    "contentData" : [
        {
            "commonName" : "Source",
            "dataValue" : { string }
        },
        {
            "commonName" : "Destination",
            "dataValue" : { string }
        },
        {
            "commonName" : "config",
            "dataValue" : { object }
        },
        {
            "commonName" : "Message",
            "dataValue" : { string }
        }
    ]
}

各プロパティの意味と制限

Property	値	説明	Notes
contentType	string	"iaCloudConveyedMsg"	固定
contentData	Array	以下に示す一つ以上の JSON オブジェクト配列。

contentData object

Property	値	説明	Notes
commonName	string	"Source"	固定
dataValue	string	Message Data の発信元を表す文字列。 CCS 、FDS が解釈可能な表現で中継可能な対象であること。
commonName	string	"Distination"	固定
dataValue	string	Message Data の配信先を表す文字列。 CCS 、FDS が解釈可能な表現で中継可能な対象であること。
commonName	string	"config"	固定
dataValue	object	Message Data の構成を表すオブジェクト。オブジェクとの内部構成は自由に拡張できるが、標準的に以下の構成に準拠すること。　{ "protocol" : "Mitsubishi MC" , "Version" : "3.4" , ????? }
commonName	string	"Message"	固定
dataValue	string	Message を Base64 エンコードした文字列。（最大 256 KB ）

USER Defined Data Model

本仕様書定義されたデータモデルは、自由に拡張して新たな DataType を定義して良い。

Files

ia-cloud-webAPI.md

Latest commit

History

ia-cloud-webAPI.md

File metadata and controls

ia-cloud Specification

Web API Version 2.07β

目的

概要

ia-cloud フィールドデータサーバ（ FDS ）

ia-cloud センターサーバ（ CCS ）

Web サービスプロトコール

HTTPS（ REST ）

ia-cloud サービスの url

認証とHTTPS

プロキシサーバの利用

HTTP(S)エラー処理

WebSocket

WebSocket コネクションの確立

サービスのリクエスト

概要

接続の開始

データオブジェクトインスタンスの格納

データオブジェクトインスタンスの取得

データオブジェクトアレーの取得

状態の確認（ serviceID の更新 ）

接続の終了

他の通信プロトコールの搬送 convey

ia-cloud オブジェクト

オブジェクトモデル

各プロパティの意味と制限

オブジェクトアレイモデル

各プロパティの意味と制限

オブジェクトモデルの簡易表現

iaCloudObject のプロパティ

ia-cloud データモデル

基本データモデル

各プロパティの意味と制限

contentData object

データモデルの簡易表現

iaCloudObjectContent のプロパティ

生産指図(Production Order) Model

各プロパティの意味と制限

contentData object

contentData object

生産実績データモデル

各プロパティの意味と制限

contentData object

在庫実績データモデル

各プロパティの意味と制限

contentData object

品質データモデル

各プロパティの意味と制限

contentData object

装置ステータスモデル

各プロパティの意味と制限

contentData object

ISO22400-2 5.2time model の定義に準じた dataValueとcommonName

エラーステイタスモデル（ エラー番号を格納 ）

各プロパティの意味と制限

contentData object

アラーム＆イベントモデル

各プロパティの意味と制限

contentData object

設備運転状態モデル

各プロパティの意味と制限

contentData object

コントロールポイントモデル

各プロパティの意味と制限

contentData object

温度調節計モデル

各プロパティの意味と制限

contentData object

アクチュエーターモデル

各プロパティの意味と制限

contentData object

Position Objects

インバータモデル

各プロパティの意味と制限

状態の確認（ serviceID の更新）

ISO22400-2 5.2time model　の定義に準じた dataValueとcommonName

エラーステイタスモデル（エラー番号を格納）