pfx-api:datamartExport
Export data from a Datamart or Datamart Data Source.
URI Format
pfx-api:datamartExport?param1=value1¶m2=value2
Parameters
|
Parameter |
Type |
Default |
Description |
|---|---|---|---|
|
objectType |
ObjectType (enum) |
-- |
The Pricefx object type. Supported: DM, DMDS |
|
dsUniqueName |
String |
-- |
Unique name of the Data Source or Datamart to export from |
|
maxRows |
Integer |
50000 |
Maximum number of rows to export |
|
suffix |
String |
customsuffix |
Suffix appended to the export identifier |
XML Route Examples
Export from a Datamart Data Source
<route>
<from uri="direct:dmExport"/>
<to uri="pfx-api:datamartExport?objectType=DMDS&dsUniqueName=MyDataSource"/>
</route>
Export with a custom row limit and suffix
<route>
<from uri="direct:dmExportCustom"/>
<to uri="pfx-api:datamartExport?objectType=DMDS&dsUniqueName=MyDataSource&maxRows=100000&suffix=export2026"/>
</route>
Export from a Datamart
<route>
<from uri="direct:dmExportDirect"/>
<to uri="pfx-api:datamartExport?objectType=DM&dsUniqueName=MyDatamart&maxRows=25000"/>
</route>
Common Pitfalls
-
dsUniqueName is required: You must specify which Datamart or Data Source to export from.
-
objectType must be DM or DMDS: This method only supports Datamart and Datamart Data Source object types.
-
maxRows default: The default limit is 50,000 rows. For larger exports, increase
maxRowsexplicitly. Be aware of memory constraints when exporting very large datasets. -
suffix parameter: The
suffixparameter defaults tocustomsuffix. Provide a meaningful suffix to differentiate exports (e.g. a date or purpose identifier). -
Difference from fetch: Use
datamartExportfor dedicated DM export API access. UsefetchwithobjectType=DMDSwhen you need filter support, batched mode, or CSV/Excel output formatting.