Difference between revisions of "RESTGet (Activity)"

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+

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
Example

Description

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

Useful links [What is REST Service]

@@ Line 1: / Line 1: @@
-This activity verifies login information and retrieves an Authentication Object 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 -->
 = Description =
 {{ActivityInfoBox
 | title = Authenticate
-| name = Authenticate
+| name = RESTGet
 | image =
-| imagecaption = Activity Authenticate
+| imagecaption = Activity RESTGet
-| purpose = Verifies login information and retrieves an Authentication Object using the UBIK USAM Service
+| purpose =  Get a resource from a server using the REST Service
 | category = UBIK Web
 | returns = true if successful
-| version = 3.5
+| version = 3.5.0+
 }}
@@ Line 20: / Line 19: @@
 ! Argument !! Type !! Direction !! Purpose
 |- align="left"
-| Application || {{String}} || In || An Application is used to identify Contexts, the Application name have to be configured in the client's settings
+| DisplayName || {{String}} ||  || Display's the name
 |- align="left"
-| AuthenticationResult || {{AuthenticationResult}} || Out || A valid Authentication Token, be aware, that these kind of tokens are only supported for short period of Time.
+| Error || {{String}} || Out || Display's error message, appears when something is wrong with your request
 |- align="left"
-| Context || {{String}} || In || A Context is used to identify a View and all relevant Scopes, the Context name have to be configured in the client's settings
+| Headers || Dictionary<{{String}}, {{String}}> || In || Authentication and providing information
 |- align="left"
-| DisplayName || {{String}} || In || Name of the File
+| MethodName || {{String}} || In || Name of the method
 |- align="left"
-| Geo || [[GeoInformation]] || In || Location (Latitude, Longitude, Altitude)
+| Parameter || String[] || In || Refers to one of the pieces of data provided as input
 |- align="left"
-| Login || {{String}} || In || The Login Object holds the necessary information for managing logins to UBIK®,  each Login name must be unique.
+| Response || {{String}} || Out ||  Data sent back to you
 |- align="left"
-| Manufacturer || {{String}} || In || Computer Manufacturer, e.g., HP, DELL and and so forth
+| Result || {{String}} || Out || Result data sent back to you
 |- align="left"
-| Model || {{String}} || In || Computer model, e.g., Pavilion, Inspiron and and so forth
+| Url || {{String}} || In || Specified Url
-|- align="left"
-| OperatingSystem || {{OSTypes}} || In || An operating system (OS) is system software that manages computer hardware, software resources, and provides common services for computer programs.
-|- align="left"
-| Password || {{String}} || In || Configures the options for a username/password style authentication.
-|- align="left"
-| Result || {{Boolean}} || Out ||
-|- align="left"
-| Satellite || {{String}} || In || Configuration of allowed devices to connect to the system
-|- align="left"
-| ServiceVersion || {{String}} || In || Current client version
-|- align="left"
-| USAMUrl || {{String}} || In || Combination of Authentication Server and Authentication Service Path
 |- align="left"
 |}
@@ Line 52: / Line 39: @@
 ===Usage===
-Use this activity to verify the login information and retrieve an Authentication Object using the UBIK USAM Service.
+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%"
 |-
-! Argument!! Value
+! 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]]
-* [[Activity:CreatePushScope (Activity)]]
+==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/