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]]WS",
"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" ]
}
...
] |
|
| | "pageBlueprints" | Array | Lists every Brikit page blueprint on your site. | Each item in this array is an object that defines one page blueprint. This array will be empty if there are no page blueprints for your site. | "pageBlueprints" : [
{
"name" : "Product Overview",
"description" : "Create a page that describes the product.",
"spaceKey" : "BP",
"pageTitle" : "[[product-name]] Overview",
"blueprintFields" : [ "product-name", "product-logo"]
},
{
"name" : "Team Member Profile",
"description" : "Create a page to show a member's profile information.",
"spaceKey" : "BP",
"pageTitle" : "[[team-member-name]]",
"blueprintFields" : [ "team-member-name", "team-member-username"],
"includeChildren" : true,
"visibility" : [ "docs", "support" ]
}
]
|
|
|  Page blueprint object / item in "pageBlueprints" array
| Object | Defines an individual page 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: | |  "name" : "string"
| 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" : "string"
| 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/title 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" : "string"
| Key/value pair | Indicates a blueprint source space. | The string value assigned to this key is the space key of the source space that will serve as the template for new spaces generated from this blueprint. This key/value pair occurs only in space 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" ]
}
...
] |
|
|  "blueprintFields" : [array]
| Key/value pair | Lists all custom substitution fields included in the blueprint. | The array assigned to this key will comprise the names of all custom substitution fields that will be a part of this blueprint. These are the fields blueprint users will be asked to provide values for whenever they create new spaces or pages from this blueprint. Each field name listed here will map to a blueprint field object defined in the JSON file. The substitution field name as it occurs in this array will match the corresponding blueprint field object's id key, which will also match the substitution field name as it occurs in the blueprint source page (enclosed in double brackets: [[substitution-field-name]]). 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" ]
}
...
] |
|
|  "spaceName" : "string"
| Key/value pair | Defines how new spaces generated from a space blueprint will be named. | The string value of this key will be the name of a new space generated via blueprint. It is possible and indeed recommended to incorporate at least one substitution field into this key's value so that each new space created from this blueprint will have a unique name from the start, without requiring any extra input from the user who is creating the new space. This key/value pair occurs only in space blueprint objects. | "spaceBlueprints" : [
...
{
"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]]WS",
"spaceDescription" : "Projects, timelines, and resources for the [[team-name]] team",
"access" : [ "Team" ]
}
...
] |
|
|  "spaceKey" : "string"
| Key/value pair | Defines the space key for new spaces generated from a blueprint; OR Indicates the space that holds a page blueprint's source page. | When this key/value pair occurs in a space blueprint object , the string value will be the space key of any new spaces generated via blueprint. As with the spaceName key, it is possible and indeed recommended to incorporate at least one substitution field into this key's value so that each new space created from this blueprint will have a unique key from the start. Otherwise, when blueprint users try to create new spaces from blueprint, they will be prompted to go back and manually enter a unique space key to avoid naming collisions. When this key/value pair occurs in a page blueprint object , the string value will simply be the key of the space that is holding the blueprint source page. Another way to think about it: The space indicated here is where we'll find the value of "pageTitle". | "spaceBlueprints" : [
...
{
"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]]WS",
"spaceDescription" : "Projects, timelines, and resources for the [[team-name]] team",
"access" : [ "Team" ]
}
...
] |
|
"pageBlueprints" : [
...
{
"name" : "Product Overview",
"description" : "Create a page that describes the product.",
"spaceKey" : "BP",
"pageTitle" : "[[product-name]] Overview",
"blueprintFields" : [ "product-name", "product-logo" ]
}
...
] |
|
|  "spaceCategories" : "string"
| Key/value pair | Adds labels to new spaces generated from a blueprint. | The string value of this key is a comma-separated list of labels that will automatically be added to any new spaces created from the blueprint. This key/value pair occurs only in space blueprint objects. Leave blank or remove this key/value pair from the object altogether if you do not want to add labels to the new spaces. | "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" ]
}
...
] |
|
|  "spaceDescription" : "string"
| Key/value pair | | | | | | | | | |  "pageTitle" : "string"
| Key/value pair | | | | |
|
|