1Duplicate Semantic Model in Same Folder
Overview
This API creates a duplicate of the Semantic Model within the same folder, along with its associated source entities (Datasets, Dataset Relationships).
Method: POST
Request URL: {kyvos-url}/rest/v2/semantic-models/{name-or-id}/deep-duplicate
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 media type of 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 to duplicate. Note: If the Semantic Model name is specified, either sourceFolderName or sourceFolderId 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. Default value is name. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
sourceFolderName | String | Name of the folder from which the Semantic Model will be duplicated. If the source Semantic Model is present in the root directory, specify [Root]. Note: If neither sourceFolderId nor sourceFolderName is provided, the source Semantic Model will be treated as a root-level entity by default. | – |
sourceFolderId | String | ID of the folder from which the Semantic Model will be duplicated. | – |
entitiesNameSuffix | String | Suffix to be appended to the duplicated Semantic Model name during the duplicate operation. | – |
Responses
200 Success
{
"code":0,
"semanticModels":[
{
"name":"Sales Semantic Model",
"id":"5D31F0D2-419B-8272-1E92-97333080E5D8",
"folderName":"Sales",
"folderId":"folder_17748761184111127067026113331526",
"status":"ADDED"
}
],
"datasets":[
{
"name":"Sales Dataset",
"id":"C1BB455E-4D6C-53F3-5767-99C25D98095F",
"folderName":"Sales Datasets",
"folderId":"folder_17562077963635127049022155488607",
"status":"ADDED"
}
],
"datasetRelationships":[
{
"name":"Sales Relationship",
"id":"41DE2067-B1A5-4A96-7EFE-37171352B426",
"folderName":"Sales Datasets",
"folderId":"folder_17634576804915127077097164585693",
"status":"ADDED"
}
],
"message":"Semantic model copied successfully."
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |