Accessing Talend Data Stewardship REST API documentation - 6.5

REST API documentation for Talend Data Stewardship

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
Data Governance > Managing campaigns
Data Governance > Managing data models

REST API simplifies your interaction with the data stored on the Talend Data Stewardship 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 users, campaigns, schemas, tasks and task history.


  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 Talend Data Stewardship API 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. 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
  6. Start testing the execution of different operations.
  7. To access other Talend Data Stewardship REST APIs, use the field on top of the page and select to access the task history API documentation page or the schema API documentation page.