1Update Properties of Dataset Relationship
Overview
This API updates one or more properties of an existing Dataset Relationship such as DESCRIPTION, TAGS, and other configurable attributes.
Method: POST
Request URL: {kyvos-url}/rest/v2/dataset-relationships/{name-or-id}/entity-properties
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 |
|---|---|---|---|
ContentType (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. | – |
Path Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
name-or-id (Required) | String | The name or ID of the Dataset Relationship whose properties need to be updated. | – |
Query Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
by (Required) | String | Specifies whether the name-or-id parameter should be interpreted as a Dataset Relationship name or a Dataset Relationship ID. If by=name, provide the Dataset Relationship name in the name-or-id parameter. If by=id, provide the Dataset Relationship ID in the name-or-id parameter. The default value is name. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
folderName | String | Name of the folder containing the Dataset Relationship. Note: If folderName is not provided, the Dataset Relationship will be treated as a root-level entity by default. | – |
propertyJson (Required) | String | JSON containing property names and their corresponding values that need to be updated in the Dataset Relationship object. Note: An example JSON is provided under the Resources section below. | – |
Responses
200 Success
{
"code": 0,
"message": "Successfully updated relationship object: Sales Relationship"
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
412 | Precondition failed. Parameter missing. |
500 | Internal Server Error |
Resources
Below is an example of JSON structure which can be used as a reference for the propertyJson parameter in the request body.
[
{
"name": "DESCRIPTION",
"value": "description"
},
{
"name": "TAGS",
"value": "tag"
}
] Description for propertyJson parameter
Name: The name of the property to set for the dataset relationship, such as DESCRIPTION or TAGS.
Value: The value assigned to the specified property. For DESCRIPTION, provide a brief summary of the dataset relationship. For TAGS, provide one or more tags used to categorize and organize the dataset relationship.