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 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
|
|
| 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 when 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
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 (