To deploy REST services, deploy the .paar file to an existing web application like ROOT, or whichever ABL web application requires the service.

The deployREST command-line tool adds REST services to a deployed ABL web application (oeabl.war).

To deploy REST services to an ABL web application for an existing instance:

  1. Get the .paar file and any ABL r-code that supports the API for the service interface from the developer.
  2. Move the r-code to the PROPATH.
  3. Go to the /bin directory of the instance.
  4. Use the deployREST command to deploy the .paar file to the ABL web application:
    deployREST.{bat|sh} path_to_rest/RESTservice.paar ABLwebapp
  5. Stop and restart the Progress Application Server (PAS) for OpenEdge instance.

Secure REST services

If deploying to a production environment, be sure to secure the REST endpoints of your services. Out of the box, the login model (the client.login.model property in the oeablSecurity.properties file) is set to anonymous (the lowest security level) allowing anyone access. The property should be changed to restrict access. For more information, see Enable ABL application authentication.

Test and validate REST services

Progress provides two ways to view the available REST services. Both are JSON-formatted, however one is in a format specific to OpenEdge and the other is based on the OpenAPI Specification. For more information, see:

Undeploy REST services

To undeploy a REST service, run the deployREST command with the -undeploy option specified, for example:
deployREST.{bat|sh} path_to_rest/RESTservice.paar ABLwebapp -undeploy