Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 1.66 KB

APIEntryPointApi.md

File metadata and controls

56 lines (37 loc) · 1.66 KB

NgsiV2.APIEntryPointApi

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

Method HTTP request Description
retrieveAPIResources GET /

retrieveAPIResources

APIEntryPoint retrieveAPIResources()

This resource does not have any attributes. Instead it offers the initial API affordances in the form of the links in the JSON body. It is recommended to follow the “url” link values, Link or Location headers where applicable to retrieve resources. Instead of constructing your own URLs, to keep your client decoupled from implementation 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.APIEntryPointApi();

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

Parameters

This endpoint does not need any parameter.

Return type

APIEntryPoint

Authorization

fiware_token

HTTP request headers

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