1Import Semantic Model Conversational Metadata
Overview
This API imports a conversational metadata file into a Semantic Model and updates the model's metadata based on the information provided in the file. Conversational metadata includes descriptions, tags, and key element information for all elements of the Semantic Model.
Method: POST
Request URL: {kyvos-url}/rest/v2/semantic-models/{name-or-id}/import-column-metadata
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 Semantic Model on which metadata needs to be imported. Note: If the Semantic Model name is provided, then folderName 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 folderName is not provided, the Semantic Model will be treated as a root-level entity by default. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
file (Required) | String | Select the CSV file downloaded using the Export Semantic Model Conversational Metadata API. | – |
lineSeparator | String | Characters for line separator. | – |
fieldSeparator | String | Delimiter to be used for each field. | – |
enclosedBy | String | Characters to be used for enclosing data. | – |
Responses
200 Success
{
"code": 0,
"message": "Successfully updated semantic model conversation metadata"
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
412 | Precondition failed. Parameter missing. |
500 | Internal Server Error |
|
|