9.66.1 REST Server Agent Overview

The REST Server agent allows the receiving of any HTTP requests from client applications and respond with an acknowledgement from the Analysis agent.

The agent produces the REST UDR, which contains both request and response fields. The request fields of the UDR include the header, method, body, and the client resource URI. After the Analysis agent has processed the request, the Rest Server agent routes the REST UDR back, which includes the original request as well as the response from the server that is determined from the APL codes.

The REST Server Agent can support the OAuth 2.0 protocol for authorization with the use of the Authorization Server. The Authorization Server is a service provider in which is used to generate OAuth 2.0 access tokens. For further information on how to setup and configure the Authorization Server, see Authorization Server

For further information about the UDR types used by the REST Server agent, see 9.66.3 REST Server UDR Types.

REST Server agent workflow

If you are working with a REST API with a schema defined in JSON or YAML, you also use the Open API Profile to automatically generate UDR structures based on this schema, see /wiki/spaces/MD83/pages/5967718 for further information.