17.4.3 Editing or Deleting a REST Data Source

Edt or delete a REST Data Source from Shared Components.

To edit or delete 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 in the center of the page.
   4. Under Data Sources, select REST Data Sources.
2. On the REST Data Sources page, click the REST Source Name.
   The REST Data Sources page appears.
3. To delete the REST Data Sources, click Delete.

   Tip:

   A REST Data Source can only be deleted, if no Oracle Application Express component is referencing it.
4. To edit the REST Data Source, edit the attributes.
5. Under REST Data Source:
   1. Name - Defines descriptive name for this REST Data Source.
   2. REST Data Source Type - Determines the REST Data Source type:

      • Simple HTTP  - Select this option for a simple HTTP data feed. Application Express assumes that all data is returned with the first request and that the server does not support server-side filtering, ordering or other advanced REST service feature. All invocation details and parameters must be configured manually.

      • Oracle REST Data Services - Select this option for Oracle REST Data Services (ORDS) REST Services. These REST services follow the Oracle REST standard, which means that GET, POST, PUT or DELETE operations are standardized. Server-side filtering and ordering are supported. Application Express can leverage these features by delegating report 

      • Oracle REST Data Services (Legacy Syntax) - Select this option for services running on older versions of Oracle REST Data Services (ORDS . These services are not completely compliant to the Oracle REST Standard.

      • Oracle Cloud Applications (SaaS) REST Service - Select this option for RESTful services provided by Oracle Cloud Applications (SaaS). Use this web service type to integrate Oracle SaaS REST Services into your Application Express Application. Application Express supports pagination for these Services.

      • Oracle Cloud Infrastructure (OCI) REST Service - Select this option for RESTful web services provided by Oracle Cloud Infrastructure. Use this web service type to integrate OCI REST Services (for example, accessing the Object Store) into your Application Express application. Application Express supports pagination for these Services.

   3. Remote Server - Choose a Remote Server object for this REST Data Source. To learn more, see field-level Help.
   4. Base URL - Lists the Base URL.
   5. URL Path Prefix - The URL Path Prefix is specific to this REST Data Source. The URL Endpoints of all operations within the REST Data Source share the same URL Path Prefix. To learn more, see field-level Help.
6. Under Authentication:
   • Credentials - Select stored credentials for authentication.
7. Subscription lists REST Data Sources that subscribe to this module.
8. Under Data Profile:
   1. Click Edit Data Profile to change how REST Data Source responses (in XML or JSON) format are being parsed and converted to rows and columns.
      The Data Profile page appears.
   2. Under Data Profile and Columns, edit the attributes.
      Row Selector stores an XML or JSON path expression pointing to the node containing the collection of rows. Columns determine how one row is parsed and converted to multiple columns.
   3. Click Apply Change to save your changes.
9. Under Operations:

   Operations contains the actual information about the external web service handler. Operations can be mapped to Database Operations which enables Application Express components to pick up the correct operation.

   1. Click Add Operation to add a REST Data Source Operation.  
      The REST Source Operation page appears.
   2. Under Operation:

      • URL Pattern - The URL Pattern is the last part of the Web Service endpoint URL. The combination of URL pattern and HTTP Operation (GET, POST, PUT, DELETE) identifies the operation within a REST Data Source.

      • HTTP Method - Defines the HTTP Operation or Method (GET, POST, PUT, DELETE) to be executed on the REST Web Service.

      • Database Operation - Assign a Database Operation to this HTTP operation. The database operation is important for Application Express components to work with the REST Data Source.

      To learn more about these attributes and see examples, see field-level Help.

   3. Under Caching:

      • Caching - Select how the Application Express engine can cache REST Source responses on the server side. If caching can be used, the component is rendered based on cached results instead of fetching from the web service again. Only HTTP "GET" requests will be cached, which will cut down expensive HTTP requests. This feature is unrelated to the browser's caching capabilities.

      • Invalidate When - Specify when cached content is to be invalidated. Provide either the amount of minutes or a "DBMS_SCHEDULER Calendaring String". With the latter, you determine cached content to be invalidated at the top of the hour, at midnight, or another specific recurring point in time.

      To learn more about these attributes and see examples, see field-level Help.

   4. Under Advanced:

      • Fixed Page Size - Enter the size of the REST service's pagination window.

      • Allow Fetching All Rows - Specify whether Application Express components are allowed to fetch all rows and executing multiple HTTP requests from the REST source operation.

      • Operation Comment - Enter any developer comments

      To learn more about these attributes, see field-level Help.

   5. Click Apply Changes.
10. Under Parameters:

    Use the parameters to pass HTTP Request Headers, use dynamic URLs, or request bodies. When a parameter, its type, default value, and direction is declared on the Edit REST Data Source Parameter page, Application Express components can reference it.

    1. Click Add Parameter to configure a REST Data Source Parameters.
    2. Click Add Parameter.
11. Subscription indicates if this REST Data Source is copy.
12. Under Advanced:
    1. Static ID - Use the Static ID to reference the REST Data Source in API Calls.
    2. Pass ECID - Indicates whether to pass the Execution Context ID (ECID) to the external web services for end-to-end tracing.
    3. HTTP Transfer Timeout - Specify a timeout value in seconds. When an HTTP request for this REST Data Source value exceeds the timeout value, the end user sees an error message. This is to prevent non-responding pages due to an unresponsive web service.
    4. Comments - Enter Comments or notes.
13. To save your changes, click Apply Changes.