Data Catalog Entries

Create Data Catalog Entry

Create a new data catalog entry.

Data catalog entries must provide a value for the source field, and depending on the value used the following values are required:

When the source field is set to DATA_TABLE the dataTableId field must be set to the ID of a data table accessible by the API.
When the source field is set to CONNECTION, both connectionId and tableId must be set.

Permissions

api.data-catalog-entries.write

POST

data-catalog-entries

Create Data Catalog Entry

curl --request POST \
  --url https://{tenant}.mindbridge.ai/api/v1/data-catalog-entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "columns": [
    {
      "name": "<string>",
      "displayName": "<string>",
      "description": "<string>",
      "nullable": true
    }
  ],
  "published": true,
  "name": "<string>",
  "description": "<string>",
  "uniqueIdentifier": [
    "<string>"
  ],
  "connectionId": "<string>",
  "tableId": "<string>"
}
'

import requests

url = "https://{tenant}.mindbridge.ai/api/v1/data-catalog-entries"

payload = {
    "columns": [
        {
            "name": "<string>",
            "displayName": "<string>",
            "description": "<string>",
            "nullable": True
        }
    ],
    "published": True,
    "name": "<string>",
    "description": "<string>",
    "uniqueIdentifier": ["<string>"],
    "connectionId": "<string>",
    "tableId": "<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({
    columns: [
      {
        name: '<string>',
        displayName: '<string>',
        description: '<string>',
        nullable: true
      }
    ],
    published: true,
    name: '<string>',
    description: '<string>',
    uniqueIdentifier: ['<string>'],
    connectionId: '<string>',
    tableId: '<string>'
  })
};

fetch('https://{tenant}.mindbridge.ai/api/v1/data-catalog-entries', 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://{tenant}.mindbridge.ai/api/v1/data-catalog-entries",
  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([
    'columns' => [
        [
                'name' => '<string>',
                'displayName' => '<string>',
                'description' => '<string>',
                'nullable' => true
        ]
    ],
    'published' => true,
    'name' => '<string>',
    'description' => '<string>',
    'uniqueIdentifier' => [
        '<string>'
    ],
    'connectionId' => '<string>',
    'tableId' => '<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://{tenant}.mindbridge.ai/api/v1/data-catalog-entries"

	payload := strings.NewReader("{\n  \"columns\": [\n    {\n      \"name\": \"<string>\",\n      \"displayName\": \"<string>\",\n      \"description\": \"<string>\",\n      \"nullable\": true\n    }\n  ],\n  \"published\": true,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"uniqueIdentifier\": [\n    \"<string>\"\n  ],\n  \"connectionId\": \"<string>\",\n  \"tableId\": \"<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://{tenant}.mindbridge.ai/api/v1/data-catalog-entries")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"columns\": [\n    {\n      \"name\": \"<string>\",\n      \"displayName\": \"<string>\",\n      \"description\": \"<string>\",\n      \"nullable\": true\n    }\n  ],\n  \"published\": true,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"uniqueIdentifier\": [\n    \"<string>\"\n  ],\n  \"connectionId\": \"<string>\",\n  \"tableId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}.mindbridge.ai/api/v1/data-catalog-entries")

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  \"columns\": [\n    {\n      \"name\": \"<string>\",\n      \"displayName\": \"<string>\",\n      \"description\": \"<string>\",\n      \"nullable\": true\n    }\n  ],\n  \"published\": true,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"uniqueIdentifier\": [\n    \"<string>\"\n  ],\n  \"connectionId\": \"<string>\",\n  \"tableId\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "version": 123,
  "creationDate": "2023-11-07T05:31:56Z",
  "lastModifiedDate": "2023-11-07T05:31:56Z",
  "createdUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "lastModifiedUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "source": "CONNECTION",
  "name": "<string>",
  "description": "<string>",
  "columns": [
    {
      "name": "<string>",
      "displayName": "<string>",
      "description": "<string>",
      "columnType": "STRING",
      "nullable": true
    }
  ],
  "uniqueIdentifier": [
    "<string>"
  ],
  "published": true,
  "connectionId": "<string>",
  "tableId": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Data Catalog Connection Entry
Data Catalog Data Table Entry

source

enum<string>

required

The type of entity this data catalog entry is associated with.

Available options:

CONNECTION,

DATA_TABLE

columns

Data Catalog Entry Column · object[]

required

The columns provided by this data catalog entry.

Minimum array length: 1

Show child attributes

published

boolean

required

Indicates whether this data catalog entry is published and available for use.

name

string

The display name of this data catalog entry.

description

string

A description of this data catalog entry.

uniqueIdentifier

string[]

List of column names that together form a unique record identifier

connectionId

string

The connection ID from which data is imported.

tableId

string

The table ID within the related connection from which data is imported.

Response

201 - application/json

Created

Data Catalog Connection Entry
Data Catalog Data Table Entry

string

The unique object identifier.

version

integer<int64>

Data integrity version to ensure data consistency.

creationDate

string<date-time>

The date that the object was originally created.

lastModifiedDate

string<date-time>

The date that the object was last updated or modified.

createdUserInfo

User Info · object

read-only

Details about the user who created the object.

Show child attributes

lastModifiedUserInfo

User Info · object

read-only

Details about the user who last modified or updated the object.

Show child attributes

source

enum<string>

The type of entity this data catalog entry is associated with.

Available options:

CONNECTION,

DATA_TABLE

name

string

The display name of this data catalog entry.

description

string

A description of this data catalog entry.

columns

Data Catalog Entry Column · object[]

The columns provided by this data catalog entry.

Show child attributes

uniqueIdentifier

string[]

List of column names that together form a unique record identifier

published

boolean

Indicates whether this data catalog entry is published and available for use.

connectionId

string

The connection ID from which data is imported.

tableId

string

The table ID within the related connection from which data is imported.

⌘I

Create Data Catalog Entry

curl --request POST \
  --url https://{tenant}.mindbridge.ai/api/v1/data-catalog-entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "columns": [
    {
      "name": "<string>",
      "displayName": "<string>",
      "description": "<string>",
      "nullable": true
    }
  ],
  "published": true,
  "name": "<string>",
  "description": "<string>",
  "uniqueIdentifier": [
    "<string>"
  ],
  "connectionId": "<string>",
  "tableId": "<string>"
}
'

import requests

url = "https://{tenant}.mindbridge.ai/api/v1/data-catalog-entries"

payload = {
    "columns": [
        {
            "name": "<string>",
            "displayName": "<string>",
            "description": "<string>",
            "nullable": True
        }
    ],
    "published": True,
    "name": "<string>",
    "description": "<string>",
    "uniqueIdentifier": ["<string>"],
    "connectionId": "<string>",
    "tableId": "<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({
    columns: [
      {
        name: '<string>',
        displayName: '<string>',
        description: '<string>',
        nullable: true
      }
    ],
    published: true,
    name: '<string>',
    description: '<string>',
    uniqueIdentifier: ['<string>'],
    connectionId: '<string>',
    tableId: '<string>'
  })
};

fetch('https://{tenant}.mindbridge.ai/api/v1/data-catalog-entries', 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://{tenant}.mindbridge.ai/api/v1/data-catalog-entries",
  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([
    'columns' => [
        [
                'name' => '<string>',
                'displayName' => '<string>',
                'description' => '<string>',
                'nullable' => true
        ]
    ],
    'published' => true,
    'name' => '<string>',
    'description' => '<string>',
    'uniqueIdentifier' => [
        '<string>'
    ],
    'connectionId' => '<string>',
    'tableId' => '<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://{tenant}.mindbridge.ai/api/v1/data-catalog-entries"

	payload := strings.NewReader("{\n  \"columns\": [\n    {\n      \"name\": \"<string>\",\n      \"displayName\": \"<string>\",\n      \"description\": \"<string>\",\n      \"nullable\": true\n    }\n  ],\n  \"published\": true,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"uniqueIdentifier\": [\n    \"<string>\"\n  ],\n  \"connectionId\": \"<string>\",\n  \"tableId\": \"<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://{tenant}.mindbridge.ai/api/v1/data-catalog-entries")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"columns\": [\n    {\n      \"name\": \"<string>\",\n      \"displayName\": \"<string>\",\n      \"description\": \"<string>\",\n      \"nullable\": true\n    }\n  ],\n  \"published\": true,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"uniqueIdentifier\": [\n    \"<string>\"\n  ],\n  \"connectionId\": \"<string>\",\n  \"tableId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}.mindbridge.ai/api/v1/data-catalog-entries")

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  \"columns\": [\n    {\n      \"name\": \"<string>\",\n      \"displayName\": \"<string>\",\n      \"description\": \"<string>\",\n      \"nullable\": true\n    }\n  ],\n  \"published\": true,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"uniqueIdentifier\": [\n    \"<string>\"\n  ],\n  \"connectionId\": \"<string>\",\n  \"tableId\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "version": 123,
  "creationDate": "2023-11-07T05:31:56Z",
  "lastModifiedDate": "2023-11-07T05:31:56Z",
  "createdUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "lastModifiedUserInfo": {
    "userId": "<string>",
    "userName": "<string>"
  },
  "source": "CONNECTION",
  "name": "<string>",
  "description": "<string>",
  "columns": [
    {
      "name": "<string>",
      "displayName": "<string>",
      "description": "<string>",
      "columnType": "STRING",
      "nullable": true
    }
  ],
  "uniqueIdentifier": [
    "<string>"
  ],
  "published": true,
  "connectionId": "<string>",
  "tableId": "<string>"
}

Overview

Details

Webhooks

API reference

Create Data Catalog Entry

Permissions

Authorizations

Body

Response