Changes

Data Import Service

2,086 bytes added, 11:40, 29 September 2021
/* Web Service */
</source>
This request also expects some Authentication dataIn order to import one object of the type <code>Example.Test</code>, which are completely dependent on contains one integer and one string parameter, the customized implementation provided via pluginsservice needs to be called in the following way:<source lang="ini">POST https://<host>/<path>/DataImportService. svc/rest/import/Example.Test HTTP/1.1Authorization: <depends on ''AuthenticationValidator''>Content-Type: application/json{ "ImportParameters": [ { "Key": "IntValue", "Value": 5 }, { "Key": "StringValue", "Value": "Hello World!" } ]}</source>
The object <code>Example.Test</code> together with its two properties is assumed to be provided via plugins (see below).This request expects some Authentication data, which is completely dependent on the customized implementation provided via plugins (see below).  If you want to develop an interface to get data from your 3rd party system to Ubik, you might want to consider using this system as well. It's easy to set up and requires minimal configuration on the Ubik side.  === Return === Let's analyze an example of this return message:<source lang="ini">{ "Status": 0, "UbikObjectId": "9c3b2bef-e0a5-4703-b9da-39c0ad43553d", "ElapsedTime": 0.0415932, "Message": "Successfully created one object."}</source> * The <code>Status</code> field has three possibilities: * <code>0</code>: The item has been successfully created. * <code>1</code>: The item has been successfully updated. This happens when an existing object has been identified by the Primary Key (configuration of <code>ImportProcessor</code> and on the Ubik-Proxy required). * <code>2</code>: An error occurred while creating/updating the object. Read the message!* The <code>UbikObjectId</code> allows for easy identification of the erroneous object in Ubik. It will only be filled up if an object has been created/updated and will be all zero if the error occurred before an object has been created.* The <code>ElapsedTime</code> field shows the time it took the system to successfully create and save the Proxy object with all data. At this point, the Proxy has been created, but the import to the real Ubik object is executed asynchronously and cannot be predicted.* The <code>Message</code> field shows a status message or the details, if an error occurred. [[Category:Data Import Service|Data Import Service]][[Category:Plugin|Data Import Service]]
== Authentication Mechanism==
187
edits