OpenVeo server API for plugins

API Docs for: 3.0.0
Show:

EntityController

Extends Controller
Defined in: lib/controllers/EntityController.js:12
Module: controllers

Summary

Provides route actions for all requests relative to entities.

Constructor

EntityController

Defined in lib/controllers/EntityController.js:12

Syntax

EntityController

(
  • Entity
)

Summary

Parameters:

  • Entity Function

    An entity function extending EntityModel

Methods

addEntityAction

Defined in lib/controllers/EntityController.js:130

Syntax

addEntityAction

()

Summary

Adds an entity.

Also expects entity data in body.

Example:

{
  "entity" : { ... }
}

getEntitiesAction

Defined in lib/controllers/EntityController.js:32

Syntax

getEntitiesAction

()

Summary

Gets a list of entities.

Example:

{
  "entities" : [ ... ]
}

getEntityAction

Defined in lib/controllers/EntityController.js:57

Syntax

getEntityAction

()

Summary

Gets a specific entity.

Expects the following url parameters :

  • id The id of the entity to retrieve

Example:

{
  "entity" : { ... }
}

removeEntityAction

Defined in lib/controllers/EntityController.js:164

Syntax

removeEntityAction

()

Summary

Removes an entity.

Expects the following url parameters :

  • id The id of the entity to remove

updateEntityAction

Defined in lib/controllers/EntityController.js:96

Syntax

updateEntityAction

()

Summary

Updates an entity.

Expects the following url parameters :

  • id The id of the entity to update

Also expects data in body.