Entity Service

In the context of Dirigible, the Entity Service means a REST service which exposes the CRUD methods on top of the database table. The following steps shows how to generate such an entity service on top of existing table.

Version 2.x


  1. Select the ScriptingServices sub-folder of the project and open the pop-up menu.
  2. From the menu, choose New -> Scripting Service.

    Entity Service

  3. From the wizard, select Entity Service on Table from the list of available templates.
  4. Click Next.
  5. From the list of all available tables, select the one that will be used to generate the entity service and click Next.

    Entity Service

  6. Enter the name of your entity service and click Finish.
  7. The generated service will be opened in the editor.

    Entity Service

  8. Now, you can use the Publish action from the project’s pop-up menu to enable the service.
  9. Go to Workspace Explorer where the project is managed and select the service artifact (books.js). This action will make a GET HTTP request to the service and the response from the service can be seen the Preview view.

    Entity Service

    In this case - just an empty JSON array.


To discover all available services, you can go to the Registry.

  1. From the main menu, choose Window -> Show Perspective -> Registry.
  2. The Registry perspective represents a view to the enabled runtime content. From its menu, choose Discover -> JavaScript to open the currently available server-side JavaScript service endpoints.
  3. You can see the list of available endpoints, where you can find yours by naming convention: {project}/{service path}

    Entity Service

  4. You directly open (and make HTTP GET request) to the service by clicking on the icon.

    Entity Service

The naming convention for the service endpoints URLs is as follows:

{protocol}://{host}:{port}/{dirigible’s runtime application context}/services/js/{project}/{service-name}

For example:

https ://dirigibleide.hana.ondemand.com/dirigible/services/js/bookstore/books.js

There are some specific requirements for the table to be exposed as an entity service (e.g. primary key has to be defined, it should be a single column, etc.). Also, the entity service itself supports a bit more operations than the standard ones defined by HTTP. For more information, see Entity Service.