Configuration Page

Configure the Oracle NetSuite REST Adapter based on the operation you selected on the Basic Info page.

Operation Type: CRUD

Select the object, operation, and request type to execute your operation.

Element Description

Select Object

Select the object on which to perform the operation. For example: account.

Select Operation

Select the operation to perform. For example: Get list of records or Get record.

Request Type
Select the request type:
  • Synchronous

    If you select Synchronous, the results appear immediately in the response, and no additional steps are required. This option is best suited for data less than 104 MB in size.

  • Asynchronous

    If you select Asynchronous, the response contains only a job ID. Use this job ID to check the job status and retrieve the task ID. Once you have both the job ID and task ID, you can fetch the complete results using the Fetch Async Result operation. This option is suitable for actions operating on long running requests (a REST request greater than 104 MB in size).

Operation Type: SuiteQL Search

Provide the SuiteQL query, binding parameters (along with data type and value), and request type.

Element Description

SuiteQL Query

Write the SuiteQL query you want to execute.

Note: Only Select statements are supported.

Binding Parameters

If your query includes binding parameters (marked as #parameterName), list them in the table along with their data type and value.

Note: Ensure that the parameter names you provide match exactly with the names used in the SuiteQL query to avoid errors.

Request Type

Select the SuiteQL query operation to be synchronous or asynchronous.

Operation Type: Asynchronous Operations

The Oracle NetSuite REST Adapter supports three types of actions under asynchronous operations:
  • Check Job Status
  • Retrieve Task ID
  • Fetch Async Result
  1. Select Check Job Status to find the status of an asynchronous operation (CRUD/SuiteQL) that you performed earlier.
  2. Select Retrieve Task ID to fetch the task ID in the response.
  3. Use this task ID and job ID to retrieve the final output using the Fetch Async Result operation.

The following table describes how to configure this action.

Element Description

Choose the type of asynchronous request that was initiated - CRUD operation or SuiteQL Search

Select the operation type:
  • CRUD
  • SuiteQL Search

Choose how to generate the response mapper for the asynchronous SuiteQL operation

(Appears for the SuiteQL Search operation type.)

Select how you want to generate the response mapper:
  • SQL
  • JSON

Async Operation Object

(Appears for the CRUD operation type.)

Select the object on which you performed the CRUD operation (request type: asynchronous). For example: account.

Async Operation Type (It should be action)

(Appears for the CRUD operation type.)

Select the operation/action that you selected while performing the CRUD operation (request type: asynchronous). For example: Get list of records.

SQL Query

(Appears if generating a response mapper using SQL.)

Provide the SQL query used in the asynchronous request to populate the response mapper.

JSON

(Appears if generating a response mapper using JSON.)

Provide a sample JSON payload to generate the response mapper for your asynchronous query.

Operation Type: RESTlet Calls

The RESTlet operation type supports two actions:
  • Create using RESTlet
  • Retrieve using RESTlet
The following table describes how to configure these actions.
Element Description

Script ID

Enter the script ID associated with the RESTlet script deployed on the NetSuite application.

Deploy ID

Enter the deploy ID associated with the RESTlet script deployed on the NetSuite application.

Sample JSON Request

Enter the sample JSON request payload.

Sample JSON Response

Enter the sample JSON response payload.

Parameter Key and Parameter Type

Optionally add an extra parameter to the script by providing a parameter key (name) and data type. Values for these parameters can be provided at runtime. Ensure that you provide values of the same data type to avoid any errors.

Operation Type: Dataset

The Dataset operation type supports two actions:
  • Get List of Datasets
  • Execute Datasets

When you select Execute Datasets as the action, the Configuration page is displayed. In the Select Dataset field, choose the required dataset from the drop-down list.