DPL Pack API

This page documents the available DPL Pack API endpoints for extracting pack metadata, executing queries and packs, retrieving mappings, configuring datastore and mail settings, and generating packs.

---

1. Extract Pack

Extracts metadata from a .DPLPack file, including connections, queries, mappings, and functions.

Method: GET
Path: /api/dplpack/packextract

Query parameters

Name	Type	Required	Description
packPath	string	Yes	Absolute file path of the .DPLPack file.

Example request

GET /api/dplpack/packextract?packPath=C:\Users\RaviKiranG\Downloads\cdata_ado.net_mysql_to_Excel 1.DPLPack

Response

Returns extracted pack metadata, including:

• Connections
• Queries
• Mappings
• Functions

---

2. Execute Query (Extract Records)

Executes a specific query defined in the pack and transfers data from source to target connections based on the query logic.

Method: POST
Path: /api/dplpack/extractRecord

Request body

{
  "jobID": "6523af0494014f3535168167",
  "packPath": "C:\Users\prabhuk\Desktop\demo\TestingMySQLAndSQLServerPack.DPLPack",
  "mCredentials": [
    {
      "connectionName": "MySQL_NativeConnector_World",
      "connectionType": "source",
      "connectionString": "Driver={MySQL ODBC 8.2 ANSI Driver};Server=localhost;Database=world;Uid=root;Port=3306;Option=3;Stmt=;Pwd=<PASSWORD>;",
      "connectorId": "MySQLProvider",
      "isLicense": false,
      "provider": "MySQLProvider",
      "rtk_key": null
    },
    {
      "connectionName": "SQLServer_NativeConnector_TestingEmployee",
      "connectionType": "source",
      "connectionString": "Server=localhost;Database=TestingEmployee;TrustServerCertificate=True;Trusted_Connection=True;",
      "connectorId": "SqlServerProvider",
      "isLicense": false,
      "provider": "SqlServerProvider",
      "rtk_key": null
    },
    {
      "connectionName": "TargetNativeConnector_Mysql_Export",
      "connectionType": "target",
      "connectionString": "Driver={MySQL ODBC 8.2 ANSI Driver};Server=localhost;Database=world;Uid=root;Port=3306;Option=3;Stmt=;Pwd=<PASSWORD>;",
      "connectorId": "MySQLProvider",
      "isLicense": false,
      "provider": "MySQLProvider",
      "rtk_key": null
    }
  ],
  "queryName": "LogTable_stdQuery",
  "fillterQuery": ""
}

Response

• Executes the selected query
• Transforms data from source connection to target connection
• Applies mappings and transformations defined in the pack

---

3. Execute Pack

Executes the entire DPL Pack, running all configured queries and mappings from source to target.

Method: POST
Path: /api/dplpack/executepack

Request body

{
  "packPath": "C:\Users\prabhuk\Desktop\demo\TestingMySQLAndSQLServerPack.DPLPack",
  "statusURL": "",
  "mCredentials": [
    {
      "connectionName": "MySQL_NativeConnector_World",
      "connectionType": "source",
      "connectionString": "Driver={MySQL ODBC 8.2 ANSI Driver};Server=localhost;Database=world;Uid=root;Port=3306;Option=3;Stmt=;Pwd=<PASSWORD>;",
      "connectorId": "MySQLProvider",
      "isLicense": false,
      "provider": "MySQLProvider",
      "rtk_key": null
    },
    {
      "connectionName": "SQLServer_NativeConnector_TestingEmployee",
      "connectionType": "source",
      "connectionString": "Server=localhost;Database=TestingEmployee;TrustServerCertificate=True;Trusted_Connection=True;",
      "connectorId": "SqlServerProvider",
      "isLicense": false,
      "provider": "SqlServerProvider",
      "rtk_key": null
    },
    {
      "connectionName": "TargetNativeConnector_Mysql_Export",
      "connectionType": "target",
      "connectionString": "Driver={MySQL ODBC 8.2 ANSI Driver};Server=localhost;Database=world;Uid=root;Port=3306;Option=3;Stmt=;Pwd=<PASSWORD>;",
      "connectorId": "MySQLProvider",
      "isLicense": false,
      "provider": "MySQLProvider",
      "rtk_key": null
    }
  ],
  "jobID": "",
  "downloadUrl": ""
}

Response

• Executes all queries in the pack
• Applies full data flow from source to target
• Tracks execution using jobID

---

4. Extract Mapping Information

Retrieves mapping definitions from the pack that describe how source fields map to target fields.

Method: POST
Path: /api/dplpack/extractpackmapping

Request body

{
  "packID": "6523af0494014f3535168167",
  "packPath": "C:\Users\RaviKiranG\Downloads\cdata_ado.net_mysql_to_Excel 1.DPLPack"
}

Response

Returns mapping details such as:

• Field-level source-to-target mappings
• Target field mapping metadata
• CRUD-related mapping details
• Transformation rules, where available

---

5. Execute CRUD Operation

Executes CRUD operations (INSERT, UPDATE, or DELETE) on a target table using the defined mappings and connection details.

Method: POST
Path: /api/dplpack/packQueryInsert

Request body

{
  "mappingName": "TargetNativeConnector_Mysql_Export",
  "opertaionType": "INSERT",
  "querytable": "logdata_testingdplpack",
  "connection": {
    "connectionName": "MySQL_NativeConnector_World",
    "connectionType": "source",
    "connectionString": "Driver={MySQL ODBC 8.2 ANSI Driver};Server=localhost;Database=world;Uid=root;Port=3306;Option=3;Stmt=;Pwd=<PASSWORD>;",
    "connectorId": "MySQLProvider",
    "isLicense": false,
    "provider": "MySQLProvider",
    "rtk_key": null
  },
  "columnifo": [
    {
      "name": "column_name",
      "val": "column_value"
    }
  ]
}

Response

• Performs the specified CRUD operation on the target table
• Uses mapping and connection metadata for execution

---

6. Setup Cache / Datastore DB

Configures the internal datastore used for caching, job tracking, and execution metadata.

Method: POST
Path: /api/dplpack/datastoreInfo

Request body

{
  "connectiontype": "Mysql",
  "connectionstring": "server=localhost;userid=root;Password=<PASSWORD>;Database=DataProLogicDB;"
}

Response

• Datastore configuration updated successfully

---

7. Setup Mail Settings

Configures SMTP settings for notifications and alerts.

Method: POST
Path: /api/dplpack/mailsettingsInfo

Request body

{
  "mailserver": "",
  "port": "",
  "authusername": "",
  "authpassword": ""
}

Response

• Mail configuration saved successfully

---

8. Configure Max Data Fetch (Preview Limits)

Sets limits for maximum rows and execution duration during query preview or execution.

Method: POST
Path: /api/dplpack/datafetchInfo

Request body

{
  "maxrows": "1000",
  "maxtime_duration_preview": "3600"
}

Response

• Data fetch limits updated successfully

---

9. Generate Pack

Generates a new .DPLPack file dynamically based on the provided configuration.

Method: POST
Path: /api/dplpack/generatepack

Request body

{
  "packId": "12345",
  "packName": "SamplePack",
  "StoreInServer": false,
  "packConnections": [
    {
      "connectionName": "New Connection",
      "connectionType": "source",
      "connectionString": "Driver={MySQL ODBC 8.2 ANSI Driver};Server=localhost;Database=testpack;Uid=root;Port=;Option=3;Stmt=;Pwd=<PASSWORD>;",
      "connectorId": "MySQLProvider",
      "provider": "MySQLProvider",
      "rtk_key": null
    }
  ],
  "packFileSavePath": "C:\Users\RaviKiranG\Downloads"
}

Response

{
  "statusCode": "200",
  "message": "Datapack has been successfully generated",
  "data": null
}

---

10. Get Mail Settings Information

Retrieves the currently configured mail (SMTP) settings.

Method: GET
Path: /api/dplpack/mailsettingsGetInfo

Query parameters

None.

Response

Returns configured mail server details such as:

• Mail server
• Port
• Authentication username
• Authentication configuration status

---

11. Get Datastore (Cache DB) Information

Retrieves the current datastore configuration used by the system.

Method: GET
Path: /api/dplpack/datastoreGetInfo

Query parameters

None.

Response

Returns details such as:

• Datastore connection type (MySQL or SQL Server)
• Connection string, masked or partially masked
• Configuration status

---

12. Get Data Fetch Configuration

Retrieves the maximum data fetch and preview execution limits.

Method: GET
Path: /api/dplpack/datafetchGetInfo

Query parameters

None.

Response

Returns details such as:

• Maximum rows allowed during query execution
• Maximum preview execution duration

---

14. Pack Connector Fetch

Retrieves all connector definitions available inside the specified .DPLPack file.

Method: POST
Path: /api/dplpack/extractpackconnectors

Headers

Header	Value
Authorization	Bearer <token>

Request Body

{
  "packID": "6523af0494014f3535168167",
  "packPath": "C:\\Users\\prabhuk\\Desktop\\CRJob\\VSDSsurvey.DPLPack"
}

---

15. Pack Query Fetch

Retrieves all query definitions available inside the specified .DPLPack file.

Method: POST
Path: /api/dplpack/extractpackqueries

Headers

Header	Value
Authorization	Bearer <token>

Request Body

{
  "packID": "6523af0494014f3535168167",
  "packPath": "C:\\Users\\prabhuk\\Desktop\\CRJob\\VSDSsurvey.DPLPack"
}

---

16. Get Integration Function

Retrieves all available integration functions.

Method: POST
Path: /api/dplpack/getintegrationfunction

Headers

Header	Value
Authorization	Bearer <token>

Request Body

None

---

17. Extract Pack Queries

Extracts query definitions from the specified .DPLPack file.

Method: POST
Path: /api/dplpack/extractpackqueries

Headers

Header	Value
Authorization	Bearer <token>

Request Body

{
  "packID": "6523af0494014f3535168167",
  "packPath": "D:\\pack\\mongoDb_nativeConnector.DPLPack"
}

---

Suggested Docusaurus file placement

docs/
  api/
    dpl-pack-api.md

Suggested sidebar entry

module.exports = {
  docs: [
    {
      type: 'category',
      label: 'API Reference',
      items: ['dpl-pack-api']
    }
  ]
};