In this article

Overview

You can use the Workday REST Snap to connect to the Workday REST APIs. This Snap supports all standard REST operations and provides a few enhancements from the traditional APIs, including better object models and better performance with faster API query responses. The=is Snap identifies the REST APIs using the OpenAPI specification specified for the service and connects to endpoints under the selected service. It also supports authentication mechanisms such as OAuth2.0.

Snap Type

The Workday REST Snap is a Write-type Snap.

Prerequisites

You must have a valid Workday REST Account, data to query, and Workday access to the specified objects. Contact your organization's Workday Security Administrator for appropriate access.

Support for Ultra Pipelines

The Workday REST Snap supports Ultra Pipelines.

Limitation

The Workday REST Snap does not support specific Unicode, Special, and UTF-8 byte characters because of the API limitation. This Snap produces an unexpected preview in the output when you pass input data with special or Unicode characters.

Known Issues

None

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input

Document

Min: 0
Max: 1

JSON Generator
Mapper

A document that conforms to the input view schema of the Snap. The input view schema is provided to an upstream Mapper Snap based on the selected service object.

Output

Document

Min: 1
Max: 1

Mapper
Router

A document that represents the record structure of the retrieved Workday service object. Each record is represented as one document on the output view.

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab:

Stop Pipeline Execution: Stops the current pipeline execution if the Snap encounters an error.
Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.
Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

Asterisk ( * ): Indicates a mandatory field.
Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon ( ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon ( ): Indicates that you can add fields in the field set.
Remove icon ( ): Indicates that you can remove fields from the field set.
Upload icon ( ): Indicates that you can upload files.

Field Name		Field Type	Description
Label* Default Value: Workday REST Example: Onboarding newhires		String	Specify a unique name for the Snap.
Service* Default Value: N/A Example: Compensation		String/Expression/Suggestion	Specify or select the Workday Service to connect to Workday.
Version* Default Value: N/A Example: v2		String/Expression/Suggestion	Select the version corresponding to the service.
OpenAPI Path* Default Value: N/A Example: /workers		String/Expression/Suggestion	Enter the path for the REST endpoint. Based on the service and version, the Snap downloads the open API specification and populates the list.
Operation* Default Value: N/A Example: get		String/Expression/Suggestion	Specify the operation to perform on the selected OpenAPI path or select from the suggestions list. The available options are: GET: Reads and retrieves content and data. POST: Creates a new resource with a new ID. PUT: Updates and replaces the existing resources. PATCH: Updates and modifies the resources. PATCH operation only modifies the content of the resources and does not entirely replace the resources. DELETE: Entirely deletes the resources.
Number of Retries Default Value: 0 Example: 3		Integer/Expression	Specify the number of attempts the Snap must make to perform the selected operation in case of connection failure or timeout. The Snap retries the request if the value is greater than zero or retries only if it encounters 401 or 500 error.
Retry Interval (seconds) Default Value: 1 Example: 2		Integer/Expression	Specify the retry interval in seconds between retry attempts.
HTTP Headers	Use this field set to add additional headers to the HTTP request defined in the Workday OpenAPI specification.
	Header Default Value: N/A Example: content-type	String/Expression	Specify a name for the HTTP header.
	Values Default Value: N/A Example: application/json	String/Expression	Specify a value to assign to the HTTP header.
Pass through Default Value: Deselected		Checkbox	Select this checkbox to enable the Snap to pass the input data to the downstream Snap and display in the output document.
Enable Pagination Default Value: Selected		Checkbox	Select this checkbox to enable the Snap to return the response in multiple pages when the input document contains the `limit` and `offset` query parameters. The maximum limit value of the page size is 100—that is, the Snap fetches all records until the last page with 100 records on each page. If the limit field is blank, the default limit value is 20 and the Snap displays only one page of records. When you deselect this checkbox, the Snap limits the number of output documents to 100, with only one page of records.
Snap Execution Default Value: Execute only Example: Validate & Execute		Dropdown list	Select one of the three modes in which the Snap executes. Available options are: Validate & Execute: Performs limited execution of the Snap, and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime. Execute only: Performs full execution of the Snap during pipeline execution without generating preview data. Disabled: Disables the Snap and all Snaps that are downstream from it.

Troubleshooting

Error

Reason

Resolution

403 Error: Unauthorized user.

The permissions are insufficient.

Ensure that you assign the required permissions and retry.

Example

Creating and Retrieving Compensation Details

This example Pipeline demonstrates how to retrieve the compensation details with the scorecardResults object using the following operations:

POST: Creates the scorecardresults object.
GET: Retrieves the compensation details.
PATCH: Updates the details.
DELETE: Deletes the IDs of the scorecard results.

This Pipeline consists of the following key steps:

Create a JSON document to send the input data.
Retrieve the scorecardResults object from Workday.
Update the data in the scorecardResults object.
Delete the updated data in the scorecardResuts object.

Step 1: Configure the JSON Generator Snap as follows with the scorecardResults object and validate the Snap:

Step 2: Configure the Mapper Snap to pass the scorecard details as an input to the Workday REST Snap.

Step 3: Configure the Workday REST Snap with the compensation Service and post Operation to create the scorecard object.

After validating the Snap, view it in the output that the object is created.

Step 4: Configure the Mapper Snap to extract the scorecardResultsID.

Step 5: Configure the Workday REST Snap with the compensation Service and get Operation. After validating the Snap, you get the object value:

Step 6: Configure the Mapper Snap to extract the scorecardResults.

Step 7: Configure the Workday REST Snap with the Mapper Snap output and Patch Operation.

After validating the Snap, you can view the output with updated object values.

Step 8: Configure the Mapper Snap to pass the original IDs that are to be deleted.

Step 9: Configure the Workday REST Snap with the Mapper Snap output and Delete Operation.

After validating the Snap, you can view the output with the deleted path ID values.

Download this Pipeline.

Getting All Records From Workday Using Pagination

Prerequisite: A valid Workday REST OAuth2 account to access the resources from Workday.

This example Pipeline demonstrates the Pagination functionality in the Workday REST Snap. In this example, we fetch all worker records from Workday using the Enable Pagination feature.

Step 1: Configure the Mapper Snap with the limit as 100 and offset at 0—this limits the worker records to 100 records on each page.

Step 2: To configure the Workday REST Snap, select the Enable Pagination checkbox to enable the Snap to paginate the response.

Step 3: Execute the pipeline. The Snap returns all worker records (365 records in this case) with 100 records on each page.

Download this pipeline.

Downloads

Download and import the pipeline into SnapLogic.
Configure Snap accounts, as applicable.
Provide Pipeline parameters, as applicable.

	File	Modified

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.

No files shared here yet.

Drag and drop to upload or browse for files

Snap Pack History

Click here to expand...

Release	Snap Pack Version	Date	Type	Updates
May 2024	main26341	08 May 2024	Stable	Updated and certified against the current SnapLogic Platform release.
February 2024	436patches25953	23 Apr 2024	Latest	Upgraded Apache CXF from version 3.4.2 to 3.6.3 to prevent vulnerability issues.
February 2024	main25112	14 Feb 2024	Stable	Updated and certified against the current SnapLogic Platform release.
November 2023	435patches24944	31 Jan 2024	Latest	Fixed an issue with Workday REST Snap where the input schema of the Snap did not populate in the upstream Mapper Snap.
November 2023	435patches24309	19 Dec 2023	Latest	Added the WorkdayQL Snap in the Workday Snap Pack, which connects with the Workday Query Language (WQL) endpoints.
November 2023	main23721	08 Nov 2023	Stable	Updated and certified against the current SnapLogic Platform release.
August 2023	main22460	16 Aug 2023	Stable	Updated and certified against the current SnapLogic Platform release.
May 2023	main21015	10 May 2023	Stable	Upgraded with the latest SnapLogic platform release.
February 2023	432patches20313	28 Mar 2023	Latest	Fixed an issue with the Workday REST Snap where it failed with a null pointer exception when the input document was null.
February 2023	main19844	09 Feb 2023	Stable	The Workday REST Snap supports Pass through and Pagination fields. Pass through: Enables the Snap to pass the input data to the output document. Enable Pagination: Enables the Snap to return the response in multiple pages based on the limit and offset query parameters. The maximum limit value is 100. Deselect this checkbox to download only one page of records.
January 2023	431patches19450	11 Jan 2023	Latest	Introduced the Workday REST Snap to connect to Workday REST APIs. This Snap supports the following new accounts: Workday Rest Access Token Workday Rest OAuth2 Account
November 2022	main18944	10 Nov 2022	Stable	Upgraded with the latest SnapLogic platform release.
October 2022	430patches18358	19 Oct 2022	Latest	The Workday Read, Workday Write, and Workday Cancel Snaps are now showing the Services in the suggestions list using the Public Web Service API, which the Snaps failed to use previously.
August 2022	430patches17587	30 Aug 2022	Latest	The performance of the Workday Read Snap is improved to reduce the execution time.
August 2022	main17386	11 Aug 2022	Stable	Upgraded with the latest SnapLogic platform release.
4.29	main15993	14 May 2022	Stable	Added support for the latest version of Workday APIs (certified to be compatible with version 37.0).
4.28 Patch	428patches14290	04 Mar 2022	Latest	Enhanced the Workday Cancel Snap with the retry mechanism fields. Number of Retries: Specifies the number of attempts the Snap should make to perform the selected operation in case of connection failure or timeout. Retry Interval (seconds): The time interval in seconds between retry attempts.
4.28	main14627	12 Feb 2022	Stable	Enhanced the Workday Read Snap with the following: Added the Pass-through on no lookup match checkbox that allows the input document to pass through to the output view when there are when no records match an input document. Parameterization of the Page Number and Page Size fields using Pipeline parameters. You can define and use the parameters in these fields using the Expression Enabler icon to pass values during runtime.
4.27	main12833	13 Nov 2021	Stable	Enhanced the Workday Read Snap with the new field Pool Size that controls the maximum number of threads in the pool. This field is available only when you select the Multi-threaded checkbox.
4.26 Patch	426patches11525	06 Sep 2021	Latest	Enhanced the Workday Read Snap with the new field Pool Size that controls the maximum number of threads in the pool. This field is available only when you select the Multi-threaded checkbox.
4.26	main11181	14 Aug 2021	Stable	Upgraded with the latest SnapLogic platform release.
4.25	main9554	08 May 2021	Stable	Upgraded with the latest SnapLogic platform release.
4.24	main8556	13 Feb 2021	Stable	Upgraded with the latest SnapLogic platform release.
4.23	main7430	14 Nov 2020	Stable	Upgraded with the latest SnapLogic platform release.
4.22	main6403	12 Sep 2020	Stable	Removes support for Workday WSDL Account. Pipelines. You must switch these Snaps using either the Workday Account or Workday Dynamic Account type.
4.21	snapsmrc542	09 May 2020	Stable	Upgraded with the latest SnapLogic platform release.
4.20 Patch	workday8817	27 Apr 2020	Latest	Fixes the Workday Write Snap that ignores the Import Synchronized checkbox selection when importing object data. The Snap now: Waits for the current import request to complete, whether successfully or with error, before initiating the next import request. Provides accurate real-time status of the request to downstream Snaps. Existing Pipelines using this Snap to might experience longer exercution times because of the synchronous behavior. However, you no longer need to use an additional Snap to capture and pass the request status to downstream Snaps.
4.20 Patch	workday8761	06 Mar 2020	Latest	Fixes the Workday Read Snap that fails to validate when configured in the New Form UI.
4.20	snapsmrc535	08 Feb 2020	Stable	Upgraded with the latest SnapLogic platform release.
4.19	snaprsmrc528	14 Nov 2019	Stable	The Workday Write Snap includes a Validate Only Load checkbox, which enables users to upload–and then manually validate–data before importing it into Workday.
4.18 Patch	workday7837	11 Sep 2019	Latest	Fixed an issue with the Workday Read Snap wherein the Snap is unable to log SOAP calls.
4.18	snapsmrc523	10 Aug 2019	Stable	Upgraded with the latest SnapLogic platform release.
4.17	ALL7402	11 Jun 2019	Latest	Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.
4.17	snapsmrc515	11 Jun 2019	Latest	Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview checkbox.
4.16 Patch	workday6973	20 Mar 2019	Latest	Fixed an issue with paging variable toggle in Workday Read Snap to produce correct preview data.
4.16 Patch	workday6862	22 Feb 2019	Latest	Fixed an issue with the Workday Read Snap not logging SOAP calls.
4.16	snapsmrc508	16 Feb 2019	Stable	Upgraded with the latest SnapLogic platform release.
4.15 Patch	workday6727	28 Jan 2019	Latest	Fixed an issue with the Soap Execute Snap failing for Workday when the Trust All certificate is enabled while using SSL authentication.
4.15 Patch	workday6292	13 Dec 2018	Latest	Fixed an issue with the Workday Read Snap giving inconsistent results. Reverting the multithreading update resolved the issue.
4.15	snapsmrc500	15 Dec 2018	Stable	Upgraded with the latest SnapLogic platform release.
4.14	snapsmrc490	11 Aug 2018	Stable	Upgraded with the latest SnapLogic platform release.
4.13 Patch	workday5247	19 Jun 2018	Latest	Fixed the Workday Read Snap that took an extended time to read from the Workday application.
4.13	snapsmrc486	12 May 2018	Stable	Upgraded with the latest SnapLogic platform release.
4.12	snapsmrc480	17 Feb 2018	Stable	Upgraded with the latest SnapLogic platform release.
4.11	snapsmrc465	11 Nov 2017	Stable	Upgraded with the latest SnapLogic platform release.
4.10	snapsmrc414	12 Aug 2017	Stable	Upgraded with the latest SnapLogic platform release.
4.9	snapsmrc405	13 May 2017	Stable	Updated the Snap with Import Synchronized, Import Batch Size and Import Batch Node to enhance the performance for Import objects supporting bulk operations. Updated the Workday Read Snap with the Page Number and the Page Size properties.
4.8	snapsmrc398	11 Feb 2017	Stable	Updated the Read Snap with the Simplified output property. Info tab added to accounts.
4.7	snapsmrc382	23 Nov 2016	Stable	Upgraded with the latest SnapLogic platform release.
4.6	snapsmrc362	13 Aug 2016	Stable	Resolved an issue in Workday Read Snap that caused errors when the timeout field was set. Resolved an issue in Snaps with Workday Dynamic account that caused an error when a pipeline parameter provided an empty value to the password field.
4.5.1	snapsmrc344	18 May 2016	Stable	Resolved issues in Workday Snaps to ensure appropriate errors are routed to the error views.
4.4.1		18 Mar 2016	Stable	Upgraded with the latest SnapLogic Platform release.
4.4		13 Feb 2016	Stable	Resolved an exception in Workday Read.
4.3.2		15 Jan 2016	Stable	Addressed the following issues: Defect: Workday Read Input Using As Of Date/Time in Response_Filter Defect: Workday Snap Does Not Show All Services

Workday REST