Skip to content

Latest commit

 

History

History
286 lines (192 loc) · 8.39 KB

SubscriptionsApi.md

File metadata and controls

286 lines (192 loc) · 8.39 KB

NgsiV2.SubscriptionsApi

All URIs are relative to http://orion.lab.fiware.org:1026/v2

Method HTTP request Description
createANewSubscription POST /subscriptions
deleteSubscription DELETE /subscriptions/{subscriptionId}
retrieveSubscription GET /subscriptions/{subscriptionId}
retrieveSubscriptions GET /subscriptions
updateSubscription PATCH /subscriptions/{subscriptionId}

createANewSubscription

createANewSubscription(body)

Creates a new subscription. The subscription is represented by a JSON object as described at the beginning of this section. Response: * Successful operation uses 201 Created * Errors use a non-2xx and (optionally) an error payload. See subsection on "Error Responses" for more details.

Example

var NgsiV2 = require('ngsi_v2');
var defaultClient = NgsiV2.ApiClient.instance;

// Configure API key authorization: fiware_token
var fiware_token = defaultClient.authentications['fiware_token'];
fiware_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//fiware_token.apiKeyPrefix = 'Token';

var apiInstance = new NgsiV2.SubscriptionsApi();

var body = new NgsiV2.Subscription(); // Subscription | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.createANewSubscription(body, callback);

Parameters

Name Type Description Notes
body Subscription

Return type

null (empty response body)

Authorization

fiware_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteSubscription

deleteSubscription(subscriptionId)

Cancels subscription. Response: * Successful operation uses 204 No Content * Errors use a non-2xx and (optionally) an error payload. See subsection on "Error Responses" for more details.

Example

var NgsiV2 = require('ngsi_v2');
var defaultClient = NgsiV2.ApiClient.instance;

// Configure API key authorization: fiware_token
var fiware_token = defaultClient.authentications['fiware_token'];
fiware_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//fiware_token.apiKeyPrefix = 'Token';

var apiInstance = new NgsiV2.SubscriptionsApi();

var subscriptionId = "subscriptionId_example"; // String | subscription Id.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteSubscription(subscriptionId, callback);

Parameters

Name Type Description Notes
subscriptionId String subscription Id.

Return type

null (empty response body)

Authorization

fiware_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

retrieveSubscription

Subscription retrieveSubscription(subscriptionId)

The response is the subscription represented by a JSON object as described at the beginning of this section. Response: * Successful operation uses 200 OK * Errors use a non-2xx and (optionally) an error payload. See subsection on "Error Responses" for more details.

Example

var NgsiV2 = require('ngsi_v2');
var defaultClient = NgsiV2.ApiClient.instance;

// Configure API key authorization: fiware_token
var fiware_token = defaultClient.authentications['fiware_token'];
fiware_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//fiware_token.apiKeyPrefix = 'Token';

var apiInstance = new NgsiV2.SubscriptionsApi();

var subscriptionId = "subscriptionId_example"; // String | subscription Id.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.retrieveSubscription(subscriptionId, callback);

Parameters

Name Type Description Notes
subscriptionId String subscription Id.

Return type

Subscription

Authorization

fiware_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

retrieveSubscriptions

[Subscription] retrieveSubscriptions(opts)

Returns a list of all the subscriptions present in the system. Response: * Successful operation uses 200 OK * Errors use a non-2xx and (optionally) an error payload. See subsection on "Error Responses" for more details.

Example

var NgsiV2 = require('ngsi_v2');
var defaultClient = NgsiV2.ApiClient.instance;

// Configure API key authorization: fiware_token
var fiware_token = defaultClient.authentications['fiware_token'];
fiware_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//fiware_token.apiKeyPrefix = 'Token';

var apiInstance = new NgsiV2.SubscriptionsApi();

var opts = { 
  'limit': 1.2, // Number | Limit the number of types to be retrieved
  'offset': 1.2, // Number | Skip a number of records
  'options': "options_example" // String | Options dictionary
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.retrieveSubscriptions(opts, callback);

Parameters

Name Type Description Notes
limit Number Limit the number of types to be retrieved [optional]
offset Number Skip a number of records [optional]
options String Options dictionary [optional]

Return type

[Subscription]

Authorization

fiware_token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

updateSubscription

UpdateSubscriptionResponse updateSubscription(subscriptionId, body)

Only the fields included in the request are updated in the subscription. Response: * Successful operation uses 204 No Content * Errors use a non-2xx and (optionally) an error payload. See subsection on "Error Responses" for more details.

Example

var NgsiV2 = require('ngsi_v2');
var defaultClient = NgsiV2.ApiClient.instance;

// Configure API key authorization: fiware_token
var fiware_token = defaultClient.authentications['fiware_token'];
fiware_token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//fiware_token.apiKeyPrefix = 'Token';

var apiInstance = new NgsiV2.SubscriptionsApi();

var subscriptionId = "subscriptionId_example"; // String | subscription Id.

var body = new NgsiV2.Subscription(); // Subscription | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateSubscription(subscriptionId, body, callback);

Parameters

Name Type Description Notes
subscriptionId String subscription Id.
body Subscription

Return type

UpdateSubscriptionResponse

Authorization

fiware_token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json