Handling Method Variations in a Single Appian Web API Object

RE: Handling Method Variations in a Single Appian Web API Object

Stefan Helzle — Thu, 05 Dec 2024 14:47:48 GMT

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.

RE: Handling Method Variations in a Single Appian Web API Object

Mathieu Drouin — Wed, 04 Dec 2024 01:03:05 GMT

Use pathSegments:

GET

POST

RE: Handling Method Variations in a Single Appian Web API Object

Shantanu Joshi — Tue, 03 Dec 2024 17:27:36 GMT

Hi Stefan Helzle Mathieu Drouin Soma

Thanks for your replies!

Actually, in my current case I will not be able to create separate API for each endpoint. The reason for same is below:

External system has a predefined UI and for each click we need our APi to respond.

Now let say our API endpoint is /endpoint1. The URL will be: www.appiancloud.com/suits/webapi/endpoint1.

First Request:
request URL: www.appiancloud.com/suits/webapi/endpoint1/alldata
In first request it will fetch list of records based on some query parameters (if provided)

response:

[
{
"id": "ID1",
"Name1": "Customer 1",
"Customernum": "3",
"Street1": "Line 111",
"Street2": "740",
},
{
"id": "ID2",
"Name1": "Customer 2",
"Customernum": "2",
"Street1": "Line 111",
"Street2": "740",
},
{
"id": "ID3",
"Name1": "Customer 3",
"Customernum": "3",
"Street1": "Line 111",
"Street2": "740",
}
]

This list of data will be showed in 3rd part systems UI

Now if an end user clicks on any specific record in the 3rd party system. That particular data will be showed to the user and in that case request/response will look like below

------

Second Request:
Request URL: www.appiancloud.com/suits/webapi/endpoint1/data/{"id"}

Response:
{
"id": "ID2",
"Name1": "Customer 1",
"Customernum": "2",
"Street1": "Line 111",
"Street2": "740",
}

Up till here it is following only GET method. Now according to the requirement there should options to perform certain actions on the specific record.
In this case request will look like below

------

Third Case:
Request URL: www.appiancloud.com/suits/webapi/endpoint1/data/{"id"}/action
Request Body: {
"name1": "updatedName"
}

response:
{
"id": "ID2",
"Name1": "updatedName",
"Customernum": "2",
"Street1": "Line 111",
"Street2": "740",
}

PS: Above is a high-level requirement, there are multiple scenarios like this,

Thank You!

RE: Handling Method Variations in a Single Appian Web API Object

Shantanu Joshi — Tue, 03 Dec 2024 17:25:01 GMT

Hi Stefan Helzle Mathieu Drouin Soma
Thanks for your replies!

Actually, in my current case I will not be able to create separate API for each endpoint. The reason for same is below:

External system has a predefined UI and for each click we need our APi to respond.

Now let say our API endpoint is /endpoint1. The web API URL will be: www.appiancloud.com/suits/webapi/endpoint1.

First Request:
request URL: www.appiancloud.com/suits/webapi/endpoint1/alldata
In first request it will fetch list of records based on some query parameters (if provided)

response:

This list of data will be showed in 3rd part systems UI

Now if an end user clicks on any specific record in the 3rd party system. That particular data will be showed to the user and in that case request/response will look like below

------

Second Request:
Request URL: www.appiancloud.com/suits/webapi/endpoint1/data/{"id"}

Response:
{
"id": "ID2",
"Name1": "Customer 1",
"Customernum": "2",
"Street1": "Line 111",
"Street2": "740",
}

Up till here it is following only GET method. Now according to the requirement there should options to perform certain actions on the specific record.
In this case request will look like below

------

Third Case:
Request URL: www.appiancloud.com/suits/webapi/endpoint1/data/{"id"}/action
Request Body: {
"name1": "updatedName"
}

response:
{
"id": "ID2",
"Name1": "updatedName",
"Customernum": "2",
"Street1": "Line 111",
"Street2": "740",
}

PS: Above is just a high level of the requirement I am working on. Please let me know if you have any suggestion on this!
Thank you!

RE: Handling Method Variations in a Single Appian Web API Object

Mathieu Drouin — Mon, 02 Dec 2024 18:06:52 GMT

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

RE: Handling Method Variations in a Single Appian Web API Object

Stefan Helzle — Mon, 02 Dec 2024 15:53:59 GMT

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

RE: Handling Method Variations in a Single Appian Web API Object

Soma — Mon, 02 Dec 2024 09:33:22 GMT

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

RE: Handling Method Variations in a Single Appian Web API Object

Shantanu Joshi — Mon, 02 Dec 2024 06:19:59 GMT

Hi In the 3rd party system we can only configure one API URL, all the requests will be made to the same API only.

RE: Handling Method Variations in a Single Appian Web API Object

sarathkumar13 — Mon, 02 Dec 2024 06:16:45 GMT

Why you dont want to create separate APIs for post and get call?