Working copy id of the current opened model (read only)
The Mendix meta model version related to the project.
The meta data of the model.
The Mendix product version the model was created with/in. Note: this does not have to equal the meta model version.
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. (Errors will be handled through the default modelstore error handler.)
Deletes the file with the specified filepath.
Deletes this model from the server, and the (SDK) client. If you are altering the model before deleting it, make sure to call this method in the callback of closeConnection.
Deploy the working copy.
Exports this model as MPK. If you are altering the model before running an export make sure to call this method in the callback of closeConnection. If outFilePath is empty, the raw request response will be provided in the callback
Given a moduleName, returns a module name (For modules, their qualified name equals their name)
Get the deployment status of the working copy. Can be STARTED, STARTING, UPDATING, STOPPED and APP_NOT_FOUND. Contains other deployment info as well.
Returns UUIDs for helper working copies for each supported Mendix version.
These are pre-defined working copies that are accessible for read operations, and contain units that might come in handy when creating pages from templates.
Downloads the file specified by the supplied filepath. If filePath is empty, the raw request response 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
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.
Generated using TypeDoc
This interface exposes a single Mendix Model. This interface contains the parts of the Model that are exposed through the SDK.