| Content Column |
|---|
| name | Page Body |
|---|
| width | 100.00002% |
|---|
| id | 821023946 |
|---|
| | Content Block |
|---|
| background-color | transparent |
|---|
| name | Prompt |
|---|
| rich-link-hovers | true |
|---|
| id | 821023943 |
|---|
| class | tight reference-prompt-flex |
|---|
| Guide to the contents of the Brikit blueprints JSON file |
| Content Block |
|---|
| name | Reference |
|---|
| rich-link-hovers | true |
|---|
| rich-links-enable | false |
|---|
| id | 1434454811 |
|---|
| class | page-pattern-heading reference-reference-flex |
|---|
| | 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. | | Expand |
|---|
| title | If your site has two space blueprints, "New Product" and "Team Workspace": |
|---|
| | HTML Wrap |
|---|
| "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 "access"department or project team",
"blueprintSpaceKey" : "teamspacebp",
"blueprintFields" : [ "team-name", "team-lead-name", "team-lead-email" ],
"spaceName" : "[[team-name]] Workspace",
"spaceKey" : "[["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-name]]Workspace",
"spaceCategories" : "workspaces",
"spaceDescription" : "Projects, timelines, and resources for the [[team-name]] team",
"access" : [ "Team" ]
}
] |
|
| Expand |
|---|
| title | If your site has no space blueprints: |
|---|
| | HTML Wrap |
|---|
| "spaceBlueprints" : [
] |
|
| | Anchor |
|---|
| space-bp-object |
|---|
| space-bp-object |
|---|
|
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: | | Expand |
|---|
| title | Object for a "New Product" space blueprint: |
|---|
| | HTML Wrap |
|---|
| "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"]
}
...
] |
|
| | 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. | | Expand |
|---|
| title | Naming a space blueprint, "New Product": |
|---|
| | HTML Wrap |
|---|
| "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"]
}
...
] |
|
| Expand |
|---|
| title | Naming a page blueprint, "Product Overview": |
|---|
| | HTML Wrap |
|---|
| "pageBlueprints" : [
...
{
"name" : "Product Overview",
"description" : "Create a page that describes the product.",
"spaceKey" : "BP",
"pageTitle" : "[[product-name]] Overview",
"blueprintFields" : [ "product-name", "product-logo" ]
}
...
] |
|
| | Anchor |
|---|
| description-key |
|---|
| description-key |
|---|
|
"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. | | Expand |
|---|
| title | Description for a "New Product" space blueprint: |
|---|
| | HTML Wrap |
|---|
| "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"]
}
...
] |
|
| Expand |
|---|
| title | Description for a "Product Overview" page blueprint: |
|---|
| | HTML Wrap |
|---|
| "pageBlueprints" : [
...
{
"name" : [ "Team"]
}
] |
|
| Expand |
|---|
| title | If your site has no space blueprints: |
|---|
| | HTML Wrap |
|---|
| "spaceBlueprints" : [
] |
|
| Space blueprint object / item in "spaceBlueprints" array | Object | Defines an individual space blueprint on your site. | This object comprises a set of name/value pairs that function as specifications or instructions for creating new spaces from this blueprint. | | "Product Overview",
"description" : "Create a page that describes the product.",
"spaceKey" : "BP",
"pageTitle" : "[[product-name]] Overview",
"blueprintFields" : [ "product-name", "product-logo" ]
}
...
] |
|
| | Anchor |
|---|
| bpspacekey-key |
|---|
| bpspacekey-key |
|---|
|
"blueprintSpaceKey" : "value" | Key/value pair | | | | | | |
|
|
