Item menu parameters

When a menu item is defined to access a representation, additional parameters can be added. These parameters and their value are described in this document, and are sent in the URL.

Parameters available in $query

orderBy

This parameter is used to define the order in which the data is sent. Any property in the facet can be used. If the sort combines two properties, they have to be separated by a comma.

count

This parameter gives the number of lines displayed in the query by default. If the number of lines available for the entity exceeds this count, paging links will appear.

key

This parameter can have values given with the following syntaxes
gt.value, lt.value, le.value, and ge.value where value is the value of the key component in which the sort is done. If several values are given they have to be separated by ~.

filter

This parameter can have a value which is the code associated with a predefined filter that will apply.

where

This parameter is used to express an SData 'where' clause between parenthesis. All the properties in the entity can be used. The accepted operators are those defined in evalueSdata.

Example

If we have a BPCUSTOMER that includes BPCTYP, BPCNUM, and BPCNAM as fields, it would be possible to create an item menu:

• That is associated with a Sage X3 application.
• With the representation BPCUSTOMER.
• With the facet Query.
• With the following list of parameters.