Try OpenEdge Now
skip to main content
Web Services
Creating OpenEdge REST Web Services : REST Applications : REST annotations in ABL code
 

REST annotations in ABL code

This section describes the syntax of the annotations that you add to ABL source files in order to expose class methods, procedures, and user-defined functions as REST resources.
If the ABL source file is an external procedure that you want to expose as a REST resource, you add a main REST annotation with executionMode set to EXTERNAL at the beginning of the file.
If the ABL source file contains multiple internal procedures or user-defined functions, you add a main REST annotation with executionMode set to SINGLE-RUN or SINGLETON. Then you add an internal REST annotation before every internal procedure and user-defined function that you want to expose as a REST resource.
Usually, you use the Define Service Interface wizard in PDSOE REST projects for annotating ABL source files. See the PDSOE online help, Progress Developer Studio for OpenEdge Guide for more information.
Note: You can add annotations to class files only if the PDSOE project includes Data Object facets. Also any ABL files annotated to implement Business Entities for Data Objects can include the executionMode set to SINGLETON only. See the Progress Developer Studio for OpenEdge Guide in the PDSOE online help for more information.
* Main REST annotations
* Internal REST annotations
* Annotation examples