Datacenter User Guide
Version 2.0 | Published November 02, 2023 ©
Rest Webserver
This section provides the steps to configure a Rest Webserver dataset, to poll data from a generic REST provider.
-
Create a new dataset of type Rest Webserver, specifying a name and (optionally) a prefix to use to identify the dataset and its values, respectively:
-
Click Add. The dataset is added to the list, and it has an initial WARNING status as it contains no configured endpoints yet.
-
Click on the dataset card and configure the webserver options in the Dataset parameters section of the main UI.
Info: If the host to connect to, does not require a port to be specified, please leave the Port field as zero.
If needed, use the API Token and Use API Token in fields to specify how an API token should be passed in the request.
-
X-API-Key embeds the API token in the X-API-Key key of the request header.
-
Custom header key embeds the API token in the request header key specified in the Custom Key field.
-
Query Parameter embeds the API token in the query parameter specified in the Custom Key field.
-
-
Select one or more endpoints from the table in the Dataset configuration panel by double clicking a row. A new endpoint card is then created.
Alternatively, you can enter a new endpoint by clicking Add new endpoint on the right-side of the panel, and then clicking on the empty endpoint that is added at the bottom of the table to configure it.
Doing so reveals the new endpoint details, where its properties can be entered.
Endpoint Options: When adding a new endpoint, parameters (for example, parts of the endpoint whose value should be fetched from other endpoints) should be encapsulated in curly braces: {part_name}.
The value inside curly braces is resolved either using other endpoints present in the Dataset configuration table, or the ones specified in the Endpoint fixed options section of the main view.
Using as example the images above, the following endpoint /authors/{authors}, would use the {authors} option from the respective endpoint in the table.
Once an endpoint is added to a dataset, you can select the endpoint card, where its properties can be entered. You can now edit the endpoint configuration.
When done, the data is added to the Dataset output table.
To change the polling rate (how often the remote REST host is polled for data, in ms) for the dataset, select if from the list and edit the Polling field in the Dataset parameters on the right-side column.
Filter a Dataset
Values read from a file into a dataset can be filtered with the Filtering tool. To do so, select the dataset card, click on the hamburger menu and then press the Filter button.
A dialog visualizing the file's payload schema opens, through which a user can filter the source data.
Please refer to the Filtering and Manipulating the Dataset Entries page to learn how to enable, disable and edit the entries added.