Replace upload data

curl --request PUT \
  --url https://{instance}.omniapp.co/api/v1/uploads/{uploadId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=@example-file;type=text/csv'

import requests

url = "https://{instance}.omniapp.co/api/v1/uploads/{uploadId}"

files = { "file": ("example-file", open("example-file", "rb"), "text/csv") }
headers = {"Authorization": "Bearer <token>"}

response = requests.put(url, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');

const options = {method: 'PUT', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://{instance}.omniapp.co/api/v1/uploads/{uploadId}', 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/uploads/{uploadId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: text/csv\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$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/uploads/{uploadId}"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: text/csv\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("PUT", url, payload)

	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.put("https://{instance}.omniapp.co/api/v1/uploads/{uploadId}")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: text/csv\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.omniapp.co/api/v1/uploads/{uploadId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: text/csv\r\n\r\n<string>\r\n-----011000010111000001101001--"

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

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "fileName": "users_updated.csv",
  "viewName": "users",
  "inDbAsTableName": "omni_upload_t7c1e22ab",
  "refreshedModelIds": [
    "880e8400-e29b-41d4-a716-446655440003"
  ],
  "rowCount": 152,
  "truncated": false
}

Upload APIs

Replace upload data

Organization Admin permissions are required to use this endpoint.

Replace the data in an existing CSV upload.

The view’s uploaded_table_name property and references to it (returned as refreshedModelIds) will automatically update, but the upload’s ID will remain unchanged. This means that any documents, queries, views, etc. using the upload will be re-pointed to the new data. For a CSV that keeps its table, the replacement data is swapped into the existing table in place. Otherwise, Omni creates a new table for the replacement, and the previous data’s artifacts are left untouched.

PUT

uploads

{uploadId}

Replace upload data

curl --request PUT \
  --url https://{instance}.omniapp.co/api/v1/uploads/{uploadId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=@example-file;type=text/csv'

import requests

url = "https://{instance}.omniapp.co/api/v1/uploads/{uploadId}"

files = { "file": ("example-file", open("example-file", "rb"), "text/csv") }
headers = {"Authorization": "Bearer <token>"}

response = requests.put(url, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');

const options = {method: 'PUT', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://{instance}.omniapp.co/api/v1/uploads/{uploadId}', 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/uploads/{uploadId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: text/csv\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$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/uploads/{uploadId}"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: text/csv\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("PUT", url, payload)

	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.put("https://{instance}.omniapp.co/api/v1/uploads/{uploadId}")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: text/csv\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.omniapp.co/api/v1/uploads/{uploadId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: text/csv\r\n\r\n<string>\r\n-----011000010111000001101001--"

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

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "fileName": "users_updated.csv",
  "viewName": "users",
  "inDbAsTableName": "omni_upload_t7c1e22ab",
  "refreshedModelIds": [
    "880e8400-e29b-41d4-a716-446655440003"
  ],
  "rowCount": 152,
  "truncated": false
}

Renaming or removing columns may break content (fields, calculations, filters) referencing the old columns.

Column data types

Columns already in the data input table keep their saved type and date format, and new columns are detected from the file. A value that doesn’t adhere to its column’s saved data type fails the request. To change a column’s type, delete the upload and create it again.

Authorizations

Authorization

string

header

required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

uploadId

string<uuid>

required

The unique identifier of the upload

Body

multipart/form-data

file

required

The replacement CSV file (must have .csv extension). Fully replaces the existing data; existing columns keep their saved type and date format. Column renames/removals may break content referencing the old columns.

Response

Upload data replaced successfully

string<uuid>

required

The upload ID. This will not change after uploading new data.

Example:

"550e8400-e29b-41d4-a716-446655440000"

fileName

string

required

File name of the replacement upload

Example:

"users_updated.csv"

viewName

string

required

View name. This will not change after uploading new data.

Example:

"users"

inDbAsTableName

string

required

Database table name in the table upload (scratch) schema. This will be empty if the underlying connection doesn't have a table upload schema configured. For a CSV that keeps its table, this name can stay the same across replaces.

Example:

"omni_upload_t7c1e22ab"

refreshedModelIds

string<uuid>[]

required

Models whose view of this upload was re-pointed at the new data, including the upload's workbook model, or the connection's shared models holding a view backed by this upload.

Example:

["880e8400-e29b-41d4-a716-446655440003"]

rowCount

integer

required

Number of rows in the replacement file

Example:

152

truncated

boolean

required

Whether the file was truncated due to row limit

Example:

false

Getting started

Who am I?

Administration APIs

AI APIs

App APIs

Branch APIs

Connection APIs

Content APIs

Dashboard APIs

Document APIs

Embed APIs

Folder APIs

Label APIs

Model APIs

Query APIs

Schedule APIs

Upload APIs

User APIs

User group APIs

Replace upload data

Column data types

Authorizations

Path Parameters

Body

Response