Versions Compared

Old Version 14

changes.mady.by.user Kalpana Malladi

Saved on

compared with

New Version 15

changes.mady.by.user Gouri Bhagchandani

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field Name

Field Type

Field dependency

Description

Label*

Default Value: WorkdayQL
Example: Workday QL Snap

String

None

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: /data

String/Expression/Suggestion

None

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

None

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: Reads and retrieves content and data for large query.

Query

Default value: N/A
Example: Get

String

Appears when you select /data in the OpenAPI Path.

Specify an encoded query string to filter the records.

Limit

Default value: N/A
Example: 10

Integer

Appears only when you select /data in OpenAPI Path and GET in Operation.

Specify the number of rows to return from the query.

Offset

Default value: N/A
Example: 5

Integer

Appears only when you select /data in OpenAPI Path and GET in Operation.

Specify the offset for the limit clause.

Query Parameters

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

Parameters

Default Value:  N/A
Example: alias

String/Expression

Appears when you select /data in the OpenAPI Path.

Specify the name of the query parameter for retrieving assets.

Values

Default Value: N/A
Example: cds_FTPUI

String

Appears when you select /data in the OpenAPI Path.

Specify the value for the query parameter for retrieving assets.

Number of Retries

Minimum value: 0

Default Value: 0
Example: 3 

Integer

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

Retry Interval (seconds)

Minimum value: 1

Default Value: 1
Example: 3 

Integer

Specify the time interval in seconds between retry attempts.

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

When you deselect this checkbox, the Snap limits the number of output documents to 100, with only one page of records.

The maximum limit value of the page size is 100—the Snap fetches all records until the last page with 100 records on each page.

Snap Execution

Default Value: Execute only
Example: Validate & Execute

Dropdown list

Select one of the following three modes in which the Snap executes:

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

Video

Watch the video to learn how to configure a WorkdayQL OAuth2 Account & Use the WorkdayQL Snap.

...

Troubleshooting

Error

Reason

Resolution

403 Error: Unauthorized user.

The permissions are insufficient.

Ensure that you assign the required permissions and retry.

Code Block
"statusCode":
500
"statusPhrase":
"Internal Server Error"
"protoVersion":
"HTTP/1.1"

Offset is greater than or equal to total row size. When the offset value provided in the Snap is greater than number of the existing records, then the Snap fails.

Provide an offset value lesser than the number of records.

...