ngsi_registration.md

NGSI Registration

This custom node is a simple node that allows to create or delete an NGSIv2 registration.

Details

• Create a registration
• Delete a registration
• Use value of actionType in payload

Create a registration

This operation allows to create a new registration.

Properties

• name: A name for a node instance
• Context Broker: An endpoint of a context broker
• ServicePath: FIWARE Service Path
• Action type: create

Input

payload JSON Object

A msg.payload contains a NGSIv2 registration data.

{
  "description": "Relative Humidity Context Source",
  "dataProvided": {
    "entities": [
      {
        "id": "room",
        "type": "Room"
      }
    ],
    "attrs": [
      "relativeHumidity"
    ]
  },
  "provider": {
    "http": {
      "url": "http://orion:1026"
    }
  }
}

Output

payload string

A msg.payload contains a registration id.

63ed51173bdeaadaf909c57b

statusCode Number

A msg.statusCode contains a status code.

201

Delete a registration

This operation allows to delete a existing registration.

Properties

• name: A name for a node instance
• Context Broker: An endpoint of a context broker
• ServicePath: FIWARE Service Path
• Action type: delete

Input

payload string

A msg.payload contains a registration id.

63ed51173bdeaadaf909c57b

Output

statusCode Number

A msg.statusCode contains a status code.

204

Use value of actionType in payload

This operation allows to create or delete a registration.

Properties

• name: A name for a node instance
• Context Broker: An endpoint of a context broker
• ServicePath: FIWARE Service Path
• Action type: value of actionType in payload

Input (create)

payload JSON Object

When creating a new registration, A msg.payload should contain a JSON Object with actionType and registration data.

{
  "actionType": "delete",
  "id": "63ed53123bdeaadaf909c57d"
}

Output (create)

payload string

A msg.payload contains a registration id.

63ed51173bdeaadaf909c57b

statusCode Number

A msg.statusCode contains a status code.

201

Input (delete)

payload JSON Object

When deleting a existing registration, A msg.payload should contain a JSON Object with actionType and registration id.

{
  "actionType": "delete",
  "id": "63ea11e4a0cec98fc6017aae"
}

Output (delete)

statusCode Number

A msg.statusCode contains a status code.

204