Previous Next JavaScript must be enabled to correctly display this content

## 18.5.8.2 Creating a BOSS REST Data Source

Learn about creating a BOSS REST Data Source.

To create a BOSS REST Data Source, run the Create REST Data Source Wizard. When prompted, select the REST Data Source Type, Oracle Cloud Applications (BOSS) REST Service. This topic describes key decision points when running the Create REST Data Source Wizard.

Tip:

For more details on all wizard options, see item Help or see the generic discussion, Creating a REST Data Source.

To create a REST Data Source:

1. Navigate to the REST Data Sources page:
   1. On the Workspace home page, click App Builder.
   2. Select an application.
   3. On the Application home page, click Shared Components.
   4. Under Data Sources, select REST Data Sources.
2. On the REST Data Sources page, click Create.
   The Create REST Data Source Wizard appears.
3. Create REST Data Source - Select From Scratch and click Next.
4. General:
   1. REST Data Source Type - Select Oracle Cloud Applications (BOSS) REST Service.
   2. Name - Enter a descriptive name for this REST Data Source.
   3. URL Endpoint - Enter the Endpoint URL (starting with `http://` or `https://`) for the REST Data Source.
   4. Click Next.
5. Remote Server - Accept the defaults.

   This step shows how APEX manages the REST API's endpoint URL as the combination of a Base URL and a Service URL Path.

6. Settings:
   1. Discover References - Set Yes to also include the first level of referenced objects as additional, read-only information for the BOSS endpoint when discovering and rediscovering the data profile. If set to No, APEX includes only the endpoint's root business object attributes. You can include others as needed by editing the Data Profile once you have created the initial REST Data Source.
   2. Use Bulk DML - Bulk DML improves performance by grouping multiple delete, update, and insert operations against this REST service into a single exchange with the remote server. Oracle recommends disabling this setting only if you encounter functional issues with a particular BOSS service endpoint while using bulk DML.
   3. Use Total Results - An Oracle Cloud Applications (BOSS) REST Service supports returning the total number of results, even if only a subset is returned (for example, the first page). In certain situations, this total row computation may add unwanted runtime overhead. You can disable APEX's use of this feature for this data source by setting the value to No.
   4. Use Pagination - In general, Oracle Cloud Applications (BOSS) REST services support retrieving results a page at a time. However, if this data source's endpoint does not support the "$offset" parameter, then set this property to No to disable pagination.
   5. Click Next.
7. Authentication, Authentication Required - Choose whether the new REST Data Source requires Authentication. If enabled, specify Credentials and Authentication Type.
8. To proceed, select one of the following:
   - Advanced - Presents advanced parameters for the Data Profile. Use Advanced to add additional named parameters that might be required for discovery.
   - Discover - Starts Discovery mode. APEX executes multiple HTTP requests in order to get information about the external Web service. One of these multiple HTTP requests can be an HTTP request to get the OpenAPI information about the Web service. APEX samples the data (JSON or XML) returned by the Web service and derives a Data Profile (consisting of metadata about the JSON attributes). Discovery results then display and confirms whether to create the REST Data Source.
9. If you click Advanced, the Parameter page appears.
   Use the Parameters page to configure initial REST Data Source parameters which might be required for discovery. Some REST Data Sources may require you set specific HTTP Headers (for example, `User-Agent`). After setting advanced parameters, click Discover.
10. After you click Discover, APEX invokes the REST service URL and a Preview appears. From the JSON response, APEX also retrieves the OpenAPI description of the BOSS endpoint, which it uses to derive attributes, data types, and additional information annotations to create a Data Profile.

    The information that displays depends on the attributes configured in the default view of the BOSS endpoint. It is expected that attributes not included in the default view will show as null during this preview. The Data tab displays the sample response data, formatted as a report.

    The Data Profile tab shows information about the data profile columns APEX has found during discovery. Use this tab to review the column names and data types.

    If you wish to remove a named column you can navigate with the TAB key to the remove column and press Enter, or simply by using the mouse by pressing the X icon.

    The Response Body tab shows information about the response body structure APEX has found during discovery.

    Click More Detail to view additional detailed information about the REST Data Source response, such as the response body, response headers and the REST Data Source operations.

11. Click Create REST Data Source.
    The REST Data Source is created.

Parent topic: Working with Oracle Cloud Applications BOSS REST Services