pfx-api:cancel

Cancel an ongoing operation in Pricefx by its typedId. This is typically used to abort long-running jobs such as calculations, imports, or data loads.

Parameters

Parameter	Type	Default	Description
`typedId`	String	--	The typedId of the operation to cancel. Required.

XML Route Examples

Cancel an operation

XML

<route>
    <from uri="direct:cancelOperation"/>
    <to uri="pfx-api:cancel?typedId=456.DM"/>
</route>

Cancel with dynamic typedId

XML

<route>
    <from uri="direct:cancelDynamic"/>
    <setHeader name="CamelPfxApiTypedId">
        <simple>${header.jobTypedId}</simple>
    </setHeader>
    <to uri="pfx-api:cancel"/>
</route>

Common Pitfalls

typedId is required: The typedId parameter must be provided. Without it, the cancel operation has no target and will fail.
Operation may have already completed: If the operation finishes before the cancel request reaches the server, the cancel may be a no-op or return an error.
Not all operations are cancellable: Only certain long-running server-side operations support cancellation. Check the Pricefx API documentation for which operations can be cancelled.