This page provides some basic examples to help developers get started with the Scaffolding REST API code. The Scaffolding REST API expects the Confluence page and Scaffolding form structure to be created beforehand.
In order to use this API from scratch, there are 3 basic steps:
If you already have the Confluence pages and Scaffolding structure created, then you can go straight Step 3.
For full example code, visit our GitHub repository.
These resources are recommended reading that will help you with the following examples.
This example will import the contents of a CSV file (employees.csv) into an existing table on a Scaffolding form.
For the rest of the example code, look at import_csv.js on our GitHub repository.
Import Product List
This example will:
- extract data from a CSV file (products.csv),
- create pages with an existing LiveTemplate (product-details-storage-format.xml) with a Scaffolding form,
- and then inject data into the Scaffolding forms on each created page.
For the rest of the example code, look at import_product_list.js on our GitHub repository.
This example uploads attachments into an existing Scaffolding form on a page.
For the rest of the example code, look at upload_attachment.js on our GitHub repository.