Update Semantic Model of Workbook
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API updates the Semantic Model of the specified Workbook.
Method: PUT
Request URL: {kyvos-url}/rest/v2/workbooks/{name-or-id}/semantic-model
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 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 | Name or ID of the Workbook in which you want to update the Semantic Model. Note: If the Workbook name is provided, then workbookFolderName 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 Workbook name or Workbook ID. If by=name, provide the Workbook name in the name-or-id parameter. If by=id, provide the Workbook ID in the name-or-id parameter. The default value is name. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
workbookFolderName | String | Name of the folder containing the Workbook. If the Workbook is present in the root directory, specify [Root]. Note: If workbookFolderName is not provided, the Workbook will be treated as a root-level entity by default. | – |
smodelName | String | Name of the Semantic Model to be updated in the Workbook. Note: Either smodelName or smodelId must be provided. | – |
smodelId | String | ID of the Semantic Model to be updated in the Workbook. | – |
smodelFolderName | String | Name of the folder containing the Semantic Model. If the Semantic Model is present in the root directory, specify [Root]. Note: If smodelFolderName is not provided, the Semantic Model will be treated as a root-level entity by default. | – |
Responses
200 Success
{
"code": 0,
"message": "Successfully updated workbook: RestApiTesting_copy_rename"
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
412 | Precondition failed. Parameter missing. |
500 | Internal Server Error |