Adding classes

Now classes and attributes can be created in the Dashboard. This is also possible using cURL and can be looked-up at Using the REST interface.

Yet another way to create new classes and attributes is to directly amend the sourcecode while using the switch

update=true

in the sdk.properties file in order to automatically generate the new meta models and meta model attributes upon upload. A new class must be annotated with "@Model":

@Model( moduleName = "MyModule", isTransient = false, isInvisible=false)

The value of the attribute "moduleName" should equal the name of the own module while "isTransient" can be used to declare whether this class is transient or not (see next chapter). You can mark a class as invisible for the REST interface; also see next chapter for more information.

Class attributes cause the generation of corresponding meta model attributes and don't require additional annotation. It is advisable to download the module right after the upload is finished in order to fetch automatically generated code.

Releasing

The module has to be "released" if you want one of the following things:

• The module should be accessible to other customers via the module market

• The module should be usable (as a library) in other modules

• The module contains a custom REST endpoint with a Swagger annotation and you want the API documentation to appear in the Apidocs

Otherwise you don't need to release your module. You can still send CRUD requests to the regular REST resources and for example create objects of a MetaModel and fetch the objects etc.

To release your module, execute the following cURL command:

• Linux

• Windows

Deploying

To make requests like creating or fetching objects of classes of your module, it has to be deployed. You can do this with the following cURL command:

• Linux

• Windows

Deleting classes

The way you can delete classes depends on whether you've already uploaded your module:

• If you haven't uploaded your module yet, you can simply delete the class on the dashboard

• Otherwise, you can either delete the class by removing it from the project folder in eclipse and upload it via ant task with the "update=overwrite" property in sdk.properties or you may delete the class from the dashboard, then delete the class from your project folder in eclipse and then down- and upload the module via and task while having the properties "update=overwrite" and "merge=false" set in your sdk.properties file.

Deleting a module

By default, when calling the delete module REST resource (DELETE request to /modules/{moduleName}), the module is not deleted completely but only for the current ApiOmat system. That is, if the module is deleted in LIVE and still used in other systems like STAGING, the content of STAGING will stay untouched. If you want to delete the whole module from the ApiOmat installation, the query parameter deleteCompletely=TRUE can be provided:

• Linux