Skip to content

Generic REST API content importer can import, historize and process generic REST API content.


You can find the configuration option in at Environment settings > OneImporter > Configurations > Generic REST API.

Here you can edit all existing configurations, create new configurations or delete existing configurations. To add a new configuration enter a Name and click Add to proceed to the configuration. To edit an existing configuration click the arrow on the left of your importer name to expand the configuration options.

The following configuration options are available:

Field Description Advice
Name Meaningful name Include database name/type
Active Option to activate and deactivate the configuration. Data is only imported if the configuration is activated.
Entity name Name of the entity imported that instances are assigned to Determine standards about entity names before your first import
Method Select what you would like to do: Read (GET), create (POST) or update (PUT)
URL Specify URL of target API
Response format Select data format of object from response
JSON path to the array containing the objects to be imported Specify array within object to filter for specific information
JSON path to the unique ID within the object Specify object within object to filter for specific information
Executing OneImporter Select a OneImporter to import the data based on the importer configuration. Requires installed OneImporter: Installation instruction
Schedule time (cron format) Determine the frequency of imports in CRON format Learn more about CRON format:

Table: Generic REST API content configuration parameters


The following image is an example of a generic REST API content configuration: generic REST API content importer configuration Figure: Example of a REST API configuration


The OneImporter imports the generic REST API content based on a specific configuration and stores the different instances in entities defined by you. To view the imported instances in, you can select 'Asset & Configuration Repository → Instance Viewer'. There you can select your specific instance and click it for a detailed view in the instance history viewer.

The following image is an example of imported generic REST API content: generic REST API content instance overview
Figure: Overview of generic REST API content (left) and topology of related instances (right)