Method annotations
- Last Updated: February 11, 2026
- 2 minute read
- OpenEdge
- Version 13.0
- Documentation
Several annotations are available at method level that perform method-related tasks. A few are provided here:
Description“/api” request handler.com.progress.fathom.api.OEMAPI class is listed in the
restconfig.xml file, the “/api” URL is mapped and provides a human-readable
description of the URLs that are mapped for the Web application. The description
text is included in the response.Refer to the REST API for the sample Web application for an example of an API for a sample Web application containing description text.
SinceRequiredResourcePermissionAdds an authorization check performed by the fathom REST servlet implementation. Authorization checks in OpenEdge Management are based on a security object identified (a string), and an action.
If the user
making the REST request exists and is authenticated, the authentication check must
succeed to invoke the method. If the user is not authenticated, the REST request
fails with a 403 Forbidden response. If the user
exists and the RequiredResourcePermission
annotation is not available, the user is authorized to access OpenEdge Management to
perform the API call.
|
SecurityBean class. At the least, your Web application should check
SecurityBean.SECURITY_RESOURCE,action=SecurityBean.ACTION_READ.