API Reference

Sessions

GET

api/session

Returns the details of the given session
Details
POST

api/session

Starts new session
Details
DELETE

api/session

Closes current session
Details
PUT

api/session

Pings the given session
Details

Databases

GET

api/databases

Returns the list of all databases
Details
GET

api/databases/{dbid}

Returns the details of the given database
Details
PUT

api/databases/{dbid}/auth

Authenticates current user to the given database
Details
PUT

api/databases/{dbid}/clearcache

Clear database L2 cache
Details

Entities

POST

api/databases/{dbid}/entities/{entity}

Creates and saves new entity
Details
GET

api/databases/{dbid}/entities/{entity}

Returns the list of entities
Details
POST

api/databases/{dbid}/entities/{entity}/edit

Creates new entity for editing
Details
GET

api/databases/{dbid}/entities/{entity}/query

Returns the list of all entities with selected fields
Details
GET

api/databases/{dbid}/entities/{entity}/{id}

Returns the details of the given entity
Details
DELETE

api/databases/{dbid}/entities/{entity}/{id}

Deletes the given entity
Details
PUT

api/databases/{dbid}/entities/{entity}/{id}

Updates and saves the given entity
Details
GET

api/databases/{dbid}/entities/{entity}/{id}/data/{property}

Returns blob data of the given entity
Details
PUT

api/databases/{dbid}/entities/{entity}/{id}/edit

Updates the given edited entity
Details
POST

api/databases/{dbid}/entities/{entity}/{id}/edit

Opens existing entity for editing
Details
GET

api/databases/{dbid}/entities/{entity}/{id}/edit

Returns the details of the given edited entity
Details
POST

api/databases/{dbid}/entities/{entity}/{id}/edit/cancel

Cancels changes made to the given edited entity
Details
GET

api/databases/{dbid}/entities/{entity}/{id}/edit/data/{property}

Returns blob data of the given edited entity
Details
POST

api/databases/{dbid}/entities/{entity}/{id}/edit/save

Saves changes made to the given edited entity
Details
POST

api/databases/{dbid}/entities/{entity}/{id}/edit/{table}

Creates new record in the given table of the given edited entity
Details
GET

api/databases/{dbid}/entities/{entity}/{id}/edit/{table}

Returns the list of all records of the given table of the given edited entity
Details
PUT

api/databases/{dbid}/entities/{entity}/{id}/edit/{table}/{tid}

Updates the given record of the given edited entity table
Details
GET

api/databases/{dbid}/entities/{entity}/{id}/edit/{table}/{tid}

Returns the details of the given record of the given edited entity table
Details
DELETE

api/databases/{dbid}/entities/{entity}/{id}/edit/{table}/{tid}

Deletes the given record of the given edited entity table
Details
GET

api/databases/{dbid}/entities/{entity}/{id}/edit/{table}/{tid}/data/{property}

Returns blob data of the given edited entity table
Details
GET

api/databases/{dbid}/entities/{entity}/{id}/history

Returns all hystory logs of the given entity
Details
GET

api/databases/{dbid}/entities/{entity}/{id}/{table}

Returns the list of all records of the given entity table
Details
POST

api/databases/{dbid}/entities/{entity}/{id}/{table}

Creates and saves new record of the given entity table
Details
GET

api/databases/{dbid}/entities/{entity}/{id}/{table}/query

Returns the list of all records with selected fields of the given entity table
Details
PUT

api/databases/{dbid}/entities/{entity}/{id}/{table}/{tid}

Updates and saves the given record of the given entity table
Details
DELETE

api/databases/{dbid}/entities/{entity}/{id}/{table}/{tid}

Deletes the given record of the given entity table
Details
GET

api/databases/{dbid}/entities/{entity}/{id}/{table}/{tid}

Returns the details of the given record of the given entity table
Details
GET

api/databases/{dbid}/entities/{entity}/{id}/{table}/{tid}/data/{property}

Returns blob data of the given entity table
Details

Database Tables

GET

api/databases/{dbid}/tables/{table}

Returns the list of all records of the given database table
Details
GET

api/databases/{dbid}/tables/{table}/query

Returns the list of all records with selected fields of the given database table
Details
GET

api/databases/{dbid}/tables/{table}/{id}

Returns the details of the given record of the given database table
Details

Jobs

DELETE

api/databases/{dbid}/jobs/{jid}

Closes the given job
Details
PUT

api/databases/{dbid}/jobs/{jid}

Updates the state of the given job
Details
GET

api/databases/{dbid}/jobs/{jid}

Returns the state of the given job
Details
POST

api/databases/{dbid}/jobs/{jname}

Starts new job
Details

Notifications

PUT

api/databases/{dbid}/tables/Notifications

Updates notifications records
Details
PUT

api/databases/{dbid}/tables/Notifications/{id}

Updates the given notification record
Details

OLAP Cubes

GET

api/databases/{dbid}/analytics/dimensions/{dimension}

Returns the list of all records of the given dimension table
Details
GET

api/databases/{dbid}/analytics/dimensions/{dimension}/query

Returns the list of all records with selected fields of the given dimension table
Details
GET

api/databases/{dbid}/analytics/dimensions/{dimension}/{id}

Returns the details of the given record of the given dimension table
Details
GET

api/databases/{dbid}/analytics/olapcubes/{olapcube}

Returns the given OLAP Cube with selected fields
Details

Full-text Search

GET

api/databases/{dbid}/search

Returns search results
Details

Metadata

GET

api/databases/{dbid}/metadata

Returns all metadata
Details
GET

api/databases/{dbid}/metadata/images/{image}

Returns the details of the given image
Details

Metadata of Entities

GET

api/databases/{dbid}/metadata/entities

Returns the list of all entity-types
Details
GET

api/databases/{dbid}/metadata/entities/{entity}

Returns the details of the given entity-type
Details
GET

api/databases/{dbid}/metadata/entities/{entity}/filteritems

Returns the list of all filter items of the given entity-type
Details
GET

api/databases/{dbid}/metadata/entities/{entity}/filteritems/{filteritem}

Returns the details of the given filter item of the given entity-type
Details
GET

api/databases/{dbid}/metadata/entities/{entity}/properties

Returns the list of all properties of the given entity-type
Details
GET

api/databases/{dbid}/metadata/entities/{entity}/properties/{property}

Returns the details of the given property of the given entity-type
Details
GET

api/databases/{dbid}/metadata/entities/{entity}/tables

Returns the list of all tables of the given entity-type
Details
GET

api/databases/{dbid}/metadata/entities/{entity}/tables/{table}

Returns the details of the given table of the given entity-type
Details
GET

api/databases/{dbid}/metadata/entities/{entity}/tables/{table}/properties

Returns the list of all properties of the given table of the given entity-type
Details
GET

api/databases/{dbid}/metadata/entities/{entity}/tables/{table}/properties/{property}

Returns the details of the given property of the given table of the given entity-type
Details
GET

api/databases/{dbid}/metadata/entities/{entity}/workflow

Returns the details of the workflow of the given entity-type
Details
GET

api/databases/{dbid}/metadata/entities/{entity}/workflow/states

Returns the list of all workflow states of the given entity-type
Details
GET

api/databases/{dbid}/metadata/entities/{entity}/workflow/states/{state}

Returns the details of the given workflow state of the given entity-type
Details
GET

api/databases/{dbid}/metadata/entities/{entity}/workflow/states/{state}/actions

Returns the list of all actions of the given workflow state of the given entity-type
Details
GET

api/databases/{dbid}/metadata/entities/{entity}/workflow/states/{state}/actions/{actionid}

Returns the details of the given workflow state action of the given entity-type
Details
GET

api/databases/{dbid}/metadata/entities/{entity}/workflow/transitions

Returns the list of all workflow transitions of the given entity-type
Details
GET

api/databases/{dbid}/metadata/entities/{entity}/workflow/transitions/{transition}

Returns the details of the given workflow transition of the given entity-type
Details
GET

api/databases/{dbid}/metadata/entities/{entity}/workflow/transitions/{transition}/actions

Returns the list of all workflow transition actions of the given entity-type
Details
GET

api/databases/{dbid}/metadata/entities/{entity}/workflow/transitions/{transition}/actions/{actionid}

Returns the details of the given workflow transition action of the given entity-type
Details
GET

api/databases/{dbid}/metadata/entities/{entity}/workflow/transitions/{transition}/reasons

Returns the list of all workflow transition reasons of the given entity-type
Details
GET

api/databases/{dbid}/metadata/entities/{entity}/workflow/transitions/{transition}/reasons/{reason}

Returns the details of the given workflow transition reason of the given entity-type
Details
GET

api/databases/{dbid}/metadata/entities/{entity}/workflow/transitions/{transition}/reasons/{reason}/actions

Returns the list of all workflow transition reason actions of the given entity-type
Details
GET

api/databases/{dbid}/metadata/entities/{entity}/workflow/transitions/{transition}/reasons/{reason}/actions/{actionid}

Returns the details of the given workflow transition reason action of the given entity-type
Details

Metadata of Tables

GET

api/databases/{dbid}/metadata/tables

Returns the list of all database tables
Details
GET

api/databases/{dbid}/metadata/tables/{table}

Returns the details of the given database table
Details
GET

api/databases/{dbid}/metadata/tables/{table}/fields

Returns the list of all fields of the given database table
Details
GET

api/databases/{dbid}/metadata/tables/{table}/fields/{field}

Returns the details of the given field of the given database table
Details
GET

api/databases/{dbid}/metadata/tables/{table}/filteritems

Returns the list of all filter items of the given database table
Details
GET

api/databases/{dbid}/metadata/tables/{table}/filteritems/{filteritem}

Returns the details of the given filter item of the given database table
Details

Metadata of OLAP Cubes

GET

api/databases/{dbid}/metadata/analytics/dimensions

Returns the list of all dimension tables
Details
GET

api/databases/{dbid}/metadata/analytics/dimensions/{dimension}

Returns the details of the given dimension table
Details
GET

api/databases/{dbid}/metadata/analytics/dimensions/{dimension}/fields

Returns the list of all fields of the given dimension table
Details
GET

api/databases/{dbid}/metadata/analytics/dimensions/{dimension}/fields/{field}

Returns the details of the given field of the given dimension table
Details
GET

api/databases/{dbid}/metadata/analytics/dimensions/{dimension}/filteritems

Returns the list of all filter items of the given dimension table
Details
GET

api/databases/{dbid}/metadata/analytics/dimensions/{dimension}/filteritems/{filteritem}

Returns the details of the given filter item of the given dimension table
Details
GET

api/databases/{dbid}/metadata/analytics/olapcubes

Returns the list of all OLAP Cubes
Details
GET

api/databases/{dbid}/metadata/analytics/olapcubes/{olapcube}

Returns the details of the given OLAP Cube
Details
GET

api/databases/{dbid}/metadata/analytics/olapcubes/{olapcube}/fields

Returns the list of all fields of the given OLAP Cube
Details
GET

api/databases/{dbid}/metadata/analytics/olapcubes/{olapcube}/fields/{ofield}

Returns the details of the given field of the given OLAP Cube
Details
GET

api/databases/{dbid}/metadata/analytics/olapcubes/{olapcube}/filteritems

Returns the list of all filter items of the given OLAP Cube
Details
GET

api/databases/{dbid}/metadata/analytics/olapcubes/{olapcube}/filteritems/{filteritem}

Returns the details of the given filter item of the given OLAP Cube
Details

Metadata of Enums

GET

api/databases/{dbid}/metadata/enums

Returns the list of all enums
Details
GET

api/databases/{dbid}/metadata/enums/{ename}

Returns the details of the given enum
Details
GET

api/databases/{dbid}/metadata/enums/{ename}/values

Returns the list of all enum values
Details
GET

api/databases/{dbid}/metadata/enums/{ename}/values/{value}

Returns the details of the given enum value
Details