Zuora REST Read

In this article

Overview

You can use this Snap to read record from a Zuora object in Rest API.  It uses POST /query/jobs for most of the Zuora Objects except Export, Import and Communicationprofile. The Snap uses /v1/action/query for them.


Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines

Limitations

None

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
A document containing all the information required by the Snap. You can modify the default name to be specific and meaningful, especially if you have more than one of the same Snap in your Pipeline.
Output

Document

  • Min:1
  • Max:1
  • Filter and JSON Formatter.

Parts and referred objects of the specification related to the selected path and operation in the second 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 Snap.

Default Value: Zuora REST Read
Example: Read Account data

OpenAPI Specification

String

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

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

Zuora Object*

String/Suggestion

Enter the desired Zuora object name. Alternatively, click the Suggestion icon to fetch the list of associated object names and select an object. The Snap executes and fetches the data for the object specified.

Default Value: [None] 
Example: Account

Where Clause

String

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

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

Limit ClauseString

Enter the LIMIT clause to indicate the maximum number of output records.

Default Value: [None]
Example: 10000

This field 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

Use this field set to define the output fields that you want to view in your query output. Specify each output field in a separate row. Click + to add a new row.

Output FieldsString

Enter the Output field names, one field name for each row. If left empty, the Snap includes all the fields in the output.

Default Value: [None]
Example: id

Number of Retries

Integer

Enter the maximum number of retries to attempt in case of connection failure.


Default Value: 0
Example: 3

Retry Interval (seconds)

Integer

Specify the interval in seconds between two reconnection attempts.

Default Value: 1
Example: 2

Pass Through

Checkbox

Select this checkbox to pass the input document through the output view under the key original

Default Value: Deselected
Example: Selected

Snap Execution

N/A

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.

Default Value: Validate & Execute
ExampleExecute

Reading Contact ID from an Account

In the following example, we create this Pipeline with Zuora Rest Read Snap and Zuora Open API Snap to create an account, link an account to contact, read the details of the contact from the contact data.

First, 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.

We configure the Mapper Snap to add data and send it 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

File Zuora Rest Read Snap.slp

Jul 22, 2021 by Shilpa Chinnakonduru

Snap Pack History

 Click to view/expand
Release Snap Pack VersionDateType  Updates
4.27main12833 StableUpgraded with the latest SnapLogic Platform release.
4.26main11181 Stable

Added 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