rrhet_test_catalog_api v1.0.68

rrhet_test_catalog_api

RrhetTestCatalogApi - JavaScript client for rrhet_test_catalog_api TestCatalogueSample This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.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 rrhet_test_catalog_api --save

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

Finally, switch to the directory you want to use your rrhet_test_catalog_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('rrhet_test_catalog_api') in javascript files from the directory you ran the last command above from.

git

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

    npm install YOUR_USERNAME/rrhet_test_catalog_api --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, that's to say your javascript file where you actually use this library):

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 RrhetTestCatalogApi = require('rrhet_test_catalog_api');

var api = new RrhetTestCatalogApi.DefaultApi()

var uuid = "uuid_example"; // {String} 

var extension = "extension_example"; // {String} 

var token = "token_example"; // {String} The authorization token


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

Documentation for API Endpoints

All URIs are relative to https://testcatalog-api.rrhemergingtech.org/v2

Documentation for Models

• RrhetTestCatalogApi.DataItem
• RrhetTestCatalogApi.DataRow
• RrhetTestCatalogApi.DataRows
• RrhetTestCatalogApi.FieldDefinition
• RrhetTestCatalogApi.GlobalRangeProperty
• RrhetTestCatalogApi.GlobalReferenceRangeParameterIndex
• RrhetTestCatalogApi.Location
• RrhetTestCatalogApi.PTSInfo
• RrhetTestCatalogApi.Permissions
• RrhetTestCatalogApi.PropertyJournal
• RrhetTestCatalogApi.SearchCriteria
• RrhetTestCatalogApi.SearchResult
• RrhetTestCatalogApi.StabilitySource
• RrhetTestCatalogApi.Test
• RrhetTestCatalogApi.TestDefinition
• RrhetTestCatalogApi.TestDefinitionSection
• RrhetTestCatalogApi.TestLocation
• RrhetTestCatalogApi.TestProperty
• RrhetTestCatalogApi.UploadedFile
• RrhetTestCatalogApi.User

Documentation for Authorization

All endpoints do not require authorization.