Accessing the Talend Dictionary Service REST API documentation

author
Talend Documentation Team
EnrichVersion
6.5
2.3
EnrichProdName
Talend Data Services Platform
Talend Big Data
Talend Real-Time Big Data Platform
Talend Data Integration
Talend Data Fabric
Talend MDM Platform
Talend Big Data Platform
Talend ESB
Talend Data Management Platform
task
Data Quality and Preparation > Managing semantic types
EnrichPlatform
Talend Data Preparation
Talend Data Stewardship

Accessing the Talend Dictionary Service REST API documentation

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

You can access all REST API documentation pages based on Swagger and run requests.

Procedure

  1. Start Talend Dictionary Service.
  2. Open a Web browser and enter the following URL, where <host> and <port> correspond to the URL of your Talend Dictionary Service instance:
    http://<host>:<port>/swagger-ui.html
    By default, the port used is 8187.

    The Talend Dictionary Service REST API documentation page opens and operations are classified into different categories:

  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
  5. Click user-controller > /user/login and use your credentials to log in.
    In the Response Headers area, you get a bearer authentication.
  6. Start testing the execution of different operations.

    To get results from the executed operations, use the Curl command from the response.

    Include the bearer authentication you got when you logged in as part of your authorization header. For example: curl -X GET --header 'Authorization: Bearer <token>' --header 'Accept: application/json' 'http://localhost:8187/categories?caseSensitive=false&isExact=false'