Reading descriptions of a dataset

Before you begin

• Make sure that the user that issues API calls has the Dataset - View permission. The ID of this permission is DATASET_READ.
• Make sure that the dataset is already created and that the user that issues API calls knows the ID of this dataset.

About this task

This operation allows you to retrieve all the descriptions of a dataset, for all columns of the dataset.

method: GET
endpoint: https://api.<env>.cloud.talend.com/datasets/{datasetId}/columns
headers: {
 "Authorization": "Bearer <your_personal_access_token>"
}

Procedure

1. Select GET from the Method list and in the field next to it, enter the endpoint to be used: https://api.<env>.cloud.talend.com/datasets/{datasetId}/columns.

2. Replace the placeholder with the correct values:

   Parameter	Value
   datasetId	Dataset for which you want to list all descriptions. You can find the dataset ID with a GET request on https://api.<env>.cloud.talend.com/datasets. It is also available in Talend Cloud applications that use datasets, in the URL of the dataset’s overview page, after /dataset/.

   

3. Click Add header to add a row and enter the following key:value pair:

   • Authorization : Bearer <your_personal_access_token>

4. Send the request.

Results

The descriptions are returned in the response body and the status code 200 is returned. For example:

[
  {
    "path": "Makes.make_id",
    "description": "identifier of the object"
  },
  {
    "path": "Makes.make_display",
    "description": "label to display"
  }
]