SOAP Web Services vs. REST Web Services Operation Mapping
The following table maps SOAP operations to their REST equivalents.
SOAP Operation |
REST Operation |
Notes |
---|---|---|
POST |
|
|
addList |
— |
List operations are currently not supported in REST web services. |
attach / detach |
— |
The attach / detach operation is currently not supported in REST web services. You can use SuiteScript to define or remove a relationship between two records. For more information, see record.attach(options) and record.detach(options). |
changeEmail |
— |
Login through user credentials is not supported in REST web services. |
changePassword |
— |
Login through user credentials is not supported in REST web services. |
GET |
You can use the async service to retrieve the status of a single async operation. |
|
DELETE |
|
|
deleteList |
— |
List operations are currently not supported in REST web services. |
GET |
|
|
governanceLimits |
|
|
GET |
|
|
— |
You can use the async service to retrieve the result of a single async operation. |
|
getBudgetExchangeRate |
— |
The budget exchange rate record is currently not available in REST web services. You can interact with the budget exchange rate record using SuiteScript. For details, see Budget Exchange Rate. |
GET |
You can achieve the equivalent in REST by sending a GET request for a specific currency rate record. |
|
getCustomizationId |
|
In REST web services, you can return data about your customization objects by sending a request to the metadata catalog. For information, see Getting Metadata. |
getDataCenterUrls |
— |
REST web services only use account-specific domains. |
getDeleted |
— |
This functionality is not available in REST web services. You can retrieve information about deleted records by using the Deleted Record search type or a SuiteQL query. For information, see Searching for Deleted Records. |
governanceLimits |
|
|
|
You can achieve the equivalent in REST by sending a GET request for a specific record. |
|
GET |
You can retrieve a list of records of the same record type in REST. |
|
getPostingTransactionSummary |
— |
You can search for financial reports and summaries in the UI. For information, see Financial Statements Overview. |
getSavedSearch |
— |
Saved Search isn't supported in REST web services. REST web services supports SuiteAnalytics Datasets. For more information, see Working with SuiteAnalytics Datasets in REST Web Services. |
getSelectValue |
— |
The getSelectValue operation is currently not supported in REST web services. |
serverTime |
|
|
|
In REST web services, you can transform a record from one type into an another, using data from an existing records. This is the equivalent of the initialize SOAP operation. For more information, see Transforming Records. |
|
GET |
|
|
|
In REST web services, you can use collection paging to move between pages of search results. |
|
PATCH |
|
|
updateList |
— |
List operations are currently not supported in REST web services. |
PATCH |
You can achieve the equivalent in REST by sending a PATCH request for a specific record. |
|
updateInviteeStatusList |
— |
List operations are currently not supported in REST web services. You can update calendar events one by one. For information, see updateInviteeStatus. |
PUT |
|
|
upsertList |
— |
List operations are currently not supported in REST web services. |