Export Apache Ossie (Open Semantic Interchange) Metadata
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
The Export Apache Ossie (formerly known as Open Semantic Interchange (OSI)) Metadata REST API exports a semantic model in the Apache Ossie (OSI) YAML format. The generated YAML contains the semantic model definition along with its associated datasets, relationships, AI metadata, and other semantic information that can be consumed by external tools supporting the Apache Ossie (OSI) specification.
The exported file is generated dynamically and returned as a downloadable attachment.
Method: GET
Request URL: {kyvos-url}/rest/v2/semantic-models/{name-or-id}/export-ossie-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 |
|---|---|---|---|
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 unique identifier of the semantic model to export. | – |
Query Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
by | String | Specifies whether the name-or-id path parameter represents the semantic model name or ID. Supported values are name and id. The default value is name. |
|
folderName | String | Name of the folder containing the semantic model. Specify this parameter when multiple semantic models have the same name. | – |
Responses
200 Success
On successful execution, the API returns the generated Apache Ossie (OSI) metadata as a downloadable YAML file.
Response Headers
Header | Description |
|---|---|
Content-Type |
|
Content-Disposition |
|
Response Body
The response body contains the generated OSI YAML document.
The exported OSI YAML may include the following information:
Semantic model
Datasets
Dataset relationships
Metrics
AI metadata
Error Responses
Invalid Parameter
{
"status": 400,
"message": "Invalid value for parameter 'by'."
}Semantic Model Not Found
{
"status": 404,
"message": "Semantic model not found."
}Dataset Relationship Not Found
{
"status": 500,
"message": "Dataset Relationship not found for semantic model 'Sales'."
}Request Examples
Export Using Semantic Model Name
GET /api/v2/semantic-models/Sales/export-ossie-metadataExport Using Semantic Model ID
GET /api/v2/semantic-models/2fd7c9d6/export-ossie-metadata?by=idExport Using Semantic Model Name and Folder
GET /api/v2/semantic-models/Sales/export-ossie-metadata?folderName=Retail