Input 

Document

• Min: 0

• Max: 1

• Workday Read

• Mapper

The OpenAPI path, operation and query parameters of the endpoint.

Output

Document

• Min: 1

• Max: 1

• Workday Delete

• Copy

The data fetched from the WQL endpoint.

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.

Label*

Default Value: WorkdayQL
Example: Workday QL Snap

String

The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

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.

Query Parameters

You can use this fieldset to define the name and value for query parameters on request.

Name

Default Value:  None.
Example: Content-type

String/Expression

Specify the name of the query parameter for retrieving assets.

Field 2

Default Value: None.
Example: application/json

String

Specify the value for the query parameter for retrieving assets.

Number of Retries 

Integer

Enter the integer value to specify the number of attempts the snap should make to perform the selected operation in case of connection failure or timeout.

Minimum value: 0

Default Value: 0
Example: 3

Retry Interval (seconds)

Integer

Enter the time interval in seconds between retry attempts.

Minimum value: 1

Default Value: 1
Example: 3

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

Account validation failed.

The Pipeline ended before the batch could complete execution due to a connection error.

Verify that the Refresh token field is configured to handle the inputs properly. If you are not sure when the input data is available, configure this field as zero to keep the connection always open.