Setup
REST API is only available to users who:
1) have purchased the flex.bi "Standard" or "Business" plan.
2) have HansaWorld version STDERP_8.1-2015-06-02
To be able to use REST API as a way to import your files you must first make sure you have the necessary plan parameters enabled:
- If you have your flex.bi on our provided cloud server, you will have to contact flex.bi support who will then set up REST API for you.
- If you have a private flex.bi server then you will have to manually add the following parameters to your account settings:
Then you will be able to perform imports with REST API.
Importing with REST API
To do an import click on the "Add new source application" button in your Source Data -> Source Applications tab. Select "HANSAWORLD" as your source application.
REST API currently only supports the full import of registers (or from the specified import date, specific user defined intervals are available currently).
If you choose to use REST API as the main method of importing data into flex.bi you will not be able to use any other file import methods from HansaWorld
Press the button create.
A page similar to this should appear
In the source data URL enter the URL to your HansaWorld server. The URL should look similar to this: http://sample.url.com:1234/WebDataAPI.hal
The URL consists of the following elements
Public Hostname | Port | .hal file name | Optional fields |
---|---|---|---|
http://sample.url.com | :1234 | /WebDataAPI.hal | ?company= *number* |
-where *number* is the number (code) of the company that's displayed in System (Module) -> Registers -> Companies. Adding this optional field will export data only from that specific company.
When you have entered your Source data URL then press continue.
In the next window you will see the following data fields.
A new data entry field has appeared just for REST API - Start import from. In this field you have to enter the date in the following format (yyyy-mm-dd). The date describes the point in time from which the data will be imported, that is to say if you enter 2016-01-01 then all data that has been created from 2016-01-01 and onward will be imported, data created before 2016-01-01 will not be imported.
If you do not enter a date, data from 365 days ago will be imported by default.
Once you are done with selecting everything you wish to import press the "Import" button and the import will begin. Importing with REST API does not upload any source files into the "Source files" section of flex.bi.