nadrf_data_management

NadrfDataManagement - JavaScript client for nadrf_data_management ADRF Data Management Service. © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.1.0-alpha.3
• Package version: 1.1.0-alpha.3
• Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install nadrf_data_management --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var NadrfDataManagement = require('nadrf_data_management');
var defaultClient = NadrfDataManagement.ApiClient.instance;

// Configure OAuth2 access token for authorization: oAuth2ClientCredentials
var oAuth2ClientCredentials = defaultClient.authentications['oAuth2ClientCredentials'];
oAuth2ClientCredentials.accessToken = "YOUR ACCESS TOKEN"

var api = new NadrfDataManagement.ADRFDataRetrievalSubscriptionsCollectionApi()
var body = new NadrfDataManagement.NadrfDataRetrievalSubscription(); // {NadrfDataRetrievalSubscription} Individual ADRF Data Retrieval Subscription resource to be created.

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

Documentation for API Endpoints

All URIs are relative to {apiRoot}/nadrf-datamanagement/v1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- NadrfDataManagement.ADRFDataRetrievalSubscriptionsCollectionApi | createADRFDataRetrievalSubscription | POST /data-retrieval-subscriptions | Creates a new Individual ADRF Data Retrieval Subscription resource. NadrfDataManagement.ADRFDataStoreRecordsCollectionApi | createADRFDataStoreRecord | POST /data-store-records | Creates a new Individual Data Store Record resource. NadrfDataManagement.ADRFDataStoreRecordsCollectionApi | getAdrfDataStoreRecords | GET /data-store-records | Retrieves existing Individual ADRF Data Store Records. NadrfDataManagement.ADRFStorageSubscriptionsApi | createADRFStorageSubscription | POST /request-storage-sub | Triggers the creation of a new ADRF Storage Subscription. NadrfDataManagement.ADRFStorageSubscriptionsApi | deleteADRFStorageSubscription | POST /request-storage-sub-removal | Triggers the removal of ADRF storage subscription. NadrfDataManagement.ADRFStoredDataApi | deleteADRFData | POST /remove-stored-data-analytics | Remove ADRF data based on data or analytics specification. NadrfDataManagement.IndividualADRFDataRetrievalSubscriptionDocumentApi | deleteADRFDataRetrievalSubscription | DELETE /data-retrieval-subscriptions/{subscriptionId} | Delete an existing Individual ADRF Data Retrieval Subscription resource. NadrfDataManagement.IndividualADRFDataStoreRecordDocumentApi | deleteADRFDataStoreRecord | DELETE /data-store-records/{storeTransId} | Delete an existing Individual ADRF Data Store Record.

Documentation for Models

• NadrfDataManagement.DataNotification
• NadrfDataManagement.DataSetTag
• NadrfDataManagement.DataSubscription
• NadrfDataManagement.NadrfAlertNotification
• NadrfDataManagement.NadrfAlertNotificationResponse
• NadrfDataManagement.NadrfDataRetrievalNotification
• NadrfDataManagement.NadrfDataRetrievalSubscription
• NadrfDataManagement.NadrfDataStoreRecord
• NadrfDataManagement.NadrfDataStoreSubscription
• NadrfDataManagement.NadrfDataStoreSubscriptionRef
• NadrfDataManagement.NadrfStoredDataSpec
• NadrfDataManagement.OneOfDataNotification
• NadrfDataManagement.OneOfDataSubscription
• NadrfDataManagement.OneOfNadrfDataRetrievalNotification
• NadrfDataManagement.OneOfNadrfDataRetrievalSubscription
• NadrfDataManagement.OneOfNadrfDataStoreRecord
• NadrfDataManagement.OneOfNadrfDataStoreSubscriptionRef
• NadrfDataManagement.OneOfNadrfStoredDataSpec
• NadrfDataManagement.StorageHandlingInfo

Documentation for Authorization

oAuth2ClientCredentials

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
  • :