• DOCUMENTATION
  • WORKATO BLOG
  • PRODUCT BLOG
  • Return to Workato
  • Log in
  • ☰
  • Community/Discussions
Solution home App Resources HTTP

HTTP: Make REST Request Action - Response body example

Modified on: Wed, May 31, 2017 at 1:05 PM

HTTP REST Request Action -Response body example

Extracting Object schema for Workato Recipes


What is : Response Body Example

One of the natural wonders of using integration tools is the ability to extract, manipulate, and push field values of any objects into other applications. With Workato, data from another applications can be transformed into Workato Recipes as data pills for future use.


http_response_samle.pnghttp_datatree.png


This is where Response Body Example field do the trick. By providing a sample document, Workato will be able to parse and devise the sample document, so that it matches with the response that it will be getting back from the API.


Respose Body sample are usually available on API documentations. They are located by the API endpoints beside its sample requests. Here's an example from Qualtrics' API :



http_resultformat.pnghttp_resonses.png

By copying the sample response to the HTTP Sample Response Body example field, the fields will now show up as part of the step's App Data for all steps below it in the recipe :


XML sample responses can be parsed as well, simply choose Parse response as XML to do so.

http_xml.pngahttp_xml.png



FAQ
HTTP Action says Extended Schema Error. What should I do?

http_schemaerror.png


This means that Workato had not been successfully parsed the given schema. This may be due to the sample response not following the proper JSON or XML structure. If you are unsure, feel free to post a question to your application's support forum, or post a topic on Workato's forum to ask for assistance.



Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.

Related Articles

    Still can't find your solution?

    Visit our forums to search for answers, or post your own questions.

    Documentation
    Developer's Library
    Tutorials
    eBooks
    Product Hour
    Product Blog
    Workato Blog
    Product updates
    Customer Stories
    © Workato 2020   Privacy   Terms   +1 (844) 469-6752
    • Documentation
    • Workato Blog
    • Product Blog
    • Solutions
    • Forums
    • Tickets
    • Log in
    • Return to Workato