Return the schema for a specified Dataset

Retrieves the latest schema definition for a given Dataset ID.

GET /api/data/v2/datasources/{DATASET_ID}/schemas/latest

Return the schema for a specified Dataset

cURL

curl --request GET \
  --url https://{instance}.domo.com/api/data/v2/datasources/{DATASET_ID}/schemas/latest \
  --header 'X-DOMO-Developer-Token: <api-key>'

import requests

url = "https://{instance}.domo.com/api/data/v2/datasources/{DATASET_ID}/schemas/latest"

headers = {"X-DOMO-Developer-Token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-DOMO-Developer-Token': '<api-key>'}};

fetch('https://{instance}.domo.com/api/data/v2/datasources/{DATASET_ID}/schemas/latest', 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}.domo.com/api/data/v2/datasources/{DATASET_ID}/schemas/latest",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-DOMO-Developer-Token: <api-key>"
  ],
]);

$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://{instance}.domo.com/api/data/v2/datasources/{DATASET_ID}/schemas/latest"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-DOMO-Developer-Token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{instance}.domo.com/api/data/v2/datasources/{DATASET_ID}/schemas/latest")
  .header("X-DOMO-Developer-Token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.domo.com/api/data/v2/datasources/{DATASET_ID}/schemas/latest")

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

request = Net::HTTP::Get.new(url)
request["X-DOMO-Developer-Token"] = '<api-key>'

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

200

{
  "schema": {
    "columns": [
      {
        "type": "STRING",
        "name": "Example Column",
        "id": "col_1",
        "visible": true,
        "metadata": {
          "colLabel": "Example Column Label",
          "colFormat": "",
          "isEncrypted": false
        }
      }
    ]
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

X-DOMO-Developer-Token · string · header · required

Domo Developer Token for authentication.

Path Parameters

DATASET_ID · string · required

The ID of the Dataset.

Example:

"aa7d9422-9abe-4581-bbf3-4a8cb5d3fc25"

Response

200

application/json

OK. Returns the schema object.

schema · object

Show child attributes