Default View

In the default view of the SOAP Schema Browser, the pane at the left side of the screen lists all the records and subrecords whose names begin with the letter you selected in the A-Z index, whereas the center pane describes details of one record. This topic describes a few highlights of the information you see in this default view.

Summary of the Record

The center pane of the default view is essentially a summary of information about one record.

Namespace Link

At the top of the page, directly below the name of the record, is a link to the namespace to which the record belongs.

If you click this link, the pane at the left refreshes to show a tabbed list of all objects in the namespace.

List of Fields

Data about the record’s fields is displayed in a table. This table includes the following columns:

• Name — The name of the field as it exists in SOAP web services.

• Type — The data type of the field. If the name of the type is underlined, you can click it to view a reference page about the type. (When you do, the pane at the left updates to include a tabbed list of other objects from the namespace.)

• Cardinality — A measure that shows two values representing the “minimum occurs” and “maximum occurs” attributes as defined for this record in the corresponding XSD file. For example, a value of 0..1 means that the field is not required and that it can be populated a maximum of one time. A value of 0..unbounded means that the field is not required and that there is no limit to the number of times it can be populated.

• Label — The label for the field as shown in the user interface.

• Required — A boolean value showing whether the entry form in the user interface requires a value for the field. A mandatory field can have a default value. When this field is not specified in the request, its value will be set to the default one. Some default values on some records are set based on the logged user. For example, a logged employee of a Canadian subsidiary might affect the currency or the subsidiary fields default value on some forms. It is best to also observe the behavior of a field in the UI.

• Help — Additional details about working with the field.

Other Data

At the bottom of each record reference page, you can find the following:

• A list of attributes related to this record. For example, if you want to know whether the record supports External Id, check this area.

• A list of search objects related to this record. For more details about any search object, click the name of the object to view a reference page about it. In response, the page updates to include, in the center pane, details about this search object and, at the left, a tabbed list of other objects from the namespace. For help with this tabbed list, see Navigating to a Different Object.

Comparing SOAP Web Services, SuiteScript, and SuiteAnalytics Connect Exposure

To check whether the record you are currently viewing is also supported in SuiteScript or SuiteAnalytics Connect, click the Records Browser tab or the Connect Browser tab at the top of the page.

If the record is supported in SuiteScript or SuiteAnalytics Connect, you are directed to the corresponding page in the SuiteScript Records Browser or SuiteAnalytics Connect Browser. Otherwise, you are directed to the first page of the respective browser.

To compare record types support across SuiteScript, SOAP, and SuiteAnalytics Connect, see SuiteCloud Supported Records.

Navigating to Other Records

To navigate to a different record, select a different record from the pane at the left. If appropriate, use the A-Z index to refresh the pane so it shows a different list of records.

Navigating to the Default View

If you have navigated to the SOAP Schema Browser’s namespace view and you want to get back to the default view, click any letter in the A-Z index at the top of the browser window.

General Notices