Get Uncommitted Writebacks on a Semantic Model
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API retrieves all uncommitted writebacks performed by a user on a Semantic Model.
Method: GET
Request URL: {kyvos-url}/rest/v2/semantic-models/{name-or-id}/writeback
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 |
|---|---|---|---|
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 for which you want to retrieve the uncommitted writebacks. Note: If the Semantic Model 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 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 which contains 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 which contains the Semantic Model. | – |
Responses
200 Success
[
{
"membersDisplayInfo": [
{
"fieldName": "ProductID",
"value": "FUR-ADV-10000002",
"fieldId": "DIM_16!!!DIMENSION_ATTRIBUTE_24"
},
{
"fieldName": "OrderID",
"value": "CG-2014-7660",
"fieldId": "DIM_63!!!DIMENSION_ATTRIBUTE_142"
}
],
"members": [
{
"levelIndex": 1,
"fieldName": "ProductID",
"name": "FUR-ADV-10000002",
"state": "DRILL_LEVEL",
"id": "DIM_16~$~DIMENSION_ATTRIBUTE_24~$~FUR-ADV-10000002",
"type": 0,
"fieldType": "ATTRIBUTE",
"value": "FUR-ADV-10000002",
"fieldId": "DIM_16!!!DIMENSION_ATTRIBUTE_24"
},
{
"levelIndex": 1,
"fieldName": "OrderID",
"name": "CG-2014-7660",
"state": "DRILL_LEVEL",
"id": "DIM_63~$~DIMENSION_ATTRIBUTE_142~$~CG-2014-7660",
"type": 0,
"fieldType": "ATTRIBUTE",
"value": "CG-2014-7660",
"fieldId": "DIM_63!!!DIMENSION_ATTRIBUTE_142"
}
],
"originalValue": "106.08",
"filters": [
],
"updatedValue": "123456",
"prevValue": "106.08"
}
]Error Responses
Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error. |