Update Properties of Worksheet
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API updates one or more properties of the specified Worksheet, such as the DESCRIPTION property, TAGS property, and more.
Method: PUT
Request URL: {kyvos-url}/rest/v2/worksheets/{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 Worksheet whose properties need to be updated. Note: If the Worksheet name is provided, then either folderName or folderId must also be provided. In addition, workbookName 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 Worksheet name or Worksheet ID. If by=name, provide the Worksheet name in the name-or-id parameter. If by=id, provide the Worksheet ID in the name-or-id parameter. The default value is name. | – |
workbookName | String | Name of the Workbook containing the Worksheet whose properties need to be updated. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
folderName | String | Name of the folder that contains the Worksheet. If the Worksheet is present in the root directory, specify [Root]. Note: If neither folderName nor folderId is provided, the Worksheet will be treated as a root-level entity by default. | – |
folderId | String | ID of the folder in which the Worksheet is present. | – |
propertyJson (Required) | String | JSON containing an array of property names and their values. Note: An example JSON is provided under the Resources section below. | – |
Responses
200 Success
{
"code": 0,
"message": "Entity properties added successfully."
}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"
}
]