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.
Procedure
-
Launch all the modules in the Talend Data Stewardship installation folder.
-
Open a web browser and enter the following URL where the host
and port values depend on your installation.
http://<host>:<port>/docs/api/swagger-ui.html
The
Data Stewardship API page opens and operations are
classified into different categories.
-
Click a category name to display or hide its operations.
-
Start testing the execution of different operations.
Troubleshooting: Using a URL with a computer name on Swagger will lead to an error
in the generated URL for the service endpoints.
Talend
recommends to use a
localhost URL to access Swagger, for
example:
http://localhost:19999//docs/api/swagger-ui.html.
Otherwise,
the generated URL will look like the following example:
http://<computer-name>.talend.com:19999/data-stewardship/internal/data-stewardship/api/v1/campaigns?taskType=ARBITRATION.
You need to remove the first data-stewardship.
-
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 Data 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.
