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 |
No |
-- |
The Pricefx object type. Typically |
|
|
String |
No |
-- |
Unique name of the field collection structure to fetch. If omitted, all objects of the specified |
XML Route Examples
Fetch a specific field collection structure:
XML
<route>
<from uri="direct:fetchFieldCollection"/>
<to uri="pfx-api:fetchFcs?objectType=CFS&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
dsUniqueNameis omitted, the endpoint returns all objects of the givenobjectType, which may be a large result set. -
Ensure the
dsUniqueNamevalue matches exactly (case-sensitive) the name configured in Pricefx.