Page Comparison

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 while when running the Pipeline 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.

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 Endpointendpoint. 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 , but and does not entirely replace the resources entirely.

• DELETE: Deletes Entirely 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.

Retry Interval (seconds)

Default Value: 1
Example: 2

Integer/Expression

Specify the time 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.

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 pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.

• Execute only: Performs full execution of the Snap during Pipeline pipeline execution without generating preview data.

• Disabled: Disables the Snap and all Snaps that are downstream from it.