outputTarget

string

Defines the target – header/property/body.

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.

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.

pricingParameterId

string

Defines the pricing parameter ID.

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).

distinctResults

Boolean

Optional parameter which specifies if the DISTINCT clause should be added to the search. Use together with valueFields option.

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.

pricingParameterId

integer

Defines ID.

dsUniqueName

string

Defines dsUniqueName for Datamarts. 

quoteUniqueName

string

Defines quoteUniqueName for Quote API.

dcrUniqueName

string

Defines dcrUniqueName for Data Change Request API.

filter

string

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

async

Boolean

false

Sets whether the processing should be asynchronous. Currently this is supported only for the delete command.

asyncTimeout

integer

30000

Sets a timeout for asynchronous evaluation (in milliseconds).

asyncRetry

integer

10000

For asynchronous evaluation, sets how often job status will be checked (in milliseconds).

customFilterExpression

string

Defines a custom filter expression. It allows for more advanced filtering, for example customFilterExpression=attribute1>attribute2 filters all rows where the value in the attribute1 column is greater than values in the attribute2 column.