Delete Calculated Members
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API deletes calculated members from the specified Semantic Model.
Method: POST
Request URL: {kyvos-url}/rest/v2/semantic-models/{name-or-id}/calculated-members/delete
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 Semantic Model from which the calculated members are to be deleted. Note: If the Semantic Model name is provided, 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 Semantic Model name or Semantic Model ID. If by=name, provide the Semantic Model name in the name-or-id parameter. If by=id, provide the Semantic Model ID in the name-or-id parameter. The default value is name. | – |
folderName | String | Name of the folder containing the Semantic Model. If the Semantic Model is present in the root directory, specify [Root]. Note: If neither folderName nor folderId is provided, the Semantic Model will be treated as a root-level entity by default. | – |
folderId | String | ID of the folder containing the Semantic Model. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
membersJson (Required) | String | An array containing JSON objects with details of the calculated members to be deleted. Note: An example JSON array is provided in the Resources section below. | – |
Responses
200 Success
{
"code": 0,
"message": "Successfully updated semantic model object: RestApiTest"
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
412 | Precondition failed. Required parameter is missing. |
500 | Internal Server Error |
Resources
Below is an example of JSON structure which can be used as a reference for the membersJson parameter in the request body.
[
{
"memberName": "MemberName1",
"dimensionName": "Account-CR",
"type": "ATTRIBUTE",
"attributeName": "Account Number"
}
]JSON Field Definitions
Field | Type | Description | Example / Notes |
|---|---|---|---|
memberName | String | Name of the calculated member to delete. |
|
dimensionName | String | Name of the dimension containing the calculated member. |
|
type | String | Type of calculated member. |
|
attributeName | String | Name of the attribute associated with the calculated member. |
|