Accessing Talend Data Catalog REST API

REST API simplifies your interaction with the data stored on the Talend Data Catalog server by using a number of methods or request types.

You can access all REST API documentation pages based on Swagger and run requests on the repository, glossaries and users.

You need to enable the REST API help by:

selecting the Enable REST API Help checkbox from the Application Server tab in Setup.bat in the installation directory.
using the command line Setup.bat -we mmdoc.

REST API calls are logged in the catalina.log and only if the Debug logging option is enabled.

Before you begin

Open a Web browser and navigate to the URL: http://<hostname>:<port>/MMDoc/. Replace the host and port names with the appropriate values depending on your installation.
You can also access the REST API documentation from the user menu at the top right corner and select REST API.
Use your credentials to log in.
The Talend Data Catalog REST API documentation page is opened and operations are classified into different categories as shown in the capture.

Information noteNote:
For more information on how to use the REST API, click the See General Documentation link to open the embedded REST API General Information page.

For more information about the MQL syntax, go to http://<hostname>:<port>/MMDoc/mql.html. Replace the host and port names with the appropriate values depending on your installation.
Click a category name to display the operation list under the category.

From the categories list:

Select	To
Show/Hide	show or hide the operation list
List Operations	expand or collapse the operation list
Expand Operations	expand the details of the operation

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!