| 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 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" ]
}
] |
|
| 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 that defines 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" ]
}
...
] |
|
| | "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. | | Expand |
|---|
| title | If your site has two page blueprints, "Product Overview" and "Team Member Profile": |
|---|
| | 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"]
},
{
"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" ]
}
]
|
|
| Expand |
|---|
| title | If your site has no page blueprints: |
|---|
| | HTML Wrap |
|---|
| "pageBlueprints" : [
] |
|
| | Anchor |
|---|
| page-bp-object |
|---|
| page-bp-object |
|---|
|
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: | | | Expand |
|---|
| title | Object that defines a "Team Member Profile" page blueprint: |
|---|
| | HTML Wrap |
|---|
| "pageBlueprints" : [
...
{
"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" ]
}
...
] |
|
| | 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" |
|
| | Anchor |
|---|
name-key | name-key | "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. | | 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" : "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. | | 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" |
| | 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-usernamelogo" ],
"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: |
|---|
| |
| | Anchor |
|---|
| description-key |
|---|
| description-key |
|---|
|
"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. | | Expand |
|---|
| title | Description for a "New Product" space blueprint: |
|---|
| | HTML Wrap |
|---|
| "pageBlueprintsspaceBlueprints" : [
...
{
"name" : "New Product Overview",
"description" : "Create a pagespace thatfor describesa thenew product.",
"spaceKeyblueprintSpaceKey" : "BPproductspacebp",
"pageTitleblueprintFields" : :[ "[[product-name]] Overview"", "product-owner-username" ],
"blueprintFieldsspaceName" : "[[ "product-name]]",
"spaceKey" : "[[product-logo" ]
}
...
] |
|
| Anchor |
|---|
bpspacekey-key | bpspacekey-key | "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. | name]]",
"spaceCategories" : "development, product",
"spaceDescription" : "Product space for everything related to [[product-name]]",
"access" : [ "Product Space" ]
}
...
] |
|
| Expand |
|---|
| title | Description for a "Product Overview" page |
|---|
| | Expand |
|---|
| title | Existing space whose key = "productspacebp" will be the template for this blueprint: |
|---|
| | HTML Wrap |
|---|
| "spaceBlueprintspageBlueprints" : [
...
{
"name" : "NewProduct ProductOverview",
"description" : "Create a spacepage forthat adescribes newthe product.",
"blueprintSpaceKeyspaceKey" : "productspacebpBP",
"blueprintFieldspageTitle" : [ "product-name", "product-owner-username" ],
"spaceName" : "[[product-name]] Overview",
"spaceKeyblueprintFields" : [ "[[product-name]]",
"spaceCategories" : "development, product",
"spaceDescription" : "Product space for everything related to [[product-name]]",
"access" : [ "Product Space" ]
}
...
-logo" ]
}
...
] |
|
| | Anchor |
|---|
| bpfieldsbpspacekey-keybpfields |
|---|
| bpspacekey-key |
|---|
|
" blueprintFieldsblueprintSpaceKey" : [array]"string" | Key/value pair | Lists all custom substitution fields included in the blueprintIndicates a blueprint source space. | The array string value assigned to this key will comprise is 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. 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. | | Expand |
|---|
| title | Existing space whose key = "productspacebp" will be the template for this blueprint: |
|---|
| | | Expand |
|---|
| title | Substitution fields used in 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 | Substitution fields used in a "Product Overview" page blueprint: |
|---|
| | 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 |
|---|
spacename-key | spacename-key | "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. | "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. | | Expand |
|---|
| title | Substitution fields used in 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 | Substitution fields used in a "Product Overview" page blueprint: |
|---|
| | 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" ]
}
|
| | Expand |
|---|
| title | How new spaces generated from a "Team Workspace" blueprint will be named: |
|---|
| | HTML Wrap |
|---|
| "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" ]
}
...
] |
|
| | Anchor |
|---|
| spacekeyspacename-keyspacekey |
|---|
| spacename-key |
|---|
|
" spaceKeyspaceName" : " string" | Key/value pair | Defines the space key for how new spaces generated from a space blueprint ; OR Indicates the space that holds a page blueprint's source page. will be named. | The string value of this key will be the name of a new space 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 It is possible and indeed recommended to incorporate at least one custom substitution field into this key's value so that each new space created from this blueprint will have a unique key name 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". , without requiring any extra input from the user who is creating the new space. (Built-in substitution fields, however, are not supported here.) This key/value pair occurs only in space blueprint objects. | | Expand |
|---|
| title | How new spaces generated from a "Team Workspace" blueprint will be named: |
|---|
| | HTML Wrap |
|---|
| "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" ]
}
...
] |
|
| | 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". | | Expand |
|---|
| title | Naming convention for space keys generated from a "Team Workspace" blueprint: |
|---|
| | HTML Wrap |
|---|
| "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" ]
}
...
] |
|
| Expand |
|---|
| title | If the source page for this page blueprint lives in a space whose key = "BP" |
|---|
| | Expand |
|---|
| title | Naming convention for space keys generated from a "Team Workspace" blueprint: |
|---|
| | HTML Wrap |
|---|
| "spaceBlueprintspageBlueprints" : [
...
{
"name" : "Team Workspace",
"description" : "Workspace for a department or project team",
"blueprintSpaceKey" name" : "teamspacebpProduct Overview",
"blueprintFieldsdescription" : [ "team-name", "team-lead-name", "team-lead-email" ] "Create a page that describes the product.",
"spaceNamespaceKey" : "[[team-name]] WorkspaceBP",
"spaceKey" pageTitle" : "[[teamproduct-name]]WS Overview",
"spaceDescriptionblueprintFields" : "Projects, timelines, and resources for the [[team-name]] team",
"access" : [ "Team" ]
}
...
] |
| | Expand |
|---|
[ "product-name", "product-logo" ]
}
...
] |
|
| | Anchor |
|---|
| spacecats-key |
|---|
| spacecats-key |
|---|
|
"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. | | Expand |
|---|
| title | Adding "development" and "product" labels to spaces created from this blueprint | title | If the source page for this page blueprint lives in a space whose key = "BP": |
|---|
| | HTML Wrap |
|---|
| "pageBlueprintsspaceBlueprints" : [
...
{
"name" : "New Product",
"description" : "Create a space for a new product.",
"blueprintSpaceKey" : "productspacebp",
"blueprintFields" : [ "product-name", "name" : "Product Overview"product-owner-username" ],
"spaceName" : "[[product-name]]",
"descriptionspaceKey" : "Create a page that describes the product.[[product-name]]",
"spaceKeyspaceCategories" : "BPdevelopment, product",
"spaceDescription"pageTitle" : " : "Product space for everything related to [[product-name]] Overview",
"blueprintFieldsaccess" : [ "product-name",Product Space"product-logo" ]
}
...
] |
|
| | Anchor |
|---|
| spacecatsspacedescription-keyspacecats |
|---|
| spacedescription-key |
|---|
|
" spaceCategoriesspaceDescription" : " string" | Key/value pair | Adds labels to new spaces generated from a blueprint. | | Key/value pair | Describes new spaces generated via blueprint. | The string value of this key will be the description (as seen in the editable via the Space Tools Menu) for any new space generated from the blueprint.It is possible to incorporate custom substitution fields into this key's value, should you wish to do that, although the use of built-in substitution fields is not supported . This key/value pair occurs only in space blueprint objects | | Expand |
|---|
| title | Adding "development" and "product" labels to Description metadata for spaces created from this 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" ]
}
...
] |
|
| | spacedescription | spacedescription | spaceDescription | "string" | Key/value pair | | | | | | | | | | Anchor |
|---|
| pagetitle-key |
|---|
| pagetitle-key |
|---|
|
"pageTitle" : " string" | Key/value pair | | | | |
|
|
