You can use the Workday REST Snap to connect to the Workday REST APIs. The Workday REST Snap identifies the REST APIs using the OpenAPI specification specified for the service and connects to endpoints under the chosen service.
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.
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 while 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.
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.
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 withe new ID.
PUT: Updates and replaces the existing resources.
PATCH: Updates and modifies the resources. PATCH operation only modifies the content of the resources, but does not replace the resources entirely.
DELETE: Deletes the resources entirely.
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 time interval in seconds between retry attempts.
HTTP Headers
Use this field set to add additional headers to the HTTP requestdefined in the WorkdayOpenAPI 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 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 contains the following key steps:
Creating a JSON document to send the input data.
Retrieving the scorecardResults object from Workday.
Updating the data in scorecardResults object.
Deleting 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 compensationService and post Operation to create the scorecard object.
After validating the Snap, you can view 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 compensationService 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 PatchOperation.
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 DeleteOperation.
After validating the Snap, you can view the output with deleted path ID values.
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: Configure the Workday REST Snap as follows. 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.
Updated and certified against the current SnapLogic Platform release.
May 2024
main26341
Stable
Updated and certified against the current SnapLogic Platform release.
February 2024
436patches25953
Latest
Upgraded Apache CXF from version 3.4.2 to 3.6.3 to prevent vulnerability issues.
February 2024
main25112
Stable
Updated and certified against the current SnapLogic Platform release.
November 2023
435patches24944
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
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
Stable
Updated and certified against the current SnapLogic Platform release.
May 2023
main21015
Stable
Upgraded with the latest SnapLogic platform release.
February 2023
432patches20313
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
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
Latest
Introduced the Workday REST Snap to connect to Workday REST APIs. This Snap supports the following new accounts:
Upgraded with the latest SnapLogic platform release.
October 2022
430patches18358
Latest
The Workday Read, Workday Write, and Workday Cancel Snaps are now showing the Services in thesuggestions list using the Public Web Service API, which the Snaps failed to use previously.
August 2022
430patches17587
Latest
The performance of the Workday Read Snap is improved to reduce the execution time.
August 2022
main17386
Stable
Upgraded with the latest SnapLogic platform release.
4.29
main15993
Stable
Added support for the latest version of Workday APIs (certified to be compatible with version 37.0).
4.28 Patch
428patches14290
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
Stable
Enhanced the Workday Read Snap with the following:
Added the Pass-throughon 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
Stable
Enhanced the Workday Read Snap with the new field PoolSize 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
Latest
Enhanced the Workday Read Snap with the new field PoolSize 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
Stable
Upgraded with the latest SnapLogic platform release.
4.25
main9554
Stable
Upgraded with the latest SnapLogic platform release.
4.24
main8556
Stable
Upgraded with the latest SnapLogic platform release.
4.23
main7430
Stable
Upgraded with the latest SnapLogic platform release.
Upgraded with the latest SnapLogic platform release.
4.20 Patch
workday8817
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
Latest
Fixes the Workday Read Snap that fails to validate when configured in the New Form UI.
4.20
snapsmrc535
Stable
Upgraded with the latest SnapLogic platform release.
4.19
snaprsmrc528
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
Latest
Fixed an issue with the Workday Read Snap wherein the Snap is unable to log SOAP calls.
4.18
snapsmrc523
Stable
Upgraded with the latest SnapLogic platform release.
4.17
ALL7402
Latest
Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.
4.17
snapsmrc515
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
Latest
Fixed an issue with paging variable toggle in Workday Read Snap to produce correct preview data.
4.16 Patch
workday6862
Latest
Fixed an issue with the Workday Read Snap not logging SOAP calls.
4.16
snapsmrc508
Stable
Upgraded with the latest SnapLogic platform release.
4.15 Patch
workday6727
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
Latest
Fixed an issue with the Workday Read Snap giving inconsistent results. Reverting the multithreading update resolved the issue.
4.15
snapsmrc500
Stable
Upgraded with the latest SnapLogic platform release.
4.14
snapsmrc490
Stable
Upgraded with the latest SnapLogic platform release.
4.13 Patch
workday5247
Latest
Fixed the Workday Read Snap that took an extended time to read from the Workday application.
4.13
snapsmrc486
Stable
Upgraded with the latest SnapLogic platform release.
4.12
snapsmrc480
Stable
Upgraded with the latest SnapLogic platform release.
4.11
snapsmrc465
Stable
Upgraded with the latest SnapLogic platform release.
4.10
snapsmrc414
Stable
Upgraded with the latest SnapLogic platform release.
4.9
snapsmrc405
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
Stable
Updated the Read Snap with the Simplified output property.
Info tab added to accounts.
4.7
snapsmrc382
Stable
Upgraded with the latest SnapLogic platform release.
4.6
snapsmrc362
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
Stable
Resolved issues in Workday Snaps to ensure appropriate errors are routed to the error views.
4.4.1
Stable
Upgraded with the latest SnapLogic Platform release.
4.4
Stable
Resolved an exception in Workday Read.
4.3.2
Stable
Addressed the following issues:
Defect: Workday Read Input Using As Of Date/Time in Response_Filter