SuiteTalk REST Web Services Overview and Setup
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. For details, see Working with Records.
-
Get and process the API definition and record metadata. For details, see Working with Resource Metadata.
-
Execute NetSuite queries on records. For details, see Record Filtering and Query.
REST Web Services Features
The following table provides an overview of features in REST web services, and how they work with records.
For information about the different REST web services features, see REST Web Services Prerequisites and Setup.
|
SuiteTalk REST Web Services |
Generally Available Records |
|---|---|
|
REST Record Service |
Fully supported. |
|
REST Query Service |
Fully supported. To see which records you can use in queries, see the Records Catalog. For information, see Records Catalog Overview. |
REST Web Services Key Features
The following list provides an overview of the main features of REST web services:
-
Metadata – for more information, see Working with Resource Metadata.
-
CRUD operations – for more information, see Working with Records.
-
Record Collection Filtering – for more information, see Record Collection Filtering.
-
Record Actions – for more information, see Executing Record Actions.
-
Record Transformation – for more information, see Transforming Records.
-
Asynchronous request execution – for more information, see REST Web Services Request Processing.
-
Workbook Dataset Execution – for more information, see Working with SuiteAnalytics Datasets in REST Web Services.
-
Workbook Dataset List – for more information, see Getting a List of Datasets Through REST Web Services.
-
SuiteQL Query Execution – for more information, see Executing SuiteQL Queries Through REST Web Services.
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. For more information about working with records metadata, see Working with Resource 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.
-
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.
-
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.
-
REST web services do not support legacy tax features. To work with taxation through REST web services, you must have the SuiteTax feature enabled. For more information about using SuiteTax, see SuiteTax.
-
Asynchronous request execution is not supported in the REST query service.
-
REST web services always load record instances in “Edit” mode, including GET requests. When a user without the Administrator role tries to run a GET request for an employee record of a user with the Administrator role, this error message will appear: “For security reasons, only an administrator is allowed to edit an administrator record”. This prevents users without the Administrator role from editing the employee record of a user with the Administrator role.
For more information, see the following topics:
Related Topics
- Authentication and Session Management for REST Web Services
- REST Web Services Request Processing
- Working with REST Web Services Using Postman
- Working with Resource Metadata
- Working with Records
- Working with Sublists
- Working with Subrecords
- Record Filtering and Query
- Error Handling and Logging in REST Web Services