> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.datagol.ai/llms.txt > Use this file to discover all available pages before exploring further. # Create Column > ## 1️⃣ Overview **Purpose:** Creates a new column inside a workbook. Supports multiple column types such as: - Text column - Number column - Date column - Other supported UI data types --- ## 2️⃣ Endpoint ``` bash POST /noCo/api/v2/workspaces/{workspaceId}/tables/{workbookId}/column ``` --- ## 3️⃣ Path Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | workspaceId | UUID | ✅ Yes | Workspace identifier | | workbookId | UUID | ✅ Yes | Workbook identifier | --- ## 4️⃣ Authentication Requires authentication using: ``` bash Authorization: Bearer ``` --- ## 5️⃣ Request Headers | Header | Required | | --- | --- | | Authorization | ✅ Yes | | Content-Type: application/json | ✅ Yes | --- ## 6️⃣ Request Body Schema ``` json { "uiDataType": "string", "uiMetadata": {}, "name": "string" } ``` --- ## 7️⃣ Field Descriptions ### Column Configuration | Field | Type | Required | Description | | --- | --- | --- | --- | | uiDataType | string | ✅ Yes | Column type (e.g., SINGLE_LINE_TEXT, NUMBER, DATE etc.) | | uiMetadata | object | ✅ Yes | Metadata for UI display (e.g., `{ "title": "My Column" }`) | | name | string | ✅ Yes | Internal column name (snake_case recommended) | --- ## 8️⃣ Example Request ``` bash curl --location 'https://be.datagol.ai/noCo/api/v2/workspaces/{workspaceId}/tables/{workbookId}/column' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "uiDataType": "SINGLE_LINE_TEXT", "uiMetadata": { "title": "sample text" }, "description": "some description" "name": "sample_text" }' ``` --- ## 9️⃣ Behavior Summary ``` id="behcol2" Creates a new workbook column. Supports: • Multiple UI data types (TEXT, NUMBER, DATE, etc.) • UI metadata configuration for rendering • Snake_case internal column naming • Server-side validation before creation ``` ## OpenAPI ````yaml /openapi/openapi.yaml post /noCo/api/v2/workspaces/{workspaceId}/tables/{workbook_Id}/column openapi: 3.0.0 info: title: DataGOL APIs version: 1.0.0 description: '' servers: - url: https://be.datagol.ai - url: https://be.datagol.ai - url: https://kg.datagol.ai - url: https://ai.datagol.ai security: [] tags: - name: Links & Joins description: > ## 🔗 Links & Joins LINK and LOOKUP are special workbook column types that enable relational data modeling across tables. | Column Type | Purpose | |---|---| | `LINK` | Defines a relationship between two tables | | `LOOKUP` | Projects columns from an associated table via a link | Both are configured through `ColumnDTO.colOptions`. A table can have multiple link columns, and each link can have multiple lookup columns. --- ## 📐 UI Data Types - **LINK** — Special column used to represent inter-table relations - **LOOKUP** — Special column used to project associated table fields via a link --- ## 🔗 LINK Semantics A LINK column stores metadata for: - `tableId` — Current table - `associatedTableId` — Associated (linked) table - `relationType` — Type of relationship - `linkColumnId` — Link column identifier **Supported relation patterns:** | Pattern | Description | |---|---| | `ONE_TO_ONE` | Each record in the source maps to one record in the destination | | `ONE_TO_MANY` | One source record maps to many destination records | | `MANY_TO_MANY` | Many source records map to many destination records | --- ## 🔍 LOOKUP Semantics - A LOOKUP column is tightly coupled with a specific LINK column - References a link using `linkColumnId` - Represents a selected column from the associated table - Multiple lookup columns can be defined for the same link --- ## 🗂️ Metadata in `ColumnDTO.colOptions` Use `colOptions` to persist link/lookup metadata. | Field | Description | |---|---| | `columnId` | Current column ID | | `tableId` | Current table ID | | `associatedTableId` | Associated table ID | | `linkColumnId` | Link column ID — used by LOOKUP; references the LINK column's `columnId` | | `relationType` | Relation semantics for LINK | --- ## 🔄 Manual Linking Record Flow To create manual record-level links: 1. Fetch associated table schema/data 2. User selects associated record(s) to link 3. Send linking payload with: - `sourceRecordId` — PK of the current table row - `destinationRecordId` — PK of the associated table row - `linkColumnId` — LINK column identifier 4. Backend resolves link metadata from `linkColumnId` (relation type, associated table, direction/constraints) 5. Backend applies relation rules and stores the link relation --- ## 📋 Record Linking Contract | Field | Description | |---|---| | `sourceRecordId` | PK of the current table row | | `destinationRecordId` | PK of the associated table row | | `linkColumnId` | LINK column identifier | | `tableId` | Current table ID | > Backend derives all remaining relation metadata from the link configuration. --- ## ⚠️ Important Notes > - LINK and LOOKUP are **column-level constructs** first; record linking is a data-level operation built on top > - LOOKUP behavior depends on LINK existence and metadata integrity > - With multiple links to the same associated table, each LOOKUP must bind to the correct `linkColumnId` > - Always treat the associated row ID as the associated table PK for linking UI selection paths: /noCo/api/v2/workspaces/{workspaceId}/tables/{workbook_Id}/column: parameters: - name: workspaceId in: path required: true schema: type: string example: '{{workspaceId}}' - name: workbook_Id in: path required: true schema: type: string example: '{{workbook_Id}}' post: tags: - WorkBook summary: Create Column description: >- ## 1️⃣ Overview **Purpose:** Creates a new column inside a workbook. Supports multiple column types such as: - Text column - Number column - Date column - Other supported UI data types --- ## 2️⃣ Endpoint ``` bash POST /noCo/api/v2/workspaces/{workspaceId}/tables/{workbookId}/column ``` --- ## 3️⃣ Path Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | workspaceId | UUID | ✅ Yes | Workspace identifier | | workbookId | UUID | ✅ Yes | Workbook identifier | --- ## 4️⃣ Authentication Requires authentication using: ``` bash Authorization: Bearer ``` --- ## 5️⃣ Request Headers | Header | Required | | --- | --- | | Authorization | ✅ Yes | | Content-Type: application/json | ✅ Yes | --- ## 6️⃣ Request Body Schema ``` json { "uiDataType": "string", "uiMetadata": {}, "name": "string" } ``` --- ## 7️⃣ Field Descriptions ### Column Configuration | Field | Type | Required | Description | | --- | --- | --- | --- | | uiDataType | string | ✅ Yes | Column type (e.g., SINGLE_LINE_TEXT, NUMBER, DATE etc.) | | uiMetadata | object | ✅ Yes | Metadata for UI display (e.g., `{ "title": "My Column" }`) | | name | string | ✅ Yes | Internal column name (snake_case recommended) | --- ## 8️⃣ Example Request ``` bash curl --location 'https://be.datagol.ai/noCo/api/v2/workspaces/{workspaceId}/tables/{workbookId}/column' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "uiDataType": "SINGLE_LINE_TEXT", "uiMetadata": { "title": "sample text" }, "description": "some description" "name": "sample_text" }' ``` --- ## 9️⃣ Behavior Summary ``` id="behcol2" Creates a new workbook column. Supports: • Multiple UI data types (TEXT, NUMBER, DATE, etc.) • UI metadata configuration for rendering • Snake_case internal column naming • Server-side validation before creation ``` requestBody: content: application/json: schema: type: object required: - uiDataType - name - uiMetadata properties: uiDataType: type: string description: type: string uiMetadata: type: object properties: title: type: string name: type: string example: uiDataType: SINGLE_LINE_TEXT uiMetadata: title: sample text name: sample_text responses: '200': description: Create Column security: - bearerAuth: [] components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: | This API uses OAuth 2.0 with the authorization code grant flow. ````