1Save Semantic Model
Overview
This API adds or updates a Semantic Model using the provided Semantic Model definition. It supports bulk save operations and requires the user to have Import and Export object privileges.
Method: POST
Request URL: {kyvos-url}/rest/v2/semantic-models/bulk
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. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
json (Required) | String | JSON representation of the Semantic Model to be added or updated. The JSON includes dimensions, hierarchies, measures, measure groups, aggregation strategy, data source mappings, and metadata configuration. Note: An example JSON is provided in the Resources section below. | – |
Responses
200 Success
{
"res": {
"code": 0,
"entityId": 106157,
"message": "Successfully added semantic model object: Accounts",
"extMessage": ""
}
}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
JSON Example for Save Semantic Model request body object.