Restful Table
This Restful Table macro adds a table that contains data retrieved from a given URL. Adding a Restful table to a Confluence page allows for data to change over the lifespan of that page (dynamic data). This can save time and can reduce error caused by manually updating data.
Example use cases could include the monitoring of traffic on specific pages, viewing completed work, stock exchange, etc.
Please note that this macro has been designed as a developer macro and requires some knowledge of REST APIs. To learn more about what can be done using REST APIs in Confluence, you can start with this Wikipedia article.
Instructions
Navigate to the page you want to edit.
Click Edit.
- Click the location where you want to add the table.
Click Insert More Content > Other Macros.
Select the Restful Table macro from Macro Browser.
There are three parameters that must be set for the Restful Table macro:
Parameter
Description
Type
Default
Required
Resource URL
Specify the URL from which to retrieve the data
string
none
Header
Headers are the labels for each column relating to the data
string
none
ID
A value indicating to which column the data belongs e.g. If a data entry has a 'userID' attribute, the Header can be set to 'User ID' and the ID will be 'userID', replicating the name of the data attribute
string
none
Click Insert. The macro placeholder displays.
Save the page to view the rendered table.
Example
Creating a Restful Table
Below are the parameters that must be set for the macro:
This is an example of the data within the page that will be retrieved using the URL https://jsonplaceholder.typicode.com/posts for this table.
Limitation: Fetched json objects must be in an array, that is to say, they must be enclosed in square brackets; additionally results are only read one level deep
Below is the output of the example Restful Table macro on the Confluence page.
Parameters not included in the table column are ignored, so the user can specify exactly what parameters they want displayed.
