Preview Sync
curl --request POST \
--url https://api.ontora.com/v1/projects/{project_id}/sync/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"node_keys": [],
"edge_keys": [],
"synced_by": "<string>"
}
'import requests
url = "https://api.ontora.com/v1/projects/{project_id}/sync/preview"
payload = {
"node_keys": [],
"edge_keys": [],
"synced_by": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({node_keys: [], edge_keys: [], synced_by: '<string>'})
};
fetch('https://api.ontora.com/v1/projects/{project_id}/sync/preview', 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.ontora.com/v1/projects/{project_id}/sync/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'node_keys' => [
],
'edge_keys' => [
],
'synced_by' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ontora.com/v1/projects/{project_id}/sync/preview"
payload := strings.NewReader("{\n \"node_keys\": [],\n \"edge_keys\": [],\n \"synced_by\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ontora.com/v1/projects/{project_id}/sync/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"node_keys\": [],\n \"edge_keys\": [],\n \"synced_by\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ontora.com/v1/projects/{project_id}/sync/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"node_keys\": [],\n \"edge_keys\": [],\n \"synced_by\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"nodes": [
{
"prj_key": "<string>",
"action": "<string>",
"name": "<string>",
"node_type": "<string>",
"target_ukl_key": "<string>",
"target_ukl_label": "<string>",
"existing_ukl_key": "<string>",
"existing_ukl_name": "<string>"
}
],
"edges": [
{
"edge_key": "<string>",
"action": "<string>",
"from_name": "<string>",
"to_name": "<string>",
"rel_type": "<string>",
"from_synced": true,
"to_synced": true,
"from_ukl_key": "<string>",
"to_ukl_key": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}projects
Preview Sync
Preview what would be synced without actually syncing.
Returns details about each node/edge and what action would be taken.
POST
/
v1
/
projects
/
{project_id}
/
sync
/
preview
Preview Sync
curl --request POST \
--url https://api.ontora.com/v1/projects/{project_id}/sync/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"node_keys": [],
"edge_keys": [],
"synced_by": "<string>"
}
'import requests
url = "https://api.ontora.com/v1/projects/{project_id}/sync/preview"
payload = {
"node_keys": [],
"edge_keys": [],
"synced_by": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({node_keys: [], edge_keys: [], synced_by: '<string>'})
};
fetch('https://api.ontora.com/v1/projects/{project_id}/sync/preview', 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.ontora.com/v1/projects/{project_id}/sync/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'node_keys' => [
],
'edge_keys' => [
],
'synced_by' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ontora.com/v1/projects/{project_id}/sync/preview"
payload := strings.NewReader("{\n \"node_keys\": [],\n \"edge_keys\": [],\n \"synced_by\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ontora.com/v1/projects/{project_id}/sync/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"node_keys\": [],\n \"edge_keys\": [],\n \"synced_by\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ontora.com/v1/projects/{project_id}/sync/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"node_keys\": [],\n \"edge_keys\": [],\n \"synced_by\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"nodes": [
{
"prj_key": "<string>",
"action": "<string>",
"name": "<string>",
"node_type": "<string>",
"target_ukl_key": "<string>",
"target_ukl_label": "<string>",
"existing_ukl_key": "<string>",
"existing_ukl_name": "<string>"
}
],
"edges": [
{
"edge_key": "<string>",
"action": "<string>",
"from_name": "<string>",
"to_name": "<string>",
"rel_type": "<string>",
"from_synced": true,
"to_synced": true,
"from_ukl_key": "<string>",
"to_ukl_key": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Was this page helpful?
⌘I