SAP Ariba Read

In this article

Overview

This snap reads data for the selected api.

The supported api’s include:

  1. Purchase Order Orders

  2. Purchase Order Items

  3. Purchase Requisitions

  4. Pending Approvals

  5. Invoices

  6. Contract Headers

  7. Contract Line Items.

  8. Query parameters to be used for filtering the data. 

    Note: Some of the query parameters are mandatory and will be thrown as snap data exception when not provided by the customer.

Snap Type

SAP Ariba Read Snap is a READ type Snap that reads data for the supported APIs

Prerequisites

  • None.

Limitations and Known Issues

None.

Account

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Ariba Oauth2 Account for information on setting up this type of account

Snap Views

Type

Description

Type

Description

Input 

This Snap has at most one document input view. Each document contains data in the form of json..

Output

This Snap has at most one document output view. Each document contains corresponding response in the form of json.

Error

This Snap has at most one document error view and produces zero or more documents in the view. Each document contains the corresponding error record if snap is not able to process data from Sap Ariba .

Snap Settings

Field Name

Description

Field Name

Description

Label

required 

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.

API name

required

User can select the appropriate object/api name to read the data.

Default value: Default value: requisitions

Sandbox

 

Please select this option if the client id is for a sandbox account or leave it unchecked if it is for a production account. If checked, the Snap uses sandbox endpoint URL.

Default value: Not selected.

All records

Reads all the records. This operation is supported only for Purchase Orders ,Purchase Order Items and Contract line items.

Default value: Not selected.

Path parameters

 

Query parameters

Lets you define the query parameters. Suggestions also added into the Query Parameter keys.

The query parameters will be attached to the URL using the http query parameter syntax, separated by & and added as key=value.

Maximum request attempts

The maximum number of attempts that the Snap must make to receive a response. If the attempts do not result in a response, the Snap terminates the request.

Retry request interval

The number of seconds for which the Snap waits between two successive requests. A retry happens only when the previous attempt resulted in an exception.

Retry Policy

Select how you want to handle connection and error responses from the following options:

  • Connection errors: Occurs when a client fails to establish a secure connection to the server.

  • Connection and auth errors (401/403): Occurs when either the user authorization fails or access to the page/resource is forbidden.

  • Connection and client errors (4xx): Occurs when the request for the resource contains bad syntax, or when the resource is not found (404).

  • Connection and server errors (5xx): Occurs when the server is unable to complete a request.

All errors: Applies to all of the above-listed errors.

Note

The snap will handle rate limit error in the backend. When failed with status code 429(Rate limit error), this snap will wait for 5 seconds if rate limit per min > 0 before retrying, and will stop if rate limit per min ==0.

Snap Execution

optional

Specifies the execution type:

  • Validate & Execute: Performs limited execution of the Snap (up to 2000 records based on Preview doc count, default is  50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution.

  • Execute only: Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.

  • Disabled: Disables the Snap and, by extension, its downstream Snaps.

Default value: Execute only

Snap Pack History