Save Dataset Relationship
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API adds or updates Dataset Relationship using the provided Dataset Relationship configuration. This API supports bulk save operations and requires import/export object privileges.
Method: POST
Request URL: {kyvos-url}/rest/v2/dataset-relationships/bulk
Authorization
API Key: sessionId
This method authenticates requests using a sessionId 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 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 representing the Dataset Relationship entity. The JSON may contain Dataset Relationship definitions, dataset nodes, join configurations, layout properties, visual settings, metadata, and other DR configurations used to add or update the DR. Note: An example JSON is provided under the Resources section below. | – |
Responses
200 Success
{
"res": {
"code": 0,
"entityId": 177867122905041270250781728601421,
"message": "Successfully updated relationship object: Realationship1",
"extMessage": ""
}
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
403 | User does not have import/export object privileges. |
412 | Precondition failed. Required parameter missing. |
500 | Internal Server Error. |
Resources
JSON Example for Save Dataset Relationship API request body object.