Handling Method Variations in a Single Appian Web API Object

Question

Hi Community, 
 
 I am working on a POC where a third-party system interacts with my Appian Web API. The setup involves the following: 
 1. The third-party system is configured to call my API endpoint: https ://appianCloud.com/suite/webapi/endpoint1 for a GET operation to retrieve data using query parameters. 
 2. In subsequent calls, the system appends /action or /response to the same endpoint URL and performs a POST operation to modify the data for the same record. 
 
 Given this requirement, I would like to know: 
 &bull; Is it possible to handle this type of scenario within a single Appian Web API object? 
 &bull; If not, are there any known workarounds or best practices to manage such dynamic operation variations? 
 
 Looking forward to your insights. Thank you in advance!

Mathieu Drouin · Accepted Answer

Use pathSegments: 
 GET 
 
 POST

Stefan Helzle · Answer

You can create multiple API objects on the same endpoint, as long as the method is different. 
 Then, in that objects, you route the call to separate expressions, depending on the path. In these expression, you do whatever is required.

Soma · Answer

It is possible to have same endpoints as long as the method is different. Create separate APIs for each methods 
 One API for GET with endpoint1 
 Another API for all the POST API, you can handle your logics using relative paths ( endpoint1/action and endpoint1/response ) 
 In the API, you can use http!request.pathSegments to differentiate the logics for each

Stefan Helzle · Answer

Why not just create separate API objects to handle the /action and /response endpoints?

Mathieu Drouin · Answer

Create two separate Web API objects (i.e. Endpoint_GET and Endpoint_POST) with the same url endpoint but different methods (GET and POST).

Handling Method Variations in a Single Appian Web API Object

Top Replies