BatchOperationsApi.md

NgsiV2.BatchOperationsApi

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

Method	HTTP request	Description
notify	POST /op/notify
query	POST /op/query
update	POST /op/update

notify

notify(body, opts)

This operation is intended to consume a notification payload so that all the entity data included by such notification is persisted, overwriting if necessary. This operation is useful when one NGSIv2 endpoint is subscribed to another NGSIv2 endpoint (federation scenarios). The request payload must be an NGSIv2 notification payload. The behaviour must be exactly the same as POST /v2/op/update with actionType equal to append. Response code: * 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.BatchOperationsApi();

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

var opts = { 
  'options': "options_example" // String | Options dictionary
};

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

Parameters

Name	Type	Description	Notes
body	Subscription
options	String	Options dictionary	[optional]

Return type

null (empty response body)

Authorization

fiware_token

HTTP request headers

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

query

[Object] query(body, opts)

The response payload is an Array containing one object per matching entity, or an empty array `[]` if no entities are found. The entities follow the JSON entity Representation format (described in the section "JSON Entity Representation"). The payload may contain the following elements (all of them optional): + `entities`: a list of entites to search for. Each element is represented by a JSON object with the following elements: + `id` or `idPattern`: Id or pattern of the affected entities. Both cannot be used at the same time, but at least one of them must be present. + `type` or `typePattern`: Type or type pattern of the entities to search for. Both cannot be used at the same time. If omitted, it means "any entity type". + `attributes`: a list of attribute names to search for. If omitted, it means "all attributes". Response code: * 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.BatchOperationsApi();

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

var opts = { 
  'limit': 1.2, // Number | Limit the number of entities to be retrieved.
  'offset': 1.2, // Number | Skip a number of records.
  'orderBy': "orderBy_example", // String | Criteria for ordering results. See \"Ordering Results\" section for details.
  '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.query(body, opts, callback);

Parameters

Name	Type	Description	Notes
body	Query
limit	Number	Limit the number of entities to be retrieved.	[optional]
offset	Number	Skip a number of records.	[optional]
orderBy	String	Criteria for ordering results. See "Ordering Results" section for details.	[optional]
options	String	Options dictionary	[optional]

Return type

[Object]

Authorization

fiware_token

HTTP request headers

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

update

update(body, opts)

This operation allows to create, update and/or delete several entities in a single batch operation. The payload is an object with two properties: + `actionType`, to specify the kind of update action to do: either `append`, `appendStrict`, `update`, `delete`. + `entities`, an array of entities, each one specified using the JSON entity Representation format (described in the section "JSON Entity Representation"). 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.BatchOperationsApi();

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

var opts = { 
  'options': "options_example" // String | Options dictionary
};

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

Parameters

Name	Type	Description	Notes
body	BatchOperation
options	String	Options dictionary	[optional]

Return type

null (empty response body)

Authorization

fiware_token

HTTP request headers

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