1Update Dataset Properties
Overview
This API modifies one or more properties of an existing Dataset, including attributes such as description, tags, etc.
Method: PUT
Request URL: {kyvos-url}/rest/v2/datasets/{name-or-id}/entity-properties
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. | – |
Path Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
name-or-id (Required) | String | Name or ID of the Dataset whose properties need to be updated. Note: If the Dataset name is provided, then folderName must also be provided. | – |
Query Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
by | String | Specifies whether the name-or-id parameter should be interpreted as a Dataset name or a Dataset ID. If by=name, provide the Dataset name in the name-or-id parameter. If by=id, provide the Dataset ID in the name-or-id parameter. The default value is name. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
folderName | String | Specifies the folder containing the Dataset whose properties need to be updated. If the Dataset is present in the root directory, specify [Root]. Note: If folderName is not provided, the Dataset will be treated as a root-level entity by default. | – |
propertyJson (Required) | String | JSON containing an array of property names and their values. Note: An example JSON is provided under the Resources section. | – |
Responses
200 Success
{
"code": 0,
"message": "Properties applied successfully on dataset."
}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, such as DESCRIPTION or TAGS.
Value: The value assigned to the specified property. For DESCRIPTION, provide a brief summary of the dataset. For TAGS, provide one or more tags used to categorize and organize the dataset.