curl --request GET \
--url https://developer.synq.io/api/schema/v1/{id} \
--header 'Authorization: Bearer <token>'
{
"schema": {
"fqn": {
"instanceName": "<string>",
"databaseName": "<string>",
"schemaName": "<string>",
"objectName": "<string>"
},
"columns": [
{
"name": "<string>",
"nativeType": "<string>",
"ordinalPosition": 123,
"description": "<string>",
"tags": [
{
"tagName": "<string>",
"tagValue": "<string>"
}
],
"isStruct": true,
"isRepeated": true,
"fields": [
{
"name": "<string>",
"nativeType": "<string>",
"description": "<string>",
"ordinalPosition": 123,
"isStruct": true,
"isRepeated": true,
"fields": [
{}
]
}
]
}
]
}
}
Get schema of the entity its identifier.
curl --request GET \
--url https://developer.synq.io/api/schema/v1/{id} \
--header 'Authorization: Bearer <token>'
{
"schema": {
"fqn": {
"instanceName": "<string>",
"databaseName": "<string>",
"schemaName": "<string>",
"objectName": "<string>"
},
"columns": [
{
"name": "<string>",
"nativeType": "<string>",
"ordinalPosition": 123,
"description": "<string>",
"tags": [
{
"tagName": "<string>",
"tagValue": "<string>"
}
],
"isStruct": true,
"isRepeated": true,
"fields": [
{
"name": "<string>",
"nativeType": "<string>",
"description": "<string>",
"ordinalPosition": 123,
"isStruct": true,
"isRepeated": true,
"fields": [
{}
]
}
]
}
]
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Identifier of the entity to get.
OK
GetEntityResponse is the response message for the GetEntity method.