RESTful service activity
Use the RESTful service activity to integrate TotalAgility with external applications.
The RESTful service activity can integrate with external applications through the RESTful web service references.
-
TotalAgility supports only simple types of RESTful web services, which should not be used with complex data structures.
-
TotalAgility supports specifying custom headers to be passed to a RESTful service activity.
RESTful web services typically map the five main HTTP methods to the operations they perform: POST, GET, PUT, DELETE, and PATCH.
The web service only sends the basic HTTP verbs – GET, PUT, POST, DELETE, and PATCH – to the server and expects JSON, or XML as the response.
For example, http://service.com/emp/123
XML format:
<Emp>
<Name>ABC</Name>
<Id>321</Id>
<Email>abc@domain.com</Email>
<Org>Tungsten</Org>
</Emp>
JSON format:
{
"Name":"ABC",
"Id":"321",
"Email":"abc@doamin.com",
"Org":"Tungsten"
}
Third-party REST APIs can be called from TotalAgility using "application/json", "application/xml", or "multipart/form-data" request content types via the RESTful service activity.
A "Multipart/form-data" request enables multiple parts to be sent in a single request, such as structured JSON metadata and binary document content (for example, a PDF file).
Multipart Form Data requests are only available for POST, PUT, or PATCH HTTP verbs.