Loading TOC...

es functions (Entity Services API)

The Entity Services API is a set of functions that enable you to define logical entity-relationship models and instantiate them for use in your application. Use these functions to create Entity Services models, generate supporting code and configuration artifacts, and manage entity instances. For details, see the Entity Services Developer's Guide.

To use the es module in your JavaScript code, include a require statement similar to the following in your code:

const es = require('/MarkLogic/entity-services/entity-services');

The library namespace prefix es is not predefined in the server.

15 functions
Function name Description
es.databasePropertiesGenerate This function is deprecated and will be removed in a future release.
es.extractionTemplateGenerate This function is deprecated and will be removed in a future release.
es.instanceConverterGenerate This function is deprecated and will be removed in a future release.
es.instanceFromDocument This function is deprecated and will be removed in a future release.
es.instanceGetAttachments This function is deprecated and will be removed in a future release.
es.instanceJsonFromDocument This function is deprecated and will be removed in a future release.
es.instanceXmlFromDocument This function is deprecated and will be removed in a future release.
es.modelFromXml This function is deprecated and will be removed in a future release.
es.modelGetTestInstances This function is deprecated and will be removed in a future release.
es.modelToXml This function is deprecated and will be removed in a future release.
es.modelValidate Validates an entity services model descriptor.
es.piiGenerate This function is deprecated and will be removed in a future release.
es.schemaGenerate This function is deprecated and will be removed in a future release.
es.searchOptionsGenerate This function is deprecated and will be removed in a future release.
es.versionTranslatorGenerate This function is deprecated and will be removed in a future release.