Page Comparison

...

Method

URI

Query Params

Token Scope

Token Space(s)

Description

Status

colour	Green
title	GET

instanceapi_url/macro

pageId

token

READ

can be limited using space list or empty to allow all spaces.

Returns an array of Macro for Assets configuration for a specific page using pageId param.
Example;

Status

colour	Green
title	GET

instance_url/macro?pageId=1234

Status

colour	Purple
title	PUT

instanceapi_url/macro

pageId

token

WRITE

can be limited using space list or empty to allow all spaces.

Updates all Macro for Assets configuration specified in the body for a specific page using pageId param.

Use

Status

colour	Green
title	GET

on a page to fetch format of a macro configuration.

Example;

Status

colour	Purple
title	PUT

instance_url/macro?pageId=1234
body:

Code Block

language	js

[
  {
    "id": "rxt-95ae25ba-0759-4b4e-a40f-edbdc7194067",
    "configuration": {
        "columns": [],
        "iql": "objectType=\"Jira Users\"",
        "displayAs": "AS_TABLE",
        "pageSize": 5,
        "schemaId": "4",
        "connectionId": "45157a8a-79ad-46f7-b920-c21211bf79ec",
        "tableOptions": {
            "linksEnabled": true,
            "downloadEnabled": false,
            "printEnabled": false
        }
    }
  } 
]

Status

colour	Blue
title	POST

instanceapi_url/page

spaceKey

token

WRITE

can be limited using space list or empty to allow all spaces.

Creates one or more new page(s) with Macro for Assets added and pre-configured.

spaceKey determine what space to add the page in.

Body takes an array of pages title and parent with macro configuration.

Example;

Status

colour	Blue
title	Post

instance_url/page?spaceKey=ABC
body:

Code Block

language	js

[
  {
    "title":"Page title",
    "parentPageId":"id of parent page or null on root level",
    "macros":[
      {
            "id": "rxt-95ae25ba-0759-4b4e-a40f-edbdc7194067",
            "configuration": {
                "columns": [],
                "iql": "objectType=\"Jira Users\"",
                "displayAs": "AS_TABLE",
                "pageSize": 5,
                "schemaId": "4",
                "connectionId": "45157a8a-79ad-46f7-b920-c21211bf79ec",
                "tableOptions": {
                    "linksEnabled": true,
                    "downloadEnabled": false,
                    "printEnabled": false
                }
            }
      }
    ]
  }
]

Status

colour	Blue
title	POST

instanceapi_url/page/copy

spaceKey

pageId

token

WRITE

can be limited using space list or empty to allow all spaces.

Copies one or more new page(s) with Macro for Assets added and pre-configured.

spaceKey determine what space to add the page in.

Body takes an array of pages with macro configuration

Example;

Status

colour	Blue
title	Post

instance_url/page/copy?spaceKey=ABC
body:

Code Block

language	js

[
  {
    "title":"Page title",
    "parentPageId":"id of parent page or null on root level",
    "copyFrom":"pageId"
    "macros":[
      {
            "id": "rxt-95ae25ba-0759-4b4e-a40f-edbdc7194067",
            "configuration": {
                "columns": [],
                "iql": "objectType=\"Jira Users\"",
                "displayAs": "AS_TABLE",
                "pageSize": 5,
                "schemaId": "4",
                "connectionId": "45157a8a-79ad-46f7-b920-c21211bf79ec",
                "tableOptions": {
                    "linksEnabled": true,
                    "downloadEnabled": false,
                    "printEnabled": false
                }
            }
      }
    ]
  }
]

...

Versions Compared

Old Version 2

New Version 3

Key