Skip to end of metadata
Go to start of metadata

Data can be easily and conveniently displayed in Confluence via the iteraplan REST API. This section describes how to retrieve iteraplan data in Confluence and display it in a table or a chart. 

Example for JSON Table Macro

For communication with the iteraplan REST-API you can use the "JSON Table" macro in Confluence (this is a paid add-on that you can find here). This retrieves the data through the REST API and presents it in a table.

1. Select the Macro „JSON Table“ in Confluence


2. Define these Parameters/Values


Example value

Description

Paths to fieldsresultA dot separated list of field names to reach the specific field within the JSON string.
In most cases the specification of the value "result" is sufficient here.
Paths to fields to be includedid, name, Complexity, Costs, typeOfStatusComma separated list of paths to fields to be included in the output.
Paths are relative to the JSON field specified in the paths parameter.
URL to JSON datahttps://demo.iteraplan.de/iteraplan_ee_release/api/data/informationsystemREST URL to retrieve all information systems, for example.
URL usersystem

User name for URL access via basic authentication.

URL user passwordpasswordUser password for URL access via basic authentication.


3. Save the configuration
You will now see a new element / macro on your wiki page

4. Save the wiki page
The data for information systems are retrieved and displayed in a table.


Example for creating Charts from JSON Data

The following example describes how to generate a simple diagrams from JSON data in Confluence. For our example, we first need JSON data from iteraplan. Create for this a JSON Table as described above.


1. Select the Macro „Chart from Table“ in Confluence


2. Save the configuration without changes
You will now see a new element / macro on your wiki page.


3. Move the "JSON Table" macro via Drag and drop into the "Chart from Table" macro
Or insert a new JSON Table macro one within the Chart from Table macro.


4. Open the configuration of the "Chart from Table" macro (double click on the macro)
You can now configure a diagram with the data from the JSON Table. Select any chart type and the data you want to represent.


5. Save the configuration and the wiki page
On your wiki page you will now see a diagram showing the data from iteraplan.

  • No labels