Operations (sample payloads)

Main operations
Copy

Create row
Copy

Create a new row in the given table.

Sample Input

1{
2    "datatable_id": "dt_123456789",
3    "properties": [
4        {
5            "key": "First Name",
6            "value": "John"
7        },
8        {
9            "key": "Last Name",
10            "value": "Doe"
11        },
12        {
13            "key": "Email",
14            "value": "john.doe@example.com"
15        },
16        {
17            "key": "Age",
18            "value": "35"
19        },
20        {
21            "key": "City",
22            "value": "New York"
23        }
24    ],
25    "key_response_by_id": false
26}

Sample Output

1{
2    "datatableId": "dt_123456789",
3    "id": "row_987654321",
4    "properties": {
5        "First Name": "John",
6        "Last Name": "Doe",
7        "Email": "john.doe@example.com",
8        "Age": "35",
9        "City": "New York"
10    }
11}

Delete row
Copy

Delete a row by the given ID.

Sample Input

1{
2    "datatable_id": "dt_123456789abcdef",
3    "row_id": "row_987654321zyxwvu"
4}

Sample Output

1{
2    "success": true
3}

List columns
Copy

Return a list of columns.

Sample Input

1{
2    "datatable_id": "dt_123456789abcdef"
3}

Sample Output

1{
2    "results": [
3        {
4            "id": "col_001",
5            "name": "customer_id",
6            "type": "string"
7        },
8        {
9            "id": "col_002",
10            "name": "first_name",
11            "type": "string"
12        },
13        {
14            "id": "col_003",
15            "name": "last_name",
16            "type": "string"
17        },
18        {
19            "id": "col_004",
20            "name": "email",
21            "type": "string"
22        },
23        {
24            "id": "col_005",
25            "name": "age",
26            "type": "integer"
27        },
28        {
29            "id": "col_006",
30            "name": "registration_date",
31            "type": "date"
32        }
33    ]
34}

List rows
Copy

Return all rows in a table.

Sample Input

1{
2    "datatable_id": "dt_123456789",
3    "key_response_by_id": false,
4    "after": "cursor_abc123",
5    "first": 10
6}

Sample Output

1{
2    "elements": [
3        {
4            "datatableId": "dt_123456789",
5            "id": "row_1",
6            "properties": {
7                "column1": "John Doe",
8                "column2": "johndoe@example.com",
9                "column3": "123-456-7890",
10                "column4": "New York",
11                "column5": "USA",
12                "column6": "Software Engineer",
13                "column7": "2023-05-15",
14                "column8": "Active"
15            }
16        },
17        {
18            "datatableId": "dt_123456789",
19            "id": "row_2",
20            "properties": {
21                "column1": "Jane Smith",
22                "column2": "janesmith@example.com",
23                "column3": "987-654-3210",
24                "column4": "London",
25                "column5": "UK",
26                "column6": "Product Manager",
27                "column7": "2023-05-14",
28                "column8": "Active"
29            }
30        }
31    ]
32}

List tables
Copy

Return a list of tables.

Sample Input

1{
2    "first": 5,
3    "after": "cursor_abc123"
4}

Sample Output

1{
2    "elements": [
3        {
4            "id": "tbl_001",
5            "name": "Customers",
6            "description": "Table containing customer information",
7            "columns": [
8                {
9                    "name": "customer_id",
10                    "id": "col_001",
11                    "type": "string"
12                },
13                {
14                    "name": "full_name",
15                    "id": "col_002",
16                    "type": "string"
17                },
18                {
19                    "name": "email",
20                    "id": "col_003",
21                    "type": "string"
22                }
23            ],
24            "userId": "usr_123",
25            "orgId": "org_456",
26            "workspaceId": "wsp_789",
27            "projectId": "prj_101",
28            "createdAt": "2023-04-15T10:30:00Z",
29            "updatedAt": "2023-04-15T10:30:00Z"
30        },
31        {
32            "id": "tbl_002",
33            "name": "Orders",
34            "description": "Table containing order information",
35            "columns": [
36                {
37                    "name": "order_id",
38                    "id": "col_004",
39                    "type": "string"
40                },
41                {
42                    "name": "customer_id",
43                    "id": "col_005",
44                    "type": "string"
45                },
46                {
47                    "name": "order_date",
48                    "id": "col_006",
49                    "type": "date"
50                },
51                {
52                    "name": "total_amount",
53                    "id": "col_007",
54                    "type": "number"
55                }
56            ],
57            "userId": "usr_123",
58            "orgId": "org_456",
59            "workspaceId": "wsp_789",
60            "projectId": "prj_101",
61            "createdAt": "2023-04-15T11:15:00Z",
62            "updatedAt": "2023-04-15T11:15:00Z"
63        }
64    ]
65}

Lookup row
Copy

Lookup a row by a column value and return first matching record.

Sample Input

1{
2    "datatable_id": "dt_123456789",
3    "column": "email",
4    "value": "john.doe@example.com",
5    "key_response_by_id": false
6}

Sample Output

1{
2    "datatableId": "dt_123456789",
3    "id": "row_987654321",
4    "properties": {
5        "email": "john.doe@example.com",
6        "first_name": "John",
7        "last_name": "Doe",
8        "age": "35",
9        "occupation": "Software Engineer",
10        "city": "New York",
11        "country": "USA",
12        "phone": "+1-555-123-4567"
13    }
14}

Update cell in row
Copy

Update a cell in the given table.

Sample Input

1{
2    "datatable_id": "dt_123456789",
3    "row_id": "row_987654321",
4    "column_id": "col_abcdefgh",
5    "value": "Updated Value",
6    "key_response_by_id": false
7}

Sample Output

1{
2    "datatableId": "dt_123456789",
3    "id": "row_987654321",
4    "properties": {
5        "Column 1": "Existing Value 1",
6        "Column 2": "Existing Value 2",
7        "Column 3": "Updated Value",
8        "Column 4": "Existing Value 4",
9        "Column 5": "Existing Value 5",
10        "Column 6": "Existing Value 6",
11        "Column 7": "Existing Value 7",
12        "Column 8": "Existing Value 8"
13    }
14}

DDL operations
Copy

List columns (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1{}

Sample Output

1[
2    {
3        "column_name": "id",
4        "data_type": "INTEGER",
5        "is_nullable": "NO",
6        "column_default": null,
7        "is_primary_key": true
8    },
9    {
10        "column_name": "first_name",
11        "data_type": "VARCHAR(50)",
12        "is_nullable": "YES",
13        "column_default": null,
14        "is_primary_key": false
15    },
16    {
17        "column_name": "last_name",
18        "data_type": "VARCHAR(50)",
19        "is_nullable": "YES",
20        "column_default": null,
21        "is_primary_key": false
22    },
23    {
24        "column_name": "email",
25        "data_type": "VARCHAR(100)",
26        "is_nullable": "NO",
27        "column_default": null,
28        "is_primary_key": false
29    },
30    {
31        "column_name": "created_at",
32        "data_type": "TIMESTAMP",
33        "is_nullable": "NO",
34        "column_default": "CURRENT_TIMESTAMP",
35        "is_primary_key": false
36    }
37]

List tables (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1{}

Sample Output

1[
2    {
3        "table_name": "customers",
4        "ddl": "CREATE TABLE customers (\n  id INT PRIMARY KEY,\n  name VARCHAR(100),\n  email VARCHAR(100),\n  created_at TIMESTAMP\n);"
5    },
6    {
7        "table_name": "orders",
8        "ddl": "CREATE TABLE orders (\n  id INT PRIMARY KEY,\n  customer_id INT,\n  order_date DATE,\n  total_amount DECIMAL(10, 2),\n  FOREIGN KEY (customer_id) REFERENCES customers(id)\n);"
9    },
10    {
11        "table_name": "products",
12        "ddl": "CREATE TABLE products (\n  id INT PRIMARY KEY,\n  name VARCHAR(200),\n  description TEXT,\n  price DECIMAL(8, 2),\n  stock_quantity INT\n);"
13    }
14]

Operations (sample payloads)

Main operationsCopy

Create rowCopy

Delete rowCopy

List columnsCopy

List rowsCopy

List tablesCopy

Lookup rowCopy

Update cell in rowCopy

DDL operationsCopy

List columns (DDL)Copy

List tables (DDL)Copy

Overview

Operations

Main operations
Copy

Create row
Copy

Delete row
Copy

List columns
Copy

List rows
Copy

List tables
Copy

Lookup row
Copy

Update cell in row
Copy

DDL operations
Copy

List columns (DDL)
Copy

List tables (DDL)
Copy