Sample: Validate and execute a saved query

This sample shows how to use the IOrganizationService.ValidateSavedQueryRequest message to validate a FetchXML query, and then use the IOrganizationService.ExecuteByIdSavedQueryRequest message to execute the query. You can download the sample from here.

How to run this sample

  1. Download or clone the Samples repo so that you have a local copy.
  2. (Optional) Edit the cds/App.config file to define a connection string specifying the Common Data Service instance you want to connect to.
  3. Open the sample solution in Visual Studio and press F5 to run the sample. After you specify a connection string in cds/App.config, any sample you run will use that connection information.

If you do not specify a connection string in cds/App.config file, a dialog will open each time you run the sample and you will need to enter information about which Common Data Service instance you want to connect to and which credentials you want to use. This dialog will cache previous connections so that you can choose a previously used connection.

Those samples in this repo that require a connection to a Common Data Service instance to run will include a linked reference to the cds/App.config file.

What this sample does

The ValidateSavedQueryRequest class is intended to be used in a scenario where it contains the data that is needed to validate a saved query (view).

The ExecuteByIdSavedQueryRequest class is intended to be used in a scenario where it contains data that is needed to execute a saved query (view) that has the specified ID.

How this sample works

In order to simulate the scenario described in What this sample does, the sample will do the following:

Setup

  1. Checks for the current version of the org.
  2. The Account method creates 3 account records.
  3. The SavedQuery method creates a Saved query.
  4. The UserQuery method creates a User query.

Demonstrate

  1. The ValidateSavedQueryRequest method creates the validate request.
  2. The ExecuteByIdSavedQueryRequest method executes the saved query.

Clean up

  1. Displays an option to delete all the data created in the sample.

The deletion is optional in case you want to examine the data created by the sample. You can manually delete the data to achieve same results.