Get Started
Monitors
Incidents
Analytics
Data Warehouse Integrations
SQLMesh Integrations
Orchestration Tool Integrations
Alerting Integrations
Catalogs
Security
Support
Developer API
- Getting Started
- REST API
- ChangesService
- CodeService
- DatabaseCoordinatesService
- SqlTestsService
- TestSuggestionsService
- DwhService
- EntitiesService
- EntityExecutionsService
- AtlanIntegrationService
- AtlanProviderService
- AtlanWorkflowService
- CommitsService
- ImpactService
- IncidentsService
- IssuesService
- LineageService
- DeploymentRulesService
- HistoryService
- MonitorInfoService
- PlatformsService
- SchemasService
- EntityIncidentsService
- EntityIssuesService
- TriageService
- gRPC API
- Webhooks
SchemasService
Get apischemav1
Get schema of the entity its identifier.
GET
/
api
/
schema
/
v1
/
{id}
Copy
Ask AI
curl --request GET \
--url https://developer.synq.io/api/schema/v1/{id} \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"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": [
{}
]
}
]
}
]
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Identifier of the entity to get.
Response
200
application/json
OK
GetEntityResponse is the response message for the GetEntity method.
Copy
Ask AI
curl --request GET \
--url https://developer.synq.io/api/schema/v1/{id} \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"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": [
{}
]
}
]
}
]
}
}
Assistant
Responses are generated using AI and may contain mistakes.