Content Formatting Macros for Confluence Server and DC

Restful Table

This Restful Table Macro provides the ability to create 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, please follow this link.

Usage

  1. Go to the form you wish to edit.

  2. Click Edit.

  3. Click Insert More Content, and select Other Macros.

  4. In the Macro Browser, search and select the Restful Table Macro from the list.

    rest 01
  5. There are three parameters that can 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

    check

    Header

    Headers are the labels for each column relating to the data

    string

    none

    check

    ID

    A value indicate 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

    check
  6. Once the Restful Table has been added to a page, it will appear on page load. A page can contain multiple tables.

    rest 02

Example

Creating a Restful Table

Below are the parameters that must be set for the macro:

rest 03

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.

rest 04

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.

rest 05

Parameters not included in the table column are ignored, so the user can specify exactly what parameters they want displayed.