17.5.1 Understanding Remote Servers

Create a Remote Server object to store REST Data Source server information.

• About Remote Servers
  Create a Remote Server object to store REST Data Source server information.
• How APEX Stores REST Data Source Information
  Learn how Oracle APEX stores REST Data Source information.
• Exporting and Importing Remote Server Information
  Learn about exporting and importing Remote Server information.

See Also:

Managing REST Data Sources

17.5.1.1 About Remote Servers

Create a Remote Server object to store REST Data Source server information.

Oracle APEX stores REST Data Source server information (for example, REST APIs) as a Remote Server object. Remote Servers can be shared among multiple REST Data Sources. Changing Remote Server properties affects all REST Sources referencing that object. For example, you can change a Remote Server's Base URL to move all associated REST Sources from a test to a production system. Since Remote Servers are stored at the workspace-level, Remote Servers are visible in all applications in a workspace.

When you create a Remote Server you select one of the following types:

• REST Data Source - Remote Server for consuming a remote REST API.

• Authentication - Remote Server for authentication.

• Print Server - Remote Server for an external print server.

17.5.1.2 How APEX Stores REST Data Source Information

Learn how Oracle APEX stores REST Data Source information.

Oracle APEX splits the endpoint URL of a REST Data Source into two parts. The first part is the server-specific part and is stored as a separate entity called the Remote Server. You can reuse a Remote Server with multiple REST Data Sources if each one uses the same server, port, and URL Path Prefix (context root). Remote Servers are stored at the workspace-level and therefore visible in all applications.

The second part of the endpoint URL and is specific to the REST Data Source. Multiple REST Data Sources can share one Remote Server, thus sharing information such as the Base URL and Authentication. If you change Remote Server attributes, the change impacts all REST Data Sources using the Remote Server. Remote Servers make it easy to move a collection of REST Data Source. For example, you can move from a test system to a production system by changing the URL within the Remote Server object.

17.5.1.3 Exporting and Importing Remote Server Information

Learn about exporting and importing Remote Server information.

When you export an application, referenced Remote Servers are added to the export file. When you import the application into another workspace, APEX checks whether the target workspace already contains Remote Servers with the same static ID. If a Remote Server already exists, the application uses it. Otherwise the Remote Servers from the import file are created in the target workspace.