> ## 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. # Get Workbook Data > ## 1️⃣ Overview **Purpose:** Retrieves records from a workbook within a workspace using **cursor-based pagination**. Supports: - Filtering queries - Sorting rules - Pagination traversal --- ## 2️⃣ Endpoint ``` bash POST /noCo/api/v2/workspaces/{workspaceId}/tables/{workbookId}/cursor ``` --- ## 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 { "requestPageDetails": { "pageNumber": 1, "pageSize": 500 }, "sortOptions": [], "whereClause": "string" } ``` --- ## 7️⃣ Field Descriptions ### Pagination Configuration | Field | Type | Required | Description | | --- | --- | --- | --- | | requestPageDetails | object | ✅ Yes | Pagination configuration | | requestPageDetails.pageNumber | number | ✅ Yes | Page number to retrieve (increment to fetch next page) | | requestPageDetails.pageSize | number | ✅ Yes | Number of records per page | | sortOptions | array | ❌ No | Sorting rules for query results | | whereClause | string | ❌ No | SQL-like conditional filter expression | --- ## 8️⃣ Example Request ``` bash curl -X POST https://be.datagol.ai/noCo/api/v2/workspaces/{workspaceId}/tables/{workbookId}/cursor \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "requestPageDetails": { "pageNumber": 1, "pageSize": 500 }, "sortOptions": [ { "columnName": "first_name", "direction": "DESC" },{ "columnName": "last_updated", "direction": "ASC" } ], "whereClause": "(`first_name` like '%d%' and `years_of_experience` > 4 and `start_date` between '2004-01-01' and '2009-12-31' and `is_active` = true)" }' ``` --- ## 9️⃣ Behavior Summary ``` Retrieves workbook records using cursor-based pagination. Supports: • Dynamic filtering using whereClause • Multi-field sorting using sortOptions • Efficient pagination traversal using pageNumber and pageSize • Large dataset handling without loading entire workbook data ``` ## OpenAPI ````yaml /openapi/openapi.yaml post /noCo/api/v2/workspaces/{workspaceId}/tables/{workbookId}/cursor 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/{workbookId}/cursor: parameters: - name: workspaceId in: path required: true schema: type: string example: '{{workspaceId}}' - name: workbookId in: path required: true schema: type: string example: '{{workbookId}}' post: tags: - WorkBook summary: Get Workbook Data description: >- ## 1️⃣ Overview **Purpose:** Retrieves records from a workbook within a workspace using **cursor-based pagination**. Supports: - Filtering queries - Sorting rules - Pagination traversal --- ## 2️⃣ Endpoint ``` bash POST /noCo/api/v2/workspaces/{workspaceId}/tables/{workbookId}/cursor ``` --- ## 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 { "requestPageDetails": { "pageNumber": 1, "pageSize": 500 }, "sortOptions": [], "whereClause": "string" } ``` --- ## 7️⃣ Field Descriptions ### Pagination Configuration | Field | Type | Required | Description | | --- | --- | --- | --- | | requestPageDetails | object | ✅ Yes | Pagination configuration | | requestPageDetails.pageNumber | number | ✅ Yes | Page number to retrieve (increment to fetch next page) | | requestPageDetails.pageSize | number | ✅ Yes | Number of records per page | | sortOptions | array | ❌ No | Sorting rules for query results | | whereClause | string | ❌ No | SQL-like conditional filter expression | --- ## 8️⃣ Example Request ``` bash curl -X POST https://be.datagol.ai/noCo/api/v2/workspaces/{workspaceId}/tables/{workbookId}/cursor \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "requestPageDetails": { "pageNumber": 1, "pageSize": 500 }, "sortOptions": [ { "columnName": "first_name", "direction": "DESC" },{ "columnName": "last_updated", "direction": "ASC" } ], "whereClause": "(`first_name` like '%d%' and `years_of_experience` > 4 and `start_date` between '2004-01-01' and '2009-12-31' and `is_active` = true)" }' ``` --- ## 9️⃣ Behavior Summary ``` Retrieves workbook records using cursor-based pagination. Supports: • Dynamic filtering using whereClause • Multi-field sorting using sortOptions • Efficient pagination traversal using pageNumber and pageSize • Large dataset handling without loading entire workbook data ``` requestBody: required: true content: application/json: schema: type: object properties: requestPageDetails: type: object properties: pageNumber: type: integer pageSize: type: integer sortOptions: type: array items: type: object properties: columnName: type: string direction: type: string whereClause: type: string example: requestPageDetails: pageNumber: 1 pageSize: 500 sortOptions: - columnName: first_name direction: DESC - columnName: last_updated direction: ASC whereClause: >- (`first_name` like '%d%' and `years_of_experience` > 4 and `start_date` between '2004-01-01' and '2009-12-31' and `is_active` = true) responses: '200': description: Get Table Data security: - bearerAuth: [] components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: | This API uses OAuth 2.0 with the authorization code grant flow. ````