1Export Semantic Model Conversational Metadata
Overview
This API retrieves conversational metadata for the specified Semantic Model. Conversational metadata includes descriptions, tags, and key element information for all elements of the semantic model.
Method: GET
Request URL: {kyvos-url}/rest/v2/semantic-models/{name-or-id}/export-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 |
|---|---|---|---|
Accept | String | Specifies the media type of the response. |
|
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 from where conversational metadata is to be exported. 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 a 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. | – |
lineSeparator | String | Characters for line separator. | Default: |
fieldSeparator | String | Delimiter to be used for each field. | Default: |
enclosedBy | String | Characters to be used for enclosing data. | Default: |
Responses
200 Success
"Name",
"Type",
"Parent Dimension",
"Parent Hierarchy",
"Tags",
"Business Context",
"Visible",
"Synonym Column"
"weight_1",
"MEASURE",
"",
"",
"",
"",
"YES",
""Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |