In this article
Table of Contents | ||||||
---|---|---|---|---|---|---|
|
Overview
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.
Support for Ultra Pipelines
The Workday REST Snap supports Ultra Pipelines.
Limitation
None
Known Issues
None
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| 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 |
|
| 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:
Learn more about Error handling in Pipelines. |
Snap Settings
Info |
---|
|
Field Name | Field Type | Description | |
---|---|---|---|
Label* Default Value: Workday REST | String | Specify a unique name for the Snap.
| |
Service* Default Value: N/A | String/Expression/Suggestion | Specify or select the Workday Service to connect to Workday. | |
Version* Default Value: N/A | String/Expression/Suggestion | Select the version corresponding to the service. | |
OpenAPI Path* Default Value:N/A | 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 | String/Expression/Suggestion | Specify the operation to perform on the selected OpenAPI path or select from the suggestions list. The available options are
| |
Number of Retries Default Value:0 | 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 | Integer/Expression | Specify the time 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 | String/Expression | Specify a name for the HTTP header. | |
Values Default Value: N/A | 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
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 | Dropdown list | Select one of the three modes in which the Snap executes. Available options are:
|
Troubleshooting
Error | Reason | Resolution |
---|---|---|
| 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 compensation Service 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 scorecardResults
ID.
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 deleted path ID values.
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: 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.
Downloads
Info |
---|
|
Attachments | ||||
---|---|---|---|---|
|
Snap Pack History
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|