Trigger Extraction

1️⃣ Overview

Purpose:
Triggers an extraction run for a specified extraction configuration and element.

Supports extraction modes for:

• New records only

• Selected rows

• Filter-based extraction

• Full dataset extraction

---

2️⃣ Endpoint

POST /noCo/api/v2/workspaces/{workspaceId}/extraction/{extractionId}/{elementType}/{elementId}/run?extractOnlyNew=true

---

3️⃣ Path Parameters

Parameter	Type	Required	Description
workspaceId	UUID	✅ Yes	Workspace identifier
extractionId	string	✅ Yes	Extraction configuration ID
elementType	string	✅ Yes	COLUMN / FILE / FOLDER
elementId	string	✅ Yes	Element identifier

---

4️⃣ Query Parameters

Parameter	Type	Required	Description
extractOnlyNew	boolean	❌ No	Default false

Behavior:

• true → Only new records are extracted

• false → Selected records are upserted (update existing + insert new)

---

5️⃣ Authentication

Requires authentication using:

Authorization: Bearer <token>

---

6️⃣ Request Headers

Header	Required
Authorization	✅ Yes
Content-Type: application/json	Optional

---

7️⃣ Request Body Schema (Optional)

{
  "rows": [],
  "whereClause": "string",
  "selectAll": true
}

---

8️⃣ Field Descriptions

Extraction Execution Controls

Field	Type	Required	Description
rows	array	❌ No	Specific rows to extract
whereClause	string	❌ No	Filter condition
selectAll	boolean	❌ No	Select all rows flag

---

9️⃣ Example Request

Trigger extraction for selected rows

curl -X POST "https://be.datagol.ai/noCo/api/v2/workspaces/{workspaceId}/extraction/{extractionId}/{elementType}/{elementId}/run?extractOnlyNew=true" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
  "selectAll": false,
  "rows": [
    {
      "id": "row1",
      "name": "Sample Data"
    }
  ]
}'

---

🔟 Behavior Summary

Triggers an extraction execution job for the specified configuration.
Supports:
• Incremental Extraction — When extractOnlyNew=true, only new records are processed.
• Upsert Extraction — When extractOnlyNew=false, existing records are updated and new records are inserted.
• Selective Extraction — Allows extraction of specific rows using the rows field.
• Filtered Extraction — Supports conditional extraction using whereClause.
• Full Extraction — When selectAll=true, extracts all matching records (rows field should be omitted).

---

📌 Additional Description

When selectAll is true, the system extracts all matching records.
If selectAll is false, the client must provide the complete row data in the rows field.

The request supports two major extraction strategies:

• Incremental Extraction: Controlled by extractOnlyNew=true

• Upsert Extraction: When extractOnlyNew=false, existing records are updated and new records are inserted.