Data Object URIs for client app access

For a mobile or Web app to access the Data Object Services and resources deployed in a given Web application, it needs only the relative or absolute URI of both the Web application and the Data Service Catalogs for any Data Object Services that the mobile app accesses. After logging into the Web application and loading the required Data Service Catalogs, the mobile app has only to call methods on the JSDOs created for each Data Object resource to access operations of the resource. It never needs to directly access specific URIs for the REST resources that implement each Data Object operation.

The following syntax describes the URIs that you need to log into a Web application and access its Data Object Services using a JSDO:

host — The host name or IP address, which is typically localhost for testing Data Object Services on the same machine as both the Web browser and the web server that hosts the Data Object Services.

port — Port where the Web server is listening for HTTP requests. The default value configured for the OE Web Server that accesses the OpenEdge AppServer is 8980, and for the Progress Application Server for OpenEdge (PAS for OpenEdge) is 8810.

The host:port can also be replaced by a Web domain (such as, www.progress.com) that accesses the required host and port.

The relative URI for the Data Object Web application, where web-app-name is the name of the Web application that contains your Data Object Service or Services, and serves as the root URI for all Data Object resources provided by the Web application. By default, this is the file name of the WAR file that you use to publish or deploy the Data Object Services to your OE Web Server or PAS for OpenEdge, and it is also the name of the Web server folder in which all of the Web application's Data Object Services and Web resources (including Data Service Catalogs) are deployed.

During development, by default, Progress Developer Studio for OpenEdge publishes each Data Object Service defined for a project with the file name of its own WAR file set to name of the Data Object Service. For production deployment, you can export and deploy multiple Data Object Services in a single WAR file, which by default has the name of the Classic or PAS for OpenEdge Server project. Note that during production deployment, a Web administrator can change the file name of the WAR file and the name of the Web application to a different value.

Note: During development, you cannot change the name of the WAR file that Developer Studio publishes for each Data Object Service in a project.

If you run a Web app in a Web browser and deploy it to the same OE Web Server or PAS for OpenEdge as the Data Object Services, the Web app only needs to access this relative URI to log into the Web application and access Data Object Services.

If you install and run a hybrid app in a native device container, or deploy and run a Web app from a different Apache Tomcat Web server from where the Data Object Services are deployed, the mobile or Web app must use the absolute URI to log into the Web application.

/static/service-name.json — The default relative URI of the Data Service Catalog for a Data Object Service, where service-name is the name of the Service. The mobile app typically loads this Catalog to access Data Object resources provided by the Service after logging into the Web application. To load the Catalog, it can use the relative URI (starting with the Web application, /web-app-name) or the absolute URI, depending on the same conditions for using a relative or absolute URI for logging into the Web application.

/static/home.html — The default relative URI of a non-UI login target available to support logging into a Web application using HTTP Basic and Form Authentication.

For more information on logging into a Web application from a mobile or Web app, see the topics on the JSDO progress.data.JSDOSession and progress.data.Session classes in the Progress Data Objects Guide and Reference: https://documentation.progress.com/output/pdo/.