node-red-contrib-platio-openblocks v0.1.4
Node-RED用Platioノード
このノードを使用すると、Node-REDから、Platioのプレート・ミニアプリにレコードを取得・作成・更新・削除することができます。
このノードは、Platio APIを使用してPlatioと通信するため、Platio APIの基本的な動作について知っておく必要があります。Platio APIについては、Platio APIドキュメントを参照してください。
プレートとPlatio APIの準備
- Platio Studioでプレートを作成します。
- プレートのユーザーを作成します。この時、「レコードや添付ファイルへのAPIでのアクセスを許可」にチェックを入れます。
- プレートのPlatio Data Consoleを開き、作成したユーザーでログインします。
- 開発者ページにアクセスし、必要な情報を確認します。
ノードの共通設定
ノードの設定
各ノードには、アクセスするアプリケーションやコレクションなどの情報を、Node-REDのUIから設定することができます。
処理ごとの設定
上記で設定した項目は、msg.plate
に値を設定することで、処理ごとに値を上書きすることができます。
msg.platio = {
applicationId: 'pxxxxxxxxxxxxxxxxxxxxxxxxxx',
collectionId: 'txxxxxxx',
authorization: 'Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
};
エラー処理
エラーが発生すると、Node-REDにエラーとして通知します。catchノードを使うことで、エラー発生時の処理を行うことができます。
各ノードについて
platio in
platio inノードを使用すると、指定したレコードを取得したり、検索条件にマッチするレコードのリストを取得することができます。
共通の設定に加えて、以下の項目を設定することができます。
ノードの設定または処理ごとに設定で、レコードIDを指定した場合、指定されたレコードを取得し、msg.payload
に設定します。レコードの形式については、Platio APIドキュメントを参照してください。
レコードIDを指定しなかった場合、指定したコレクション内のレコードの配列を取得し、msg.payload
に設定します。
取得件数を指定すると、指定された件数のレコードを取得します。APIの制限(100)以上の値を指定した場合、APIを繰り返し呼び出します。
platio out
platio outノードを使用すると、レコードを作成したり、既存のレコードを更新・削除することができます。
共通の設定に加えて、以下の項目を設定することができます。
ノードの設定または処理ごとに設定で、レコードIDを指定しなかった場合、msg.payload
に指定された値でレコードを作成します。
レコードIDを指定した場合には、そのレコードを更新します。レコードを更新するときには、msg.payload
に含まれないカラムの値は削除されます。
レコードIDを指定し、かつ削除がtrue
の場合には、レコードを削除します。レコードを削除する場合には、msg.payload
は使用されません。
レコード作成・更新時のmsg.payload
は、以下のような形式で指定します。詳細については、Platio APIドキュメントを参照してください。
msg.payload = {
values: {
cxxxxxxx: {
type: 'Number',
value: 20
},
cyyyyyyy: {
type: 'String',
value: 'Text'
}
}
};