The NetSuite REST web services provide an integration channel that extends the capabilities of SuiteTalk. REST web services provide a REST-based interface for interacting with NetSuite.
Using REST web services, you can:
-
Use CRUD (create, read, update, delete) operations to perform business processing on NetSuite records and to navigate dynamically between records.
-
Get and process the API definition and record metadata.
-
Execute NetSuite queries on records.
The following tables provide an overview of fully supported and beta features in REST web services.
|
Record API (...record/v1) |
Status |
|---|---|
|
Metadata CRUD operations Record Collection Filtering |
|
|
Record Actions |
Beta |
|
Record Transformation |
Beta |
|
Query API (...query/v1) |
Status |
|---|---|
|
Workbook Dataset Execution |
Beta |
|
SuiteQL Query Execution |
Fully supported |
Benefits of REST Web Services
The main benefits of REST web services include the following:
-
Simple access to records metadata. This includes user and company-specific metadata.
-
Easier handling of custom records and custom fields.
-
Easy to navigate API.
-
In contrast to RESTlets, you do not need to write, deploy, and run custom scripts.
Limitations of REST Web Services
Consider the following information when working with REST web services.
-
Enumeration values must be provided and are returned in the SuiteScript internal format. This is the format used by Record.getValue(options) and Record.setValue(options) functions.
-
Query only returns record IDs and HATEOAS links. (See HATEOAS.) That is, query results have a form of non-expanded references. Additionally, you can only use body fields in query conditions.
-
Making queries on transactions and certain other record types is not supported.
-
Translations in REST web services follow the same behavior as in SuiteScript. For custom records, a user’s preference (Home > Set Preferences > Language) is taken into the account. For standard records, translations are returned and updated in the company’s primary language. Additionally, in the current version of REST web services, it is not possible to read and update translations on the translation sublist for both custom records and standard records. This behavior is different from the behavior of SuiteScript.