entulib

2.0.8 • Public • Published

entulib

npm version

Library for authenticated access to Entu database API.

Service Request Description HTTP Method
Get Entity Fetch Entity by ID GET
Find Entity Description GET
Get Childs Description GET
Get Relationships Description GET
Edit Entity Description PUT
Add Entity Description POST
Poll Description GET

Authentication of application is done with

  • API key
    • that is stored in Entu
      • and is attached to entity
        • that identifies the application

Usage

$ npm install entulib --save, then var entu = require('entulib')

Methods to please your application

All methods return a promise

  • getEntity(id, entuOptions)
  • getEntities(definition, limit, page, entuOptions)
  • getChilds(parentEid, definition, entuOptions)
  • getRelationships(parentEid, definition, entuOptions)
  • edit(params, entuOptions)
  • add(parentEid, definition, properties, entuOptions)
  • pollUpdates(entuOptions)
  • pollParents(id, entuOptions)

EntuOptions

entuOptions = {
  entuUrl: entuUrl,
  user: user,
  key: key
}

Readme

Keywords

none

Package Sidebar

Install

npm i entulib

Weekly Downloads

1

Version

2.0.8

License

MIT

Unpacked Size

16.3 kB

Total Files

4

Last publish

Collaborators

  • argoroots
  • michelek
  • mitselek