Input 

Document

• Min: 0

• Max: 2

• Mapper

• JSON Parser

A document containing all the information required by the Snap. You can add the second input view to supply the Zuora OpenAPI specification.

Output

Document

• Min: 0

• Max: 2

• JSON Formatter

• Mapper

• JSON Splitter

• The HTTP response for the specified operation in the first output view. 

  • Parts and referred objects of the specification related to the selected path and operation in the second output view.

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.

Label*

Default Value: Zuora OpenAPI
Example: Create Product

String

Enter a unique 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.

OpenAPI specification

Default Value: N/A
Example: https://assets.zuora.com/zuora-documentation/swagger.yaml

sldb:///openapi.json

openapi.json

openapi.yaml

String/Expression

Enter the URL for the Zuora OpenAPI specification (JSON or YAML) file. You can leave this field blank if you want to use a built-in Zuora OpenAPI 3.0 specification file.

OpenAPI path*

Default Value: N/A
Example: /v1/object/product

String/Expression/Suggestion

Enter the path defined for the given Zuora OpenAPI specification or select from the suggestions list.

Operation*

Default Value: N/A
Example: post

String/Expression/Suggestion

Specify the operation to perform on the selected OpenAPI path or select from the suggestions list.

Number of Retries

Default Value: 0
Example: 3

Integer/Expression

Specify the interval in seconds between two reconnection attempts.

Retry Interval (seconds)

Default Value: 1
Example: 2

Integer/Expression

Specifies the minimum number of seconds for which the Snap must wait before attempting recovery from a network failure.

HTTP Headers

Use this field set to add additional headers to the HTTP request headers defined in the Zuora OpenAPI specification. This field set comprises the following fields:

Headers

String

Specify a name for the HTTP header.

Values

String

Specify a value for the HTTP header.

Query Parameters

Use this field set to to add query parameters in addition to those defined in the Zuora OpenAPI specification. Specify each query parameter in a separate row. Click to add a new row.

Parameters

String

Specify a name for the query parameter.

Values

String

Specify the value for the query parameter.

Snap Execution

Default Value:  Execute only
Example: Validate & Execute

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.