Create Dataset Relationship
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API creates a new Dataset Relationship.
Method: POST
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 |
|---|---|---|---|
Content-Type (Required) | String | Specifies the media type of the request body. |
|
sessionid | String | The session ID is the token received from the Login API. Note: Session ID is required for token-based authentication. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
json (Required) | String | JSON configuration used to create the Dataset Relationship. It contains relationship properties, datasets, joins, layout settings, and other Dataset Relationship metadata. Note: An example JSON is provided in the Resources section. | – |
Responses
200 Success
{
"code": 0,
"message": "Successfully added Dataset Relationship : Ambev Relationship1"
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
412 | Precondition failed. Parameter missing. |
500 | Internal Server Error. |
Use Cases
The Create Dataset Relationship API can be used to create Dataset Relationships using:
Tabular view
Graphical view with the
layoutproperty
Simplified JSON examples (containing only the core fields) for each use case are provided in the Resources section below.
Resources
JSON Examples for request body parameter and use cases.