Invoke Query Parameters Page

Configure the query parameters to control the amount and order of the records returned in the response. Based on the selections you made on the Operations page, the following fields are displayed on the Query Parameters page.

If you selected Query on the Operations page, the following options are displayed:

Configure Query parameters:

Query Expression

Element	Description
Select navigation properties	Select to get the child entities associated with a selected entity type in the response. That is, users can expand the navigation property of an entity. Filters by navigation name: Enter the initial letters to filter the display of navigation properties names. Configure expand parameters: Lists the expand parameters that meet the selection criteria. Your selected expand parameters: Lists your expand parameters selection.
Select required fields in response	Allows users to request a specific set of properties (required fields) for an entity. Filters by field name: Enter the initial letters to filter the display of field names. Configure fields: Lists the fields that meet the selection criteria. Your selected fields: Lists your field selection.
Top n records ($top)	Allows users to get only the first n (for example, 50) records in the response.
Skip n records ($skip)	Allows users to skip the first n (for example, 20) records in the response.
Count of records ($inlinecount)	Allows users to include a count of records in the response.
Add $orderby Query Parameter	Allows users to sort the result set in a particular order: ascending or descending.
Add $filter Query Parameter	Allows users to filter the set of resources that are returned in the response by applying conditions.
Click to see generated query	Click Generate Query to generate the report query. After you provide the required details and click Generate Query, the generated report query is displayed.

Query Builder

Element Description

Element	Description
Enter Query	Enter a valid query statement. You can enter a static query. For example: `expand=to_PurchaseOrderItem&select=PurchaseOrder,CompanyCode, PurchaseOrderType,PurchasingDocumentDeletionCode, AddressPostalCode,to_PurchaseOrderItem&top=20&skip=2&inlinecount= allpages&orderby=PurchaseOrder desc&filter=PurchaseOrder eq '4500000002' and PurchaseOrderType ne 'stri'` You can also enter a dynamic query. For example: `expand=to_PurchaseOrderItem&select=PurchaseOrder,CompanyCode, PurchaseOrderType,PurchasingDocumentDeletionCode,AddressPostalCode, to_PurchaseOrderItem&top=#top&skip=#skip&inlinecount=#inlinecount&orderby=#orderby &filter=#filter`
Click here to test query	Click Validate Query to validate the query. If a query is valid, a `Success` message is displayed and the query response is displayed for a successful query. If the query is invalid, a `Fail` message is displayed.

Enter Query

Enter a valid query statement. You can enter a static query. For example:

expand=to_PurchaseOrderItem&select=PurchaseOrder,CompanyCode,
PurchaseOrderType,PurchasingDocumentDeletionCode,
AddressPostalCode,to_PurchaseOrderItem&top=20&skip=2&inlinecount=
allpages&orderby=PurchaseOrder desc&filter=PurchaseOrder eq '4500000002' 
and PurchaseOrderType ne 'stri'

You can also enter a dynamic query. For example:

expand=to_PurchaseOrderItem&select=PurchaseOrder,CompanyCode,
PurchaseOrderType,PurchasingDocumentDeletionCode,AddressPostalCode,
to_PurchaseOrderItem&top=#top&skip=#skip&inlinecount=#inlinecount&orderby=#orderby 
&filter=#filter

Click here to test query Click Validate Query to validate the query. If a query is valid, a Success message is displayed and the query response is displayed for a successful query. If the query is invalid, a Fail message is displayed.

If you selected Get on the Operations page, the following options are displayed:

Configure Query parameters:

Query Expression

Element

Description

Select navigation properties

Select to get the child entities associated with a selected entity type in the response. That is, users can expand the navigation property of an entity.

Filters by navigation name: Enter the initial letters to filter the display of navigation properties names.
Configure expand parameters: Lists the expand parameters that meet the selection criteria.
Your selected expand parameters: Lists your expand parameters selection.

Select required fields in response

Allows users to request a specific set of properties (required fields) for an entity.

Filters by field name: Enter the initial letters to filter the display of field names.
Configure fields: Lists the fields that meet the selection criteria.
Your selected fields: Lists your field selection.

Query Builder

Element	Description
Enter Query	Enter a valid query statement. For example: `expand=to_PurchaseOrderItem&select=PurchaseOrder`
Click here to test query	Click Validate Query to validate the query. If a query is valid, a `Success` message is displayed and the query response is displayed for a successful query. If the query is invalid, a `Fail` message is displayed.

Note:

To use multilevel navigation, you can enter a query as follows.

For OData version 2:

expand=toPaymentMethodAssignmentV3/countryNav/currencyNav/statusNav

For OData version 4:

expand=_PurchaseOrderItem(expand=_PurchaseOrderScheduleLineTP(expand=_SubcontractingComponent))