Workday REST

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 supportUltra 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

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

Field Name

Field Type

Description

Label*

Default ValueWorkday REST
ExampleOnboarding newhires

String

Specify a unique name for the Snap.

 

 

Service*

Default Value: N/A
ExampleCompensation

String/Expression/Suggestion

Specify or select the Workday Service to connect to Workday.

Version*

Default Value: N/A
Examplev2

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 ValueN/A
Examplecontent-type

String/Expression

Specify a name for the HTTP header.

Values

Default ValueN/A
Exampleapplication/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 ValueExecute 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

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:

  1. Create a JSON document to send the input data.

  2. Retrieve the scorecardResults object from Workday.

  3. Update the data in the scorecardResults object.

  4. 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

 

Snap Pack History


Related Content