Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This article describes data source functionality in the Grid Custom Field.

...

You can connect

...

a grid to an

...

a REST or an SQL data source

...

Info

The Data source type is REST. We support only JSON for processing data.

You can access remote REST API using data sources in the Grid Custom Field.

Image Removed

Data source configuration

You can add a Data source under the Data Sources tab in the grid configuration dashboard.

Image Removed

Available fields:

Name - a name of your data source connection

Description - optional description of the data source for your reference. It will be displayed below the title in the Data source list.  

URL -  URL address of the web service you want to connect to the grid.

Path -  the path to JSON arrayYou can specify it when loading a specific array from the JSON. 

Headers - allows adding header fields. You can use them in case the data source requires HTTP authentication

 

You can test a connection to the data source using a Test Connection button.

The data loads in a preview and you can check if it's correct.

Image Removed

 

...

You can specify the direct path to an array inside the JSON with the help of JSONPath expressions. Data may be found and extracted out of JSON structures.

JSONPath expressions always refer to a JSON structure.  A JSON structure is usually anonymous and doesn't have a "root member object". Thus the JSONPath assumes the abstract name $ assigned to the outer level object.

JSONPath expressions can use the dot–notation

Code Block
$.store.book[0].title

...

Info

JSONPath square brackets operate on the object or array addressed by the previous path fragment. Indices always start by 0.

 

Check how to initialize the gird with the data source.to fill in a grid with external data.

It is possible to connect a data source manually or by importing it.

Excerpt

Connect the grid to a REST or an SQL data source.

To connect an external data source:

  1. Navigate to ⚙️ → Add-onsData Sources.

    Image Added
  2. Select Add Data Source to add a new data source.

    Image Added
  3. Enter the name of your data source in the Name field.

  4. If necessary, add a description of your data source in the Description field.

  5. Choose the data source type in the Datasource Type dropdown. For REST data sources choose REST, for SQL data sources select SQL.

    Image Added
  6. Enter the fields for your data source. For REST data source fields check REST data sources fields. For SQL data sources check SQL data sources.

  7. Press Save.


 To connect a data source to the grid you need to add it into the grid configuration under the Data Receiver tab. For more information check Filling a grid with data from REST or SQL data sources.

...

See also

Child pages (Children Display)
styleh3
excerptTypesimple