Invoke Query Parameters Page

Configure the invoke query parameters for the Retrieve All and Retrieve by ID operations.

Retrieve All

This page appears when you select the Retrieve All option on the Operations page.

Element Description

Select navigation properties
Select to get the child entities associated with a selected entity type in the response. That is, you 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 query parameters that meet the selection criteria.
  • Your selected expand parameters: Lists your expand query parameters selection.

Note: The navigation property supports multiple levels of hierarchy. However, within the shuttle box, only the first-level navigation property is available by default.

To enable multilevel navigation, modifications must be made through the Edit Query option.

Select required fields in response
Allows you 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.
Add $orderby Query Parameters
Allows you to sort the result set in an ascending or descending order. Example:
https: //host/service.svc/Order?$orderby=ShipCountry
Add $filter Query Parameters
Allows you to filter the set of resources that are returned in the response by applying conditions. Example:
https://host/service.svc/Oreder?$filetr = ShipCountry
Edit Query

The child page shows a query generated based on your selected query parameters. You can edit and save the query as needed.

Note:
  • You can use this option to add up to fifth-level navigation properties.
  • For Customized Query:
    • If the query is edited, the Summary Page shows the edited query under the Customized Query section.
    • The Configure Query Parameter page does not provide the option to select from the shuttle box.
    • Only the Edit Query, Try Query, and Reset Configuration options are available.
    • Revisiting the invoke after adding a customized query shows a warning message above that shows the previously-selected query.
Try Query

When the query is successful, the child page shows the top five rows. If it fails, an error message is shown.

Note: The Try Query option is mandatory for Create, Update, and Merge. The child page displays where you must provide the ID details for the newly added invoke. Click Test to view the response. Click Continue to proceed.

Reset Configuration

If the Query is customized (that is, edited) and the invoke connection is then re-edited, a warning message is displayed.

Clicking Reset Configuration clears the customized query entirely and returns the default configuration.

Retrieve by ID

This page appears when you select the Retrieve by ID option on the Operations page.

Element Description

Select navigation properties
Select to get the child entities associated with a selected entity type in the response. That is, you 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 query parameters that meet the selection criteria.
  • Your selected expand parameters: Lists your expand query parameters selection.

Note: The navigation property supports multiple levels of hierarchy. However, within the shuttle box, only the first-level navigation property is available by default. To enable multilevel navigation, modifications must be made through the Edit Query option.

Select required fields in response
Allows you 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.
Edit Query

The child page shows a query generated based on your selected query parameters. You can edit and save the query as needed.

Note:
  • You can use this option to add up to fifth-level navigation properties.
  • For Customized Query:
    • If the query is edited, the Summary Page shows the edited query under the Customized Query section.
    • The Configure Query Parameter page does not provide the option to select from the shuttle box.
    • Only the Edit Query, Try Query, and Reset Configuration options are available.
    • Revisiting the invoke after adding a customized query shows a warning message above that shows the previously-selected query.
Try Query

When the query is successful, the child page shows the top five rows. If it fails, an error message is shown.

Note: The Try Query option is mandatory for Create, Update, and Merge. The child page shows where you must provide the ID details for the newly added invoke. Click Test to view the response. Click Continue to proceed.

Reset Configuration

If the Query is customized (that is, edited) and the invoke connection is then re-edited, a warning message is displayed.

Clicking Reset Configuration clears the customized query entirely and returns the default configuration.