1Delete Calculated Measures in Workbook

1Delete Calculated Measures in Workbook

Overview

This API deletes the specified calculated measures in a Workbook.

Method: DELETE

Request URL: {kyvos-url}/rest/v2/workbooks/{name-or-id}/calculated-measures


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

Header Name

Type

Description

Possible Values

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

Parameter Name

Type

Description

Possible Values

name-or-id (Required)

String

Name or ID of the Workbook to be processed.

Note: If the Workbook name is provided, then either folderName or folderId must also be provided.

–


Query Parameters

Parameter Name

Type

Description

Possible Values

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 will be 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

Parameter Name

Type

Description

Possible Values

measureNames

String

Comma-separated names of the calculated measures to delete.

Note: Either measureNames or deleteAll must be provided. If both parameters are specified, deleteAll takes precedence.

–

deleteAll

Boolean

When set to true, all calculated measures in the Workbook are deleted.

true / false

Default: false


Responses

200 Success

{ "code": 0, "message": "Successfully updated workbook: AdvCopy" }

Status Code

Description

Status Code

Description

401

Authorization information is missing or invalid.

404

No matching record found.

412

Precondition failed. Parameter missing.

500

Internal Server Error


Copyright Kyvos, Inc. 2026. All rights reserved.