The REST API Browser

Go to the REST API Browser.

The REST API Browser provides a visual overview of the structure and capabilities of the REST web services Record API. The data presented in the REST API Browser is based on OpenAPI 3.0 metadata. For more information about metadata, see Working with OpenAPI 3.0 Metadata.

The REST API browser provides the following information:

• The summary of all records, sublists, schema definitions, and other objects.

• The available operations you can perform on a record.

• The description of URLs, HTTP methods, and request parameters used for CRUD operations.

• The structure of responses you can receive after performing an operation.

• The structure of error messages.

• The description of field names and field types, and the properties of fields.

• The subformat of strings associated with specialized fields such as date and time fields.

Navigating in the REST API Browser

The REST API Browser is designed to let you browse for records and schema definitions in an alphabetical order.

To view records and schema definitions:

1. Click the name of the appropriate record in the left pane.

   

2. Review the path, the request parameters, and the responses.

3. Click the linked resource in the Responses section. By clicking the link, you can navigate to the schema definitions section of the REST API Browser.

   

4. In the schema definitions section, review the properties of the resource.

   

Related Topics

• NetSuite Record Structure
• Using CRUD Operations on Custom Records, Custom Lists, and Custom Transactions v1
• Creating a Record Instance
• Getting a Record Instance
• Updating a Record Instance
• Using the Upsert Operation
• Deleting a Record Instance
• Accessing Subresources in REST Web Services
• Using External IDs
• Using Datetime Fields
• Executing Record Actions
• Transforming Records
• Working with the Pricing Sublist on Item Records
• Using the REST Web Services SuiteScript Execution Context

General Notices