Migrate a model

curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/models/{modelId}/migrate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "gitRef": "main",
  "targetModelId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "branchName": "migrate-from-prod",
  "commitMessage": "Migrate model from production",
  "deleteViewsAndTopicsMissingFromSource": true
}
'

import requests

url = "https://{instance}.omniapp.co/api/v1/models/{modelId}/migrate"

payload = {
    "gitRef": "main",
    "targetModelId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "branchName": "migrate-from-prod",
    "commitMessage": "Migrate model from production",
    "deleteViewsAndTopicsMissingFromSource": True
}
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({
    gitRef: 'main',
    targetModelId: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    branchName: 'migrate-from-prod',
    commitMessage: 'Migrate model from production',
    deleteViewsAndTopicsMissingFromSource: true
  })
};

fetch('https://{instance}.omniapp.co/api/v1/models/{modelId}/migrate', 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://{instance}.omniapp.co/api/v1/models/{modelId}/migrate",
  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([
    'gitRef' => 'main',
    'targetModelId' => 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    'branchName' => 'migrate-from-prod',
    'commitMessage' => 'Migrate model from production',
    'deleteViewsAndTopicsMissingFromSource' => true
  ]),
  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://{instance}.omniapp.co/api/v1/models/{modelId}/migrate"

	payload := strings.NewReader("{\n  \"gitRef\": \"main\",\n  \"targetModelId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"branchName\": \"migrate-from-prod\",\n  \"commitMessage\": \"Migrate model from production\",\n  \"deleteViewsAndTopicsMissingFromSource\": true\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://{instance}.omniapp.co/api/v1/models/{modelId}/migrate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"gitRef\": \"main\",\n  \"targetModelId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"branchName\": \"migrate-from-prod\",\n  \"commitMessage\": \"Migrate model from production\",\n  \"deleteViewsAndTopicsMissingFromSource\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.omniapp.co/api/v1/models/{modelId}/migrate")

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  \"gitRef\": \"main\",\n  \"targetModelId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"branchName\": \"migrate-from-prod\",\n  \"commitMessage\": \"Migrate model from production\",\n  \"deleteViewsAndTopicsMissingFromSource\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

Git

Migrate a model

Copy a model from one Omni connection to another by reading the source model’s YAML at a specific Git ref and writing it to the target model. Supports same-organization and cross-organization migrations.

This API:

Reads the full model YAML from the source model’s git repository at the specified gitRef (merged with the default branch).
If branchName is provided and the branch already exists on the target model, the API writes to that branch. If the branch doesn’t exist, one is created.
Writes the YAML to the target model or branch, replacing its model definition.

Requirements

To successfully migrate a model:

The user performing the migration must have:
- For the source model - Querier, Modeler, or Connection Admin permissions
- For the target model - Modeler or Connection Admin permissions
- For cross-organization migrations - The user must be a member of both organizations
The source model must have git configured. This is required so the API can read the model YAML from the repository.
The target model should have an identical schema model to the source model at the instant the git ref was committed.

POST

models

{modelId}

migrate

Migrate a model

curl --request POST \
  --url https://{instance}.omniapp.co/api/v1/models/{modelId}/migrate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "gitRef": "main",
  "targetModelId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "branchName": "migrate-from-prod",
  "commitMessage": "Migrate model from production",
  "deleteViewsAndTopicsMissingFromSource": true
}
'

import requests

url = "https://{instance}.omniapp.co/api/v1/models/{modelId}/migrate"

payload = {
    "gitRef": "main",
    "targetModelId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "branchName": "migrate-from-prod",
    "commitMessage": "Migrate model from production",
    "deleteViewsAndTopicsMissingFromSource": True
}
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({
    gitRef: 'main',
    targetModelId: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    branchName: 'migrate-from-prod',
    commitMessage: 'Migrate model from production',
    deleteViewsAndTopicsMissingFromSource: true
  })
};

fetch('https://{instance}.omniapp.co/api/v1/models/{modelId}/migrate', 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://{instance}.omniapp.co/api/v1/models/{modelId}/migrate",
  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([
    'gitRef' => 'main',
    'targetModelId' => 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    'branchName' => 'migrate-from-prod',
    'commitMessage' => 'Migrate model from production',
    'deleteViewsAndTopicsMissingFromSource' => true
  ]),
  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://{instance}.omniapp.co/api/v1/models/{modelId}/migrate"

	payload := strings.NewReader("{\n  \"gitRef\": \"main\",\n  \"targetModelId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"branchName\": \"migrate-from-prod\",\n  \"commitMessage\": \"Migrate model from production\",\n  \"deleteViewsAndTopicsMissingFromSource\": true\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://{instance}.omniapp.co/api/v1/models/{modelId}/migrate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"gitRef\": \"main\",\n  \"targetModelId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"branchName\": \"migrate-from-prod\",\n  \"commitMessage\": \"Migrate model from production\",\n  \"deleteViewsAndTopicsMissingFromSource\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.omniapp.co/api/v1/models/{modelId}/migrate")

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  \"gitRef\": \"main\",\n  \"targetModelId\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"branchName\": \"migrate-from-prod\",\n  \"commitMessage\": \"Migrate model from production\",\n  \"deleteViewsAndTopicsMissingFromSource\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

{
  "error": "<response_code>",
  "message": "<error_reason>"
}

Authorizations

Authorization

string

header

required

Requires an Organization API Key. Personal Access Tokens (PATs) are not supported for this endpoint.

Include in the Authorization header as: Bearer ORGANIZATION_API_KEY

Path Parameters

modelId

string<uuid>

required

The shared model ID to read YAML from.

Body

application/json

gitRef

string

required

Git reference (branch name, tag, or commit SHA) to read the source model YAML from.

Example:

"main"

targetModelId

string<uuid>

required

The shared model ID to write the YAML to.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

branchName

string

Required if the target model has git enabled.. Branch name on the target model. If the branch doesn't exist, it will be created.

Example:

"migrate-from-prod"

commitMessage

string

Git commit message.

Example:

"Migrate model from production"

deleteViewsAndTopicsMissingFromSource

boolean

default:true

Controls how views and topics present in the target model but missing from the source model are handled. When true (default), these views and topics are marked as ignored: true. When false, they are inherited from the parent model instead.

Example:

true

Response

Model migrated successfully

success

boolean

Whether the migration completed successfully.

Example:

true

Create or update a pull request for a model branch

Retrieve a topic

⌘I

Getting started

AI APIs

API token APIs

Connection APIs

Content APIs

Dashboard APIs

Document APIs

Folder APIs

Label APIs

Model APIs

Query APIs

Schedule APIs

Upload APIs

User APIs

User group APIs

Migrate a model

Requirements

Authorizations

Path Parameters

Body

Response