User Tools

Site Tools


transformations:iteratewebrequest

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
transformations:iteratewebrequest [2021/07/02 21:58] craigttransformations:iteratewebrequest [2023/11/02 08:07] (current) – [Options settings] dmitry
Line 13: Line 13:
 \\  \\ 
 =====Use cases===== =====Use cases=====
-The action is intended for repeating uniform interactions with REST APIs, cloud applications and websites. +The action is intended for repeating uniform interactions with REST APIs, cloud applicationsand websites. 
  
 \\  \\ 
 =====Action settings===== =====Action settings=====
 ^ Setting  ^ Description  ^ ^ Setting  ^ Description  ^
-|Connector<sup>*</sup>|Select or create a Web Location connector.|+|Connector/Base URL<sup>*</sup>|Select or create a Web Location connector, or enter the base URL for the request.  Select between "Connector" and\\ "Base URL" using the selector to the //left// of the input field.|
 |Request method|Select the request method.  Options:  //GET//, //HEAD//, //POST//, //PUT//, //DELETE//, //CONNECT//, //OPTIONS//, //TRACE//, and //PATCH//.| |Request method|Select the request method.  Options:  //GET//, //HEAD//, //POST//, //PUT//, //DELETE//, //CONNECT//, //OPTIONS//, //TRACE//, and //PATCH//.|
-|Path<sup>1</sup>|See "Path setting", below.| +|Path<sup>%%**%%</sup>|See "Path setting", below.| 
-|Add URL parameters<sup>1</sup>|Check to insert parameters into the URL.  See "URL parameters", below, for details.| +|Add URL parameters<sup>%%**%%</sup>|Check to insert parameters into the URL.  See "URL parameters", below, for details.| 
-|Body<sup>1</sup>|See "Request Body settings", below.| +|Body<sup>%%**%%</sup>|See "Request Body settings", below.| 
-|Headers<sup>1</sup>|See "Request Headers settings", below.| +|Headers<sup>%%**%%</sup>|See "Request Headers settings", below.| 
-|Response<sup>1</sup>|See "Response settings", below.|+|Response<sup>%%**%%</sup>|See "Response settings", below.|
 <sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\ <sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\
-<sup>1</sup> Setting can be specified using the values in a selected table column.\\+<sup>%%**%%</sup> Setting can be specified using a [[:parameters|parameter]] or the values in a selected table column.\\
 \\  \\ 
 ====Path setting==== ====Path setting====
-The URL path is appended to the endpoint URL specified in the Web Location connector. EasyMorph parameters can be inserted into the path using curly braces if needed. Alternatively, the entire path can be specified with a parameteror using the values in a specified column.+The URL path is appended to the endpoint URL specified in the Web Location connector. EasyMorph parameters can be inserted into the path using curly braces if needed. Alternatively, the entire path can be specified with a parameter or using the values in a specified column.
  
 **Examples:** **Examples:**
Line 82: Line 82:
 \\  \\ 
 __**Form**__\\ __**Form**__\\
-This body type is equivalent to submitting a web-form. Name-value pairs are encoded as if it was a web-form.+This body type is equivalent to submitting a web form. Name-value pairs are encoded as if it was a web-form.
  
 Header Content-Type is automatically set to "application/x-www-form-urlencoded". Header Content-Type is automatically set to "application/x-www-form-urlencoded".
Line 100: Line 100:
 \\  \\ 
 __**File**__\\ __**File**__\\
-The request body is read from the specified file and inserted verbatim.+The request body is read from the specified file and inserted verbatim. When //Upload file (multi-part upload)// is selected, additional parameters can be defined as well. 
 + 
  
 \\  \\ 
Line 122: Line 124:
 __**Save response body to file, fail if HTTP error**__\\ __**Save response body to file, fail if HTTP error**__\\
 In this case, if the response status is not an error (i.e. HTTP status codes 4xx or 5xx) then the response body (only the body!) will be saved verbatim into the specified file (the filename of which can be created automatically, or specified using values in a specified column). In this case, if the response status is not an error (i.e. HTTP status codes 4xx or 5xx) then the response body (only the body!) will be saved verbatim into the specified file (the filename of which can be created automatically, or specified using values in a specified column).
 +
 +\\ 
 +====Options settings====
 +Check //Send requests in parallel// to enable parallel requests and choose the //Degree of parallelism// (from 2 to 20) from the drop-down. With this option selected, the order in which requests are sent is no longer guaranteed.
  
 \\  \\ 
Line 135: Line 141:
 When developing workflows with web requests it may be necessary to re-run parts of workflows. In this case, it is recommended to always start from the Web Request actions that do authentication so that the session cookies can be set under the hood. When developing workflows with web requests it may be necessary to re-run parts of workflows. In this case, it is recommended to always start from the Web Request actions that do authentication so that the session cookies can be set under the hood.
  
 +Iterate Web Request automatically sends the //User-Agent HTTP header// (e.g. "User-Agent: EasyMorph 5.4") unless disabled in the [[connectors:weblocation|Web Location connector]].
 +
 +
 +\\ 
 +=====Community examples=====
 +  * [[https://community.easymorph.com/t//1865/4|Dynamical genereting of path based on previous step]] ([[https://community.easymorph.com/uploads/short-url/70xVAnShgK4EiXuSa4HgMJtFAM2.morph|Project]]; Module: //Import and send//; Group: //Tab 1//; Table: //Send request//;\\ Action position: //2//)
 +  * [[https://community.easymorph.com/t//2158/5|API pagination how I create loop]] ([[https://community.easymorph.com/uploads/short-url/rQmjCeA2LXPlqzxhL5N9IoCE5CR.morph|Project]]; Module: //responseToCSV//; Group: //Tab 1//; Table: //Fetch data from API//; Action position: //3//)
 +  * [[https://community.easymorph.com/t//2160/1|How to pull data from web APIs with pagination]] ([[https://community.easymorph.com/uploads/short-url/dvCSpcEDXYZ8aB0B2gtnt7qulTF.morph|Project]]; Module: //Query API//; Group: //Group 1//; Table: //Query//; Action position: //2//)
 +  * [[https://community.easymorph.com/t//2641/1|How to publish real-time data to streaming dataset in Power BI]] ([[https://community.easymorph.com/uploads/short-url/22DTxfF295TVGQhGyvWGsHyadRt.morph|Project]]; Module: //Main//; Group: //Tab 1//; Table: //Table 1//; Action position: //6//)
  
 \\  \\ 
transformations/iteratewebrequest.txt · Last modified: 2023/11/02 08:07 by dmitry

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki