Work with Spaces

With HAPI, we've made it easy for you to create, modify, and archive spaces.

Create a new space with default values

You can create a new space as follows:

groovy
Spaces.create("TIS", "Teams in Space")

Set details when creating a new space

When you create a space, some assumptions are made about fields such as the space lead (set to the current user), the space type (set to business), and the default assignee for the space (set to Unassigned). You can set these values, as well as optional values such as the description or the URL when you create the space. For example:

groovy
Spaces.create("TIS", "Teams in Space") {
    setLeadAccountId('user account id')
    setSpaceTypeKey('business')
    setDescription("This is a new space!")
    setUrl("https://google.com")
    setDefaultAssigneeToProjectLead()
    setAvatarId(10001)
}

Create a space using a template

You can create a new space using a template as follows:

groovy
Spaces.create("TIS", "Teams in Space"){
    setSpaceTemplateKey('Kanban')
}

The space templates available to you are provided through completions. You'll notice the names are the same as those you see when you create a space through Jira.

Retrieve a space by key

You can retrieve a space by key as follows:

groovy
Spaces.getByKey("TIS")

Update a space

In this example, we're updating the space key, name, description, and space category and setting the default assignee to unassigned. You can update a space as follows:

groovy
Spaces.getByKey("TIS").update {
    setKey("TEAM")
    setName("Team space")
    setDescription("This is an updated space!")
    setDefaultAssigneeToUnassigned()
    setSpaceCategory("Backend spaces")
}

Delete a space

You can delete a space as follows:

groovy
Spaces.getByKey("TIS").delete()

This also deletes any work items, components, and versions related to the space.