Hi All,
we implemented a WEB - API for document retrieval by providing the Document ID as input parameter. Some times WEB-API consumers facing issues when the given document is larger size like more than >500MB.
Please clarify below couple of questions.
Thanks in advance.
-Ram.
Discussion posts and replies are publicly visible
Hello Ram,
I have honestly been researching this problem of yours since you posted it, and frankly I am puzzled, like I thought of so many things (some are not so clever) so here goes,
first Question: what I found out was that Appian doesn't support uploading files larger than 1GB, so naturally I think the limit for sending a document is 1GB.
second Question: I'm still quite puzzled as to what exactly is happening, like, Appian let's you create your own logic as to when to return certain status codes when certain criteria is met, and is it really that bad that the web service isn't run at all? I hope you check your admin console "monitoring" section (img below) and maybe get an idea if the service is run at all, and if the document downloading is started or not from the Appian platform, I think it might be that the application starting the web API is failing to receive such a big file, IDK.
as for the third question I hope someone with a more expertise might help us here.
.
one last thing, I have created a test web API in my Appian instance that retrieves a document by its id and have uploaded two files one with a size of 500MB and another with a size of 667MB, and when i invoke the URL for the service it does what it's supposed to and downloads the file with no problems, I don't know what that might mean in your case but it's just an FYI.
best of luck.
-Ahmad
Hi Ahmad,
Thanks for your efforts. One thing on last one is like are you retrieving those large docs through appian it self or any third party tools like Soap UI or Postman?
nope just plain old Appian test button as well as opening the URL that Appian generates, I am very positive the problem has to do with the third party App that you have,
good luck Ram.
I am pleased to inform you that I have found where the web API logs are located
it's in the system logs > perflogs >
web_api_details.csv web_api_summary.csv
they have full details of your web API's status codes, and every thing.
hope this helps you uncovering the mystery of your web API.
Good luck
references:
https://docs.appian.com/suite/help/21.1/Web_APIs.html#logging
https://docs.appian.com/suite/help/21.1/Logging.html#web-api-performance-logs
https://docs.appian.com/suite/help/21.1/Logging.html#web-api-metrics-logs
Thanks Ahmed. These logs didnt provide any timeout errors. Is there any way we can configure the Web-API response timeout value?
yes there is a way to control the time-out for an API call, but it must be done from the client side (the one that calls the Appian API), by editing the keep-Alive parameter in the HTTP request, see below links for more info.
https://docs.appian.com/suite/help/17.3/Web_APIs.html
https://community.appian.com/discussions/f/integrations/11132/web-api-timeout-to-manually-set
Finally found some thing in documentation
glad you found a solution for your problem
: )