nodeum_api v1.88.0

nodeum_api

NodeumApi - JavaScript client for nodeum_api The Nodeum API makes it easy to tap into the digital data mesh that runs across your organisation. Make requests to our API endpoints and we’ll give you everything you need to interconnect your business workflows with your storage.

All production API requests are made to:

http://nodeumhostname/api/

The current production version of the API is v1.

REST The Nodeum API is a RESTful API. This means that the API is designed to allow you to get, create, update, & delete objects with the HTTP verbs GET, POST, PUT, PATCH, & DELETE.

JSON The Nodeum API speaks exclusively in JSON. This means that you should always set the Content-Type header to application/json to ensure that your requests are properly accepted and processed by the API.

Authentication All API calls require user-password authentication.

Cross-Origin Resource Sharing The Nodeum API supports CORS for communicating from Javascript for these endpoints. You will need to specify an Origin URI when creating your application to allow for CORS to be whitelisted for your domain.

Pagination Some endpoints such as File Listing return a potentially lengthy array of objects. In order to keep the response sizes manageable the API will take advantage of pagination. Pagination is a mechanism for returning a subset of the results for a request and allowing for subsequent requests to “page” through the rest of the results until the end is reached. Paginated endpoints follow a standard interface that accepts two query parameters, limit and offset, and return a payload that follows a standard form. These parameters names and their behavior are borrowed from SQL LIMIT and OFFSET keywords.

Versioning The Nodeum API is constantly being worked on to add features, make improvements, and fix bugs. This means that you should expect changes to be introduced and documented.

However, there are some changes or additions that are considered backwards-compatible and your applications should be flexible enough to handle them. These include:

• Adding new endpoints to the API
• Adding new attributes to the response of an existing endpoint
• Changing the order of attributes of responses (JSON by definition is an object of unordered key/value pairs)

Filter parameters When browsing a list of items, multiple filter parameters may be applied. Some operators can be added to the value as a prefix:

• = value is equal. Default operator, may be omitted
• != value is different
• > greater than
• >= greater than or equal
• < lower than
• >= lower than or equal
• >< included in list, items should be separated by |
• !>< not included in list, items should be separated by |
• ~ pattern matching, may include % (any characters) and _ (one character)

• !~ pattern not matching, may include % (any characters) and _ (one character)

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 2.1.0
• Package version: 1.88.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://www.nodeum.io/

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 nodeum_api --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your nodeum_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/nodeum-io/nodeum-sdk-js then install it via:

    npm install nodeum-io/nodeum-sdk-js --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 NodeumApi = require('nodeum_api');

var defaultClient = NodeumApi.ApiClient.instance;
// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'
// Configure API key authorization: BearerAuth
var BearerAuth = defaultClient.authentications['BearerAuth'];
BearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//BearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new NodeumApi.CloudBucketsApi()
var opts = {
  'limit': 56, // {Number} The number of items to display for pagination.
  'offset': 56, // {Number} The number of items to skip for pagination.
  'sortBy': ["null"], // {[String]} Sort results by attribute.  Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
  'id': "id_example", // {String} Filter on id
  'cloudConnectorId': "cloudConnectorId_example", // {String} Filter on cloud connector id
  'poolId': "poolId_example", // {String} Filter on a pool id
  'name': "name_example", // {String} Filter on name
  'location': "location_example", // {String} Filter on location
  'price': "price_example" // {String} Filter on price
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.indexCloudBuckets(opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost/api/v2

Documentation for Models

• NodeumApi.ActiveJobStatus
• NodeumApi.ApiKey
• NodeumApi.ApiKeyCollection
• NodeumApi.ApiKeyFull
• NodeumApi.ApiKeyFullAllOf
• NodeumApi.ApiKeyScope
• NodeumApi.AttributeError
• NodeumApi.Blank
• NodeumApi.ByDateFacet
• NodeumApi.ByDateFacetBucket
• NodeumApi.ByDateFacetBucketAllOf
• NodeumApi.ByDateFacetBuckets
• NodeumApi.ByFileExtensionFacet
• NodeumApi.ByFileExtensionFacetAllOf
• NodeumApi.ByGroupOwnerFacet
• NodeumApi.ByGroupOwnerFacetAllOf
• NodeumApi.ByMetadataBucket
• NodeumApi.ByMetadataBucketAllOf
• NodeumApi.ByMetadataFacet
• NodeumApi.ByMetadataFacetAllOf
• NodeumApi.ByMetadataKeyBucket
• NodeumApi.ByMetadataKeyBucketAllOf
• NodeumApi.ByMetadataKeyBuckets
• NodeumApi.ByMetadataValueBuckets
• NodeumApi.ByPrimaryCloudFacet
• NodeumApi.ByPrimaryCloudFacetAllOf
• NodeumApi.ByPrimaryFacet
• NodeumApi.ByPrimaryFacetAllOf
• NodeumApi.ByPrimaryNasFacet
• NodeumApi.ByPrimaryNasFacetAllOf
• NodeumApi.ByPrimaryStorageFacet
• NodeumApi.ByPrimaryTypeFacet
• NodeumApi.BySecondaryCloudFacet
• NodeumApi.BySecondaryCloudFacetAllOf
• NodeumApi.BySecondaryNasFacet
• NodeumApi.BySecondaryNasFacetAllOf
• NodeumApi.BySecondaryStorageFacet
• NodeumApi.BySecondaryTapeFacet
• NodeumApi.BySecondaryTapeFacetAllOf
• NodeumApi.BySecondaryTypeFacet
• NodeumApi.BySecondaryTypeFacetAllOf
• NodeumApi.BySizeFacet
• NodeumApi.ByTaskMetadataFacet
• NodeumApi.ByTaskMetadataFacetAllOf
• NodeumApi.ByTaskStatusFacet
• NodeumApi.ByTaskStatusFacetAllOf
• NodeumApi.ByTaskStorageFacet
• NodeumApi.ByTaskStorageFacetAllOf
• NodeumApi.ByTaskWorkflowFacet
• NodeumApi.ByTaskWorkflowFacetAllOf
• NodeumApi.ByTypeFacetBucket
• NodeumApi.ByTypeFacetBuckets
• NodeumApi.ByUserOwnerFacet
• NodeumApi.ByUserOwnerFacetAllOf
• NodeumApi.CloudBucket
• NodeumApi.CloudBucketCollection
• NodeumApi.CloudBucketSimpleCollection
• NodeumApi.CloudConnector
• NodeumApi.CloudConnectorCollection
• NodeumApi.Container
• NodeumApi.ContainerCollection
• NodeumApi.ContainerPrivilege
• NodeumApi.ContainerPrivilegeCollection
• NodeumApi.DateToFileFacets
• NodeumApi.DefaultFacet
• NodeumApi.Error
• NodeumApi.FileFacet
• NodeumApi.FileFacetAllOf
• NodeumApi.FileMetadataDefinition
• NodeumApi.FileMetadataDefinitionCollection
• NodeumApi.Frozen
• NodeumApi.GreaterThan
• NodeumApi.GreaterThanAllOf
• NodeumApi.GreaterThanOrEqualTo
• NodeumApi.ImportFile
• NodeumApi.ImportFileCollection
• NodeumApi.ImportFileWithPath
• NodeumApi.Invalid
• NodeumApi.LessThan
• NodeumApi.LessThanAllOf
• NodeumApi.LessThanOrEqualTo
• NodeumApi.MetadataDefinition
• NodeumApi.MountCollection
• NodeumApi.MountInfo
• NodeumApi.MountNotification
• NodeumApi.MountStatus
• NodeumApi.Nas
• NodeumApi.NasCollection
• NodeumApi.NasShare
• NodeumApi.NasShareCollection
• NodeumApi.NodeumFile
• NodeumApi.NodeumFileCollection
• NodeumApi.NodeumFileWithPath
• NodeumApi.NodeumFileWithPathAllOf
• NodeumApi.OccurrenceLessThan
• NodeumApi.OccurrenceLessThanAllOf
• NodeumApi.OccurrenceLessThanOrEqualTo
• NodeumApi.OnTapesFile
• NodeumApi.OnTapesFileCollection
• NodeumApi.Pool
• NodeumApi.PoolCollection
• NodeumApi.PoolUp
• NodeumApi.PoolUpAllOf
• NodeumApi.PrimaryScan
• NodeumApi.QuotaOnCache
• NodeumApi.Reset
• NodeumApi.ResetSections
• NodeumApi.SizeToDateFacets
• NodeumApi.StorageByTypeFacets
• NodeumApi.StorageCloudBucketByTypeFacets
• NodeumApi.StorageCloudBucketFacets
• NodeumApi.StorageFacet
• NodeumApi.StorageNasShareByTypeFacets
• NodeumApi.StorageNasShareFacets
• NodeumApi.StoragePoolByTypeFacets
• NodeumApi.StoragePoolFacets
• NodeumApi.StorageTapeByTypeFacets
• NodeumApi.StorageTapeFacets
• NodeumApi.SystemGroup
• NodeumApi.SystemGroupCollection
• NodeumApi.SystemUser
• NodeumApi.SystemUserCollection
• NodeumApi.Taken
• NodeumApi.TakenAllOf
• NodeumApi.Tape
• NodeumApi.TapeCollection
• NodeumApi.TapeDrive
• NodeumApi.TapeDriveAllOf
• NodeumApi.TapeDriveCollection
• NodeumApi.TapeDriveDevice
• NodeumApi.TapeDriveDeviceCollection
• NodeumApi.TapeLibrary
• NodeumApi.TapeLibraryAllOf
• NodeumApi.TapeLibraryCollection
• NodeumApi.TapeLibraryDevice
• NodeumApi.TapeLibraryDeviceCollection
• NodeumApi.TapeStat
• NodeumApi.TapeStatCollection
• NodeumApi.Task
• NodeumApi.TaskByWorkflowBucket
• NodeumApi.TaskByWorkflowBucketAllOf
• NodeumApi.TaskByWorkflowBuckets
• NodeumApi.TaskCallback
• NodeumApi.TaskCallbackCollection
• NodeumApi.TaskCollection
• NodeumApi.TaskDestinationCollection
• NodeumApi.TaskDestinationDown
• NodeumApi.TaskDestinationUp
• NodeumApi.TaskExecution
• NodeumApi.TaskExecutionCollection
• NodeumApi.TaskFacet
• NodeumApi.TaskFacetAllOf
• NodeumApi.TaskFacetBucket
• NodeumApi.TaskFacetBuckets
• NodeumApi.TaskFacetMetadataBucket
• NodeumApi.TaskFacetMetadataKeyBucket
• NodeumApi.TaskFacetMetadataKeyBucketAllOf
• NodeumApi.TaskFacetMetadataKeyBuckets
• NodeumApi.TaskFacetMetadataValueBuckets
• NodeumApi.TaskMetadataDefinition
• NodeumApi.TaskMetadataDefinitionAllOf
• NodeumApi.TaskMetadataDefinitionCollection
• NodeumApi.TaskMetadatum
• NodeumApi.TaskMetadatumCollection
• NodeumApi.TaskOption
• NodeumApi.TaskOptionCollection
• NodeumApi.TaskSchedule
• NodeumApi.TaskScheduleCollection
• NodeumApi.TaskSourceCollection
• NodeumApi.TaskSourceDown
• NodeumApi.TaskSourceUp
• NodeumApi.TooLong
• NodeumApi.TooLongAllOf
• NodeumApi.TooShort
• NodeumApi.TooShortAllOf
• NodeumApi.TypeToPrimaryFacets
• NodeumApi.TypeToSecondaryFacets
• NodeumApi.UserConfiguration
• NodeumApi.UserConfigurationCollection

Documentation for Authorization

BasicAuth

• Type: HTTP basic authentication

BearerAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header