Test Data Object Services using URIs
- Last Updated: January 16, 2024
- 1 minute read
- OpenEdge
- Version 12.8
- Documentation
A Data Object service has a Data Service Catalog that defines the schema of the data and
the operations on the data that are supported by one or more of the Data Object
resources. Regardless of whether a Data Object service is WebHandler or REST-based, Data
Object service clients can use the following URI syntax for locating resources:
scheme://host:port/web-app/static/service-name.json
You should test Data Object services before you package them as an ABL Web Application. You can use various REST clients, such as the Postman REST Client, that allow you to access Data Object operations directly as REST resources. To test these services, you must know the absolute REST URI of the WebHandler or REST resource that accesses each Data Object operation.
The syntax for the absolute URI for WebHandler-based Data Object services is:
scheme://host:port/web-app/web/pdo/service-name/resource-name[op-element]
For example,
scheme://host:port/web-app/web/pdo/service-name/resource-name?filter=filter-string
is the absolute URI to perform a Read operation using a filter.
The syntax for the absolute URI for REST-based services is:
scheme://host:port/web-app/rest/service-name/resource-name[op-element]
The following table lists each element in the syntax with its description:
Syntax element |
Description |
|---|---|
scheme |
A URI scheme supported by Data Object services. It can be HTTP or HTTPS. |
host |
The host name or the IP address of the machine that contains the PAS for OpenEdge instance that hosts the Data Object services. |
port |
The port number on which the Web Server listens for HTTP requests. The default port number configured for PAS for OpenEdge is 8810. |
web-app |
The name of the Web Application that contains your Data Object services. |
static-resource |
The relative URI for a static file or Web page that the Mobile App must access from the Mobile Web Application. |
service-name |
The relative URI for the Data Object service. |
resource-name |
The relative URI for the Data Object resource. |
op-element |
A relative URI or a URI query parameter that is specified to identify specific Data Object resource operations. The syntax is: ?filter=filter-string—For the read operation, this URI query parameter identifies the INPUT filter parameter value passed to the implementing ABL routine, where filter-string is a string value that you must specify. /operation-name—For an Invoke or Submit operation, operation-name by default is the case-sensitive name of the ABL routine that implements the specified Invoke or Submit operation. The operation-name can also be any other value that you annotate for the relative URI of an Invoke or Submit operation routine that uniquely identifies and distinguishes the routine from any other that is defined in the resource. |