NGSI attribute

このカスタム・ノードは、NGSIv2 エンティティの属性の読み取り、更新、または削除ができるノードです。

属性の読み取り

NGSIv2 エンティティの属性を読み取ることができます。

プロパティ

  • name: ノード・インスタンスの名前
  • Context Broker: Context Broker のエンドポイント
  • ServicePath: FIWARE Service Path
  • Action type: read
  • Entity id: 読み取る属性のエンティティ id
  • Entity type: 読み取る属性のエンティティ・タイプ
  • Attribute name: 読み取る属性の名前
  • Metadata: 属性を読み取る属性名
  • Skip forwarding: Context Broker は Context Provider への転送をスキップします
  • Encode / Decode forbidden chars: off または on

入力

payload JSON Object

msg.payload には、読み取る属性に関連する情報が含まれている必要があります。

{}
{
  "attrName": "relativeHumidity"
}
{
  "id": "E",
  "type": "T",
  "attrName": "relativeHumidity"
}

出力

payload JSON Object

msg.payload には、属性を表すオブジェクトが含まれています。

{
  "type":"Number",
  "value":45,
  "metadata":{}
}

statusCode Number

msg.statusCode にはステータス・コードが含まれています。

200

属性の更新

NGSIv2 エンティティの属性を更新できます。

プロパティ

  • name: ノード・インスタンスの名前
  • Context Broker: Context Broker のエンドポイント
  • ServicePath: FIWARE Service Path
  • Action type: update
  • Entity id: 更新する属性のエンティティ id
  • Entity type: 更新する属性のエンティティ・タイプ
  • Attribute name: 更新する属性の名前
  • Override metadata: true の場合、既存のメタデータを置き換えます
  • Forced update: true の場合、一致するサブスクリプションをトリガーします
  • Flow control: true の場合、フロー制御メカニズムが有効になります
  • Encode / Decode forbidden chars: off または on

入力

payload JSON Object

msg.payload には、更新する属性を表すオブジェクトが含まれている必要があります。

{
  "type": "Number",
  "value": 1234.5
}

出力

statusCode Number

msg.statusCode にはステータス・コードが含まれています。

204

属性の削除

NGSIv2 エンティティの属性を削除できます。

プロパティ

  • name: ノード・インスタンスの名前
  • Context Broker: Context Broker のエンドポイント
  • ServicePath: FIWARE Service Path
  • Action type: delete
  • Entity id: 削除する属性のエンティティ id
  • Entity type: 削除する属性のエンティティ・タイプ
  • Attribute name: 削除する属性の名前
  • Encode / Decode forbidden chars: off または on

入力

payload JSON Object

msg.payload には、削除する属性に関連する情報が含まれている必要があります。

{}
{
  "attrName": "relativeHumidity"
}
{
  "id": "E",
  "type": "T",
  "attrName": "relativeHumidity"
}

出力

payload null または string

msg.statusCode にはステータス・コードが含まれています。

204

Payload 内の actionType の値を使用

NGSIv2 エンティティの属性の読み取り、更新、または削除が可能です。

プロパティ

  • name: ノード・インスタンスの名前
  • Context Broker: Context Broker のエンドポイント
  • ServicePath: FIWARE Service Path
  • Action type: value of actionType in payload
  • Entity id: 読み取り、更新、または削除を行う属性のエンティティ id
  • Entity type: 読み取り、更新、または削除を行う属性のエンティティ・タイプ
  • Attribute name: 読み取り、更新、または削除を行う属性の名前
  • Metadata: メタデータ名のリスト
  • Skip forwarding: Context Broker は Context Provider への転送をスキップします
  • Override metadata: true の場合、既存のメタデータを置き換えます
  • Forced update: true の場合、一致するサブスクリプションをトリガーします
  • Flow control: true の場合、フロー制御メカニズムが有効になります
  • Encode / Decode forbidden chars: off または on

入力 1

payload JSON Object

属性を読み取る場合、msg.payload には、読み取る属性に関連する情報を含む JSON オブジェクトが含まれている必要があります。

{
  "actionType": "read",
  "attrName": "relativeHumidity"
}

出力 1

payload JSON Object

msg.payload には、属性を表すオブジェクトが含まれています。

{
  "type":"Number",
  "value":45,
  "metadata":{}
}
statusCode Number

msg.statusCode にはステータス・コードが含まれています。

200

入力 2

payload JSON Object

属性を更新する場合、 msg.payload には、更新する属性の関連情報を含む JSON オブジェクトが含まれている必要があります。

{
  "actionType": "update",
  "attribute": {
    "type": "Number",
    "value": 1234.5
  }
}

出力 2

statusCode Number

msg.statusCode にはステータス・コードが含まれています。

204

入力 3

payload JSON Object

属性を削除する場合、msg.payload には、削除する属性に関連する情報を含む JSON オブジェクトが含まれている必要があります。

{
  "actionType": "delete",
  "attrName": "relativeHumidity"
}

出力 3

statusCode Number

msg.statusCode にはステータス・コードが含まれています。

204