How to build an advanced table from REST API data - Cloud
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 such that 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 name | Advanced Tables - JSON Table |
Macro syntax (Old editor) | {json-table} |
Macro syntax (New editor - case insensitive) | /JSON Table |
Define these parameters/values
Paths to fields | $ |
Paths to fields to be included | name,description,releaseDate,released,archived,userReleaseDate,self |
Paths to be used to determine sort order | name |
Output format | wiki |
URL to JSON data | https://xxxxxxxx.atlassian.net/rest/api/2/project/TBL/versions |
Columns to show | name,description,releaseDate,released,archived |
Augments to data row values | %name%|https://xxxxxxxx.atlassian.net/browse/TBL/fixforversion/%id%],,,!%released%.png!,!%archived%.png! |
Augments to heading row values | Name,Description,Release Date, Released, Archived |
Auto number on each row | On |
Sort descending | On |
Screenshots
Wiki markup input (Old editor)
{json-table:
paths=$|
fieldPaths=name,description,releaseDate,released,archived,userReleaseDate,self|
sortPaths=name|
url=https://xxxxxxxx.atlassian.net/rest/api/2/project/TBL/versions|
output=wiki|
columns=name,description,releaseDate,released,archived|
augments=[%name%%!%https://xxxxxxxx.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 used augments to show an emoticon instead of the true and false values of the released and archived fields. 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, attached to this page (or some other page), and referenced in wiki markup notation by !true.png! and !false.png!. On your site, you will need to add those two 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 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!
