RenderOsi
curl --request POST \
--url https://developer.synq.io/api/entities/semantic-models/v1alpha/osi/render \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"semanticModel": {
"declarerEntityId": "<string>",
"nativeName": "<string>",
"description": "<string>",
"groups": [
{
"name": "<string>",
"fields": [
{
"name": "<string>",
"nativeName": "<string>",
"nativeType": "<string>",
"description": "<string>",
"ordinalPosition": 123,
"tags": [
{
"tagName": "<string>",
"tagValue": "<string>"
}
],
"definition": {
"nativeKind": "<string>",
"expression": {
"dialects": [
{
"nativeDialect": "<string>",
"expression": "<string>",
"isTruncated": true
}
]
},
"nativeAggregation": "<string>",
"displayFolder": "<string>",
"format": "<string>",
"filter": {
"dialects": [
{
"nativeDialect": "<string>",
"expression": "<string>",
"isTruncated": true
}
]
},
"nonAdditiveDimensions": [
"<string>"
],
"nativeKey": "<string>",
"isTime": true,
"nativeId": "<string>",
"aiContext": {
"text": "<string>",
"instructions": "<string>",
"synonyms": [
"<string>"
],
"examples": [
"<string>"
],
"extraJson": "<string>"
},
"customExtensions": [
{
"vendorName": "<string>",
"data": "<string>"
}
],
"displayName": "<string>"
}
}
],
"displayName": "<string>",
"source": {
"entityId": "<string>"
},
"description": "<string>",
"primaryKey": [
"<string>"
],
"uniqueKeys": [
{
"fields": [
"<string>"
]
}
],
"aiContext": {
"text": "<string>",
"instructions": "<string>",
"synonyms": [
"<string>"
],
"examples": [
"<string>"
],
"extraJson": "<string>"
},
"customExtensions": [
{
"vendorName": "<string>",
"data": "<string>"
}
]
}
],
"relationships": [
{
"name": "<string>",
"from": "<string>",
"fromFields": [
"<string>"
],
"to": "<string>",
"toFields": [
"<string>"
],
"on": {
"dialects": [
{
"nativeDialect": "<string>",
"expression": "<string>",
"isTruncated": true
}
]
},
"nativeJoinType": "<string>",
"aiContext": {
"text": "<string>",
"instructions": "<string>",
"synonyms": [
"<string>"
],
"examples": [
"<string>"
],
"extraJson": "<string>"
},
"customExtensions": [
{
"vendorName": "<string>",
"data": "<string>"
}
]
}
],
"aiContext": {
"text": "<string>",
"instructions": "<string>",
"synonyms": [
"<string>"
],
"examples": [
"<string>"
],
"extraJson": "<string>"
},
"customExtensions": [
{
"vendorName": "<string>",
"data": "<string>"
}
]
}
}
'import requests
url = "https://developer.synq.io/api/entities/semantic-models/v1alpha/osi/render"
payload = { "semanticModel": {
"declarerEntityId": "<string>",
"nativeName": "<string>",
"description": "<string>",
"groups": [
{
"name": "<string>",
"fields": [
{
"name": "<string>",
"nativeName": "<string>",
"nativeType": "<string>",
"description": "<string>",
"ordinalPosition": 123,
"tags": [
{
"tagName": "<string>",
"tagValue": "<string>"
}
],
"definition": {
"nativeKind": "<string>",
"expression": { "dialects": [
{
"nativeDialect": "<string>",
"expression": "<string>",
"isTruncated": True
}
] },
"nativeAggregation": "<string>",
"displayFolder": "<string>",
"format": "<string>",
"filter": { "dialects": [
{
"nativeDialect": "<string>",
"expression": "<string>",
"isTruncated": True
}
] },
"nonAdditiveDimensions": ["<string>"],
"nativeKey": "<string>",
"isTime": True,
"nativeId": "<string>",
"aiContext": {
"text": "<string>",
"instructions": "<string>",
"synonyms": ["<string>"],
"examples": ["<string>"],
"extraJson": "<string>"
},
"customExtensions": [
{
"vendorName": "<string>",
"data": "<string>"
}
],
"displayName": "<string>"
}
}
],
"displayName": "<string>",
"source": { "entityId": "<string>" },
"description": "<string>",
"primaryKey": ["<string>"],
"uniqueKeys": [{ "fields": ["<string>"] }],
"aiContext": {
"text": "<string>",
"instructions": "<string>",
"synonyms": ["<string>"],
"examples": ["<string>"],
"extraJson": "<string>"
},
"customExtensions": [
{
"vendorName": "<string>",
"data": "<string>"
}
]
}
],
"relationships": [
{
"name": "<string>",
"from": "<string>",
"fromFields": ["<string>"],
"to": "<string>",
"toFields": ["<string>"],
"on": { "dialects": [
{
"nativeDialect": "<string>",
"expression": "<string>",
"isTruncated": True
}
] },
"nativeJoinType": "<string>",
"aiContext": {
"text": "<string>",
"instructions": "<string>",
"synonyms": ["<string>"],
"examples": ["<string>"],
"extraJson": "<string>"
},
"customExtensions": [
{
"vendorName": "<string>",
"data": "<string>"
}
]
}
],
"aiContext": {
"text": "<string>",
"instructions": "<string>",
"synonyms": ["<string>"],
"examples": ["<string>"],
"extraJson": "<string>"
},
"customExtensions": [
{
"vendorName": "<string>",
"data": "<string>"
}
]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
semanticModel: {
declarerEntityId: '<string>',
nativeName: '<string>',
description: '<string>',
groups: [
{
name: '<string>',
fields: [
{
name: '<string>',
nativeName: '<string>',
nativeType: '<string>',
description: '<string>',
ordinalPosition: 123,
tags: [{tagName: '<string>', tagValue: '<string>'}],
definition: {
nativeKind: '<string>',
expression: {
dialects: [{nativeDialect: '<string>', expression: '<string>', isTruncated: true}]
},
nativeAggregation: '<string>',
displayFolder: '<string>',
format: '<string>',
filter: {
dialects: [{nativeDialect: '<string>', expression: '<string>', isTruncated: true}]
},
nonAdditiveDimensions: ['<string>'],
nativeKey: '<string>',
isTime: true,
nativeId: '<string>',
aiContext: {
text: '<string>',
instructions: '<string>',
synonyms: ['<string>'],
examples: ['<string>'],
extraJson: '<string>'
},
customExtensions: [{vendorName: '<string>', data: '<string>'}],
displayName: '<string>'
}
}
],
displayName: '<string>',
source: {entityId: '<string>'},
description: '<string>',
primaryKey: ['<string>'],
uniqueKeys: [{fields: ['<string>']}],
aiContext: {
text: '<string>',
instructions: '<string>',
synonyms: ['<string>'],
examples: ['<string>'],
extraJson: '<string>'
},
customExtensions: [{vendorName: '<string>', data: '<string>'}]
}
],
relationships: [
{
name: '<string>',
from: '<string>',
fromFields: ['<string>'],
to: '<string>',
toFields: ['<string>'],
on: {
dialects: [{nativeDialect: '<string>', expression: '<string>', isTruncated: true}]
},
nativeJoinType: '<string>',
aiContext: {
text: '<string>',
instructions: '<string>',
synonyms: ['<string>'],
examples: ['<string>'],
extraJson: '<string>'
},
customExtensions: [{vendorName: '<string>', data: '<string>'}]
}
],
aiContext: {
text: '<string>',
instructions: '<string>',
synonyms: ['<string>'],
examples: ['<string>'],
extraJson: '<string>'
},
customExtensions: [{vendorName: '<string>', data: '<string>'}]
}
})
};
fetch('https://developer.synq.io/api/entities/semantic-models/v1alpha/osi/render', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://developer.synq.io/api/entities/semantic-models/v1alpha/osi/render",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'semanticModel' => [
'declarerEntityId' => '<string>',
'nativeName' => '<string>',
'description' => '<string>',
'groups' => [
[
'name' => '<string>',
'fields' => [
[
'name' => '<string>',
'nativeName' => '<string>',
'nativeType' => '<string>',
'description' => '<string>',
'ordinalPosition' => 123,
'tags' => [
[
'tagName' => '<string>',
'tagValue' => '<string>'
]
],
'definition' => [
'nativeKind' => '<string>',
'expression' => [
'dialects' => [
[
'nativeDialect' => '<string>',
'expression' => '<string>',
'isTruncated' => true
]
]
],
'nativeAggregation' => '<string>',
'displayFolder' => '<string>',
'format' => '<string>',
'filter' => [
'dialects' => [
[
'nativeDialect' => '<string>',
'expression' => '<string>',
'isTruncated' => true
]
]
],
'nonAdditiveDimensions' => [
'<string>'
],
'nativeKey' => '<string>',
'isTime' => true,
'nativeId' => '<string>',
'aiContext' => [
'text' => '<string>',
'instructions' => '<string>',
'synonyms' => [
'<string>'
],
'examples' => [
'<string>'
],
'extraJson' => '<string>'
],
'customExtensions' => [
[
'vendorName' => '<string>',
'data' => '<string>'
]
],
'displayName' => '<string>'
]
]
],
'displayName' => '<string>',
'source' => [
'entityId' => '<string>'
],
'description' => '<string>',
'primaryKey' => [
'<string>'
],
'uniqueKeys' => [
[
'fields' => [
'<string>'
]
]
],
'aiContext' => [
'text' => '<string>',
'instructions' => '<string>',
'synonyms' => [
'<string>'
],
'examples' => [
'<string>'
],
'extraJson' => '<string>'
],
'customExtensions' => [
[
'vendorName' => '<string>',
'data' => '<string>'
]
]
]
],
'relationships' => [
[
'name' => '<string>',
'from' => '<string>',
'fromFields' => [
'<string>'
],
'to' => '<string>',
'toFields' => [
'<string>'
],
'on' => [
'dialects' => [
[
'nativeDialect' => '<string>',
'expression' => '<string>',
'isTruncated' => true
]
]
],
'nativeJoinType' => '<string>',
'aiContext' => [
'text' => '<string>',
'instructions' => '<string>',
'synonyms' => [
'<string>'
],
'examples' => [
'<string>'
],
'extraJson' => '<string>'
],
'customExtensions' => [
[
'vendorName' => '<string>',
'data' => '<string>'
]
]
]
],
'aiContext' => [
'text' => '<string>',
'instructions' => '<string>',
'synonyms' => [
'<string>'
],
'examples' => [
'<string>'
],
'extraJson' => '<string>'
],
'customExtensions' => [
[
'vendorName' => '<string>',
'data' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://developer.synq.io/api/entities/semantic-models/v1alpha/osi/render"
payload := strings.NewReader("{\n \"semanticModel\": {\n \"declarerEntityId\": \"<string>\",\n \"nativeName\": \"<string>\",\n \"description\": \"<string>\",\n \"groups\": [\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"nativeName\": \"<string>\",\n \"nativeType\": \"<string>\",\n \"description\": \"<string>\",\n \"ordinalPosition\": 123,\n \"tags\": [\n {\n \"tagName\": \"<string>\",\n \"tagValue\": \"<string>\"\n }\n ],\n \"definition\": {\n \"nativeKind\": \"<string>\",\n \"expression\": {\n \"dialects\": [\n {\n \"nativeDialect\": \"<string>\",\n \"expression\": \"<string>\",\n \"isTruncated\": true\n }\n ]\n },\n \"nativeAggregation\": \"<string>\",\n \"displayFolder\": \"<string>\",\n \"format\": \"<string>\",\n \"filter\": {\n \"dialects\": [\n {\n \"nativeDialect\": \"<string>\",\n \"expression\": \"<string>\",\n \"isTruncated\": true\n }\n ]\n },\n \"nonAdditiveDimensions\": [\n \"<string>\"\n ],\n \"nativeKey\": \"<string>\",\n \"isTime\": true,\n \"nativeId\": \"<string>\",\n \"aiContext\": {\n \"text\": \"<string>\",\n \"instructions\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"examples\": [\n \"<string>\"\n ],\n \"extraJson\": \"<string>\"\n },\n \"customExtensions\": [\n {\n \"vendorName\": \"<string>\",\n \"data\": \"<string>\"\n }\n ],\n \"displayName\": \"<string>\"\n }\n }\n ],\n \"displayName\": \"<string>\",\n \"source\": {\n \"entityId\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"primaryKey\": [\n \"<string>\"\n ],\n \"uniqueKeys\": [\n {\n \"fields\": [\n \"<string>\"\n ]\n }\n ],\n \"aiContext\": {\n \"text\": \"<string>\",\n \"instructions\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"examples\": [\n \"<string>\"\n ],\n \"extraJson\": \"<string>\"\n },\n \"customExtensions\": [\n {\n \"vendorName\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n }\n ],\n \"relationships\": [\n {\n \"name\": \"<string>\",\n \"from\": \"<string>\",\n \"fromFields\": [\n \"<string>\"\n ],\n \"to\": \"<string>\",\n \"toFields\": [\n \"<string>\"\n ],\n \"on\": {\n \"dialects\": [\n {\n \"nativeDialect\": \"<string>\",\n \"expression\": \"<string>\",\n \"isTruncated\": true\n }\n ]\n },\n \"nativeJoinType\": \"<string>\",\n \"aiContext\": {\n \"text\": \"<string>\",\n \"instructions\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"examples\": [\n \"<string>\"\n ],\n \"extraJson\": \"<string>\"\n },\n \"customExtensions\": [\n {\n \"vendorName\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n }\n ],\n \"aiContext\": {\n \"text\": \"<string>\",\n \"instructions\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"examples\": [\n \"<string>\"\n ],\n \"extraJson\": \"<string>\"\n },\n \"customExtensions\": [\n {\n \"vendorName\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://developer.synq.io/api/entities/semantic-models/v1alpha/osi/render")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"semanticModel\": {\n \"declarerEntityId\": \"<string>\",\n \"nativeName\": \"<string>\",\n \"description\": \"<string>\",\n \"groups\": [\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"nativeName\": \"<string>\",\n \"nativeType\": \"<string>\",\n \"description\": \"<string>\",\n \"ordinalPosition\": 123,\n \"tags\": [\n {\n \"tagName\": \"<string>\",\n \"tagValue\": \"<string>\"\n }\n ],\n \"definition\": {\n \"nativeKind\": \"<string>\",\n \"expression\": {\n \"dialects\": [\n {\n \"nativeDialect\": \"<string>\",\n \"expression\": \"<string>\",\n \"isTruncated\": true\n }\n ]\n },\n \"nativeAggregation\": \"<string>\",\n \"displayFolder\": \"<string>\",\n \"format\": \"<string>\",\n \"filter\": {\n \"dialects\": [\n {\n \"nativeDialect\": \"<string>\",\n \"expression\": \"<string>\",\n \"isTruncated\": true\n }\n ]\n },\n \"nonAdditiveDimensions\": [\n \"<string>\"\n ],\n \"nativeKey\": \"<string>\",\n \"isTime\": true,\n \"nativeId\": \"<string>\",\n \"aiContext\": {\n \"text\": \"<string>\",\n \"instructions\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"examples\": [\n \"<string>\"\n ],\n \"extraJson\": \"<string>\"\n },\n \"customExtensions\": [\n {\n \"vendorName\": \"<string>\",\n \"data\": \"<string>\"\n }\n ],\n \"displayName\": \"<string>\"\n }\n }\n ],\n \"displayName\": \"<string>\",\n \"source\": {\n \"entityId\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"primaryKey\": [\n \"<string>\"\n ],\n \"uniqueKeys\": [\n {\n \"fields\": [\n \"<string>\"\n ]\n }\n ],\n \"aiContext\": {\n \"text\": \"<string>\",\n \"instructions\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"examples\": [\n \"<string>\"\n ],\n \"extraJson\": \"<string>\"\n },\n \"customExtensions\": [\n {\n \"vendorName\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n }\n ],\n \"relationships\": [\n {\n \"name\": \"<string>\",\n \"from\": \"<string>\",\n \"fromFields\": [\n \"<string>\"\n ],\n \"to\": \"<string>\",\n \"toFields\": [\n \"<string>\"\n ],\n \"on\": {\n \"dialects\": [\n {\n \"nativeDialect\": \"<string>\",\n \"expression\": \"<string>\",\n \"isTruncated\": true\n }\n ]\n },\n \"nativeJoinType\": \"<string>\",\n \"aiContext\": {\n \"text\": \"<string>\",\n \"instructions\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"examples\": [\n \"<string>\"\n ],\n \"extraJson\": \"<string>\"\n },\n \"customExtensions\": [\n {\n \"vendorName\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n }\n ],\n \"aiContext\": {\n \"text\": \"<string>\",\n \"instructions\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"examples\": [\n \"<string>\"\n ],\n \"extraJson\": \"<string>\"\n },\n \"customExtensions\": [\n {\n \"vendorName\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/entities/semantic-models/v1alpha/osi/render")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"semanticModel\": {\n \"declarerEntityId\": \"<string>\",\n \"nativeName\": \"<string>\",\n \"description\": \"<string>\",\n \"groups\": [\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"nativeName\": \"<string>\",\n \"nativeType\": \"<string>\",\n \"description\": \"<string>\",\n \"ordinalPosition\": 123,\n \"tags\": [\n {\n \"tagName\": \"<string>\",\n \"tagValue\": \"<string>\"\n }\n ],\n \"definition\": {\n \"nativeKind\": \"<string>\",\n \"expression\": {\n \"dialects\": [\n {\n \"nativeDialect\": \"<string>\",\n \"expression\": \"<string>\",\n \"isTruncated\": true\n }\n ]\n },\n \"nativeAggregation\": \"<string>\",\n \"displayFolder\": \"<string>\",\n \"format\": \"<string>\",\n \"filter\": {\n \"dialects\": [\n {\n \"nativeDialect\": \"<string>\",\n \"expression\": \"<string>\",\n \"isTruncated\": true\n }\n ]\n },\n \"nonAdditiveDimensions\": [\n \"<string>\"\n ],\n \"nativeKey\": \"<string>\",\n \"isTime\": true,\n \"nativeId\": \"<string>\",\n \"aiContext\": {\n \"text\": \"<string>\",\n \"instructions\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"examples\": [\n \"<string>\"\n ],\n \"extraJson\": \"<string>\"\n },\n \"customExtensions\": [\n {\n \"vendorName\": \"<string>\",\n \"data\": \"<string>\"\n }\n ],\n \"displayName\": \"<string>\"\n }\n }\n ],\n \"displayName\": \"<string>\",\n \"source\": {\n \"entityId\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"primaryKey\": [\n \"<string>\"\n ],\n \"uniqueKeys\": [\n {\n \"fields\": [\n \"<string>\"\n ]\n }\n ],\n \"aiContext\": {\n \"text\": \"<string>\",\n \"instructions\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"examples\": [\n \"<string>\"\n ],\n \"extraJson\": \"<string>\"\n },\n \"customExtensions\": [\n {\n \"vendorName\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n }\n ],\n \"relationships\": [\n {\n \"name\": \"<string>\",\n \"from\": \"<string>\",\n \"fromFields\": [\n \"<string>\"\n ],\n \"to\": \"<string>\",\n \"toFields\": [\n \"<string>\"\n ],\n \"on\": {\n \"dialects\": [\n {\n \"nativeDialect\": \"<string>\",\n \"expression\": \"<string>\",\n \"isTruncated\": true\n }\n ]\n },\n \"nativeJoinType\": \"<string>\",\n \"aiContext\": {\n \"text\": \"<string>\",\n \"instructions\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"examples\": [\n \"<string>\"\n ],\n \"extraJson\": \"<string>\"\n },\n \"customExtensions\": [\n {\n \"vendorName\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n }\n ],\n \"aiContext\": {\n \"text\": \"<string>\",\n \"instructions\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"examples\": [\n \"<string>\"\n ],\n \"extraJson\": \"<string>\"\n },\n \"customExtensions\": [\n {\n \"vendorName\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"document": {
"osiVersion": "<string>",
"document": "<string>"
}
}synq.entities.semantic_models.v1alpha.OsiService
RenderOsi
Render a semantic model as an OSI document. The document is always YAML.
The document is always valid OSI. When the model has no value for a property that OSI requires, the document has a fallback value: a field with no expression gets its own name as the expression, and a group with no source gets its name as the source. What OSI has no property for is kept in a custom extension with the vendor name COALESCE, so ParseOsi gives back the same model.
Give the whole model. A model read with field_names or without the definitions renders each measure as a plain column. To get the OSI document of an entity, call SemanticModelsService.BatchGetSemanticModels with SEMANTIC_MODEL_FORMAT_OSI.
POST
/
api
/
entities
/
semantic-models
/
v1alpha
/
osi
/
render
RenderOsi
curl --request POST \
--url https://developer.synq.io/api/entities/semantic-models/v1alpha/osi/render \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"semanticModel": {
"declarerEntityId": "<string>",
"nativeName": "<string>",
"description": "<string>",
"groups": [
{
"name": "<string>",
"fields": [
{
"name": "<string>",
"nativeName": "<string>",
"nativeType": "<string>",
"description": "<string>",
"ordinalPosition": 123,
"tags": [
{
"tagName": "<string>",
"tagValue": "<string>"
}
],
"definition": {
"nativeKind": "<string>",
"expression": {
"dialects": [
{
"nativeDialect": "<string>",
"expression": "<string>",
"isTruncated": true
}
]
},
"nativeAggregation": "<string>",
"displayFolder": "<string>",
"format": "<string>",
"filter": {
"dialects": [
{
"nativeDialect": "<string>",
"expression": "<string>",
"isTruncated": true
}
]
},
"nonAdditiveDimensions": [
"<string>"
],
"nativeKey": "<string>",
"isTime": true,
"nativeId": "<string>",
"aiContext": {
"text": "<string>",
"instructions": "<string>",
"synonyms": [
"<string>"
],
"examples": [
"<string>"
],
"extraJson": "<string>"
},
"customExtensions": [
{
"vendorName": "<string>",
"data": "<string>"
}
],
"displayName": "<string>"
}
}
],
"displayName": "<string>",
"source": {
"entityId": "<string>"
},
"description": "<string>",
"primaryKey": [
"<string>"
],
"uniqueKeys": [
{
"fields": [
"<string>"
]
}
],
"aiContext": {
"text": "<string>",
"instructions": "<string>",
"synonyms": [
"<string>"
],
"examples": [
"<string>"
],
"extraJson": "<string>"
},
"customExtensions": [
{
"vendorName": "<string>",
"data": "<string>"
}
]
}
],
"relationships": [
{
"name": "<string>",
"from": "<string>",
"fromFields": [
"<string>"
],
"to": "<string>",
"toFields": [
"<string>"
],
"on": {
"dialects": [
{
"nativeDialect": "<string>",
"expression": "<string>",
"isTruncated": true
}
]
},
"nativeJoinType": "<string>",
"aiContext": {
"text": "<string>",
"instructions": "<string>",
"synonyms": [
"<string>"
],
"examples": [
"<string>"
],
"extraJson": "<string>"
},
"customExtensions": [
{
"vendorName": "<string>",
"data": "<string>"
}
]
}
],
"aiContext": {
"text": "<string>",
"instructions": "<string>",
"synonyms": [
"<string>"
],
"examples": [
"<string>"
],
"extraJson": "<string>"
},
"customExtensions": [
{
"vendorName": "<string>",
"data": "<string>"
}
]
}
}
'import requests
url = "https://developer.synq.io/api/entities/semantic-models/v1alpha/osi/render"
payload = { "semanticModel": {
"declarerEntityId": "<string>",
"nativeName": "<string>",
"description": "<string>",
"groups": [
{
"name": "<string>",
"fields": [
{
"name": "<string>",
"nativeName": "<string>",
"nativeType": "<string>",
"description": "<string>",
"ordinalPosition": 123,
"tags": [
{
"tagName": "<string>",
"tagValue": "<string>"
}
],
"definition": {
"nativeKind": "<string>",
"expression": { "dialects": [
{
"nativeDialect": "<string>",
"expression": "<string>",
"isTruncated": True
}
] },
"nativeAggregation": "<string>",
"displayFolder": "<string>",
"format": "<string>",
"filter": { "dialects": [
{
"nativeDialect": "<string>",
"expression": "<string>",
"isTruncated": True
}
] },
"nonAdditiveDimensions": ["<string>"],
"nativeKey": "<string>",
"isTime": True,
"nativeId": "<string>",
"aiContext": {
"text": "<string>",
"instructions": "<string>",
"synonyms": ["<string>"],
"examples": ["<string>"],
"extraJson": "<string>"
},
"customExtensions": [
{
"vendorName": "<string>",
"data": "<string>"
}
],
"displayName": "<string>"
}
}
],
"displayName": "<string>",
"source": { "entityId": "<string>" },
"description": "<string>",
"primaryKey": ["<string>"],
"uniqueKeys": [{ "fields": ["<string>"] }],
"aiContext": {
"text": "<string>",
"instructions": "<string>",
"synonyms": ["<string>"],
"examples": ["<string>"],
"extraJson": "<string>"
},
"customExtensions": [
{
"vendorName": "<string>",
"data": "<string>"
}
]
}
],
"relationships": [
{
"name": "<string>",
"from": "<string>",
"fromFields": ["<string>"],
"to": "<string>",
"toFields": ["<string>"],
"on": { "dialects": [
{
"nativeDialect": "<string>",
"expression": "<string>",
"isTruncated": True
}
] },
"nativeJoinType": "<string>",
"aiContext": {
"text": "<string>",
"instructions": "<string>",
"synonyms": ["<string>"],
"examples": ["<string>"],
"extraJson": "<string>"
},
"customExtensions": [
{
"vendorName": "<string>",
"data": "<string>"
}
]
}
],
"aiContext": {
"text": "<string>",
"instructions": "<string>",
"synonyms": ["<string>"],
"examples": ["<string>"],
"extraJson": "<string>"
},
"customExtensions": [
{
"vendorName": "<string>",
"data": "<string>"
}
]
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
semanticModel: {
declarerEntityId: '<string>',
nativeName: '<string>',
description: '<string>',
groups: [
{
name: '<string>',
fields: [
{
name: '<string>',
nativeName: '<string>',
nativeType: '<string>',
description: '<string>',
ordinalPosition: 123,
tags: [{tagName: '<string>', tagValue: '<string>'}],
definition: {
nativeKind: '<string>',
expression: {
dialects: [{nativeDialect: '<string>', expression: '<string>', isTruncated: true}]
},
nativeAggregation: '<string>',
displayFolder: '<string>',
format: '<string>',
filter: {
dialects: [{nativeDialect: '<string>', expression: '<string>', isTruncated: true}]
},
nonAdditiveDimensions: ['<string>'],
nativeKey: '<string>',
isTime: true,
nativeId: '<string>',
aiContext: {
text: '<string>',
instructions: '<string>',
synonyms: ['<string>'],
examples: ['<string>'],
extraJson: '<string>'
},
customExtensions: [{vendorName: '<string>', data: '<string>'}],
displayName: '<string>'
}
}
],
displayName: '<string>',
source: {entityId: '<string>'},
description: '<string>',
primaryKey: ['<string>'],
uniqueKeys: [{fields: ['<string>']}],
aiContext: {
text: '<string>',
instructions: '<string>',
synonyms: ['<string>'],
examples: ['<string>'],
extraJson: '<string>'
},
customExtensions: [{vendorName: '<string>', data: '<string>'}]
}
],
relationships: [
{
name: '<string>',
from: '<string>',
fromFields: ['<string>'],
to: '<string>',
toFields: ['<string>'],
on: {
dialects: [{nativeDialect: '<string>', expression: '<string>', isTruncated: true}]
},
nativeJoinType: '<string>',
aiContext: {
text: '<string>',
instructions: '<string>',
synonyms: ['<string>'],
examples: ['<string>'],
extraJson: '<string>'
},
customExtensions: [{vendorName: '<string>', data: '<string>'}]
}
],
aiContext: {
text: '<string>',
instructions: '<string>',
synonyms: ['<string>'],
examples: ['<string>'],
extraJson: '<string>'
},
customExtensions: [{vendorName: '<string>', data: '<string>'}]
}
})
};
fetch('https://developer.synq.io/api/entities/semantic-models/v1alpha/osi/render', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://developer.synq.io/api/entities/semantic-models/v1alpha/osi/render",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'semanticModel' => [
'declarerEntityId' => '<string>',
'nativeName' => '<string>',
'description' => '<string>',
'groups' => [
[
'name' => '<string>',
'fields' => [
[
'name' => '<string>',
'nativeName' => '<string>',
'nativeType' => '<string>',
'description' => '<string>',
'ordinalPosition' => 123,
'tags' => [
[
'tagName' => '<string>',
'tagValue' => '<string>'
]
],
'definition' => [
'nativeKind' => '<string>',
'expression' => [
'dialects' => [
[
'nativeDialect' => '<string>',
'expression' => '<string>',
'isTruncated' => true
]
]
],
'nativeAggregation' => '<string>',
'displayFolder' => '<string>',
'format' => '<string>',
'filter' => [
'dialects' => [
[
'nativeDialect' => '<string>',
'expression' => '<string>',
'isTruncated' => true
]
]
],
'nonAdditiveDimensions' => [
'<string>'
],
'nativeKey' => '<string>',
'isTime' => true,
'nativeId' => '<string>',
'aiContext' => [
'text' => '<string>',
'instructions' => '<string>',
'synonyms' => [
'<string>'
],
'examples' => [
'<string>'
],
'extraJson' => '<string>'
],
'customExtensions' => [
[
'vendorName' => '<string>',
'data' => '<string>'
]
],
'displayName' => '<string>'
]
]
],
'displayName' => '<string>',
'source' => [
'entityId' => '<string>'
],
'description' => '<string>',
'primaryKey' => [
'<string>'
],
'uniqueKeys' => [
[
'fields' => [
'<string>'
]
]
],
'aiContext' => [
'text' => '<string>',
'instructions' => '<string>',
'synonyms' => [
'<string>'
],
'examples' => [
'<string>'
],
'extraJson' => '<string>'
],
'customExtensions' => [
[
'vendorName' => '<string>',
'data' => '<string>'
]
]
]
],
'relationships' => [
[
'name' => '<string>',
'from' => '<string>',
'fromFields' => [
'<string>'
],
'to' => '<string>',
'toFields' => [
'<string>'
],
'on' => [
'dialects' => [
[
'nativeDialect' => '<string>',
'expression' => '<string>',
'isTruncated' => true
]
]
],
'nativeJoinType' => '<string>',
'aiContext' => [
'text' => '<string>',
'instructions' => '<string>',
'synonyms' => [
'<string>'
],
'examples' => [
'<string>'
],
'extraJson' => '<string>'
],
'customExtensions' => [
[
'vendorName' => '<string>',
'data' => '<string>'
]
]
]
],
'aiContext' => [
'text' => '<string>',
'instructions' => '<string>',
'synonyms' => [
'<string>'
],
'examples' => [
'<string>'
],
'extraJson' => '<string>'
],
'customExtensions' => [
[
'vendorName' => '<string>',
'data' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://developer.synq.io/api/entities/semantic-models/v1alpha/osi/render"
payload := strings.NewReader("{\n \"semanticModel\": {\n \"declarerEntityId\": \"<string>\",\n \"nativeName\": \"<string>\",\n \"description\": \"<string>\",\n \"groups\": [\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"nativeName\": \"<string>\",\n \"nativeType\": \"<string>\",\n \"description\": \"<string>\",\n \"ordinalPosition\": 123,\n \"tags\": [\n {\n \"tagName\": \"<string>\",\n \"tagValue\": \"<string>\"\n }\n ],\n \"definition\": {\n \"nativeKind\": \"<string>\",\n \"expression\": {\n \"dialects\": [\n {\n \"nativeDialect\": \"<string>\",\n \"expression\": \"<string>\",\n \"isTruncated\": true\n }\n ]\n },\n \"nativeAggregation\": \"<string>\",\n \"displayFolder\": \"<string>\",\n \"format\": \"<string>\",\n \"filter\": {\n \"dialects\": [\n {\n \"nativeDialect\": \"<string>\",\n \"expression\": \"<string>\",\n \"isTruncated\": true\n }\n ]\n },\n \"nonAdditiveDimensions\": [\n \"<string>\"\n ],\n \"nativeKey\": \"<string>\",\n \"isTime\": true,\n \"nativeId\": \"<string>\",\n \"aiContext\": {\n \"text\": \"<string>\",\n \"instructions\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"examples\": [\n \"<string>\"\n ],\n \"extraJson\": \"<string>\"\n },\n \"customExtensions\": [\n {\n \"vendorName\": \"<string>\",\n \"data\": \"<string>\"\n }\n ],\n \"displayName\": \"<string>\"\n }\n }\n ],\n \"displayName\": \"<string>\",\n \"source\": {\n \"entityId\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"primaryKey\": [\n \"<string>\"\n ],\n \"uniqueKeys\": [\n {\n \"fields\": [\n \"<string>\"\n ]\n }\n ],\n \"aiContext\": {\n \"text\": \"<string>\",\n \"instructions\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"examples\": [\n \"<string>\"\n ],\n \"extraJson\": \"<string>\"\n },\n \"customExtensions\": [\n {\n \"vendorName\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n }\n ],\n \"relationships\": [\n {\n \"name\": \"<string>\",\n \"from\": \"<string>\",\n \"fromFields\": [\n \"<string>\"\n ],\n \"to\": \"<string>\",\n \"toFields\": [\n \"<string>\"\n ],\n \"on\": {\n \"dialects\": [\n {\n \"nativeDialect\": \"<string>\",\n \"expression\": \"<string>\",\n \"isTruncated\": true\n }\n ]\n },\n \"nativeJoinType\": \"<string>\",\n \"aiContext\": {\n \"text\": \"<string>\",\n \"instructions\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"examples\": [\n \"<string>\"\n ],\n \"extraJson\": \"<string>\"\n },\n \"customExtensions\": [\n {\n \"vendorName\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n }\n ],\n \"aiContext\": {\n \"text\": \"<string>\",\n \"instructions\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"examples\": [\n \"<string>\"\n ],\n \"extraJson\": \"<string>\"\n },\n \"customExtensions\": [\n {\n \"vendorName\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://developer.synq.io/api/entities/semantic-models/v1alpha/osi/render")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"semanticModel\": {\n \"declarerEntityId\": \"<string>\",\n \"nativeName\": \"<string>\",\n \"description\": \"<string>\",\n \"groups\": [\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"nativeName\": \"<string>\",\n \"nativeType\": \"<string>\",\n \"description\": \"<string>\",\n \"ordinalPosition\": 123,\n \"tags\": [\n {\n \"tagName\": \"<string>\",\n \"tagValue\": \"<string>\"\n }\n ],\n \"definition\": {\n \"nativeKind\": \"<string>\",\n \"expression\": {\n \"dialects\": [\n {\n \"nativeDialect\": \"<string>\",\n \"expression\": \"<string>\",\n \"isTruncated\": true\n }\n ]\n },\n \"nativeAggregation\": \"<string>\",\n \"displayFolder\": \"<string>\",\n \"format\": \"<string>\",\n \"filter\": {\n \"dialects\": [\n {\n \"nativeDialect\": \"<string>\",\n \"expression\": \"<string>\",\n \"isTruncated\": true\n }\n ]\n },\n \"nonAdditiveDimensions\": [\n \"<string>\"\n ],\n \"nativeKey\": \"<string>\",\n \"isTime\": true,\n \"nativeId\": \"<string>\",\n \"aiContext\": {\n \"text\": \"<string>\",\n \"instructions\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"examples\": [\n \"<string>\"\n ],\n \"extraJson\": \"<string>\"\n },\n \"customExtensions\": [\n {\n \"vendorName\": \"<string>\",\n \"data\": \"<string>\"\n }\n ],\n \"displayName\": \"<string>\"\n }\n }\n ],\n \"displayName\": \"<string>\",\n \"source\": {\n \"entityId\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"primaryKey\": [\n \"<string>\"\n ],\n \"uniqueKeys\": [\n {\n \"fields\": [\n \"<string>\"\n ]\n }\n ],\n \"aiContext\": {\n \"text\": \"<string>\",\n \"instructions\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"examples\": [\n \"<string>\"\n ],\n \"extraJson\": \"<string>\"\n },\n \"customExtensions\": [\n {\n \"vendorName\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n }\n ],\n \"relationships\": [\n {\n \"name\": \"<string>\",\n \"from\": \"<string>\",\n \"fromFields\": [\n \"<string>\"\n ],\n \"to\": \"<string>\",\n \"toFields\": [\n \"<string>\"\n ],\n \"on\": {\n \"dialects\": [\n {\n \"nativeDialect\": \"<string>\",\n \"expression\": \"<string>\",\n \"isTruncated\": true\n }\n ]\n },\n \"nativeJoinType\": \"<string>\",\n \"aiContext\": {\n \"text\": \"<string>\",\n \"instructions\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"examples\": [\n \"<string>\"\n ],\n \"extraJson\": \"<string>\"\n },\n \"customExtensions\": [\n {\n \"vendorName\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n }\n ],\n \"aiContext\": {\n \"text\": \"<string>\",\n \"instructions\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"examples\": [\n \"<string>\"\n ],\n \"extraJson\": \"<string>\"\n },\n \"customExtensions\": [\n {\n \"vendorName\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/entities/semantic-models/v1alpha/osi/render")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"semanticModel\": {\n \"declarerEntityId\": \"<string>\",\n \"nativeName\": \"<string>\",\n \"description\": \"<string>\",\n \"groups\": [\n {\n \"name\": \"<string>\",\n \"fields\": [\n {\n \"name\": \"<string>\",\n \"nativeName\": \"<string>\",\n \"nativeType\": \"<string>\",\n \"description\": \"<string>\",\n \"ordinalPosition\": 123,\n \"tags\": [\n {\n \"tagName\": \"<string>\",\n \"tagValue\": \"<string>\"\n }\n ],\n \"definition\": {\n \"nativeKind\": \"<string>\",\n \"expression\": {\n \"dialects\": [\n {\n \"nativeDialect\": \"<string>\",\n \"expression\": \"<string>\",\n \"isTruncated\": true\n }\n ]\n },\n \"nativeAggregation\": \"<string>\",\n \"displayFolder\": \"<string>\",\n \"format\": \"<string>\",\n \"filter\": {\n \"dialects\": [\n {\n \"nativeDialect\": \"<string>\",\n \"expression\": \"<string>\",\n \"isTruncated\": true\n }\n ]\n },\n \"nonAdditiveDimensions\": [\n \"<string>\"\n ],\n \"nativeKey\": \"<string>\",\n \"isTime\": true,\n \"nativeId\": \"<string>\",\n \"aiContext\": {\n \"text\": \"<string>\",\n \"instructions\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"examples\": [\n \"<string>\"\n ],\n \"extraJson\": \"<string>\"\n },\n \"customExtensions\": [\n {\n \"vendorName\": \"<string>\",\n \"data\": \"<string>\"\n }\n ],\n \"displayName\": \"<string>\"\n }\n }\n ],\n \"displayName\": \"<string>\",\n \"source\": {\n \"entityId\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"primaryKey\": [\n \"<string>\"\n ],\n \"uniqueKeys\": [\n {\n \"fields\": [\n \"<string>\"\n ]\n }\n ],\n \"aiContext\": {\n \"text\": \"<string>\",\n \"instructions\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"examples\": [\n \"<string>\"\n ],\n \"extraJson\": \"<string>\"\n },\n \"customExtensions\": [\n {\n \"vendorName\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n }\n ],\n \"relationships\": [\n {\n \"name\": \"<string>\",\n \"from\": \"<string>\",\n \"fromFields\": [\n \"<string>\"\n ],\n \"to\": \"<string>\",\n \"toFields\": [\n \"<string>\"\n ],\n \"on\": {\n \"dialects\": [\n {\n \"nativeDialect\": \"<string>\",\n \"expression\": \"<string>\",\n \"isTruncated\": true\n }\n ]\n },\n \"nativeJoinType\": \"<string>\",\n \"aiContext\": {\n \"text\": \"<string>\",\n \"instructions\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"examples\": [\n \"<string>\"\n ],\n \"extraJson\": \"<string>\"\n },\n \"customExtensions\": [\n {\n \"vendorName\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n }\n ],\n \"aiContext\": {\n \"text\": \"<string>\",\n \"instructions\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"examples\": [\n \"<string>\"\n ],\n \"extraJson\": \"<string>\"\n },\n \"customExtensions\": [\n {\n \"vendorName\": \"<string>\",\n \"data\": \"<string>\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"document": {
"osiVersion": "<string>",
"document": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The semantic model to render.
Show child attributes
Show child attributes
Response
200 - application/json
Success
The OSI document, in YAML, with the OSI specification version it uses.
Show child attributes
Show child attributes