Accessing an ARIS repository via the ARIS API

Using this module allows you to extract information about models and objects from the ARIS repository and transfer them to other information systems, as well as to create objects and models in the ARIS repository based on data from external sources. The ARIS API provides creating calls to the ARIS repository and using them to get the necessary information about the relationships of various entities.

Figure 1 represents some of the available API calls to the ARIS repository.

Figure 1. Examples of the API calls for ARIS repository

Most API calls have required and/or optional parameters. In figure 2 there are some of the parameters for the GET/api/databases/{dbName}/find call, which is used to search for items in the database.

Figure 2. Examples of parameters for the GET/api/databases/{dbName}/find call

The ARIS API will be useful for performing various business tasks. Among them is the modeling of organization’s subsystems based on data obtained from external accounting systems and ERP systems. For example, it is possible to create a model of the organizational structure based on data obtained from SAP. Data from specialized accounting and IT management systems can become the basis for creating a model with a catalog of information systems, including their properties and environment, in the ARIS repository. Similarly, models of risks, documents, key performance indicators, goals, services, products, and other business-relevant areas of knowledge can be created.

Other example of business task is to get information about business process structure (sequence of activities) from ARIS repository and use it for configuring an automated system or for calculating business indicators for which the structure of business process, process rules and other process components are important.

As for licensing, the ARIS API requires both a server and client license. The server license for the ARIS API, starting from version 9.8 SR6, is included in the ARIS Connect Server license and does not require an additional purchase. The ARIS API client license is included in several client products: ARIS Connect Viewer, ARIS Connect Contributor, ARIS Connect Designer, ARIS Architect, ARIS Designer. But the set of available API methods may vary depending on the type of client license.

When working with ARIS versions below 10.0.12, a certificate is required to access the ARIS API, which can be got for free on the ARIS Community by filling in the inquiry form.

Starting from ARIS 10.0.12, certificates are not required to access the ARIS API.

Also, our company can offer another way of interaction between internal systems and ARIS by using the Web service providing API to ARIS. You can find more information about it at link.

If you have any questions about ARIS API, you can contact us by the technical support request form or at info@dainovaro.com.