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 |
Usage |
---|---|
REST Web Services feature |
Enable the feature at Setup > Company > Enable Features > SuiteCloud subtab, in the SuiteTalk (Web Services) section, on the SuiteCloud subtab. To use the feature, you must accept the SuiteCloud Terms of Service. |
REST Record Service (beta) feature |
Enable the feature at Setup > Company > Enable Features > SuiteCloud subtab, in the SuiteTalk (Web Services) section, on the SuiteCloud subtab. To use the feature, you must accept the SuiteCloud Terms of Service. This feature enables you to work with the REST record service beta functionality. Using the REST record service, you can perform CRUD operations on beta records, filter record collections, interact with record metadata, and perform record actions and transformations. |
REST Query Service (beta) feature |
Enable the feature at Setup > Company > Enable Features > SuiteCloud subtab, in the SuiteTalk (Web Services) section, on the SuiteCloud subtab. To use the feature, you must accept the SuiteCloud Terms of Service. This feature enables you to work with the REST query service beta functionality. Using the REST query service, you can work with datasets and related functionality. |
SuiteAnalytics Workbook feature |
Enable the feature at Setup > Company > Enable Features, on the Analytics subtab. |
Required Permissions:
-
Setup > REST Web Services
-
Setup > Log in using Access Tokens
-
Reports > SuiteAnalytics Workbook
Note: There are permissions that will require Two-Factor Authentication (2FA) that will not allow the Web Services role to be used in Integrations. If the role has any permissions from this list, they need to be removed.
To generate the Consumer ID & Secret (from Integration record) and Token ID & Secret (Access Tokens), please refer to this guide.