REST Web Services Prerequisites and Setup
To use REST web services, the relevant features must be enabled in your account. Additionally, the REST web services user must have the required permissions assigned to the user’s role. See the following table for information about enabling the required features and assigning the required permissions.
|
Feature or Permission |
Usage |
|---|---|
|
REST Web Services feature |
By enabling the REST Web Services feature you have access to generally available REST functionality. Enable the feature at Setup > Company > Setup Tasks > Enable Features, in the SuiteTalk (Web Services) section, on the SuiteCloud subtab. To use the feature, you must accept the SuiteCloud Terms of Service. |
|
SuiteAnalytics Workbook feature |
Enable the feature at Setup > Company > Setup Tasks > Enable Features, on the Analytics subtab. |
|
Permissions:
|
See Standard Roles with the REST Web Services, SuiteAnalytics Workbook, and Log in Using Access Tokens Permissions for a list of roles that have the required permissions assigned by default. See To assign the required permissions to a user’s role: for information about assigning the permissions manually. |
Using the administrator role for building web services integrations or accessing REST web services is not preferred for security reasons.
Standard Roles with the REST Web Services, SuiteAnalytics Workbook, and Log in Using Access Tokens Permissions
The following standard roles have the SuiteAnalytics Workbook, Log in using Access Tokens, and REST Web Services permissions assigned by default. For more information about standard roles, see NetSuite Roles Overview.
-
Accountant
-
Accountant (Reviewer)
-
A/P Clerk
-
A/R Clerk
-
Bookkeeper
-
CEO (Hands Off)
-
CEO
-
Sales Manager
-
Sales Person
-
Store Manager
-
Support Manager
-
Support Person
-
Employee Center
-
Warehouse Manager
-
Payroll Manager
-
Partner Center
-
Intranet Manager
-
Marketing Manager
-
Marketing Assistant
-
System Administrator
-
Sales Administrator
-
Support Administrator
-
Marketing Administrator
-
Advanced Partner Center
-
Online Form User
-
Engineer
-
Issue Administrator
-
Payroll Setup
-
Engineering Manager
-
Product Manager
-
CFO
-
Retail Clerk (Web Services Only)
-
Buyer
-
Developer
If you create a new role, or if you use an existing custom role or a standard role that does not have the required permissions by default, you can assign the permissions manually.
To assign the required permissions to a user’s role:
-
Go to Setup > Users/Roles > User Management > Manage Roles.
-
Locate the role you want to modify. Click the corresponding Edit or Customize link.
-
On the Permissions subtab, click Setup.
-
In the Permission list, select REST Web Services.
-
In the Level list, select Full.
-
Click Add.
-
On the Permissions subtab, click Setup.
-
In the Permission list, select Log in using Access Tokens.
-
In the Level list, select Full.
-
Click Add.
-
On the Permissions subtab, click Reports.
-
In the Permission list, select SuiteAnalytics Workbook.
-
In the Level list, select Edit.
-
Click Add.
-
Click Save.