Build an advanced table from REST API data - 8.x

Overview

This page shows how to use the JSON Table macro, which is part of the Advanced Tables for Confluence app, to create a table that contains version information retrieved directly from Jira. This example uses a number of the advanced capabilities of the JSON Table macro, including augments to transform data into links and a particular emoticon, so the data is presented in a succinct, informative manner. The columns can be customized to meet your specific needs.

Macro browser input

Select this macro

Macro nameAdvanced Tables - JSON Table
Macro syntax{json-table}

Define these parameters/values

JSON Table settings > Data source > Method of locating JSON data (URL) > URL of JSON data
https://bobswift.atlassian.net/rest/api/2/project/TBL/versions
JSON Table settings > Data format > Paths to fields$
JSON Table settings > Data format > Paths to fields to be included
name,description,releaseDate,released,archived,userReleaseDate,self
JSON Table settings > Data format > Paths to be used to determine sort ordername
JSON Table settings > Data format > Augments to data row values

[%name%|https://bobswift.atlassian.net/browse/TBL/fixforversion/%id%],,,!%released%.png!,!%archived%.png!
JSON Table settings > Data format > Augments to heading row values
Name,Description,Release Date, Released, Archived
JSON Table settings > Data settings > Output formatwiki
JSON Table settings > Data settings > Column to display
name,description,releaseDate,released,archived
Column settings > Numbering & Totaling > Insert auto number columnOn
Column settings > Sorting > Automatically sort in descending orderOn

Screenshots

Wiki markup input

{json-table:
paths=$|
fieldPaths=name,description,releaseDate,released,archived,userReleaseDate,self|
sortPaths=name|
url=https://bobswift.atlassian.net/rest/api/2/project/TBL/versions|
output=wiki|
columns=name,description,releaseDate,released,archived| 
augments=[%name%%!%https://bobswift.atlassian.net/browse/TBL/fixforversion/%id%],,,!%released%.png!,!%archived%.png!,|
headingAugments=Name,Description,Release Date, Released, Archived|
sortDescending=true|
autoNumber=true}
{json-table}

Emoticons

For this example, we augmented the true and false values of the released and archived fields to show an emoticon instead. This is a general technique that can be used to make tables look better. For this case, it is simply having emoticon images named true and false and attached to this page (or some other page) and referenced in wiki markup notation by !true.png! and !false.png!. On your site, you need to add these images and reference them accordingly. They can be named differently, but must have true and false in the name somewhere so the released and archived values determine which emoticon is to be shown. Wiki markup notation for images in the most general way is: !SPACE:my page^myimg.jpg!.

Example result

Other examples

Visit our full list of product examples for additional inspiration!