Guide to the contents of the Brikit blueprints JSON file

Data ElementStructureWhat It DoesWhat It MeansExample

"spaceBlueprints"

ArrayLists 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"] }
]

"spaceBlueprints" : [
]

Space blueprint object / item in "spaceBlueprints" array

ObjectDefines 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.

 
     
  • link
  • link
  • link
  • link