Working copy id of the current opened model (read only)
The Mendix meta model version related to the project.
The Mendix product version the model was created with/in. Note: this does not have to equal the meta model version.
The actual contents of the model.
The meta data of the model.
Adds the given module json to the project, which will make the module and its units read-only and unloadable. Returns the added module.
Gives error if
Returns all units in the project, including modules, folders etc. To retrieve all "real" documents (pages, microflows etc.), use allDocuments().
Ends the connection with the Model API client. Flushes any pending deltas and invokes the callback once complete. If a callback is provided but no error callback is provided, errors will be handled through the default modelstore error handler.
Creates and returns a new element in the SDK and on the server. After creation, assign or add this instance to a property that accepts this kind of elements.
structureTypeName of the element type you want to create
Deletes the file with the specified filepath.
Deletes this model from the server, and the (SDK) client.
Exports the module as MPK. If outFilePath is empty, the raw response body will be provided in the callback
Exports this model as MPK. If outFilePath is empty, the raw response body will be provided.
Returns a list of unitIds that contains a specific custom widget
Given a qualified name, returns a Module.
Flushes any pending deltas and invokes the callback once complete. If a callback is provided but no error callback is provided, errors will be handled through the default modelstore error handler.
Downloads the file specified by the supplied filepath. If outFilePath is empty, the raw response body will be provided in the callback
Returns an array of all filepaths in the working copy.
Returns all files or a subset of files options.filter: glob pattern to limit the set of files options.format: "json" or "zip" options.path: useful if format is "zip". If provided the zip will be stored on disk
Get the event id for the last processed batch of deltas in Model Server after flushing any pending deltas. If a callback is provided but no error callback is provided, errors will be handled through the default modelstore error handler.
Imports the given module MPK.
Importing a module overwrites existing files in the project.
Gives error if
Given an id, fetches a complete unit. The result might be returned from the cache. Use this method if you have just a unit Id, otherwise, unit.fetch() is a simpler alternative.
Uploads the supplied file to the specified filepath.
Sets the callback that is invoked when an error occurs in an asynchronous operation for which no error callback is specified.
Examples of such operations are making changes to the model and loading elements.
Generated using TypeDoc
This interface exposes a single Mendix Model. This interface contains the parts of the Model that are exposed through the SDK.