Getting the status of the save operation using the API - Cloud

Talend Cloud Data Stewardship User Guide

Version
Cloud
Language
English
Product
Talend Cloud
Module
Talend Data Stewardship
Content
Administration and Monitoring > Managing users
Data Governance > Assigning tasks
Data Governance > Managing campaigns
Data Governance > Managing data models
Data Quality and Preparation > Handling tasks
Last publication date
2023-08-28

Saving a semantic type in sandbox status as a draft is an asynchronous task. The status of the operation can be checked.

Procedure

  1. If you do not have a personal access token yet, generate one. For further information, see Generating a Personal Access Token.
  2. Open Talend API Tester in your browser.
  3. From the Repository tab, select Get in the Method drop-down list.
  4. Enter the following URL: https://tds.{region}.cloud.talend.com/semanticservice/v2/categories/{{categoryId}}/draft/status

    You'll find a list of the URLs to use for each data center in Talend Cloud regions and URLs.

    {{categoryID}} is the identifier returned when you created the semantic type, for example: 5f80848e51b6b16703a4318d.

  5. Click the Add header button and enter Authorization in the name field and Bearer followed by a whitespace and your token in the value field.
  6. Click the Add header button and enter Cookie in the name field, then leave the value field empty.
  7. Click Send.

Results

When the asynchronous "save as a draft" operation completes, the API returns a 200 HTTP. The response has a status field with the value FINISH, for example:

{
    "id": "5f80848e51b6b16703a4318d",
    "errors": [],
    "status": "FINISH"
}