Jump to: navigation, search

Difference between revisions of "RESTGet (Activity)"


(Created page with "This activity verifies login information and retrieves an Authentication Object using the UBIK USAM Service. <!-- DO NOT REMOVE THIS -->{{Template:Activity/Begin}}<!-- DO NOT...")
 
Line 1: Line 1:
This activity verifies login information and retrieves an Authentication Object using the UBIK USAM Service.
+
This activity performs a "READ" operation using the UBIK USAM Service.
  
 
<!-- DO NOT REMOVE THIS -->{{Template:Activity/Begin}}<!-- DO NOT REMOVE THIS -->
 
<!-- DO NOT REMOVE THIS -->{{Template:Activity/Begin}}<!-- DO NOT REMOVE THIS -->
Line 20: Line 20:
 
! Argument !! Type !! Direction !! Purpose  
 
! Argument !! Type !! Direction !! Purpose  
 
|- align="left"
 
|- 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}} || In || Display's the name
 
|- align="left"
 
|- 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"
 
|- 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 || {{String)}} || In || authentication and providing information
 
|- align="left"
 
|- align="left"
| DisplayName || {{String}} || In || Name of the File
+
| MethodName || {{String}} || In || Name of the  
 
|- align="left"
 
|- align="left"
| Geo || [[GeoInformation]] || In || Location (Latitude, Longitude, Altitude)
+
| Parameter || {{String}} || In || a parameter, is a special kind of variable, used to refer to one of the pieces of data provided as input
 
|- align="left"
 
|- 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"
 
|- align="left"
| Manufacturer || {{String}} || In || Computer Manufacturer, e.g., HP, DELL and and so forth
+
| Result || {{String}} || Out || Result sent back to you
 
|- align="left"
 
|- align="left"
| Model || {{String}} || In || Computer model, e.g., Pavilion, Inspiron and and so forth
+
| Url || {{String}} || In ||  
|- 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"
 
|- align="left"
 
|}
 
|}
Line 52: Line 40:
  
 
===Usage===
 
===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=
 
  
  
Line 68: Line 54:
  
 
==See also==
 
==See also==
* [[Workflow Designer]]
 
* [[Activity:CreatePushScope (Activity)]]
 

Revision as of 08:31, 26 March 2020

This activity performs a "READ" operation using the UBIK USAM Service.


[edit]

Description

Authenticate
Name Authenticate
Purpose Verifies login information and retrieves an Authentication Object using the UBIK USAM Service
Category UBIK Web
Returns true if successful
Version 3.5

Arguments

Argument Type Direction Purpose
DisplayName String In Display's the name
Error String Out Display's error message, appears when something is wrong with your request
Headers String) In authentication and providing information
MethodName String In Name of the
Parameter String In a parameter, is a special kind of variable, used to refer to one of the pieces of data provided as input
Response String Out Data sent back to you
Result String Out Result sent back to you
Url String In


Usage

Use this activity to get a resource from a server


Argument Value


See also