Guide to the contents of the Brikit blueprints JSON file |
| Data Element | Structure | What It Does | What It Means | Example |
|---|
| Array | Lists every Brikit space blueprint on your site. | Each item in this array is an object that defines one space blueprint. This array will be empty if there are no space blueprints for your site. | "spaceBlueprints" : [
{
"name" : "New Product",
"description" : "Create a space for a new product.",
"blueprintSpaceKey" : "productspacebp",
"blueprintFields" : [ "product-name", "product-owner-username" ],
"spaceName" : "[[product-name]]",
"spaceKey" : "[[product-name]]",
"spaceCategories" : "development, product",
"spaceDescription" : "Product space for everything related to [[product-name]]",
"access" : ["Product Space"]
},
{
"name" : "Team Workspace",
"description" : "Workspace for a department or project team",
"blueprintSpaceKey" : "teamspacebp",
"blueprintFields" : [ "team-name", "team-lead-name", "team-lead-email" ],
"spaceName" : "[[team-name]] Workspace",
"spaceKey" : "[[team-name]]Workspace",
"spaceCategories" : "workspaces",
"spaceDescription" : "Projects, timelines, and resources for the [[team-name]] team",
"access" : [ "Team" ]
}
] |
|
|  Space blueprint object / item in "spaceBlueprints" array
| Object | Defines an individual space blueprint on your site. | This object comprises a set of key/value pairs that function as specifications or instructions for creating new spaces from this blueprint. Keys in this object: | "spaceBlueprints" : [
...
{
"name" : "New Product",
"description" : "Create a space for a new product.",
"blueprintSpaceKey" : "productspacebp",
"blueprintFields" : [ "product-name", "product-owner-username" ],
"spaceName" : "[[product-name]]",
"spaceKey" : "[[product-name]]",
"spaceCategories" : "development, product",
"spaceDescription" : "Product space for everything related to [[product-name]]",
"access" : ["Product Space"]
}
...
] |
|
|  "name" : "value"
| Key/value pair | Defines the name of a space or page blueprint. | The string value assigned to this key will be the name of the blueprint as it appears in the Blueprints Menu and Blueprint Definitions Page. This key/value pair occurs in both space blueprint objects and page blueprint objects. | "spaceBlueprints" : [
...
{
"name" : "New Product",
"description" : "Create a space for a new product.",
"blueprintSpaceKey" : "productspacebp",
"blueprintFields" : [ "product-name", "product-owner-username" ],
"spaceName" : "[[product-name]]",
"spaceKey" : "[[product-name]]",
"spaceCategories" : "development, product",
"spaceDescription" : "Product space for everything related to [[product-name]]",
"access" : ["Product Space"]
}
...
] |
|
"pageBlueprints" : [
...
{
"name" : "Product Overview",
"description" : "Create a page that describes the product.",
"spaceKey" : "BP",
"pageTitle" : "[[product-name]] Overview",
"blueprintFields" : [ "product-name", "product-logo" ]
}
...
] |
|
|  "description" : "value"
| Key/value pair | Describes a space or page blueprint. | The string value assigned to this key will be the description of the blueprint as it appears directly below the blueprint's name in the Blueprints Menu. This key/value pair occurs in both space blueprint objects and page blueprint objects. | "spaceBlueprints" : [
...
{
"name" : "New Product",
"description" : "Create a space for a new product.",
"blueprintSpaceKey" : "productspacebp",
"blueprintFields" : [ "product-name", "product-owner-username" ],
"spaceName" : "[[product-name]]",
"spaceKey" : "[[product-name]]",
"spaceCategories" : "development, product",
"spaceDescription" : "Product space for everything related to [[product-name]]",
"access" : ["Product Space"]
}
...
] |
|
"pageBlueprints" : [
...
{
"name" : "Product Overview",
"description" : "Create a page that describes the product.",
"spaceKey" : "BP",
"pageTitle" : "[[product-name]] Overview",
"blueprintFields" : [ "product-name", "product-logo" ]
}
...
] |
|
|  "blueprintSpaceKey" : "value"
| Key/value pair | | | | |
|
|