Work with Spaces

Learn about using HAPI to complete tasks on the space level.

With HAPI, we've made it easy for you to work wtih spaces!

Create a new space with a title and key

To create a space with a space key in Confluence, enter a script like this:

def space = Spaces.create("Analytics and Data", "AD") {}

This script creates an Analytics and Data space with a space key of AD: The Analytics and Data space shown in the Spaces screen.

You can customize the script by changing the space name and space key.

Delete a space

Run a script like this to delete a space:

def space = Spaces.getById(172720132)
space.delete()

This message appears after the script runs:

You can customize the script by changing the space key.

Delete all pages in a space

You can delete all pages in a space with the following statuses:

Current
Archived
Historical
Draft

Warning: To run this script, you must be an administrator of the space.

To do this, specify the space key in a script like this:

Spaces.getByKey("DT").deleteAllPages()

When you run the script, the pages are deleted from the space if they had one of the above statuses: The homepage of the deleted space.

Tip: The homepage for the space is not deleted.

To customize this script, change the space key.

Get all pages in a space

To get a list of pages in a space, enter a script like this:

def allPages = Spaces.getByKey("AD").getAllPages()
def allPageTitles = []
allPages.each(page ->
    allPageTitles.add(page.title)
)
allPageTitles

You can customize this script by changing the space key.

Get all pages and their body format in a space

Using HAPI, you can do the following three things with one script:

Get all pages in a space
Set the body format of each page
Fetch the body of each page

Run this script:

def pages = Spaces.getByKey("TEST").getAllPages(){
        setBodyFormat("storage") 
}
pages.each { page ->
    logger.info("Extracting body contents for page '${page.title}'")
    def storage = page.body.storage.value
    logger.info(storage) //extracted contents of page here
}

The results of this script show a list of page keys:

You can also view the Logs to see the page content:

You can customize this script by changing the space key.

Get space permissions

To get space permissions, enter a script like this:

def space = Spaces.getById(158072836) 
space.getPermissions()

The script returns the permission of the space:You can customize the script by changing the space key.

Retrieve a space with its space key

To retrieve a space with its space key in Confluence, enter a script like this:

def space = Spaces.getByKey("AD")

This script retrieves the space AD:

The result of the "Retrieve a Space with it's Space Key" script. You can customize the script by changing the space key.

Retrieve a space with its ID

To retrieve a space with its space ID in Confluence, enter a script like this:

def space = Spaces.getById(158072836)

This script retrieves a space by the ID 158072836:

You can customize the script by changing the space ID.

Search for spaces with CQL

To search for a space in Confluence with CQL, enter a script like this:

def spaces = Spaces.search("valid CQL here")

For example:

def spaces = Spaces.search("title~data")

The script returns a list of spaces containing the word data in the title:
You can customize the script by changing the CQL.
Tip: For more information about using CQL, visit CQL Guide.

Update the status of a space

To update the status of a space, enter a script like this:

def space = Spaces.getByKey("TST2")
space.update {
    status = "archived"
}

After you run the script, the updated status appears in the Results:

And the space is in the Archived section (Spaces > Archived):

You can customize the script by changing the space key and the status. The two accepted statuses are archived and current.

Update the name of the space

To update the space name, enter a script like this:

def space = Spaces.getByKey("DOCS")
space.update {
    name = "Technical Documentation"
}

This script will update the name of the space from Product Documentation to Technical Documentation.

After you run the script, the new name appears in the Results:

You can also see the new name in the space:

You can customize the script by changing the space key and the new name.