Eviratec Entity SDK (JavaScript)

EviratecEntityApi - JavaScript SDK for the Eviratec Entity API eviratec.com.au / 3xqt.co This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 0.1.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 entity-sdk --save

git

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

npm install eviratec/entity-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.

Getting Started

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

var EviratecEntityApi = require('eviratec_entity_api');

var api = new EviratecEntityApi.EntityApi()

var model = new EviratecEntityApi.Model2(); // {Model2} The new **Entity** to add

var userID = 3.4; // {Number} The ID of the user who owns the resource

var className = "className_example"; // {String} The EntityType's ClassName


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createEntity(model, userID, className, callback);

Documentation for API Endpoints

All URIs are relative to https://entity-api.preview.eviratec.software

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- EviratecEntityApi.EntityApi | createEntity | POST /U/{UserID}/T/{ClassName}/Entities | Creates a new Entity EviratecEntityApi.EntityApi | deleteEntityByEntityID | DELETE /U/{UserID}/T/{ClassName}/E/{EntityID} | Deletes an existing Entity EviratecEntityApi.EntityApi | getEntityByEntityID | GET /U/{UserID}/T/{ClassName}/E/{EntityID} | Retrieves an existing Entity EviratecEntityApi.EntityApi | getEntityList | GET /U/{UserID}/T/{ClassName}/Entity/List | Retrieves a list of Entities EviratecEntityApi.EntityAttributeApi | deleteEntityAttributeByAttributeKey | DELETE /U/{UserID}/T/{ClassName}/E/{EntityID}/A/{AttributeKey} | Deletes an existing EntityAttribute EviratecEntityApi.EntityAttributeApi | getEntityAttributeByAttributeKey | GET /U/{UserID}/T/{ClassName}/E/{EntityID}/A/{AttributeKey} | Retrieves an existing EntityAttribute EviratecEntityApi.EntityAttributeApi | updateEntityAttributeByAttributeKey | PUT /U/{UserID}/T/{ClassName}/E/{EntityID}/A/{AttributeKey} | EviratecEntityApi.EntityTypeApi | createEntityType | POST /U/{UserID}/Types | Creates a new EntityType EviratecEntityApi.EntityTypeApi | getEntityTypeByClassName | GET /U/{UserID}/T/{ClassName} | Retrieves an existing EntityType EviratecEntityApi.EntityTypeApi | getEntityTypeList | GET /U/{UserID}/Type/List | Retrieves a list of Types EviratecEntityApi.TypeAttributeApi | createTypeAttribute | POST /U/{UserID}/T/{ClassName}/Attributes | Creates a new TypeAttribute EviratecEntityApi.TypeAttributeApi | getTypeAttributeByAttributeKey | GET /U/{UserID}/T/{ClassName}/A/{AttributeKey} | Retrieves an existing TypeAttribute EviratecEntityApi.TypeAttributeApi | updateTypeAttributeByAttributeKey | PUT /U/{UserID}/T/{ClassName}/A/{AttributeKey} |

Documentation for Models

• EviratecEntityApi.Entity
• EviratecEntityApi.EntityAttribute
• EviratecEntityApi.EntityType
• EviratecEntityApi.InlineResponse200
• EviratecEntityApi.InlineResponse2001
• EviratecEntityApi.Model
• EviratecEntityApi.Model1
• EviratecEntityApi.Model2
• EviratecEntityApi.NewEntity
• EviratecEntityApi.NewEntityAttribute
• EviratecEntityApi.NewEntityType
• EviratecEntityApi.NewTypeAttribute
• EviratecEntityApi.TypeAttribute
• EviratecEntityApi.UUserIDTClassNameEntitiesAttributes
• EviratecEntityApi.UUserIDTClassNameEntityListAttributes
• EviratecEntityApi.UUserIDTypeListAttributes
• EviratecEntityApi.UUserIDTypesAttributes

Documentation for Authorization

All endpoints do not require authorization.

License

Copyright (c) 2017 Callan Peter Milne

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.