Jump to: navigation, search

Difference between revisions of "RESTGet (Activity)"


(Arguments)
(Example)
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
This activity is used to get a resource from a server and performs a "READ" operation using the UBIK USAM Service.
+
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 -->
Line 8: Line 8:
 
| image =  
 
| image =  
 
| imagecaption = Activity RESTGet
 
| imagecaption = Activity RESTGet
| purpose =  Get a resource from a server using the UBIK USAM Service
+
| 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
Line 23: Line 23:
 
| 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 || Dictionary<{{String_MSDN}}, {{String_MSDN}}> || In || Authentication and providing information
+
| Headers || Dictionary<{{String}}, {{String}}> || In || Authentication and providing information
 
|- align="left"
 
|- align="left"
 
| MethodName || {{String}} || In || Name of the method
 
| MethodName || {{String}} || In || Name of the method
Line 40: Line 40:
 
===Usage===
 
===Usage===
 
Use this activity to get a resource from a server.
 
Use this activity to get a resource from a server.
 
 
  
  
 
=Example=
 
=Example=
Gets Customizing Version.
+
Exemplary values to get Customizing Info from UBIK Content service.
  
 
{| class="wikitable" | width = "25%"
 
{| class="wikitable" | width = "25%"
 
|-
 
|-
! Argument!! Value
+
! RESTGet!! Value
 
|- align="left"
 
|- align="left"
| DisplayName || "RESTGet<String"
+
| DisplayName || RESTGet<String
 
|- align="left"
 
|- align="left"
 
| Error ||  
 
| Error ||  
Line 66: Line 64:
 
|- align="left"
 
|- align="left"
 
| Url || "https://81.10.184.186:888/UBIK/DBG/AUG/MT/TEMPLATE/Content/UbikContent.svc"
 
| Url || "https://81.10.184.186:888/UBIK/DBG/AUG/MT/TEMPLATE/Content/UbikContent.svc"
 +
|}
 +
{| class="wikitable" | width = "50%"
 +
|-
 +
! DebugMessage!! Value
 +
|- align="left"
 +
| DisplayName || DebugMessage
 +
|- align="left"
 +
| Result ||
 +
|- align="left"
 +
| Text || "info"
 +
|- align="left"
 +
| UBIKObject ||
 +
|- align="left"
 
|}
 
|}
  
  
 
<!-- DO NOT REMOVE THIS -->{{Template:Activity/End}}<!-- DO NOT REMOVE THIS -->
 
<!-- DO NOT REMOVE THIS -->{{Template:Activity/End}}<!-- DO NOT REMOVE THIS -->
 +
==See also==
 +
* [[Workflow Designer]]
  
==See also [What is REST Service]==
+
==Useful links [What is REST Service]==
 
* https://www.sitepoint.com/developers-rest-api/
 
* https://www.sitepoint.com/developers-rest-api/
 
* https://mlsdev.com/blog/81-a-beginner-s-tutorial-for-understanding-restful-api
 
* https://mlsdev.com/blog/81-a-beginner-s-tutorial-for-understanding-restful-api
 
* https://www.smashingmagazine.com/2018/01/understanding-using-rest-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.


[edit]

Description

Authenticate
Name RESTGet
Purpose Get a resource from a server using the REST Service
Category UBIK Web
Returns true if successful
Version 3.5.0+

Arguments

Argument Type Direction Purpose
DisplayName String Display's the name
Error String Out Display's error message, appears when something is wrong with your request
Headers Dictionary<String, String> In Authentication and providing information
MethodName String In Name of the method
Parameter String[] In Refers to one of the pieces of data provided as input
Response String Out Data sent back to you
Result String Out Result data sent back to you
Url String In Specified Url


Usage

Use this activity to get a resource from a server.


Example

Exemplary values to get Customizing Info from UBIK Content service.

RESTGet Value
DisplayName RESTGet<String
Error
Headers
MethodName "GetCustomizingInfo"
Parameter
Resonse
Result "info"
Url "https://81.10.184.186:888/UBIK/DBG/AUG/MT/TEMPLATE/Content/UbikContent.svc"
DebugMessage Value
DisplayName DebugMessage
Result
Text "info"
UBIKObject


See also

Useful links [What is REST Service]