9.65.1 REST Client Agent Overview

The REST Client processing agent allows querying of any HTTP API using any of the methods specified in the RFC 2616 (https://tools.ietf.org/html/rfc2616#section-5.1.1).

The agent expects RESTCycleUDR types, which contain both request and response fields. The request fields of the UDR include the header, method, body, and the target resource URI. After performing a HTTP query, the agent routes a RESTCycleUDR type that includes the original request as well as the response from the server. 

For further information about the UDR types used by the REST Client agent, see 9.65.3 REST Client UDR Types.

REST Client 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.