View source for Documentation:Rest Services In MDriven

<message>Write the content here to display this box</message>
'''REST Services''' are services executed by connecting to a URL that defines operation and parameters and returns an answer – not seldom as JSON objects.

You must set the tagged value '''RestAllowed''' on the ViewModels you want to allow Rest access to.

=== '''Calling Existing REST Services''' ===
MDriven supports a couple of EAL operators to manage REST services. All operators reside on the [[Documentation:SelfVM|selfVM]] variable which is available only in the ViewModel context.
 ''selfVM.RestGet(targeturl,user,pwd,optionalnestingwithheaders)''
'''Read:''' [[Documentation:OCLOperators RestGet|OCLOperators RestGet]]
 ''selfVM.RestPost(targeturl,user,pwd,optionalnestingwithheadersAndUploadValues)''
'''Read:''' [[Documentation:OCLOperators RestPost|OCLOperators RestPost]]
 ''selfVM.RestDownload(targeturl,user,pwd,optionalnestingwithheaders)''
'''Read:''' [[Documentation:OCLOperators RestDownload|OCLOperators RestDownload]]

'''Note!''' ''optionalnestingwithheaders'' is the '''name''' of the blue ViewModel class in the example below (as an OCL String).

==== Example ====
[[File:2018-05-29 10h31 45.png|none|thumb|689x689px]]
The action '''GetExporttest''' retrieves data by converting another ViewModel to XML - it stores it in the variable <code>vText</code>.

The next action invokes RestPost to send that data to a URL address; it also says it should look at the nesting named 'Xml'. In this nesting, we have the STRINGCONTENT ('''see also''' [[Documentation:OCLOperators RestPost|OCLOperators RestPost]]) which gets its content from the vText variable. We also add the header Authorization with a bearer token to get access from the receiving service.

'''See also''': [[Documentation:Exposing Ourselves as a REST Service|Exposing Ourselves as a REST Service]]
[[Category:Rest]]
[[Category:Advanced]]
{{Edited|July|12|2025}}