FIQL

FIQL is used to create complex requests. FIQL (pronounced “fickle”) stands for Feed Item Query Language, and it is a solution to REST’s inherent lack of search functionality.

Parameters

• fiql: Criteria used to restrict results. This part of the query is optional.

• fields (required): Comma‐delimited list of fields to be returned for matching resources

• URL: {{url}}/rest/businessObject/ObjectTable/details?fiql={filtering criteria}&fields={comma‐delimited list of fields}

Comparison Operators

Operator	Description
==	equals
!=	does not equal
=gt=	greater than
=ge=	greater than or equal to
=lt=	less than
=le=	less than or equal to

Logical Operators

Operator	Description
;	AND
,	OR – not currently supported by Lucernex

Reserved Word

The word empty is used when no value is specified. This reserved word does not work with text fields.

Query Options

• $top allows you to specify the number of records you want returned for your query.

• $skip allows you to skip a certain number of records returned by the query.

  0 is counted as the first record in your results.

• Use these two parameters in conjunction with the x-total-count value in the response header. This value tells you how many records match your query parameters.

  Example

  Parameter / Value	Scenario 1	Scenario 2
  x-total count	100	100
  $top	15	10
  $skip	0	10
  Records Returned	1-16	10-20

  These parameters are optional. If you use one or both parameters, Lucernex will return a short-term paginated query cache. This query cache will be stored until there has been 20 seconds of inactivity. This allows you to paginate quickly through the returned data, without having to repeatedly query our database.

  Pagination does not deliver any performance benefits for an individual call—all the relevant data is pulled and the response size is limited, but the request will not be any faster than if these parameters are not used. However, if you use different $skip and $top parameters for subsequent calls whose fiql and field parameters remain the same, you will see performance benefits because the results of the initial call are stored in cache for the amount of time configured for your Lucernex environment.

  To learn more about the $top and $skip parameters, see Microsoft’s Query options overview article.