NetSuite REST SuiteQL

Overview

You can use this Snap to execute SuiteQL queries on NetSuite server.


NetSuite REST SuiteQL Overview

Prerequisites

None.

Limitations and known issues

None.

Snap views

Type Description Examples of upstream and downstream Snaps
Input This Snap has at the most one document input view. The input data typically includes the SuiteQL query that you want to execute on your database. The specific format of the input data can vary depending on the design of your pipeline and the data source you are using. In addition to the SuiteQL query, you may also need to provide additional parameters that need to be substituted in the query. Mapper
Output This Snap has at the most one document output view and displays the SuiteQL query resultset. Mapper
Learn more about Error handling.

Snap settings

Note: Learn about the common controls in the Snap settings dialog.
Field/Field set Description

Label*

String

Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: NetSuite REST SuiteQL

Example: Execute employees list
Query*

String/Expression

Specify a valid SuiteQL query.

Default value: N/A

Example: SELECT * from Employee
Write error on no results

Checkbox

Select this checkbox to produce an error when no results are returned in response to the request.

Default status: Deselected
Enable asynchronous request processing

Checkbox

Select this checkbox to enable asynchronous processing.

Default status: Deselected
Poll async job results

Checkbox

Select this checkbox to poll the async job and write the actual results to the output. When disabled, the Snap writes the async request response immediately without waiting for job completion.

This field is available only when Enable asynchronous request processing is selected.

To check the status of a job and retrieve its results later, map the id field from the output of this Snap to the NetSuite REST Check Async Status and NetSuite REST Get Async Result Snaps.

Default status: Deselected
Pagination parameters Specify the pagination parameters to control and manage the amount of data to retrieve from the NetSuite server.
Pages

Integer/Expression
Specify the number of pages to read from the NetSuite server.
Note: When the value is set to 0, the Snap reads all pages from the endpoint.

Default value: 0

Example: 10
Page size

Integer/Expression

Specify the number of records (per page) to return from the SuiteQL query result set.

Default value: 1000

Example: 2000

Snap execution

Dropdown list
Choose 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

Example: Execute only

Examples