pfx-api:refresh

Refresh a Datamart. Available from Integration Manager v1.1.15.

URI Format

pfx-api:refresh?param1=value1&param2=value2

Parameters

Parameter	Type	Default	Description
targetName	String	--	Name of the Datamart to refresh
incrementalDate	String	--	Incremental date for the refresh operation
incremental	Boolean	--	Whether to perform an incremental refresh instead of a full refresh

XML Route Examples

Full Datamart refresh

XML

<route>
    <from uri="direct:refreshDM"/>
    <to uri="pfx-api:refresh?targetName=MyDatamart"/>
</route>

Incremental Datamart refresh

XML

<route>
    <from uri="direct:refreshDMIncremental"/>
    <to uri="pfx-api:refresh?targetName=MyDatamart&amp;incremental=true"/>
</route>

Incremental refresh with a specific date

XML

<route>
    <from uri="direct:refreshDMWithDate"/>
    <to uri="pfx-api:refresh?targetName=MyDatamart&amp;incremental=true&amp;incrementalDate=2026-01-01"/>
</route>

Common Pitfalls

targetName is required: You must specify the Datamart name via targetName. Without it, the component does not know which Datamart to refresh.
incremental flag: When incremental is not set or set to false, a full refresh is performed, which can be time-consuming on large Datamarts. Use incremental=true for faster delta refreshes when possible.
incrementalDate format: Provide the date as a string recognized by Pricefx (e.g. 2026-01-01). If omitted during an incremental refresh, Pricefx determines the date automatically.
Version requirement: This method is only available from Integration Manager v1.1.15 and later. Earlier versions do not support the refresh method.