Additional operations
Preview separate native binding and Knowledge Record drafts without publishing
Preview separate native binding and Knowledge Record drafts without publishing
curl --request POST \
--url https://api.atlan.com/ontology/v1/native-drafts/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"bindings": [
{
"api_name": "<string>",
"links": [
{
"api_name": "<string>",
"join_keys": [
{
"source_property_api_name": "<string>",
"target_property_api_name": "<string>"
}
],
"logical_link_api_name": "<string>",
"source_object_api_name": "<string>",
"target_object_api_name": "<string>"
}
],
"objects": [
{
"api_name": "<string>",
"grain": {
"uniqueness": [
"<string>"
]
},
"logical_object_api_name": "<string>",
"relation": {
"mode": "query_backed",
"query": {
"outputs": [
{
"name": "<string>",
"nullable": true,
"physical_type": "<string>"
}
],
"sql": "<string>",
"default_catalog": "<string>",
"default_schema": "<string>",
"dependencies": [
{
"qualified_name": "<string>"
}
]
}
}
}
],
"properties": [
{
"api_name": "<string>",
"implementation": {
"field": {
"qualified_name": "<string>"
},
"kind": "field"
},
"object_api_name": "<string>",
"ontology_property_api_name": "<string>"
}
],
"source_scope": {
"source": {
"qualified_name": "<string>"
}
}
}
],
"ontology_id": "<string>",
"records": [
{
"api_name": "<string>",
"display_name": "<string>",
"effective_from": "<string>",
"record_type_api_name": "<string>",
"values": {},
"effective_to": "<string>",
"knowledge_references": [
{
"concept": {
"artifact_id": "<string>",
"content_hash": "<string>",
"kind": "<string>",
"version_ordinal": 123
}
}
],
"related_concept_api_names": [
"<string>"
],
"relationships": [
{
"link_api_name": "<string>",
"target_record_api_name": "<string>"
}
],
"review_notes": [
"<string>"
],
"source_passages": [
{
"document_version": "<string>",
"locator": "<string>",
"quote": "<string>",
"source_id": "<string>"
}
]
}
],
"source_versions": [
{
"artifact_id": "<string>",
"content_hash": "<string>",
"kind": "<string>",
"version_ordinal": 123
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
bindings: [
{
api_name: '<string>',
links: [
{
api_name: '<string>',
join_keys: [{source_property_api_name: '<string>', target_property_api_name: '<string>'}],
logical_link_api_name: '<string>',
source_object_api_name: '<string>',
target_object_api_name: '<string>'
}
],
objects: [
{
api_name: '<string>',
grain: {uniqueness: ['<string>']},
logical_object_api_name: '<string>',
relation: {
mode: 'query_backed',
query: {
outputs: [{name: '<string>', nullable: true, physical_type: '<string>'}],
sql: '<string>',
default_catalog: '<string>',
default_schema: '<string>',
dependencies: [{qualified_name: '<string>'}]
}
}
}
],
properties: [
{
api_name: '<string>',
implementation: {field: {qualified_name: '<string>'}, kind: 'field'},
object_api_name: '<string>',
ontology_property_api_name: '<string>'
}
],
source_scope: {source: {qualified_name: '<string>'}}
}
],
ontology_id: '<string>',
records: [
{
api_name: '<string>',
display_name: '<string>',
effective_from: '<string>',
record_type_api_name: '<string>',
values: {},
effective_to: '<string>',
knowledge_references: [
{
concept: {
artifact_id: '<string>',
content_hash: '<string>',
kind: '<string>',
version_ordinal: 123
}
}
],
related_concept_api_names: ['<string>'],
relationships: [{link_api_name: '<string>', target_record_api_name: '<string>'}],
review_notes: ['<string>'],
source_passages: [
{
document_version: '<string>',
locator: '<string>',
quote: '<string>',
source_id: '<string>'
}
]
}
],
source_versions: [
{
artifact_id: '<string>',
content_hash: '<string>',
kind: '<string>',
version_ordinal: 123
}
]
})
};
fetch('https://api.atlan.com/ontology/v1/native-drafts/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.atlan.com/ontology/v1/native-drafts/preview"
payload = {
"bindings": [
{
"api_name": "<string>",
"links": [
{
"api_name": "<string>",
"join_keys": [
{
"source_property_api_name": "<string>",
"target_property_api_name": "<string>"
}
],
"logical_link_api_name": "<string>",
"source_object_api_name": "<string>",
"target_object_api_name": "<string>"
}
],
"objects": [
{
"api_name": "<string>",
"grain": { "uniqueness": ["<string>"] },
"logical_object_api_name": "<string>",
"relation": {
"mode": "query_backed",
"query": {
"outputs": [
{
"name": "<string>",
"nullable": True,
"physical_type": "<string>"
}
],
"sql": "<string>",
"default_catalog": "<string>",
"default_schema": "<string>",
"dependencies": [{ "qualified_name": "<string>" }]
}
}
}
],
"properties": [
{
"api_name": "<string>",
"implementation": {
"field": { "qualified_name": "<string>" },
"kind": "field"
},
"object_api_name": "<string>",
"ontology_property_api_name": "<string>"
}
],
"source_scope": { "source": { "qualified_name": "<string>" } }
}
],
"ontology_id": "<string>",
"records": [
{
"api_name": "<string>",
"display_name": "<string>",
"effective_from": "<string>",
"record_type_api_name": "<string>",
"values": {},
"effective_to": "<string>",
"knowledge_references": [{ "concept": {
"artifact_id": "<string>",
"content_hash": "<string>",
"kind": "<string>",
"version_ordinal": 123
} }],
"related_concept_api_names": ["<string>"],
"relationships": [
{
"link_api_name": "<string>",
"target_record_api_name": "<string>"
}
],
"review_notes": ["<string>"],
"source_passages": [
{
"document_version": "<string>",
"locator": "<string>",
"quote": "<string>",
"source_id": "<string>"
}
]
}
],
"source_versions": [
{
"artifact_id": "<string>",
"content_hash": "<string>",
"kind": "<string>",
"version_ordinal": 123
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"diagnostics": [
"<string>"
],
"drafts": [
{
"kind": "<string>",
"metadata": "<unknown>",
"name": "<string>",
"references": [
{
"json_pointer": "<string>",
"target_kind": "<string>",
"target_name": "<string>"
}
]
}
],
"is_valid": true,
"preview_id": "<string>",
"workspace_id": "<string>"
}{
"code": "invalid_base64",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "alg_mismatch",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "access_denied",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "conflict",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "compressed_payload_too_large",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "unsupported_content_encoding",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "source_unavailable",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "internal_error",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "auth_unavailable",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "request_timeout",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Available options:
base64, gzip, base64 Body
application/json
⌘I
Preview separate native binding and Knowledge Record drafts without publishing
curl --request POST \
--url https://api.atlan.com/ontology/v1/native-drafts/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"bindings": [
{
"api_name": "<string>",
"links": [
{
"api_name": "<string>",
"join_keys": [
{
"source_property_api_name": "<string>",
"target_property_api_name": "<string>"
}
],
"logical_link_api_name": "<string>",
"source_object_api_name": "<string>",
"target_object_api_name": "<string>"
}
],
"objects": [
{
"api_name": "<string>",
"grain": {
"uniqueness": [
"<string>"
]
},
"logical_object_api_name": "<string>",
"relation": {
"mode": "query_backed",
"query": {
"outputs": [
{
"name": "<string>",
"nullable": true,
"physical_type": "<string>"
}
],
"sql": "<string>",
"default_catalog": "<string>",
"default_schema": "<string>",
"dependencies": [
{
"qualified_name": "<string>"
}
]
}
}
}
],
"properties": [
{
"api_name": "<string>",
"implementation": {
"field": {
"qualified_name": "<string>"
},
"kind": "field"
},
"object_api_name": "<string>",
"ontology_property_api_name": "<string>"
}
],
"source_scope": {
"source": {
"qualified_name": "<string>"
}
}
}
],
"ontology_id": "<string>",
"records": [
{
"api_name": "<string>",
"display_name": "<string>",
"effective_from": "<string>",
"record_type_api_name": "<string>",
"values": {},
"effective_to": "<string>",
"knowledge_references": [
{
"concept": {
"artifact_id": "<string>",
"content_hash": "<string>",
"kind": "<string>",
"version_ordinal": 123
}
}
],
"related_concept_api_names": [
"<string>"
],
"relationships": [
{
"link_api_name": "<string>",
"target_record_api_name": "<string>"
}
],
"review_notes": [
"<string>"
],
"source_passages": [
{
"document_version": "<string>",
"locator": "<string>",
"quote": "<string>",
"source_id": "<string>"
}
]
}
],
"source_versions": [
{
"artifact_id": "<string>",
"content_hash": "<string>",
"kind": "<string>",
"version_ordinal": 123
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
bindings: [
{
api_name: '<string>',
links: [
{
api_name: '<string>',
join_keys: [{source_property_api_name: '<string>', target_property_api_name: '<string>'}],
logical_link_api_name: '<string>',
source_object_api_name: '<string>',
target_object_api_name: '<string>'
}
],
objects: [
{
api_name: '<string>',
grain: {uniqueness: ['<string>']},
logical_object_api_name: '<string>',
relation: {
mode: 'query_backed',
query: {
outputs: [{name: '<string>', nullable: true, physical_type: '<string>'}],
sql: '<string>',
default_catalog: '<string>',
default_schema: '<string>',
dependencies: [{qualified_name: '<string>'}]
}
}
}
],
properties: [
{
api_name: '<string>',
implementation: {field: {qualified_name: '<string>'}, kind: 'field'},
object_api_name: '<string>',
ontology_property_api_name: '<string>'
}
],
source_scope: {source: {qualified_name: '<string>'}}
}
],
ontology_id: '<string>',
records: [
{
api_name: '<string>',
display_name: '<string>',
effective_from: '<string>',
record_type_api_name: '<string>',
values: {},
effective_to: '<string>',
knowledge_references: [
{
concept: {
artifact_id: '<string>',
content_hash: '<string>',
kind: '<string>',
version_ordinal: 123
}
}
],
related_concept_api_names: ['<string>'],
relationships: [{link_api_name: '<string>', target_record_api_name: '<string>'}],
review_notes: ['<string>'],
source_passages: [
{
document_version: '<string>',
locator: '<string>',
quote: '<string>',
source_id: '<string>'
}
]
}
],
source_versions: [
{
artifact_id: '<string>',
content_hash: '<string>',
kind: '<string>',
version_ordinal: 123
}
]
})
};
fetch('https://api.atlan.com/ontology/v1/native-drafts/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.atlan.com/ontology/v1/native-drafts/preview"
payload = {
"bindings": [
{
"api_name": "<string>",
"links": [
{
"api_name": "<string>",
"join_keys": [
{
"source_property_api_name": "<string>",
"target_property_api_name": "<string>"
}
],
"logical_link_api_name": "<string>",
"source_object_api_name": "<string>",
"target_object_api_name": "<string>"
}
],
"objects": [
{
"api_name": "<string>",
"grain": { "uniqueness": ["<string>"] },
"logical_object_api_name": "<string>",
"relation": {
"mode": "query_backed",
"query": {
"outputs": [
{
"name": "<string>",
"nullable": True,
"physical_type": "<string>"
}
],
"sql": "<string>",
"default_catalog": "<string>",
"default_schema": "<string>",
"dependencies": [{ "qualified_name": "<string>" }]
}
}
}
],
"properties": [
{
"api_name": "<string>",
"implementation": {
"field": { "qualified_name": "<string>" },
"kind": "field"
},
"object_api_name": "<string>",
"ontology_property_api_name": "<string>"
}
],
"source_scope": { "source": { "qualified_name": "<string>" } }
}
],
"ontology_id": "<string>",
"records": [
{
"api_name": "<string>",
"display_name": "<string>",
"effective_from": "<string>",
"record_type_api_name": "<string>",
"values": {},
"effective_to": "<string>",
"knowledge_references": [{ "concept": {
"artifact_id": "<string>",
"content_hash": "<string>",
"kind": "<string>",
"version_ordinal": 123
} }],
"related_concept_api_names": ["<string>"],
"relationships": [
{
"link_api_name": "<string>",
"target_record_api_name": "<string>"
}
],
"review_notes": ["<string>"],
"source_passages": [
{
"document_version": "<string>",
"locator": "<string>",
"quote": "<string>",
"source_id": "<string>"
}
]
}
],
"source_versions": [
{
"artifact_id": "<string>",
"content_hash": "<string>",
"kind": "<string>",
"version_ordinal": 123
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"diagnostics": [
"<string>"
],
"drafts": [
{
"kind": "<string>",
"metadata": "<unknown>",
"name": "<string>",
"references": [
{
"json_pointer": "<string>",
"target_kind": "<string>",
"target_name": "<string>"
}
]
}
],
"is_valid": true,
"preview_id": "<string>",
"workspace_id": "<string>"
}{
"code": "invalid_base64",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "alg_mismatch",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "access_denied",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "conflict",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "compressed_payload_too_large",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "unsupported_content_encoding",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "source_unavailable",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "internal_error",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "auth_unavailable",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "request_timeout",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}