OData Query Wizard (Magic xpi 4.9)
The OData Query Wizard helps you to build OData queries with the correct syntax, and is available when you select the Get operation in the OData Configuration dialog box's Operation field.
It contains the following separate screens:
The Restrictions screen lets you filter the number of results that will be returned by the query. Select one of the following from the drop-down list:
-
count
-
top 1
-
top 20 (default)
-
top 100
-
top 1000
The Where screen lets you define which results will be fetched by the query. It contains the following parameters as columns:
-
Field Name: Select the required field name from the drop-down list. The available field names are determined by the entity that you selected in the OData Configuration dialog box's Entity field.
-
Operator: Select the required operator from the drop-down list. The available operators are determined by the field name that you selected in the Field Name column.
-
<!?Field Name?!>: This read-only column displays the previously selected field name.
Click Add to add lines to the Where query, and click Delete to delete lines from the Where query.
|
|
When you add a line, the OData query is created with ‘and’ between the created lines. You can manually edit the resulting query as required.
|
The Column Selection screen lets you select columns for your query. Select the check box next to the required column(s). The available columns are determined by the entity that you selected in the OData Configuration dialog box's Entity field.
The Expand screen lets you select additional entities that are related to the entity that you selected in the OData Configuration dialog box's Entity field.
The Order screen lets you define the order of the results that are fetched by the query. It contains the following parameters as columns:
-
Field Name: Select the required field name from the drop-down list. The available field names are determined by the entity that you selected in the OData Configuration dialog box's Entity field.
-
Direction: Select the direction of the results order from the drop-down list. The options are Ascending or Descending.
Once you have gone through these screens, click Finish. The OData Query Wizard will close, and you will then see your newly created query in the OData Configuration dialog box's Parameters field.
