entulib
v2.0.8
Published
Javascript library to access Entu database
Downloads
20
Readme
entulib
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
- and is attached to entity
- that is stored in Entu
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
}