API Methods in custom modules

The platform allows you to create custom API methods as a part of your module and then use them in a web API or scripts in widgets, pages, and business processes. For example, you can create methods for starting a business process, complex data fetching, or set up methods for interaction with an internal or external system. You can create general-purpose methods and use them in different places repeatedly.

To create or edit a method:

1. Go to Administration > Modules.
2. Hover the mouse over the module and click the gear icon.

3. Go to the API Methods tab.
4. Click Edit. The method editor will open.
5. Click the +Add button. In the window that opens, enter the required information.

• Name.* Enter the method name.
• Address.* Select HTTP request method: GET or POST. Specify at what address to access the method.
• Function.* Create a function to execute when getting a request.
• Authorization. Select an authentication type to use when getting a request.
  • Internal authentication. When this option is checked, the method can be called in scripts within business processes, in widgets, and forms. At the same time, you cannot call the method from an external system. The user on whose behalf the script is executed must be authorized in ELMA365.
  • External authentication. When this option is selected, the method will be available from the external system by a token.
• Asynchronous start. This option allows you to continue your work without waiting for method execution to finish.
• Description. Write a detailed description of the method here.

1. Go to the Scripts tab and write the method source code. Use the TypeScript programming language. If you'd like to know more about the basic principles of scrip-writing in ELMA365, please visit TypeScript SDK Help Center.
2. Save and publish the method.

Accessing the Global constant

You can use the Global constant in API methods to access variables inside workspaces and global parameters. But, using such a constant prevents the module downloading. It means that enabling access to the Global constant in API methods limits the module export.

To enable the access to the Global constant:

1. In the method editor, go to the Scripts tab;

2. In the top menu, click Settings;
3. In the window that opens, select the Global option.

Was this helpful?

Thanks for your feedback!

Please specify why:

Recommendations did not help meArticle is hard to understandDidn`t answer my questionContent does not match the topicOther

How we can improve it?

YesNo

Please specify whyRecommendations did not help meArticle is hard to understandDidn`t answer my questionContent does not match the topicOther

Found a typo? Highlight the text, press ctrl + enter and notify us