Skip to content

Latest commit

 

History

History
196 lines (134 loc) · 6.69 KB

AttributesApi.md

File metadata and controls

196 lines (134 loc) · 6.69 KB
Raw

NgsiV2.AttributesApi

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

Method HTTP request Description
getAttributeData GET /entities/{entityId}/attrs/{attrName}
removeASingleAttribute DELETE /entities/{entityId}/attrs/{attrName}
updateAttributeData PUT /entities/{entityId}/attrs/{attrName}

getAttributeData

Entity getAttributeData(entityId, attrName, opts)

Returns a JSON object with the attribute data of the attribute. The object follows the JSON Representation for attributes (described in "JSON Attribute Representation" 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.AttributesApi();

var entityId = "entityId_example"; // String | Id of the entity

var attrName = "attrName_example"; // String | Name of the attribute to be retrieved.

var opts = { 
  'type': "type_example", // String | Entity type, to avoid ambiguity in the case there are several entities with the same entity id.
  'metadata': "metadata_example" // String | A list of metadata names to include in the response. See \"Filtering out attributes and metadata\" section for more detail.
};

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

Parameters

Name Type Description Notes
entityId String Id of the entity
attrName String Name of the attribute to be retrieved.
type String Entity type, to avoid ambiguity in the case there are several entities with the same entity id. [optional]
metadata String A list of metadata names to include in the response. See "Filtering out attributes and metadata" section for more detail. [optional]

Return type

Entity

Authorization

fiware_token

HTTP request headers

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

removeASingleAttribute

removeASingleAttribute(entityId, attrName, opts)

Removes an entity attribute. 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.AttributesApi();

var entityId = "entityId_example"; // String | Id of the entity.

var attrName = "attrName_example"; // String | Attribute name.

var opts = { 
  'type': "type_example" // String | Entity type, to avoid ambiguity in the case there are several entities with the same entity id.
};

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

Parameters

Name Type Description Notes
entityId String Id of the entity.
attrName String Attribute name.
type String Entity type, to avoid ambiguity in the case there are several entities with the same entity id. [optional]

Return type

null (empty response body)

Authorization

fiware_token

HTTP request headers

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

updateAttributeData

updateAttributeData(entityId, attrName, body, opts)

The request payload is an object representing the new attribute data. Previous attribute data is replaced by the one in the request. The object follows the JSON Representation for attributes (described in "JSON Attribute Representation" section). 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.AttributesApi();

var entityId = "entityId_example"; // String | Id of the entity to update

var attrName = "attrName_example"; // String | Attribute name

var body = null; // Object | 

var opts = { 
  'type': "type_example" // String | Entity type, to avoid ambiguity in case there are several entities with the same entity id.
};

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

Parameters

Name Type Description Notes
entityId String Id of the entity to update
attrName String Attribute name
body Object
type String Entity type, to avoid ambiguity in case there are several entities with the same entity id. [optional]

Return type

null (empty response body)

Authorization

fiware_token

HTTP request headers

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