Update Properties of Workbook
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 a Workbook, such as the DESCRIPTION and TAGS properties.
Method: PUT
Request URL: {kyvos-url}/rest/v2/workbooks/{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 Workbook whose properties need to be updated. Note: If the Workbook name is provided, folderName must also be provided in the request body. | – |
Query Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
by | String | Specifies whether the name-or-id path parameter should be interpreted as a Workbook name or ID.
Default: |
|
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
folderName | String | Name of the folder containing the Workbook. If the Workbook is in the root directory, specify [Root]. Note: If folderName is not provided, the Workbook is treated as a root-level entity by default. | – |
propertyJson (Required) | String | JSON containing an array of property names and their values to be updated. Note: A sample JSON is provided under the Resources section below. | – |
Responses
200 Success
{
"code": 0,
"message": "Properties of the workbook updated successfully."
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
412 | Precondition failed. Required 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"
}
]