Skip to content

Latest commit

 

History

History
161 lines (152 loc) · 4.59 KB

SubscriptionsFunctions.md

File metadata and controls

161 lines (152 loc) · 4.59 KB

Subscriptions Functions

Read Functions.

Get Subscriptions

The listSubscriptions() function is used for retrieving the subscriptions list stored in the Orion ContexBroker. Remember that, the ContextBroker responds to this request, the latest 20 subscriptions stored; for the moment, this function does not support the pagination mechanism to retrieve large sets of resources. Example:

cb.listSubscriptions(headers)
.then((result) => console.log(result))
.catch((err) => console.log(err))

Get a Subscription

The getSubscription() function is used for retrieving a specific subscription. This function receives as parameter the id of the subscription. For example:

cb.getSubscription("5a83c5463fc4dec59e4ef8e2", headers)
.then((result) => console.log(result))
.catch((err) => console.log(err))

Create Functions.

Create Subscription.

The createSubscription() function is used for registering a subscription in the Orion ContextBroker. This function receives as parameter the NGSI subscription, and retuns the id of the subscription created. Example:

cb.createSubscription({
	"description": "Alert subscription TEST",
	"subject": {
	"entities": [
  		{
			"idPattern": ".*",
			"type": "Alert"
		}
	],
	"condition": {
		"attrs": [
  			"id",	
  			"type",
  			"category",
  			"subCategory",
  			"location",
  			"address",
  			"dateObserved",
  			"validFrom",
  			"validTo",
  			"description",
  			"alertSource",
  			"data",
  			"severity"
		]
		}
	},
	"notification": {
  		"attrs": [
  			"id",  
          	"type",
            "category",
            "subCategory",
            "location",
            "address",
            "dateObserved",
            "validFrom",
            "validTo",
            "description",
            "alertSource",
            "data",
            "severity"
        ],
		"attrsFormat": "normalized",
		"http": {
			"url": "http://service.mx"
		}
	},
	"throttling": 5
}, headers)
.then((result) => console.log(result))
.catch((err) => console.log(err))

Update Functions.

Update Subscription

The updateSubscription() function is used for updating an existing subscription. This function receives two parameters: the id of the subscription and the body of the subscription. The subscription to update must be stored in the ContextBroker previously. The following function updates the subscription with id: 5a93a9063fc4dec59e4ef8eb.

cb.updateSubscription("5a93a9063fc4dec59e4ef8eb", {
	"description": "Alert subscription TEST",
	"subject": {
	"entities": [
  		{
			"idPattern": ".*",
			"type": "Alert"
		}
	],
	"condition": {
		"attrs": [
  			"id",	
  			"type",
  			"location",
  			"address",
  			"dateObserved",
  			"validFrom",
  			"validTo",
  			"description",
		]
		}
	},
	"notification": {
  		"attrs": [
  			"id",  
          	"type",
            "category",
            "subCategory",
            "location",
            "address",
            "dateObserved",
            "validFrom",
            "validTo",
            "description",
            "alertSource",
            "data",
            "severity"
        ],
		"attrsFormat": "normalized",
		"http": {
			"url": "http://crateservice.com"
		}
	},
	"throttling": 5
})
.then((result) => console.log(result))
.catch((err) => console.log(err))

Update Subscription Status.

The updateSubscriptionStatus() function is used for updating the status of a subscription. A subscription can have three types of status: active, inactive and failed. The next function updates the status the subscription with id: 5a81e50a3fc4dec59e4ef8dc.

cb.updateSubscriptionStatus("5a81e50a3fc4dec59e4ef8dc", "active", headers)
.then((result) => console.log(result))
.catch((err) => console.log(err))

Delete Functions.

##Delete Subscription. The deleteSubscription() function is used for removing an subscription stored in the ContextBroker. This function receives as parameter the id of the subscription.The next function removes from the ContextBroker the subscription with id: 5a93a9103fc4dec59e4ef8ec.

cb.deleteSubscription("5a93a9103fc4dec59e4ef8ec")
.then((result) => console.log(result))
.catch((err) => console.log(err))