Skip to content

Latest commit

 

History

History
253 lines (190 loc) · 5.93 KB

entity-attributes.md

File metadata and controls

253 lines (190 loc) · 5.93 KB
Raw

NGSI-LD entity attributes

This custom node is a simple node that allows to append, update, upsert or replace attributes of NGSI-LD entity.

Contents

Details

Append attributes

It allows to append attributes of NGSI-LD entity.

Properties

Property Description
Name A name for a node instance
Broker An endpoint of a NGSI-LD broker
Action type append
Entity id Id of the concerned entity
@context NGSI-LD @context
Encode forbidden chars off or on

Example

Input1

payload JSON Object

A msg.payload should contain an object with the attributes.

{
  "batteryLevel": {
    "type": "Property",
    "value": 0.9,
    "unitCode": "C62"
  },
  "controlledAsset": {
    "type": "Relationship",
    "object": "urn:ngsi-ld:Building:barn002"
  }
}

Input2

payload JSON Object

A msg.payload should contain information related to the attributes to append. The values in the payload may overwrite properties.

Name Data type Description
entityId string Id of the concerned entity
attrs JSON Object Attributes to append
forbidden boolean true or false 
{
  "entityId": "urn:ngsi-ld:TemperatureSensor:002",
  "attrs": {
    "batteryLevel": {
      "type": "Property",
      "value": 0.9,
      "unitCode": "C62"
    },
    "controlledAsset": {
      "type": "Relationship",
      "object": "urn:ngsi-ld:Building:barn002"
    }
  }
}

Output

statusCode Number

A msg.statusCode contains a status code.

204

Update attributes

It allows to update attributes of NGSI-LD entity.

Properties

Property Description
Name A name for a node instance
Broker An endpoint of a NGSI-LD broker
Action type append
Entity id Id of the concerned entity
@context NGSI-LD @context
Encode forbidden chars off or on

Example

Input1

payload JSON Object

A msg.payload should contain an object with the attributes.

{
  "batteryLevel": {
    "type": "Property",
    "value": 0.9,
    "unitCode": "C62"
  },
  "controlledAsset": {
    "type": "Relationship",
    "object": "urn:ngsi-ld:Building:barn002"
  }
}

Input2

payload JSON Object

A msg.payload should contain information related to the attributes to update. The values in the payload may overwrite properties.

Name Data type Description
entityId string Id of the concerned entity
attrs JSON Object Attributes to update
forbidden boolean true or false 
{
  "entityId": "urn:ngsi-ld:TemperatureSensor:002",
  "attrs": {
    "batteryLevel": {
      "type": "Property",
      "value": 0.9,
      "unitCode": "C62"
    },
    "controlledAsset": {
      "type": "Relationship",
      "object": "urn:ngsi-ld:Building:barn002"
    }
  }
}

Output

statusCode Number

A msg.statusCode contains a status code.

204

Upsert attributes

It allows to upsert attributes of NGSI-LD entity.

Properties

Property Description
Name A name for a node instance
Broker An endpoint of a NGSI-LD broker
Action type append
Entity id Id of the concerned entity
@context NGSI-LD @context
Encode forbidden chars off or on

Example

Input1

payload JSON Object

A msg.payload should contain an object with the attributes.

{
  "batteryLevel": {
    "type": "Property",
    "value": 0.9,
    "unitCode": "C62"
  },
  "controlledAsset": {
    "type": "Relationship",
    "object": "urn:ngsi-ld:Building:barn002"
  }
}

Input2

payload JSON Object

A msg.payload should contain information related to the attributes to upsert. The values in the payload may overwrite properties.

Name Data type Description
entityId string Id of the concerned entity
attrs JSON Object Attributes to upsert
forbidden boolean true or false 
{
  "entityId": "urn:ngsi-ld:TemperatureSensor:002",
  "attrs": {
    "batteryLevel": {
      "type": "Property",
      "value": 0.9,
      "unitCode": "C62"
    },
    "controlledAsset": {
      "type": "Relationship",
      "object": "urn:ngsi-ld:Building:barn002"
    }
  }
}

Output

statusCode Number

A msg.statusCode contains a status code.

204