Get dataset fields

API Endpoint: Retrieve Related Fields

This endpoint retrieves the fields related to a specific dataset identified by its unique ID. It is particularly useful for understanding the structure and attributes of the dataset, allowing users to access metadata that can aid in data analysis and integration tasks.

Request

• Method: GET

• URL: https://{{base_url}}/zde/api/v2/datasets/{datasetId}/related/{relatedDatasetId}/fields

  • Path Parameters:

    • datasetId: The unique identifier of the dataset for which related fields are being requested.

    • relatedDatasetId: The unique identifier of the related dataset.

Response

• Status Code: 200 OK

• Content-Type: application/json

• Response Structure:
  The response is a JSON array containing objects that represent the fields related to the specified dataset. Each object in the array includes the following properties:

  • name: The name of the field.

  • type: The data type of the field.

  • description: A brief description of the field.

  • indexed: A boolean indicating whether the field is indexed.

  • aggregatedIndex: A boolean indicating whether the field is part of an aggregated index.

Example of a response object:

{
  "name": "",
  "type": "",
  "description": "",
  "indexed": true,
  "aggregatedIndex": true
}

This endpoint is essential for users looking to explore the relationships between datasets and their fields, facilitating better data management and utilization.