Accessing Talend Data Stewardship REST API documentation - 7.1

Talend Data Stewardship User Guide

English (United States)
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Real-Time Big Data Platform
Talend Data Stewardship
Administration and Monitoring > Managing users
Data Governance > Assigning tasks
Data Governance > Managing campaigns
Data Governance > Managing data models
Data Quality and Preparation > Handling tasks
Data Quality and Preparation > Managing semantic types

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

You can access all REST API documentation pages based on Swagger and run requests on users, campaigns, schemas, tasks and task history. You can download a JSON file from any of the REST API documentation pages.


  1. Launch all the modules in the Talend Data Stewardship installation folder.
  2. Use your credentials to log in to Talend Data Stewardship at http://<hostname>:<port>. Replace the host and port names with the appropriate values depending on your installation.
  3. Open a web browser and navigate to the URL: http://<host>:<port>/docs/api/swagger-ui.html. Replace the host and port names with the appropriate values depending on your installation.
    The Data Stewardship Service documentation page is opened and operations are classified into different categories as shown in the capture.
  4. Click a category name to display the operation list under the category.
  5. Start testing the execution of different operations.
  6. To access other documentation pages, click in the field on top of the page and select to access the Data Models Service page or the Stewardship History Service page.
    The data model APIs are under Data Models Service and the default namespace for all schema service APIs is org.talend.schema.