Coupa Read

Overview

Use this Snap to read Coupa resource records such as suppliers by using the relevant resource APIs. You can choose the detail-level of the output and additionally use query parameters to filter the result. Moreover, you can also query a specific record by using the record's ID.

Supported Accounts

Prerequisites

A valid Coupa Account with appropriate permissions.

Limitations

None.

Snap views

Type Description Examples of upstream and downstream Snaps
Input

This Snap has at most one document input view.

Optional. Use upstream Snaps when querying a specific resource record using the record's ID.

Output

This Snap has exactly one document output view.

JSON document containing the record details. Level of detail varies according to the configuration of the Response Type field.

Learn more about Error handling.

Examples

Snap settings

Note: Learn about the common controls in the Snap settings dialog.
Field/Field set Description

Label

String

Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: Coupa Read

Example: Coupa Read Suppliers

Response Type

String

Specifies the level of detail required in the Snap's output. You can configure this keeping in mind the available memory and likely processing time that it would take to execute this Snap.

Available options are:

  • all: Output contains all details of the selected resource.
  • limited: Output contains only the records' ID.
  • shallow: Output contains ID as well as the direct child attributes of each record.

Learn more: API Return Formats.

Default value: all

Example: limited

API Path

String/Expression/ Suggestion

Required. The API name associated with the target resource. Select the target resource from the suggestions in the field. Suggestions vary based on the SnapLogic Coupa account.

Note:

When fetching resource elements such as id (for example, suppliers/:id), you must provide the query value as an upstream parameter.

Example: suppliers

Query Parameters

Use this fieldset to define query parameters and values to filter the results of the query. See Querying Options for details.

Query Parameter

String

The parameter to be used to filter the results of the query. You can also include operators along with the arguments based upon your requirements. See API Operators for details.

Example:

  • limit
  • email
  • email[not_eq]
Query Parameter Value

String/Expression

The value corresponding to the specified parameter.

Example:

Snap execution

Dropdown list
Choose 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.

Default value: Validate & Execute

Example: Execute only