Import and export
Preview a bounded interchange document as native logical resources
Preview a bounded interchange document as native logical resources
curl --request POST \
--url https://api.atlan.com/ontology/v1/imports/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document": "<string>",
"ontology_id": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({document: '<string>', ontology_id: '<string>'})
};
fetch('https://api.atlan.com/ontology/v1/imports/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/imports/preview"
payload = {
"document": "<string>",
"ontology_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"apply_supported": true,
"is_valid": true,
"ontology_id": "<string>",
"preview_id": "<string>",
"proposed_resources": [
{
"api_name": "<string>",
"definition": "<unknown>",
"kind": "<string>",
"display_name": "<string>"
}
],
"report": {
"adapter_version": "<string>",
"approximations": 1,
"diagnostics": [
{
"code": "<string>",
"message": "<string>",
"severity": "info",
"resource": "<string>"
}
],
"generated_identities": 1,
"lossless": true,
"omissions": 1,
"unsupported": 1
},
"validation_diagnostics": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"remediation": "<string>",
"resource": "<string>",
"severity": "error"
}
]
}{
"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": "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": "logical_model_invalid",
"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 a bounded interchange document as native logical resources
curl --request POST \
--url https://api.atlan.com/ontology/v1/imports/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document": "<string>",
"ontology_id": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({document: '<string>', ontology_id: '<string>'})
};
fetch('https://api.atlan.com/ontology/v1/imports/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/imports/preview"
payload = {
"document": "<string>",
"ontology_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"apply_supported": true,
"is_valid": true,
"ontology_id": "<string>",
"preview_id": "<string>",
"proposed_resources": [
{
"api_name": "<string>",
"definition": "<unknown>",
"kind": "<string>",
"display_name": "<string>"
}
],
"report": {
"adapter_version": "<string>",
"approximations": 1,
"diagnostics": [
{
"code": "<string>",
"message": "<string>",
"severity": "info",
"resource": "<string>"
}
],
"generated_identities": 1,
"lossless": true,
"omissions": 1,
"unsupported": 1
},
"validation_diagnostics": [
{
"code": "<string>",
"message": "<string>",
"path": "<string>",
"remediation": "<string>",
"resource": "<string>",
"severity": "error"
}
]
}{
"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": "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": "logical_model_invalid",
"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>"
}