Jump to: navigation, search

Difference between revisions of "RESTPost (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...")
 
 
(30 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
This activity verifies login information and retrieves an Authentication Object using the UBIK USAM Service.
+
This activity is used to create a new resource on a server and performs an "Post" operation using any web service.
  
 
<!-- DO NOT REMOVE THIS -->{{Template:Activity/Begin}}<!-- DO NOT REMOVE THIS -->
 
<!-- DO NOT REMOVE THIS -->{{Template:Activity/Begin}}<!-- DO NOT REMOVE THIS -->
Line 5: Line 5:
 
= Description =
 
= Description =
 
{{ActivityInfoBox
 
{{ActivityInfoBox
−
| title = Authenticate
+
| title = RESTPost
−
| name = Authenticate
+
| name = RESTPost
 
| image =  
 
| image =  
−
| imagecaption = Activity Authenticate
+
| imagecaption = Activity RESTPost
−
| purpose = Verifies login information and retrieves an Authentication Object using the UBIK USAM Service
+
| purpose = Create a new resource on a server using the UBIK USAM 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 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
+
| Body || {{String}} || In || Contains information wich is sent to the server
 
|- 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.
+
| DisplayName || {{String}} || || Display's the name
 
|- 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
+
| Error || {{String}} || Out || Display's error message, appears when something is wrong with your request
 
|- align="left"
 
|- align="left"
−
| DisplayName || {{String}} || In || Name of the File
+
| Headers || Dictionary<{{String}}, {{String}}> || In || Authentication and providing information
 
|- align="left"
 
|- align="left"
−
| Geo || [[GeoInformation]] || In || Location (Latitude, Longitude, Altitude)
+
| MethodName || {{String}} || In || Name of the method
 
|- 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
+
| Parameter || String[] || In || Refers to one of the pieces of data provided as input
 
|- align="left"
 
|- align="left"
−
| Manufacturer || {{String}} || In || Computer Manufacturer, e.g., HP, DELL and and so forth
+
| Response || {{String}} || Out || Data sent back to you
 
|- align="left"
 
|- align="left"
−
| Model || {{String}} || In || Computer model, e.g., Pavilion, Inspiron and and so forth
+
| Result || {{String}} || Out || Result data sent back to you
 
|- align="left"
 
|- 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
+
| Url || {{String}} || In || Specified Url
−
|- align="left"
+
−
| Password || {{String}} || In || Configures the options for a username/password style authentication
+
−
|- align="left"
+
−
| Result || {{Boolean}} || Out || True or False
+
−
|- 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 42:
  
 
===Usage===
 
===Usage===
−
Use this activity to verify the login information and retrieve an Authentication Object using the UBIK USAM Service.
+
Use this activity to create a new "Post" resource on any server using the UBIK Content service.
 +
 
 +
 
  
  
 
=Example=
 
=Example=
−
Exemplary values to get Token.
+
Exemplary values using RESTPost to get Hierarchy details from UBIK Content service.
−
 
+
 
{| class="wikitable" | width = "50%"
 
{| class="wikitable" | width = "50%"
 
|-
 
|-
−
! Argument!! Value
+
! A+B Assign !! Value
 
|- align="left"
 
|- align="left"
−
| Application || "APP_MT"
+
| DisplayName || Assign
 
|- align="left"
 
|- align="left"
−
| AuthenticationResult || "token"
+
| To || args
 
|- align="left"
 
|- align="left"
−
| Context || "CMT_MT"
+
| Value || New UBIK.Service.DTO.V211.HierarchyDeltaArguments()
 
|- align="left"
 
|- align="left"
−
| DispalyName || "Authenticate"
+
|}
 +
 
 +
{| class="wikitable" | width = "50%"
 +
|-
 +
! A+B Assign !! Value
 
|- align="left"
 
|- align="left"
−
| Geo || "New UBIK.Kernel.GeoInformation(18, 42, 333)"
+
| DisplayName || Assign
 
|- align="left"
 
|- align="left"
−
| Login || "MHM"
+
| To || args.StartingPoint
 
|- align="left"
 
|- align="left"
−
| Manufacturer || "mein HP"
+
| Value || New UBIK.Service.DTO.V211.HierarchyRoot()
 
|- align="left"
 
|- align="left"
−
| Model || "Probook...."
+
|}
 +
 
 +
{| class="wikitable" | width = "50%"
 +
|-
 +
! A+B Assign !! Value
 
|- align="left"
 
|- align="left"
−
| OperatingSystem || "UBIK.Service.DTO.V220.OSTypes.X_IOS"
+
| DisplayName || Assign
 
|- align="left"
 
|- align="left"
−
| Password || ""
+
| To || args.ChildrenDepth
 
|- align="left"
 
|- align="left"
−
| Result || ""
+
| Value || 1
 
|- align="left"
 
|- align="left"
−
| Satellite || "myDevice"
 
−
|- align="left"
 
−
| ServiceVersion || "264"
 
−
|- align="left"
 
−
| USAMUrl || "https://81.10.184.186:888/UBIK/DBG/AUG/MT/TEMPLATE/USAM/USAM.svc"
 
 
|}
 
|}
  
−
<!-- DO NOT REMOVE THIS -->{{Template:Activity/End}}<!-- DO NOT REMOVE THIS -->
+
{| class="wikitable" | width = "50%"
−
 
+
−
==See also==
+
−
* [[Workflow Designer]]
+
−
* [[Activity:CreatePushScope (Activity)]]This activity verifies login information and retrieves an Authentication Object using the UBIK USAM Service.
+
−
 
+
−
<!-- DO NOT REMOVE THIS -->{{Template:Activity/Begin}}<!-- DO NOT REMOVE THIS -->
+
−
 
+
−
= Description =
+
−
{{ActivityInfoBox
+
−
| title = Authenticate
+
−
| name = Authenticate
+
−
| image =
+
−
| imagecaption = Activity 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===
+
−
{| class="wikitable sortable" | width = "50%"
+
 
|-
 
|-
−
! Argument !! Type !! Direction !! Purpose
+
! A+B Assign !! Value
 
|- 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 || Assign
 
|- 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.
+
| To || authToken
 
|- 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
+
| Value || "e1191c36-2081-4ffe-8d8e-4b798d4523a1"
 
|- align="left"
 
|- align="left"
−
| DisplayName || {{String}} || In || Name of the File
+
|}
 +
 
 +
{| class="wikitable" | width = "50%"
 +
|-
 +
! RESTPost!! Value
 
|- align="left"
 
|- align="left"
−
| Geo || [[GeoInformation]] || In || Location (Latitude, Longitude, Altitude)
+
| Body || args
 
|- 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
+
| DisplayName || RESTPost<BCHierarchyDeltaShipments,HierarchyDeltaArguments>
 
|- align="left"
 
|- align="left"
−
| Manufacturer || {{String}} || In || Computer Manufacturer, e.g., HP, DELL and and so forth
+
| Error ||  
 
|- align="left"
 
|- align="left"
−
| Model || {{String}} || In || Computer model, e.g., Pavilion, Inspiron and and so forth
+
| Headers ||  
 
|- align="left"
 
|- 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
+
| MethodName || "GetHierarchyDeltasV212"
 
|- align="left"
 
|- align="left"
−
| Password || {{String}} || In || Configures the options for a username/password style authentication
+
| Parameter || New String(){"APP_MT","CXT_MT",authToken,"264"}
 
|- align="left"
 
|- align="left"
−
| Result || {{Boolean}} || Out || True or False
+
| Response ||  
 
|- align="left"
 
|- align="left"
−
| Satellite || {{String}} || In || Configuration of allowed devices to connect to the system
+
| Result|| result
 
|- align="left"
 
|- align="left"
−
| ServiceVersion || {{String}} || In || Current client version
+
| Url || "https://81.10.184.186:888/UBIK/DBG/AUG/MT/TEMPLATE/Content/UbikContent.svc"
−
|- align="left"
+
−
| USAMUrl || {{String}} || In || Combination of Authentication Server and Authentication Service Path
+
 
|- align="left"
 
|- align="left"
 
|}
 
|}
  
  
−
===Usage===
 
−
Use this activity to verify the login information and retrieve an Authentication Object using the UBIK USAM Service.
 
  
  
−
=Example=
 
−
Exemplary values to get Token.
 
−
 
−
{| class="wikitable" | width = "50%"
 
−
|-
 
−
! Argument!! Value
 
−
|- align="left"
 
−
| Application || "APP_MT"
 
−
|- align="left"
 
−
| AuthenticationResult || "token"
 
−
|- align="left"
 
−
| Context || "CMT_MT"
 
−
|- align="left"
 
−
| DispalyName || "Authenticate"
 
−
|- align="left"
 
−
| Geo || "New UBIK.Kernel.GeoInformation(18, 42, 333)"
 
−
|- align="left"
 
−
| Login || "MHM"
 
−
|- align="left"
 
−
| Manufacturer || "mein HP"
 
−
|- align="left"
 
−
| Model || "Probook...."
 
−
|- align="left"
 
−
| OperatingSystem || "UBIK.Service.DTO.V220.OSTypes.X_IOS"
 
−
|- align="left"
 
−
| Password || ""
 
−
|- align="left"
 
−
| Result || ""
 
−
|- align="left"
 
−
| Satellite || "myDevice"
 
−
|- align="left"
 
−
| ServiceVersion || "264"
 
−
|- align="left"
 
−
| USAMUrl || "https://81.10.184.186:888/UBIK/DBG/AUG/MT/TEMPLATE/USAM/USAM.svc"
 
−
|}
 
  
 
<!-- DO NOT REMOVE THIS -->{{Template:Activity/End}}<!-- DO NOT REMOVE THIS -->
 
<!-- DO NOT REMOVE THIS -->{{Template:Activity/End}}<!-- DO NOT REMOVE THIS -->
Line 191: Line 129:
 
==See also==
 
==See also==
 
* [[Workflow Designer]]
 
* [[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/
 +
 
 +
<!-- DO NOT REMOVE THIS -->{{Template:Activity/Begin}}<!-- DO NOT REMOVE THIS -->

Latest revision as of 08:55, 14 April 2020

This activity is used to create a new resource on a server and performs an "Post" operation using any web service.


[edit]

Description

RESTPost
Name RESTPost
Purpose Create a new resource on a server using the UBIK USAM Service
Category UBIK Web
Returns true if successful
Version 3.5.0+

Arguments

Argument Type Direction Purpose
Body String In Contains information wich is sent to the server
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 create a new "Post" resource on any server using the UBIK Content service.



Example

Exemplary values using RESTPost to get Hierarchy details from UBIK Content service.

A+B Assign Value
DisplayName Assign
To args
Value New UBIK.Service.DTO.V211.HierarchyDeltaArguments()
A+B Assign Value
DisplayName Assign
To args.StartingPoint
Value New UBIK.Service.DTO.V211.HierarchyRoot()
A+B Assign Value
DisplayName Assign
To args.ChildrenDepth
Value 1
A+B Assign Value
DisplayName Assign
To authToken
Value "e1191c36-2081-4ffe-8d8e-4b798d4523a1"
RESTPost Value
Body args
DisplayName RESTPost<BCHierarchyDeltaShipments,HierarchyDeltaArguments>
Error
Headers
MethodName "GetHierarchyDeltasV212"
Parameter New String(){"APP_MT","CXT_MT",authToken,"264"}
Response
Result result
Url "https://81.10.184.186:888/UBIK/DBG/AUG/MT/TEMPLATE/Content/UbikContent.svc"




See also


Useful Links [What is REST Service]


Retrieved from "https://wiki.augmensys.com/index.php?title=RESTPost_(Activity)&oldid=22312"