Try OpenEdge Now
skip to main content
Administration
REST Administration : REST Web Application Administration : Managing REST Web applications : Constructing and debugging REST requests to access a REST Web service
 
Constructing and debugging REST requests to access a REST Web service
You can identify the information required to invoke an OpenEdge REST Web service by sending a GET request from a REST client in the following URI format:
http[s]://<host_name>:<port>/<rest_application_name>/rest
The request produces a detailed JSON output that helps you identify how all the REST services are deployed in your REST Web application. This information enables you to debug missing parameters in your REST requests. Additionally, the JSON output helps you identify whether the AppServer is running.
Note: As the JSON output consists of all the REST Web application information, viewing the JSON output is restricted to REST Web application users assigned to the ROLE_PSCDebug role. However, users assigned to the ROLE_PSCUSER role are permitted to retrieve just the AppServer information by sending a GET request in the following URI format:
http[s]://<host_name>:<port>/rest/_oeping
The following is the JSON output format:
{
"AppServerStatus":{
"PingStatus":"[true|false]",
"ABLReturnVal":"[String returned from the ABL code]"
"Error": {
_errorMsg:"[Error message (if any) while running the
ABL code]"
_errorNum:"[Error number associated with the error
message]"
}
},
"RESTServices":[
{[REST Service1 JSON]},
{[REST Service2 JSON]},
...
{[REST ServiceN JSON]}
]
}
The AppServerStatus section helps you identify the status of the AppServer. The RESTServices section lists the status of each REST service deployed in your REST Web application.
* Interpreting the AppServerStatus section
* Interpreting the RESTServices section