NGSI entity

このカスタム・ノードは、NGSIv2 エンティティの作成、読み取り、アップサート、または削除を可能にするノードです。

エンティティの作成

NGSIv2 エンティティを作成できます。

プロパティ

• name: ノード・インスタンスの名前
• Context Broker: Context Broker のエンドポイント
• ServicePath: FIWARE Service Path
• Action type: create
• Representation: normalized または keyValues
• Encode / Decode forbidden chars: off または on

入力

payload JSON Object

msg.payload には、作成するエンティティが含まれている必要があります。

{
  "id": "E",
  "type": "T",
  "temperature": {
    "type": "Number",
    "value": 25,
    "metadata": {
      "TimeInstant": {
        "type": "DateTime",
        "value": "2023-02-10T20:33:53.199Z"
      }
    }
  },
  "relativeHumidity": {
    "type": "Number",
    "value": 45,
    "metadata": {}
  },
  "atmosphericPressure": {
    "type": "Number",
    "value": 1003.5,
    "metadata": {}
  }
}

出力

statusCode Number

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

201

エンティティの読み取り

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

プロパティ

• name: ノード・インスタンスの名前
• Context Broker: Context Broker のエンドポイント
• ServicePath: FIWARE Service Path
• Action type: read
• Entity id: 読み取るエンティティの id
• Entity type: 読み取るエンティティのタイプ
• attributes: 読み取るエンティティの属性のリスト
• Representation: normalized または keyValues
• Date Modified: true の場合、dateModified の属性とメタデータを取得します
• Encode / Decode forbidden chars: off または on

入力

payload String または JSON Object

msg.payload には、NGSIv2 エンティティを読み取るためのエンティティ id が含まれている必要があります。

urn:ngsi-ld:Building:store001

msg.payload には、NGSIv2 エンティティを読み取るための条件が含まれている必要があります。

{
  "id": "urn:ngsi-ld:Building:store001",
  "type": "Building",
  "attrs": "humidity",
  "keyValues": true,
  "dateModified": false
}

出力

payload JSON Object

msg.payload には、NGSIv2 エンティティが含まれます。

{
  "id": "E1",
  "type": "T",
  "humidity": {
    "type": "Number",
    "value": 51,
    "metadata": {}
  },
  "temperature": {
    "type": "Number",
    "value": 25,
    "metadata": {}
  }
}

statusCode Number

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

200

エンティティのアップサート

NGSIv2 エンティティをアップサート (upsert) できます。

プロパティ

• name: ノード・インスタンスの名前
• Context Broker: Context Broker のエンドポイント
• ServicePath: FIWARE Service Path
• Action type: upsert
• Representation: normalized または keyValues
• Encode / Decode forbidden chars: off または on

入力

payload JSON Object

msg.payload にはアップサートするエンティティが含まれている必要があります。

{
  "id": "E",
  "type": "T",
  "temperature": {
    "type": "Number",
    "value": 25,
    "metadata": {
      "TimeInstant": {
        "type": "DateTime",
        "value": "2023-02-10T20:33:53.199Z"
      }
    }
  },
  "relativeHumidity": {
    "type": "Number",
    "value": 45,
    "metadata": {}
  },
  "atmosphericPressure": {
    "type": "Number",
    "value": 1003.5,
    "metadata": {}
  }
}

出力

statusCode Number

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

204

エンティティの削除

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

プロパティ

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

入力

payload String または JSON Object

msg.payload には、NGSIv2 エンティティを削除するためのエンティティ id が含まれている必要があります。

urn:ngsi-ld:Building:store001

msg.payload には、NGSIv2 エンティティを削除する条件が含まれている必要があります。

{
  "id": "urn:ngsi-ld:Building:store001",
  "type": "Building",
}

出力

statusCode Number

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: 作成、読み取り、アップサート、または削除するエンティティのタイプ
• Representation: normalized または keyValues
• Date Modified: true の場合、dateModified の属性とメタデータを取得します
• Encode / Decode forbidden chars: off または on

入力 (create)

payload JSON Object

エンティティを作成するとき、 msg.payload には actionType と entity を含む JSON オブジェクトが含まれている必要があります。

{
  "actionType": "create",
  "entity": {
    "id": "E",
    "type": "T",
    "temperature": {
      "type": "Number",
      "value": 25,
      "metadata": {
        "TimeInstant": {
          "type": "DateTime",
          "value": "2023-02-10T20:33:53.199Z"
        }
      }
    },
    "relativeHumidity": {
      "type": "Number",
      "value": 45,
      "metadata": {}
    },
    "atmosphericPressure": {
      "type": "Number",
      "value": 1003.5,
      "metadata": {}
    }
  }
}

出力 (create)

statusCode Number

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

201

入力 (read)

payload JSON Object

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

{
  "actionType": "read",
  "id": "E",
  "type": "T"
}

出力 (read)

payload JSON Object

msg.payload には、エンティティを表すオブジェクトが含まれます。

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

statusCode Number

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

200

入力 (upsert)

payload JSON Object

エンティティをアップサートする場合、 msg.payload には actionType と entity を含む JSON オブジェクトが含まれている必要があります

{
  "actionType": "upsert",
  "entity": {
    "id": "E",
    "type": "T",
    "temperature": {
      "type": "Number",
      "value": 29,
      "metadata": {
        "TimeInstant": {
          "type": "DateTime",
          "value": "2023-02-10T20:33:53.199Z"
        }
      }
    },
    "relativeHumidity": {
      "type": "Number",
      "value": 58,
      "metadata": {}
    },
    "atmosphericPressure": {
      "type": "Number",
      "value": 1234.5,
      "metadata": {}
    }
  }
}

出力 (upsert)

statusCode Number

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

204

入力 (delete)

payload JSON Object

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

{
  "actionType": "delete",
  "id": "E",
  "type": "T"
}

出力 (delete)

statusCode Number

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

204