Difference between revisions of "RESTGet (Activity)"
(→Example) |
|||
| (39 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | This activity performs a "READ" operation using the | + | This activity is used to get a resource from a server and performs a "READ" operation using the REST Service. |
<!-- DO NOT REMOVE THIS -->{{Template:Activity/Begin}}<!-- DO NOT REMOVE THIS --> | <!-- DO NOT REMOVE THIS -->{{Template:Activity/Begin}}<!-- DO NOT REMOVE THIS --> | ||
| − | |||
= Description = | = Description = | ||
{{ActivityInfoBox | {{ActivityInfoBox | ||
| Line 9: | Line 8: | ||
| image = | | image = | ||
| imagecaption = Activity RESTGet | | imagecaption = Activity RESTGet | ||
| − | | purpose = | + | | purpose = Get a resource from a server using the REST Service |
| category = UBIK Web | | category = UBIK Web | ||
| returns = true if successful | | returns = true if successful | ||
| − | | version = 3.5 | + | | version = 3.5.0+ |
}} | }} | ||
| Line 20: | Line 19: | ||
! Argument !! Type !! Direction !! Purpose | ! Argument !! Type !! Direction !! Purpose | ||
|- align="left" | |- align="left" | ||
| − | | DisplayName || {{String}} || | + | | DisplayName || {{String}} || || Display's the name |
|- align="left" | |- align="left" | ||
| Error || {{String}} || Out || Display's error message, appears when something is wrong with your request | | Error || {{String}} || Out || Display's error message, appears when something is wrong with your request | ||
|- align="left" | |- align="left" | ||
| − | | Headers || {{String | + | | Headers || Dictionary<{{String}}, {{String}}> || In || Authentication and providing information |
|- align="left" | |- align="left" | ||
| − | | MethodName || {{String}} || In || Name of the | + | | MethodName || {{String}} || In || Name of the method |
|- align="left" | |- align="left" | ||
| − | | Parameter || | + | | Parameter || String[] || In || Refers to one of the pieces of data provided as input |
|- align="left" | |- align="left" | ||
| Response || {{String}} || Out || Data sent back to you | | Response || {{String}} || Out || Data sent back to you | ||
|- align="left" | |- align="left" | ||
| − | | Result || {{String}} || Out || Result sent back to you | + | | Result || {{String}} || Out || Result data sent back to you |
|- align="left" | |- align="left" | ||
| − | | Url || {{String}} || In || | + | | Url || {{String}} || In || Specified Url |
|- align="left" | |- align="left" | ||
|} | |} | ||
| Line 40: | Line 39: | ||
===Usage=== | ===Usage=== | ||
| − | Use this activity to get a resource from a server | + | Use this activity to get a resource from a server. |
| + | =Example= | ||
| + | Exemplary values to get Customizing Info from UBIK Content service. | ||
| + | {| class="wikitable" | width = "25%" | ||
| + | |- | ||
| + | ! RESTGet!! Value | ||
| + | |- align="left" | ||
| + | | DisplayName || RESTGet<String | ||
| + | |- align="left" | ||
| + | | Error || | ||
| + | |- align="left" | ||
| + | | Headers || | ||
| + | |- align="left" | ||
| + | | MethodName || "GetCustomizingInfo" | ||
| + | |- align="left" | ||
| + | | Parameter || | ||
| + | |- align="left" | ||
| + | | Resonse || | ||
| + | |- align="left" | ||
| + | | Result || "info" | ||
| + | |- align="left" | ||
| + | | Url || "https://81.10.184.186:888/UBIK/DBG/AUG/MT/TEMPLATE/Content/UbikContent.svc" | ||
| + | |} | ||
{| class="wikitable" | width = "50%" | {| class="wikitable" | width = "50%" | ||
|- | |- | ||
| − | ! | + | ! DebugMessage!! Value |
| + | |- align="left" | ||
| + | | DisplayName || DebugMessage | ||
| + | |- align="left" | ||
| + | | Result || | ||
| + | |- align="left" | ||
| + | | Text || "info" | ||
| + | |- align="left" | ||
| + | | UBIKObject || | ||
|- align="left" | |- align="left" | ||
| − | |||
|} | |} | ||
| − | |||
| + | <!-- DO NOT REMOVE THIS -->{{Template:Activity/End}}<!-- DO NOT REMOVE THIS --> | ||
==See also== | ==See also== | ||
| + | * [[Workflow Designer]] | ||
| + | |||
| + | ==Useful links [What is REST Service]== | ||
| + | * https://www.sitepoint.com/developers-rest-api/ | ||
| + | * https://mlsdev.com/blog/81-a-beginner-s-tutorial-for-understanding-restful-api | ||
| + | * https://www.smashingmagazine.com/2018/01/understanding-using-rest-api/ | ||
Latest revision as of 08:39, 14 April 2020
This activity is used to get a resource from a server and performs a "READ" operation using the REST Service.
