Get List of Dataset Relationships

This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here.

This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here.

Overview

This API retrieves the list of Dataset Relationships along with their associated folders from the root directory, with support for filtering, pagination, and search operations.

Method: GET

Request URL: {kyvos-url}/rest/v2/dataset-relationships

Authorization

API Key: `sessionid`

This method authenticates requests using a session ID which acts like an API key.

BasicAuth: HTTP Authorization Scheme

This method authenticates requests using a username and password sent in the HTTP Authorization header.

Headers

Header Name	Type	Description	Possible Values

Header Name

Type

Description

Possible Values

sessionid

String

The session ID is the token received from the Login API.

Note: Session ID is required for token-based authentication.

–

Query Parameters

Parameter Name	Type	Description	Possible Values

Parameter Name	Type	Description	Possible Values
show	String	Determines the type of objects returned in the response. The response can contain folders, Dataset Relationships, or both, based on other filters applied.	all – Returns folders and Dataset Relationships from the root directory. list – Returns only Dataset Relationships from the root directory. folders – Returns only folders. Default: `all`
owner	String	Filters entities by owner (the user who created the entity).	–
tags	String	Filters entities by tags. This filter works only when the entity contains a single tag.	–
searchText	String	Filters entities by their names. All entities whose names contain the searched text are included in the result, irrespective of case.	–
modifiedAfter	String	Returns entities modified after the specified Unix timestamp.	–
modifiedBefore	String	Returns entities modified before the specified Unix timestamp.	–
count	Number	Limits the number of records returned in the response. Applicable only when show=list or show=folders. Note: The `count` parameter is applied only when its value is positive. If a negative value is provided, all available records are returned. Default: `500`.	–
lastEntityName	String	Returns only entities appearing after the specified entity name. Used for pagination.	–
lastEntityId	String	Returns only entities appearing after the specified entity ID. Used for pagination.	–

Responses

200 Success

{
  "folders": [
    {
      "owner": "Admin",
      "name": "0c627g",
      "id": "folder_A836739A-FAB3-26E0-E8ED-5EFB0CB64571",
      "lastModified": "01/12/2026 16:16:50 IST",
      "accessRights": "1",
      "ownerId": "392958299"
    },
    {
      "owner": "admin",
      "name": "2 Portfolio and Bounce Latest",
      "id": "folder_16892292613985127017034158861747",
      "lastModified": "04/09/2026 17:15:31 IST",
      "accessRights": "1",
      "ownerId": "16829355748415127020038186922409"
    }
  ],
  "datasetRelationships": [
    {
      "owner": "admin",
      "name": "ColumnMasking",
      "id": "5201E38A-60D5-3F87-AEC5-74C5F1D93A17",
      "lastModified": "02/27/2026 10:54:30 IST",
      "accessRights": "1",
      "ownerId": "16829355748415127020038186922409",
      "lastModifiedTimestamp": "1772169870993"
    },
    {
      "owner": "admin",
      "name": "dataset_copy",
      "id": "0F516E50-9F0D-EA5A-8787-76D957EB1878",
      "lastModified": "04/15/2026 18:06:03 IST",
      "accessRights": "1",
      "ownerId": "16829355748415127020038186922409",
      "lastModifiedTimestamp": "1776256563936"
    }
  ]
}

Status Code	Description

Status Code	Description
401	Authorization information is missing or invalid.
404	No matching record found.
500	Internal Server Error.