Deep Copy Semantic Model
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API creates a copy of a Semantic Model in the specified target folder, including copies of all associated source entities (Datasets, Dataset Relationships), which are then linked to the new Semantic Model.
Method: POST
Request URL: {kyvos-url}/rest/v2/semantic-models/{name-or-id}/deep-copy
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 source Semantic Model whose deep copy is to be created. Note: If the Semantic Model name is specified, then either sourceFolderName or sourceFolderId must also be provided in the request body. | – |
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. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
sourceFolderName | String | Folder name of the Semantic Model to be copied. If the Semantic Model is present in the root directory, specify Note: If neither sourceFolderId nor sourceFolderName is provided, the source Semantic Model will be treated as a root-level entity by default. | – |
sourceFolderId | String | Folder ID of the source Semantic Model to be copied. | – |
targetSmodelName (Required) | String | Name of the Semantic Model copy to be created. | – |
targetFolderName (Required) | String | Name of the target folder where the Semantic Model copy is created. Note: If you want to copy the Semantic Model to the root directory, specify [Root]. | – |
linkedEntitiesNameSuffix | String | Suffix value that will be appended to all copied source entities. | – |
appendTimeStamp | Boolean | If |
Default: |
overwriteExistingEntities | Boolean | If |
Default: |
Responses
200 Success
{
"code":0,
"semanticModels":[
{
"name":"Sales Semantic Model",
"id":"054A7886-5393-D7C3-683E-098ABECA0AB4",
"folderName":"Sales",
"folderId":"8069D7C4-7B56-DDB4-B047-D94D76361E32",
"status":"ADDED"
}
],
"datasets":[
{
"name":"Sales Dataset",
"id":"817E7A45-7207-DE97-EBF0-DD9CA44DDD18",
"folderName":"Sales",
"folderId":"249536C1-F8F1-B060-A1C4-22F0B446A9FE",
"status":"ADDED"
}
],
"datasetRelationships":[
{
"name":"Sales Relationship",
"id":"DBA2BAF1-0FC6-63B6-33DA-AC63CC373428",
"folderName":"Sales",
"folderId":"A9A2CFD3-1D95-CE23-E68C-8843D02A2D2D",
"status":"ADDED"
}
],
"message":"Semantic model copied successfully."
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
412 | Precondition failed. Parameter missing. |
500 | Internal Server Error |