Querying for Precise Data Using the Workday Read Snap
This example demonstrates how you can query for all the data associated with an object, and for specific data within an object, using the Workday Read Snap.

Download this Pipeline
Once you have configured the Workday Read Snap with your Workday account details, you should be able to view the services and objects that Workday has enabled for your account. You can then use these services and objects to query the Workday database associated with your account.
You can use the Workday Read Snap to:
- Retrieve all the data associated by default with an object
- Retrieve specific data from Workday by specifying specific criteria for data inclusion
- Retrieve specific data from Workday by specifying specific criteria for data exclusion
Retrieving all the Data Associated by Default with an Object
To retrieve all the data associated by default with an object:
- Add the Workday Read Snap to your pipeline and configure your account details.
- Save the configuration details and wait for validation to complete. Once the Snap is validated, click Settings. This displays the Settings popup.
-
In the Settings screen, enter a Label for the new Snap and change the default Timeout details if required.
Tip: We recommend labeling your Snaps such that their names are indicative of their role in the pipeline. This helps other users understand the purpose of the Snap better. - Click the Suggestions icon on the right of the Service field. This displays a suggestion list containing all the Workday services accessible to your account. Select the service associated with the data you want to retrieve. You can also enter the initial letters of the service you are looking for to further filter the list of services displayed.
- Similarly, click the Suggestions icon on the right of the Object field. This displays a suggestion list containing all the objects associated with the service you selected in the Service field. Select the object that contains the data you want to retrieve. You can also enter the initial letters of the object you are looking for to further filter the list of objects displayed.
-
Given the size of the data typically returned as a result of an object-level request, it is typically a good idea to limit the values of the Page Number and Page Size fields to 1, especially during the testing phase. This way, only the first data record is retrieved, and you can see the result returned by the query almost immediately.
Note: You can also use Pipeline parameters to specify short strings for complicated service and object names in Workday. For step-by-step information on managing properties of pipelines, see Pipeline Properties Parameters. - Save your changes and close the popup. The application validates your settings and displays a preview of the data retrieved if the validation is successful. Note that we only chose the service and object containing the data needed, and made no further specifications. The data retrieved therefore contains only the default data associated with the object you chose.
Including Specific Data
Use the Outputs field set in the Workday Read Snap settings to limit the kind of information Workday returns as the result of your query. Excluding unnecessary fields increases Snap throughput and simplifies downstream Snap pipeline development. It also allows you to retrieve only those pieces of information that you actually require, thereby reducing the need to search for relevant data in the query results.
To include only specific data in your results:
- Open the Workday Read Snap that you used to retrieve the default list of data contained in the Staffing > Get_Workers object.
- Click the + button at the right of the Outputs field set. This adds a row of fields under Outputs. These are the fields that you will use to enter further specifications related to the data you want to retrieve from Workday.
- Click the Suggestions icon on the right of the Path field. This displays a suggestion list containing all the inclusions and exclusions that Workday has made available for the concerned object, to your account. To view all the organizational information associated with workers in your organization, select Response_Group.Include_Organizations from the drop-down list.
-
In the Value field adjacent to the Path field, True is selected by default. Leave it unchanged.
Note: You can also use Pipeline parameters to specify short strings for complicated service and object names in Workday. For step-by-step information on managing properties of pipelines, see Pipeline Properties Parameters. - Save your changes and exit the popup. The application validates your changes. Once this is complete, click the icon adjacent to the Workday Read Snap to display a preview of the data retrieved using your modified query.
Excluding Specific Data
You can combine an Exclude expression with an Include expression in the Outputs field set to query Workday for all the organizational information associated with a worker without including specific data nodes. For example, to exclude the Organization_Support_Role_Data node that contains details associated with each worker's role in the organization:
- Click the Workday Read Snap to open the Workday Read popup. Navigate to the Settings tab.
- Click the + button at the right of the Outputs field set. This adds another row of fields under Outputs to enter the data exclusion specifications.
- In the field under the Path column heading, enter Response_Group.Exclude_Organization_Support_Role_Data.
-
The Value field defaults to True. Leave it unchanged.
Note: You can also use Pipeline parameters to specify short strings for complicated service and object names in Workday. For step-by-step information on managing properties of pipelines, see Pipeline Properties Parameters. - Save your changes and close the popup. Allow the application to validate your changes. Once this is done, click the icon to the right of the Workday Read Snap to display a preview of the data returned in response to your query. The new output contains all the fields that were returned in the previous query, except for Organization_Support_Role_Data. By combining Include with Exclude expressions, you can control the data that Workday returns to queries.
- Download and import the SLP file into your Environment.
- Configure Snap accounts.
- Provide Pipeline parameters, if any.