Versions Compared

Key

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

On this page

...

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.


Prerequisites

  • Valid Coupa account with appropriate permissions.

Limitations

None.

Snap Views

TypeFormatNumber of ViewsCompatible Upstream and Downstream SnapsDescription
Input Document
  • Min: 0
  • Max: 1
  • Mapper Snap
  • Copy Snap
Optional. Use upstream Snaps when querying a specific resource record using the record's ID.
OutputDocument
  • Min: 1
  • Max: 1
  • Document to Binary + File Writer

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

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 running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

  • Stop Pipeline Execution: Stops the current pipeline execution when the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the rest of the 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.

...

Field NameField TypeDescription

Label*


Default ValueCoupa Read
Example
Coupa Read

StringThe name for the Snap. We recommend you update the Snap name, if there is more than one of the same Snap in your Pipeline.

Response Type


Default Valueall
Example
limited

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.

API Path*


Default Value: N/A
Example: 
suppliers

String

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.


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


Default ValueN/A
Example: 

  • limit
  • email
  • email[not_eq]
StringThe 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.

Query Parameter Value


Default Value: N/A
Example: 

String/IntegerThe value corresponding to the specified parameter.

Snap Execution


Default ValueValidate & Execute
Example
: Execute only

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.

...

Multiexcerpt include macro
nameCoupa_SPH
templateData[]
pageCoupa Snap Pack
addpanelfalse

...

Related Links

...

...