Skip to end of banner
Go to start of banner

Zuora REST Read

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 27 Next »

In this article

Overview

You can use this Snap to retrieve the data from all the fields for a Zuora object. It uses POST /query/jobs for most of the Zuora Objects except Export, Import and Communicationprofile. The Snap uses /v1/action/query for them.

  • Expected upstream Snaps: [Optional] If none, the Snap executes once. If there are input documents, the Snap executes once for each input document.

  • Expected downstream Snaps: Any Snap that has a document input view, such as Filter or Mapper or JSON Formatter.

  • Expected output: This Snap provides records for all fields of the selected Zuora object if the Output Fields property is empty.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines

Limitations


Known Issues

None.

Snap Input and Output

Input/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Document

  • Min:1
  • Max:1
  • Mapper Snap
This Snap has at most one document input view.
Output

Document

  • Min:1
  • Max:1
  • Filter

This Snap has exactly one document output view.

Snap Settings

Field names marked with an asterisk ( * ) are mandatory.

Field Name

Data type

Description

Label*

String

Specify a unique label for the account.

Default ValueZuora REST Read
ExampleRead Account data

OpenAPI Specification

String

Enter the URL for the OpenAPI specification file. If the property is left empty, the Snap uses the built-in OpenAPI specification.


Example: zuora_open_api_spec3.json, sldb:///zuora_open_api_spec3.json
Default value: [None]

Zuora Object*

String

Required.  Enter the desired Zuora object name. Click the Suggestions icon to see the available object namesThe Snap executes and fetches the data for the object specified.

Example: Account
Default value: [None] 

Where Clause

String

Enter the WHERE clause of the Zuora SELECT query without the word ‘WHERE’.

Example: name = ‘SnapLogic’
Default value: [None] 

Limit ClauseString

Enter the maximum number of output records.

Example: 10000
Default value: [None]

This property does not support Zuora Objects: export, import and communicationprofile. Use Where Clause to limit the number of records. For more information, refer to the Zuora documentation on Zuora Query Processing Limitations.

Output Fields

String

Enter the SELECT field names, one field name for each row. If empty, the Snap attempts to select all fields.

Example: id
Default value: [None]

Number of retries

Integer

Enter the maximum number of retry attempts in case of a failure in execution.

Example: 3
Default value: 0

Retry interval (seconds)

Integer

Specify the minimum number of seconds to wait before the next retry.

Example: 2
Default value: 1

Pass Through

Checkbox

If selected, the input document will be passed through to the output view under the key 'original'. 

Default value: deselected

Snap Execution

N/A

Indicates how the Snap must be executed. Available options are:

  • Validate & Execute: Performs limited execution of the Snap (up to 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: Validate & Execute

Examples


In the following use case example, the Pipeline uses Zuora Rest Read Snap and Zuora Open API Snap to create an account with a unique ID from the Mapper Snap, link it to a contact and read the contact data using Rest Read Snap.

The data is added to the Mapper Snap and sent to the Open API Snap.

Settings

Output view

The details created are sent from the upstream Snap to create a unique account ID using Open API Snap. Following are the Snap settings and the output view:

Settings

Output view

Using Mapper Snap, we are sending data to create a contact for an account by mapping a unique account ID. The details of the data created can be seen under Expression and Target Path. The Output view for the Mapper Snap is as follows:

Settings

Output view

Settings

Output view

The contact for an account is created and a unique contact ID is generated. The Settings and Output view are as follows:

Settings

Output view

The contact details can be fetched by passing a unique contact ID using Zuora Rest Read by passing $entity.Id.

Settings

Output view

Download this Pipeline

Downloads

Important Steps to Successfully Reuse Pipelines

  1. Download and import the Pipeline into SnapLogic.
  2. Configure Snap accounts as applicable.
  3. Provide Pipeline parameters as applicable.

  File Modified
No files shared here yet.

Snap Pack History

 Click to view/expand
Release Snap Pack VersionDateType  Updates
November 2024

main29029

 

Stable

Updated and certified against the current Snaplogic Platform release.

August 2024main27765 StableUpdated and certified against the current Snaplogic Platform release.

May 2024

main26341

 

Stable

Updated and certified against the current SnapLogic Platform release.

February 2024436patches25953 Latest

Upgraded Apache CXF from version 3.4.2 to 3.6.3 to prevent vulnerability issues.

February 2024main25112 StableUpdated and certified against the current SnapLogic Platform release.
November 2023main23721 StableUpdated and certified against the current SnapLogic Platform release.

August 2023

main22460

 

Stable

Updated and certified against the current SnapLogic Platform release.

May 2023

main21015 

Stable

Upgraded with the latest SnapLogic Platform release.

February 2023main19844 StableUpgraded with the latest SnapLogic Platform release.
November 2022main18944 StableUpgraded with the latest SnapLogic Platform release.
October 2022430patches17426 Latest

The Zuora OpenAPI Snap now does not display the following checkboxes:

  • Pass through

  • Display headers for Get

  • Trust all certificates

  • Enable URL Encoding

August 2022main17386 StableUpgraded with the latest SnapLogic Platform release.
4.29main15993 StableUpgraded with the latest SnapLogic Platform release.
4.28main14627 StableUpgraded with the latest SnapLogic Platform release.
4.27main12833 StableUpgraded with the latest SnapLogic Platform release.
4.26main11181 Stable

Introduced the following Snaps and account types to connect these Snaps with the Zuora REST API. 

4.25main9554
 
StableUpgraded with the latest SnapLogic Platform release.
4.24main8556
StableUpgraded with the latest SnapLogic Platform release.
4.23main7430
 
StableUpgraded with the latest SnapLogic Platform release.
4.22main6403
 
StableUpgraded with the latest SnapLogic Platform release.
4.21snapsmrc542

 

StableUpgraded with the latest SnapLogic Platform release.
4.20snapsmrc535
 
StableUpgraded with the latest SnapLogic Platform release.
4.19snaprsmrc528
 
StableUpgraded with the latest SnapLogic Platform release.
4.18snapsmrc523
 
StableUpgraded with the latest SnapLogic Platform release.
4.17ALL7402
 
Latest

Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.

4.17snapsmrc515
 
Latest

Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.

4.16snapsmrc508
 
StableUpgraded with the latest SnapLogic Platform release.
4.15snapsmrc500
 
StableUpgraded with the latest SnapLogic Platform release.
4.14snapsmrc490
 
StableUpgraded with the latest SnapLogic Platform release.
4.13

snapsmrc486

 
StableUpgraded with the latest SnapLogic Platform release.
4.12

snapsmrc480

 
StableUpgraded with the latest SnapLogic Platform release.
4.11snapsmrc465
 
StableUpgraded with the latest SnapLogic Platform release.
4.10

snapsmrc414

 
StableUpgraded with the latest SnapLogic Platform release.
4.9snapsmrc405
 
StableUpgraded with the latest SnapLogic Platform release.
4.8

snapsmrc398

 
StableUpgraded with the latest SnapLogic Platform release.
4.7 Patchzuora2593 Latest

Add additional retry logic for connection to server.

4.7 Patch zuora2521 Latest

Retry added for failed login.


4.7

snapsmrc382

 
StableUpgraded with the latest SnapLogic Platform release.
4.6snapsmrc362
 
StableUpgraded with the latest SnapLogic Platform release.
4.5.1

snapsmrc344

 
Stable

Zuora Read Snap now has an option to remove the namespace prefixes from the Snap output.

4.4.1
 Stable

Zuora Read Snap updated to include ProductRatePlan added to Object list.


See Also

  • No labels