Update Dataset Relationship
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API updates an existing Dataset Relationship.
Method: PUT
Request URL: {kyvos-url}/rest/v2/dataset-relationships/{name-or-id}
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 media type of 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 definition used to update the Data Relationship. It can contain relationship properties, datasets, joins, layout settings, and other Data Relationship metadata. Note: An example JSON is provided under the Resources section below. | – |
Responses
200 Success
{
"code": 0,
"message": " Successfully updated relationship object : 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 Update Dataset Relationship API has two common use cases: updating relationships in tabular view, and in graphical view using the layout property. Examples for both are provided in the Resources section below.
Resources
JSON Examples for request body parameter and use cases.