pfx-api:fetchFcs

pfx-api:fetchFcs

Fetch a field collection structure (CFS) from Pricefx. If dsUniqueName is not set, fetches all objects of the given objectType.


URI Format

pfx-api:fetchFcs?objectType=CFS&dsUniqueName=MyFieldCollection

Parameters

Parameter

Type

Required

Default

Description

objectType

ObjectType

No

--

The Pricefx object type. Typically CFS (Calculated Field Set) or related types.

dsUniqueName

String

No

--

Unique name of the field collection structure to fetch. If omitted, all objects of the specified objectType are returned.


XML Route Examples

Fetch a specific field collection structure:

XML
<route>
    <from uri="direct:fetchFieldCollection"/>
    <to uri="pfx-api:fetchFcs?objectType=CFS&amp;dsUniqueName=MyFieldCollection"/>
</route>

Fetch all field collection structures:

XML
<route>
    <from uri="direct:fetchAllFcs"/>
    <to uri="pfx-api:fetchFcs?objectType=CFS"/>
</route>

Common Pitfalls

  • When dsUniqueName is omitted, the endpoint returns all objects of the given objectType, which may be a large result set.

  • Ensure the dsUniqueName value matches exactly (case-sensitive) the name configured in Pricefx.