REST Server Agent

Owned by Kevin Wu
Last updated: Jan 03, 2024
1 min read

The REST Server agent allows the receiving of any HTTP requests from client applications and responds with an acknowledgment 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 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 REST Server UDR Types.



REST Server agent workflow

Prerequisites

The reader of this information should be familiar with:

  • Representational state transfer (REST)

  • RFC 2616 - Hypertext Transfer Protocol -- HTTP/1.1

  • RFC 6749 - OAuth 2.0 Authorization Framework

  • RFC 7617 - Basic HTTP Authentication Scheme

  • RFC 5246 - Transport Layer Security (TLS) Protocol