Delete Workbook Parameters
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API deletes specified parameters from a Workbook.
Method: DELETE
Request URL: {kyvos-url}/rest/v2/workbooks/{name-or-id}/parameters
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 from which parameters are to be deleted. Note: If the Workbook name is provided, then either folderName or folderId 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. | – |
folderName | String | Name of the folder containing the Workbook. If the Workbook is present in the root directory, specify [Root]. Note: If neither folderName nor folderId is provided, the Workbook is treated as a root-level entity by default. | – |
folderId | String | ID of the folder containing the Workbook. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
isDeleteAll | Boolean | Indicates whether all Workbook parameters should be removed. When set to true, all parameters are deleted regardless of the values provided in parameterJson. Note: Either parameterJson or isDeleteAll must be provided. If both are specified, isDeleteAll takes precedence. |
Default: |
parameterJson | String | JSON string containing the names of the parameters to be deleted. Note: An example JSON is provided in the Resources section below. | – |
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. |
Resources
Below is an example of JSON structure which can be used as a reference for the parameterJson parameter in the request body.
{
"parametersName": [
"Parameter1",
"CustomDate",
"CustomNumber"
]
}