pfx-api:fetchFcs

Returns a list of Data Feed, Data Source, Datamart definitions based on FilterCriteria in the request body; fcType specifies a Type Code (e.g. DMF, DMDS, DM...) or a typedId of the object.

Properties

Option

Type

Default

Description

Option

Type

Default

Description

outputTargetName

string

 

Defines an output target name for the target type header and property. Put here the names of the exchange header and exchange property.

outputTarget

string

 

Defines the output target – header/property.

typedId

string

 

Defines typedId of the Pricefx entity.

valueFields

string

 

Specifies one or more fields (strings separated by a comma) to be returned. Only these fields are fetched by the server from the database, so it generally gives a better performance. The result object is sent as a list of fields (instead of a Map; compare with resultFields).

If omitted, all fields are returned.

sql

string

 

Optional parameter which can be used instead of the PfxApiConfigurationfilter link. Accepts an SQL-like syntax to define a filter logic. For example: 'SELECT a WHERE b 1 ORDER BY a ASC'

The FROM clause has to be omitted – it has no meaning in the filter API.

connection

string

 

Defines connection to Pricefx. This is an optional parameter and if it is omitted, the connection is taken from the Spring bean named pricefx.

sortBy

string

 

Defines the sorting. It overrides sortBy from a filter. Allows expression value (groovy, simple, constant).

enableNullFields

Boolean

false

Defines if during fetch null fields should be returned via REST API back to a client. 

resultFields

string

 

Specifies one or more fields (strings separated by a comma) to be returned (but the server still fetches all the fields from the database). The result object is sent as a Map (compare with valueFields).

If omitted, all fields are returned.

pricingParameterName

string

 

Defines the pricing parameter name for lookup table values.

startRow

integer

 

Defines a start row for the fetch command.

endRow

integer

 

Defines an end row for the fetch command.

dsUniqueName

string

 

Defines dsUniqueName for Datamarts. 

filter

string

 

Defines the name of a filter used by the fetch or delete commands.

Examples

<route> <from uri="direct:start"/> <setHeader name="sortByHeader"> <groovy>'headerSortField1,headerSortField2'</groovy> </setHeader> <setHeader name="sortByHeaderSingleValue"> <groovy>'headerSortFieldSingleValue'</groovy> </setHeader> <toD uri="pfx-api:fetchFcs?typedId=1234''' + uriSuffix + '''"/> <to uri="mock:end"/> </route>

IntegrationManager version 5.8.0