Accessing Talend Cloud Data Catalog REST API - Cloud

Talend Cloud Data Catalog User Guide

Version
Cloud
Language
English
Product
Talend Cloud
Module
Talend Data Catalog
Content
Data Governance
Last publication date
2023-11-13
REST API simplifies your interaction with the data stored on the Talend Cloud 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.

Before you begin

  • The REST API help option has been enabled.
  • You have been assigned a global role with the REST API Access capability.

Procedure

  1. Open a Web browser and navigate to the URL: https://<TENANT>.datacatalog.<REGION>.cloud.talend.com/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 tool menu at the top right corner and select REST API.
  2. Use your credentials to log in.
    The Talend Cloud Data Catalog REST API documentation page is opened and operations are classified into different categories as shown in the capture.
    Note:

    For more information on how to use the REST API, click the See General Documentation link.

    For more information about the MQL syntax, go to https://<TENANT>.datacatalog.<REGION>.cloud.talend.com/MMDoc/mql.html. Replace the host and port names with the appropriate values depending on your installation.

  3. Click a category name to display the operation list under the category.
  4. 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