API and Automation
Demo Video https://www.youtube.com/watch?v=Bdd6J_KnUIo
Pre-condition
Navigate to Manage Apps
Click on Configure button on Macro for Assets
Click on API tab
Click Generate Access Token
Copy the token and the URL you will need them when configure web requests
Â
Create a Template page
Create a new Page in Confluence
Add the Macro for Assets
Configure it as you like the table to look like when new objects are added
Save the macro
Get the Template page configuration
From any rest tool, example postman send a GET request to get the config of the configured Macro above.
In postman, select Method GET
Past the URL from pre-condition step into URL field
On Params tab add;
Key as
token
and Value paste token from pre-conditionKey as
pageId
and Value paste page id of the Template page created in this step
Click Send
View the response, copy that, you will need it in the next tutorial
Use case 1. Create Page when New object has been created
Navigate to Global Automation at
instance_url/jira/settings/automation
Click Create
Select Trigger Object
Add component, select THEN action
Select Send web request
Paste the copied URL from pre-condition into Web request url field
Add ?token=<<<token from pre-condition>>>&spaceKey=<<<THE_SPACEKEY>>>
Select Method POST
Select Custom Data
Add the following body, it will create a Page with the same name as the object
[ { "title":"{{object.name}}", "parentPageId":"", "macros":<<<MACRO_CONFIG_GOES_HERE>>> } ]
Paste the response from the Get template configuration step (e.g. REST request) in the <<<MACRO_CONFIG_GOES_HERE>>> part of the above code.
[ { "title":"{{object.name}}", "parentPageId":"", "macros":[ { "id": "THIS_CAN_BE_BLANK", "configuration": { "columns": [], "iql": "key={{object.key}}", "displayAs": "AS_VERTICAL_TABLE", "pageSize": 25, "schemaId": "6", "connectionId": "45157a8a-79ad-46f7-b920-c21211bf79ec" } } ] } ]
Click Turn on Rule
Name the rule something, lets call it Create page from object.
Use case 2. Copy Page when New object has been created
Navigate to Global Automation at
instance_url/jira/settings/automation
Click Create
Select Trigger Object
Add component, select THEN action
Select Send web request
Paste the copied URL from pre-condition into Web request url field
Add ?token=<<<token from pre-condition>>>&spaceKey=<<<THE_SPACEKEY>>>&pageId=<<<THE_PAGE_ID_TO_COPY>>>
Select Method PATCH
Select Custom Data
Add the following body, it will create a Page with the same name as the object
[ { "title":"{{object.name}}", "parentPageId":"", "macros":<<<MACRO_CONFIG_GOES_HERE>>> } ]
Paste the response from the Get template configuration step (e.g. REST request) in the <<<MACRO_CONFIG_GOES_HERE>>> part of the above code.
Click Turn on Rule
Name the rule something, lets call it Create page from object.
Test the setup
Create an Object
This will now call the automation that will result in create a new Page with the macro config. Depending on use case it can be a blank page or a copy of a page
Â
Â