Preview publishing to the catalog
curl --request GET \
--url https://api.example.com/api/registry/ontologies/{artifact_id}/versions/{version_id}/plan \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/registry/ontologies/{artifact_id}/versions/{version_id}/plan"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/registry/ontologies/{artifact_id}/versions/{version_id}/plan', 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://api.example.com/api/registry/ontologies/{artifact_id}/versions/{version_id}/plan",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/registry/ontologies/{artifact_id}/versions/{version_id}/plan"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/registry/ontologies/{artifact_id}/versions/{version_id}/plan")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/registry/ontologies/{artifact_id}/versions/{version_id}/plan")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"artifact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": "<string>",
"catalog": "<string>",
"operations": [
{
"action": "create_group",
"urn": "<string>",
"name": "<string>",
"detail": "",
"concept": "<string>",
"table": "<string>",
"column": "<string>",
"payload": {}
}
],
"unchanged": 123,
"counts": {},
"kept_in_registry": [
{
"source": "<string>",
"label": "<string>",
"target": "<string>"
}
],
"drift": [
{
"urn": "<string>",
"name": "<string>",
"fields": [
"<string>"
]
}
],
"planned_at": "2023-11-07T05:31:56Z",
"previous_version": "<string>",
"warnings": [
"<string>"
]
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}Ontologies
Preview publishing to the catalog
A dry run against the data catalog: every write publishing this version would make, what stays in the registry, and catalog edits made outside the registry since the last publish. Writes nothing. Global ontologies only.
GET
/
api
/
registry
/
ontologies
/
{artifact_id}
/
versions
/
{version_id}
/
plan
Preview publishing to the catalog
curl --request GET \
--url https://api.example.com/api/registry/ontologies/{artifact_id}/versions/{version_id}/plan \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/registry/ontologies/{artifact_id}/versions/{version_id}/plan"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/registry/ontologies/{artifact_id}/versions/{version_id}/plan', 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://api.example.com/api/registry/ontologies/{artifact_id}/versions/{version_id}/plan",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/registry/ontologies/{artifact_id}/versions/{version_id}/plan"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/registry/ontologies/{artifact_id}/versions/{version_id}/plan")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/registry/ontologies/{artifact_id}/versions/{version_id}/plan")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"artifact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": "<string>",
"catalog": "<string>",
"operations": [
{
"action": "create_group",
"urn": "<string>",
"name": "<string>",
"detail": "",
"concept": "<string>",
"table": "<string>",
"column": "<string>",
"payload": {}
}
],
"unchanged": 123,
"counts": {},
"kept_in_registry": [
{
"source": "<string>",
"label": "<string>",
"target": "<string>"
}
],
"drift": [
{
"urn": "<string>",
"name": "<string>",
"fields": [
"<string>"
]
}
],
"planned_at": "2023-11-07T05:31:56Z",
"previous_version": "<string>",
"warnings": [
"<string>"
]
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}{
"error": "<string>",
"code": 500
}Authorizations
OAuth2AuthorizationCodeBearerAPIKeyHeader
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The ontology's artifact ID.
The version's ID.
Response
Successful Response
A dry run: what publishing this version would write to the catalog.
Which catalog the plan is for, e.g. 'datahub'.
Show child attributes
Show child attributes
Entities already as the version says.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?

