COBie
6.3JSON FORMAT
ISO/IEC 21778:2017
The ability to deliver COBie data in a JSON format is new for this version.
General
- There is a restriction that additional properties (user added columns) must be of type ‘string’.
- References within a JSON document should use JSON pointers. That means that the value of all references will have different values when delivered in JSON than when delivered in other formats.
- For references to the COBie.PickList table, there are specified enums for lists that are enumerated in the table. There are no references to external standards.
- This schema will be much easier for JavaScript applications to consume if the field names are valid JavaScript identities. Therefore, the COBie.X.Name field is replaced with ‘_Ref’ and it has been added to all table references.
- The COBie.X.Table and COBie.X.Table.Name fields have been replaced with a single ‘Table_Ref’ field that is either a JSON-pointer or an array of JSON pointers.
Instructions Table
- Version and Release should be numeric.
- All the unit fields are required, and the Organization column is updated to reflect that.
Facility Table
- COBie.Facility.Latitude, COBie.Facility.Longitude, and COBie.Facility.Elevation should be numeric as this assumes a +/- real number as used by GPS.
- Minimum and maximum constraints have been added to COBie.Facility.Latitude and COBie.Facility.Longitude.
Component Table
- COBie.Space.SecondaryName is rendered as ‘SecondarySpace_Ref’.
Job Table
- COBie.Job.Table and COBie.Job.Table.Name are rendered as arrays.
- COBie.Job.ResourceNames is replaced with ‘Resource_Ref’, which is an array of JSON pointers.
Risk
- The following fields have been replaced and each of them is single valued:
- COBie.Risk.SpatialTable and COBie.Risk.SpatialTable.Name with ‘Spatial_Ref’.
- COBie.Risk.PhysicalTable and COBie.Risk.PhysicalTable.Name with ‘Physical_Ref’.
- COBie.Risk.ProcessTable and COBie.Risk.ProcessTable.Name with ‘Process_Ref’.
Sample Schema
{
"title": "COBie v3 JSON Schema",
"$schema": "http://json-schema.org/draft-04/schema#",
"$id": "https://www.nibs.com/Schema/COBie/v3",
"description": "",
"type": "object",
"required": [
"Instructions",
"Company",
"Facility",
"Level",
"SpaceType",
"Space",
"Type",
"Component"
],
"properties": {
"Instructions": {
"type": "object",
"description": "Provides written instructions related to the COBie database, but also contains the general submittal information for a particular COBie deliverable.",
"required": [
"Title",
"Version",
"Release",
"Status",
"Region",
"ExportDateTime",
"AreaUnit",
"CurrencyUnit",
"DurationUnit",
"LinearUnit",
"VolumeUnit",
"WeightUnit",
"AreaMeasurementStandard",
"CoordinateSystemDescription",
"CoordinateSystemOrigin",
"ClassificationSystem.Company",
"ClassificationSystem.Facility",
"ClassificationSystem.SpaceType",
"ClassificationSystem.Type",
"ClassificationSystem.System"
],
"properties": {
"Title": {
"type": "string"
},
"Version": {
"type": "number",
"default": 3
},
"Release": {
"type": "number",
"default": 0
},
"Status": {
"type": "string",
"description": "The version IFC with which this COBie deliverable aligns.",
"default": "IFC4"
},
"Region": {
"type": "string",
"description": "Format is ISO-639-1 two letter language code",
"examples": [
"en-US",
"en-GB"
]
},
"ExportDateTime": {
"type": "string",
"format": "date-time",
"description": "Format is ISO-8601 (YYYY-MM-DD) with exact time optional",
"examples": [
"2022-12-31",
"2022-12-31T13:00:00"
]
},
"Milestone": {
"type": "string",
"description": "A description of the project milestone for which this COBie deliverable represents.",
"examples": [
"50% DD",
"90% CD",
"Handover"
]
},
"OriginatingCompany": {
"type": "string",
"format": "json-pointer",
"description": "The name of the company that generated this COBie deliverable, referencing a COBie.Company.Name value.",
"examples": [
"/Company/3"
]
},
"AreaUnit": {
"type": "string",
"description": "From the 'Units.Area' field on the PickLists table",
"enum": [
"Square Inches",
"Square Feet",
"Square Miles",
"Square Millimeters",
"Square Meters",
"Square Kilometers"
],
"examples": [
"Square Feet",
"Square Meters"
]
},
"CurrencyUnit": {
"type": "string",
"description": "From the 'Units.Currency' field on the PickLists table",
"examples": [
"Dollars",
"Euros"
]
},
"DurationUnit": {
"type": "string",
"description": "From the 'Units.Duration' field on the PickLists table",
"enum": [
"As required",
"Day",
"Minute",
"Month",
"Quarter",
"Week",
"Year"
],
"examples": [
"Month",
"Year"
]
},
"LinearUnit": {
"type": "string",
"description": "From the 'Units.Linear' field on the PickLists table",
"enum": [
"Inches",
"Feet",
"Miles",
"Millimeters",
"Meters",
"Kilometers"
],
"examples": [
"Feet",
"Meters"
]
},
"VolumeUnit": {
"type": "string",
"description": "From the 'Units.Volume' field on the PickLists table",
"enum": [
"Cubic Feet",
"Cubic Meters"
],
"examples": [
"Cubic Feet",
"Cubic Meters"
]
},
"WeightUnit": {
"type": "string",
"description": "From the 'Units.Weight' field on the PickLists table",
"enum": [
"Ounces",
"Pounds",
"Tons",
"Grams",
"Kilograms",
"Metric Tons"
],
"examples": [
"Pounds",
"Kilograms"
]
},
"AreaMeasurementStandard": {
"type": "string",
"examples": [
"BOMA 2017 for Office Buildings",
"Standard Methods of Measurement (ANSI/BOMA Z65.1—2017)"
]
},
"CoordinateSystemDescription": {
"type": "string",
"examples": [
"Degrees, Minutes, Seconds"
]
},
"CoordinateSystemOrigin": {
"type": "string",
"examples": [
"38°54'12.438\"N, 77°2'1.0314\"W"
]
},
"ClassificationSystem_Company": {
"type": "string",
"description": "Provide system name and version",
"examples": [
"OmniClass Table 34",
"Uniclass Table Ro"
]
},
"ClassificationSystem_Facility": {
"type": "string",
"description": "Provide system name and version",
"examples": [
"OmniClass Table 11",
"Uniclass Table En"
]
},
"ClassificationSystem_SpaceType": {
"type": "string",
"description": "Provide system name and version",
"examples": [
"OmniClass Table 13",
"Uniclass Table SL"
]
},
"ClassificationSystem_Type": {
"type": "string",
"description": "Provide system name and version",
"examples": [
"OmniClass Table 23",
"Uniclass Table Pr"
]
},
"ClassificationSystem_System": {
"type": "string",
"description": "Provide system name and version",
"examples": [
"OmniClass Table 21",
"Uniclass Table EF"
]
}
},
“additionalProperties”: {
"type": "string"
}
},
"Company": {
"type": "array",
"uniqueItems": true,
"description": "Represents the information related to a company that is referenced elsewhere in a COBie deliverable.",
"items": [
{
"type": "object",
"required": [
"Name",
"Phone"
],
"properties": {
"Name": {
"type": "string",
"description": "The name of the Company. This is the primary key for this data table and each must be unique.",
"examples": [
"ABC_Corp",
"xyzconstruction-com"
]
},
"Phone": {
"type": "string",
"description": "The telephone number for the Company.",
"examples": [
"+1 (202) 289-7800"
]
},
"Category": {
"type": "string",
"description": "The classification for the Company. This data field value comes from one of the values in COBie.PickList.Company.Category data field.",
"examples": [
"34-10 11 Owner",
"Ro_10_20_14 Client"
]
},
"Website": {
"type": "string",
"description": "The website address for the Company.",
"examples": [
"www.abccorp.com"
]
},
"Street": {
"type": "string",
"description": "The street address for the Company.",
"examples": [
"1090 Vermont Avenue NW, Suite 700"
]
},
"PostalBox": {
"type": "string",
"description": "The postal box address for the Company.",
"examples": [
"P.O. Box 1234"
]
},
"Town": {
"type": "string",
"description": "The city or town address for the Company",
"examples": [
"Washington"
]
},
"StateRegion": {
"type": "string",
"description": "The state or regional address for the Company.",
"examples": [
"DC",
"NC"
]
},
"PostalCode": {
"type": "string",
"description": "The zip, or postal code, address for the Company.",
"examples": [
"20005"
]
},
"Country": {
"type": "string",
"description": "The country where the Company is located.",
"examples": [
"U.S.A.",
"U.K.",
"Germany"
]
},
"ExtIdentifier": {
"type": "string",
"description": "The unique identifier of the identified ExternalObject that would allow COBie data to be matched back to the data from which it was developed in the named ExternalSystem. This might be a GUID or ElementID.",
"examples": [
"4ec17585-c36e-4cc3-8301-61df48a06d7e-000c89be"
]
},
"ExtObject": {
"type": "string",
"description": "The name of the data object within the computer system that holds the data provided in a given row of COBie data. The default values are the associated IFC entities that are mapped (and those that are excluded) when transforming IFC data to a given row of COBie data.",
"examples": [
"IfcSpace"
]
},
"ExtSystem": {
"type": "string",
"description": "The name of the computer system generating the row of COBie data.",
"examples": [
"Autodesk Revit 2023, Build: 20220429_1500(x64)",
"ArchiCAD 19 Full (USA) / Build: 5005",
"IBM Maximo"
]
},
"Certifications": {
"type": "string"
},
"Department": {
"type": "string",
"description": "The name of the department for the Company.",
"examples": []
},
"OrganizationCode": {
"type": "string",
"description": "The organizational code for the Company."
}
},
“additionalProperties”: {
"type": "string"
}
}
]
},
"Facility": {
"type": "object",
"description": "Provides information related to the facility, structure, or group of structures (in the case of infrastructure projects) for which the COBie deliverable represents.",
"required": [
"Name",
"Address",
"Latitude",
"Longitude",
"Elevation"
],
"properties": {
"Name": {
"type": "string",
"description": "The name of the Facility for this COBie deliverable. This is the primary key for this data table and each must be unique."
},
"Descriptions": {
"type": "string",
"description": "A general text description of the facility, structure, or group of structures as part of this COBie deliverable."
},
"Types": {
"type": "string",
"enum": [
"Facility",
"Project",
"Site"
],
"description": "The type of facility, structure, or group of structures as part of this COBie deliverable. This data field value comes from one of the values in COBie.PickList.Facility.Type data field.",
"examples": [
"Facility",
"Project",
"Site"
]
},
"Category": {
"type": "string",
"description": "The classification for the Facility. This data field value comes from one of the values in COBie.PickList.Facility.Category data field.",
"examples": [
"11-27 25 19 Office-Retail Building",
"En_20_15_10 Multiple occupation office buildings"
]
},
"Address": {
"type": "string",
"description": "The city or town address of the project in Facility.",
"examples": [
"1090 Vermont Avenue NW, Suite 700, Washington, DC 20005"
]
},
"Latitude": {
"type": "number",
"minimum": -90,
"maximum": 90,
"description": "The specific latitude for the facility, structure, or group of structures as part of this COBie deliverable.",
"examples": [
42.3584
]
},
"Longitude": {
"type": "number",
"minimum": -180,
"maximum": 180,
"description": "The specific longitude for the facility, structure, or group of structures as part of this COBie deliverable.",
"examples": [
-71.0598
]
},
"Elevation": {
"type": "number",
"description": "The specific elevation above sea level for the facility, structure, or group of structures as part of this COBie deliverable.",
"examples": [
354,
14,
115,
5
]
},
"ExtIdentifier": {
"type": "string",
"description": "The unique identifier of the identified ExternalObject that would allow COBie data to be matched back to the data from which it was developed in the named ExternalSystem. This might be a GUID or ElementID.",
"examples": [
"4ec17585-c36e-4cc3-8301-61df48a06d7e-000c89be"
]
},
"ExtObject": {
"type": "string",
"description": "The name of the data object within the computer system that holds the data provided in a given row of COBie data. The default values are the associated IFC entities that are mapped (and those that are excluded) when transforming IFC data to a given row of COBie data.",
"examples": [
"IfcSpace"
]
},
"ExtSystem": {
"type": "string",
"description": "The name of the computer system generating the row of COBie data.",
"examples": [
"Autodesk Revit 2023, Build: 20220429_1500(x64)",
"ArchiCAD 19 Full (USA) / Build: 5005",
"IBM Maximo"
]
},
"Description": {
"type": "string"
}
},
“additionalProperties”: {
"type": "string"
}
},
"Level": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "Contains information related to the vertical levels of a facility or, in the case of infrastructure projects, the geographic areas such as the site surrounding a facility/structure, a rail or highway corridor, etc.",
"items": [
{
"type": "object",
"required": [
"Name"
],
"properties": {
"Name": {
"type": "string",
"title": "The name of the Level.",
"description": "This is the primary key for this data table and each must be unique."
},
"Description": {
"type": "string",
"description": "A general text description of the Level.",
"examples": [
"3rd floor area plan"
]
},
"Category": {
"type": "string",
"enum": [
"Roof",
"Floor",
"Site"
],
"description": "The classification for the Level. This data field value comes from one of the values in COBie.PickList.Level.Category data field.",
"examples": [
"Roof",
"Floor",
"Site"
]
},
"PartOf": {
"type": "string",
"format": "json-pointer",
"description": "A json-pointer reference to another Level item on this data table to represent that this item is a subset of that one. For example, a facility on a sloped grade that has a single “Level 1” floor per the signage, but that is separated within by a few steps, so the model has two different levels defined to manage the elements.",
"examples": [
"Floor/23"
]
},
"ExtIdentifier": {
"type": "string",
"description": "The unique identifier of the identified ExternalObject that would allow COBie data to be matched back to the data from which it was developed in the named ExternalSystem. This might be a GUID or ElementID.",
"examples": [
"4ec17585-c36e-4cc3-8301-61df48a06d7e-000c89be"
]
},
"ExtObject": {
"type": "string",
"description": "The name of the data object within the computer system that holds the data provided in a given row of COBie data. The default values are the associated IFC entities that are mapped (and those that are excluded) when transforming IFC data to a given row of COBie data.",
"examples": [
"IfcSpace"
]
},
"ExtSystem": {
"type": "string",
"description": "The name of the computer system generating the row of COBie data.",
"examples": [
"Autodesk Revit 2023, Build: 20220429_1500(x64)",
"ArchiCAD 19 Full (USA) / Build: 5005",
"IBM Maximo"
]
},
"Elevation": {
"type": "number",
"description": "The elevation at the top of the level structure. If allowable values are not specified by contract, the default value is measured as a relative value compared to the facility’s datum.",
"examples": [
354,
14,
115,
5
]
},
"Height": {
"type": "number",
"description": "The distance between the top of level structure to bottom of structure above.",
"examples": [
10,
12
]
}
},
“additionalProperties”: {
"type": "string"
}
}
]
},
"SpaceType": {
"type": "array",
"description": "Provides information related to the different types of spaces that make up a facility, structure, or group of structures for this COBie deliverable.",
"uniqueItems": true,
"items": [
{
"type": "object",
"required": [
"Name"
],
"properties": {
"Name": {
"type": "string",
"description": "This is the primary key for this data table and each must be unique."
},
"Description": {
"type": "string",
"description": "A general text description of the Space Type.",
"examples": [
"Shared Open cubicles"
]
},
"Category": {
"type": "string",
"description": "The classification for the Space Type. This data field value comes from one of the values in COBie.PickList.SpaceType.Category data field.",
"examples": [
"13-55 11 Office Spaces",
"SL_20_15_27 Enclosed offices"
]
},
"ExtIdentifier": {
"type": "string",
"description": "The unique identifier of the identified ExternalObject that would allow COBie data to be matched back to the data from which it was developed in the named ExternalSystem. This might be a GUID or ElementID.",
"examples": [
"4ec17585-c36e-4cc3-8301-61df48a06d7e-000c89be"
]
},
"ExtObject": {
"type": "string",
"description": "The name of the data object within the computer system that holds the data provided in a given row of COBie data. The default values are the associated IFC entities that are mapped (and those that are excluded) when transforming IFC data to a given row of COBie data.",
"examples": [
"IfcSpace"
]
},
"ExtSystem": {
"type": "string",
"description": "The name of the computer system generating the row of COBie data.",
"examples": [
"Autodesk Revit 2023, Build: 20220429_1500(x64)",
"ArchiCAD 19 Full (USA) / Build: 5005",
"IBM Maximo"
]
}
},
“additionalProperties”: {
"type": "string"
}
}
]
},
"Space": {
"type": "array",
"uniqueItems": true,
"minItems": 1,
"description": "Spaces represent the horizontal decomposition of Levels in COBie and which have common functional purpose and user.",
"items": [
{
"type": "object",
"required": [
"Name",
"Description",
"Level_Ref"
],
"properties": {
"Name": {
"type": "string",
"description": "The name of the Space. This is the primary key for this data table and each value must be unique and must not contain a comma. This is often the room number in the construction documents."
},
"Description": {
"type": "string",
"description": "A general text description of the Space.",
"examples": [
"Bob's Office",
"Conference room seating 12"
]
},
"SpaceType_Ref": {
"type": "string",
"format": "json-pointer",
"description": "A json-pointer reference to an item from the space type data table."
},
"Level_Ref": {
"type": "string",
"format": "json-pointer",
"description": "A json-pointer reference to an item from the Level data table."
},
"PartOf": {
"type": "string",
"format": "json-pointer",
"description": "A json-pointer reference to another Level item on this data table to represent that this item is a subset of that one. For example, a large open Room that has cubicles within. Each cubicle space would be part of the large open space.",
"examples": [
"Space/105"
]
},
"ExtIdentifier": {
"type": "string",
"description": "The unique identifier of the identified ExternalObject that would allow COBie data to be matched back to the data from which it was developed in the named ExternalSystem. This might be a GUID or ElementID.",
"examples": [
"4ec17585-c36e-4cc3-8301-61df48a06d7e-000c89be"
]
},
"ExtObject": {
"type": "string",
"description": "The name of the data object within the computer system that holds the data provided in a given row of COBie data. The default values are the associated IFC entities that are mapped (and those that are excluded) when transforming IFC data to a given row of COBie data.",
"examples": [
"IfcSpace"
]
},
"ExtSystem": {
"type": "string",
"description": "The name of the computer system generating the row of COBie data.",
"examples": [
"Autodesk Revit 2023, Build: 20220429_1500(x64)",
"ArchiCAD 19 Full (USA) / Build: 5005",
"IBM Maximo"
]
},
"GrossArea": {
"type": "number",
"description": "The total space area as specified in the design contract and calculated by the identified COBie.Instruction.AreaMeasurementStandard value.",
"examples": [
"1125.25",
"3201"
]
},
"NetArea": {
"type": "number",
"description": "The usable space area as specified in the design contract and calculated by the identified COBie.Instruction.AreaMeasurementStandard value.",
"examples": [
"988.62",
"3110.3"
]
},
"UsableHeight": {
"type": "number",
"description": "Distance from top of finished level to bottom of ceiling. If there is no ceiling, then this value must match COBie.Level.Height.",
"examples": [
"22",
"120"
]
}
},
“additionalProperties”: {
"type": "string"
}
}
]
},
"Zone": {
"type": "array",
"description": "Zones represent the aggregation of Spaces that provide some common purpose.",
"items": [
{
"type": "object",
"required": [
"Name",
"Space_Ref"
],
"properties": {
"Name": {
"type": "string",
"title": "The name of the Zone.",
"description": "This is the primary key for this data table and each must be unique."
},
"Description": {
"type": "string",
"description": "A general text description of the Zone.",
"examples": [
"Seating for the development orginization"
]
},
"Category": {
"type": "string",
"description": "The classification for the Zone. This data field value comes from one of the values in COBie.PickList.Zone.Category data field.",
"examples": [
"Circulation Zone",
"Occupancy Zone"
]
},
"Space_Ref": {
"type": "array",
"minItems": 1,
"description": "An array of json-pointer references to an items from the space data table.",
"items": {
"type": "string",
"format": "json-pointer"
}
},
"PartOf": {
"type": "string",
"format": "json-pointer",
"description": "A json-pointer reference to another Zone item on this data table to represent that this item is a subset of that one. For example, a large zone for the west wing of a facility could be divided up into smaller zones that are part of the west wing zone.",
"examples": [
"Space/105"
]
},
"ExtIdentifier": {
"type": "string",
"description": "The unique identifier of the identified ExternalObject that would allow COBie data to be matched back to the data from which it was developed in the named ExternalSystem. This might be a GUID or ElementID.",
"examples": [
"4ec17585-c36e-4cc3-8301-61df48a06d7e-000c89be"
]
},
"ExtObject": {
"type": "string",
"description": "The name of the data object within the computer system that holds the data provided in a given row of COBie data. The default values are the associated IFC entities that are mapped (and those that are excluded) when transforming IFC data to a given row of COBie data.",
"examples": [
"IfcSpace"
]
},
"ExtSystem": {
"type": "string",
"description": "The name of the computer system generating the row of COBie data.",
"examples": [
"Autodesk Revit 2023, Build: 20220429_1500(x64)",
"ArchiCAD 19 Full (USA) / Build: 5005",
"IBM Maximo"
]
}
},
“additionalProperties”: {
"type": "string"
}
}
]
},
"Type": {
"type": "array",
"description": "Represents information related to the different types of products and equipment in the Facility.",
"items": [
{
"type": "object",
"required": [
"Name",
"Description",
"Manufacturer_Ref",
"ModelNumber",
"WarrantyGuarantorParts_Ref",
"WarrantyDurationParts",
"WarrantyGuarantorLabor_Ref",
"WarrantyDurationLabor",
"WarrantyDurationUnit"
],
"properties": {
"Name": {
"type": "string",
"title": "The name of the asset Type.",
"description": "This is the primary key for this data table and each must be unique."
},
"Description": {
"type": "string",
"description": "A general text description of the asset Type.",
"examples": [
"32x80 Hollow core door"
]
},
"Category": {
"type": "string",
"description": "The classification for the asset type. This data field value comes from one of the values in COBie.PickList.Type.Category data field.",
"examples": [
"23-33 11 22 Electric Boilers",
"Pr_60_60_08_27 Electric Boilers"
]
},
"AssetType": {
"type": "string",
"enum": [
"Fixed",
"Moveable"
],
"description": "The type of asset. This data field value comes from one of the values in COBie.PickList.Type.AssetType data field.",
"examples": [
"Fixed",
"Moveable"
]
},
"ExtIdentifier": {
"type": "string",
"description": "The unique identifier of the identified ExternalObject that would allow COBie data to be matched back to the data from which it was developed in the named ExternalSystem. This might be a GUID or ElementID.",
"examples": [
"4ec17585-c36e-4cc3-8301-61df48a06d7e-000c89be"
]
},
"ExtObject": {
"type": "string",
"description": "The name of the data object within the computer system that holds the data provided in a given row of COBie data. The default values are the associated IFC entities that are mapped (and those that are excluded) when transforming IFC data to a given row of COBie data.",
"examples": [
"IfcSpace"
]
},
"ExtSystem": {
"type": "string",
"description": "The name of the computer system generating the row of COBie data.",
"examples": [
"Autodesk Revit 2023, Build: 20220429_1500(x64)",
"ArchiCAD 19 Full (USA) / Build: 5005",
"IBM Maximo"
]
},
"Manufacturer_Ref": {
"type": "string",
"format": "json-pointer",
"description": "The name of the company that manufactures the asset. This is a json-pointer reference to an entry in the COBie.Company table.",
"examples": [
"Company/26"
]
},
"ModelNumber": {
"type": "string",
"format": "json-pointer",
"description": "During the construction and handover phases, this is the manufacturer’s model number of the installed product. During planning and design phases, this data field is not applicable",
"examples": [
"Mark IV v2"
]
},
"WarrantyGuarantorParts_Ref": {
"type": "string",
"format": "json-pointer",
"description": "During the construction and handover phases, this is the name of the company that is responsible for replacement parts during the warranty period. During planning and design phases, this data field is not applicable. This is a json-pointer reference to an entry in the COBie.Company table.",
"examples": [
"Company/27"
]
},
"WarrantyDurationParts": {
"type": "string",
"format": "json-pointer",
"description": "During the construction and handover phases, this is the length of the warranty period for replacement parts provided by the product manufacturer. During planning and design phases, this data field is not applicable.",
"examples": [
"3",
"36"
]
},
"WarrantyGuarantorLabor_Ref": {
"type": "string",
"format": "json-pointer",
"description": "During the construction and handover phases, this is the name of the company that is responsible for labor costs during the warranty period. During planning and design phases, this data field is not applicable. This is a json-pointer reference to an entry in the COBie.Company table.",
"examples": [
"Company/28"
]
},
"WarrantyDurationLabor": {
"type": "string",
"format": "duration",
"description": "During the construction and handover phases, this is the length of the warranty period for labor repairs provided by the product manufacturer. During planning and design phases, this data field is not applicable.",
"examples": [
"1",
"12"
]
},
"WarrantyDurationUnit": {
"type": "string",
"enum": [
"As required",
"Day",
"Minute",
"Month",
"Quarter",
"Week",
"Year"
],
"description": "The unit of measure associated with values found in COBie.Type.WarrantyDurationParts and COBie.Type.WarrantyDurationLabor. If allowable values are not specified by contract, the default values are Month and Year. This data field value comes from one of the values in COBie.PickList.Units.Duration data field."
},
"ModelReference": {
"type": "string"
},
"NominalHeight": {
"type": "number"
},
"NominalLength": {
"type": "number"
},
"NominalWeight": {
"type": "number"
},
"NominalWidth": {
"type": "number"
},
"PurchaseCost": {
"type": "string",
"description": "The purchase cost of the asset."
},
"WarrantyDescription": {
"type": "string",
"description": "A description of the warranty for the asset."
}
},
“additionalProperties”: {
"type": "string"
}
}
]
},
"Component": {
"type": "array",
"description": "The individual instances of the products and equipment define in the Type data table.",
"items": [
{
"type": "object",
"required": [
"Name",
"Description",
"Space_Ref"
],
"properties": {
"Name": {
"type": "string",
"title": "The name of the asset Component.",
"description": "The name of the asset Component. This is the primary key for this data table and each value must be unique and must not contain a comma."
},
"Description": {
"type": "string",
"description": "A general text description of the asset Component."
},
"AssetIdentifier": {
"type": "string"
},
"BarCode": {
"type": "string"
},
"SerialNumber": {
"type": "string"
},
"TagNumber": {
"type": "string"
},
"Type_Ref": {
"type": "string",
"format": "json-pointer",
"description": "A json-pointer reference to an item from the type data table."
},
"Space_Ref": {
"type": "array",
"format": "json-pointer",
"description": "A json-pointer reference to an item from the space data table."
},
"SecondarySpace_Ref": {
"type": "array",
"minItems": 1,
"description": "An array of json-pointer references to items from the space data table.",
"items": {
"type": "string",
"format": "json-pointer",
}
},
"ExtIdentifier": {
"type": "string",
"description": "The unique identifier of the identified ExternalObject that would allow COBie data to be matched back to the data from which it was developed in the named ExternalSystem. This might be a GUID or ElementID.",
"examples": [
"4ec17585-c36e-4cc3-8301-61df48a06d7e-000c89be"
]
},
"ExtObject": {
"type": "string",
"description": "The name of the data object within the computer system that holds the data provided in a given row of COBie data. The default values are the associated IFC entities that are mapped (and those that are excluded) when transforming IFC data to a given row of COBie data.",
"examples": [
"IfcSpace"
]
},
"ExtSystem": {
"type": "string",
"description": "The name of the computer system generating the row of COBie data.",
"examples": [
"Autodesk Revit 2023, Build: 20220429_1500(x64)",
"ArchiCAD 19 Full (USA) / Build: 5005",
"IBM Maximo"
]
},
"InstallationDate": {
"type": "string",
"format": "date"
},
"WarrantyStartDate": {
"type": "string",
"format": "date"
}
},
“additionalProperties”: {
"type": "string"
}
}
]
},
"System": {
"type": "array",
"description": "Systems represent aggregations of Components that provide some common function.",
"items": [
{
"type": "object",
"required": [
"Name",
"Component_Ref"
],
"properties": {
"Name": {
"type": "string",
"title": "The name of the System.",
"description": "This is the primary key for this data table and each must be unique."
},
"Description": {
"type": "string",
"description": "A general text description of the System.",
"examples": [
"East wing HVAC"
]
},
"Category": {
"type": "string",
"description": "The classification for the System. This data field value comes from one of the values in COBie.PickList.System.Category data field.",
"examples": [
"21-04 20 10 Domestic Water Distribution",
"EF_55_70 Water supply"
]
},
"Component_Ref": {
"type": "array",
"minItems": 1,
"description": "An array of json-pointer references to items from the component table.",
"items": {
"type": "string",
"format": "json-pointer"
},
"examples": [
[
"Component/105",
"Component/237"
]
]
},
"PartOf": {
"type": "string",
"format": "json-pointer",
"description": "A json-pointer reference to another System item on this data table to represent that this item is a subset of that one. For example, a large zone for the west wing of a facility could be divided up into smaller zones that are part of the west wing zone.",
"examples": [
"System/105"
]
},
"ExtIdentifier": {
"type": "string",
"description": "The unique identifier of the identified ExternalObject that would allow COBie data to be matched back to the data from which it was developed in the named ExternalSystem. This might be a GUID or ElementID.",
"examples": [
"4ec17585-c36e-4cc3-8301-61df48a06d7e-000c89be"
]
},
"ExtObject": {
"type": "string",
"description": "The name of the data object within the computer system that holds the data provided in a given row of COBie data. The default values are the associated IFC entities that are mapped (and those that are excluded) when transforming IFC data to a given row of COBie data.",
"examples": [
"IfcSpace"
]
},
"ExtSystem": {
"type": "string",
"description": "The name of the computer system generating the row of COBie data.",
"examples": [
"Autodesk Revit 2023, Build: 20220429_1500(x64)",
"ArchiCAD 19 Full (USA) / Build: 5005",
"IBM Maximo"
]
}
},
“additionalProperties”: {
"type": "string"
}
}
]
},
"Resource": {
"type": "array",
"description": "Resource records identify the tools, materials, and training needed to maintain the facility, structure, or group of structures.",
"items": [
{
"type": "object",
"required": [
"Name"
],
"properties": {
"Name": {
"type": "string",
"title": "The name of the Resource.",
"description": "The name of the Resource that is required to be used on the Job. This Resource may be shared across multiple Jobs. This is the primary key for this data table and each value must be unique and must not contain a comma."
},
"Description": {
"type": "string",
"description": "A general text description of the Resource.",
"examples": [
"T8 warm white florescent tubes – 4ft"
]
},
"Category": {
"type": "string",
"enum": [
"Labor",
"Material",
"Tools",
"Training"
],
"description": "The classification for the Resource. This data field value comes from one of the values in COBie.PickList.Resource.Category data field.",
"examples": [
"Labor",
"Material"
]
},
"ExtIdentifier": {
"type": "string",
"description": "The unique identifier of the identified ExternalObject that would allow COBie data to be matched back to the data from which it was developed in the named ExternalSystem. This might be a GUID or ElementID.",
"examples": [
"4ec17585-c36e-4cc3-8301-61df48a06d7e-000c89be"
]
},
"ExtObject": {
"type": "string",
"description": "The name of the data object within the computer system that holds the data provided in a given row of COBie data. The default values are the associated IFC
entities that are mapped (and those that are excluded) when transforming IFC data to a given row of COBie data.",
"examples": [
"IfcSpace"
]
},
"ExtSystem": {
"type": "string",
"description": "The name of the computer system generating the row of COBie data.",
"examples": [
"Autodesk Revit 2023, Build: 20220429_1500(x64)",
"ArchiCAD 19 Full (USA) / Build: 5005",
"IBM Maximo"
]
}
},
“additionalProperties”: {
"type": "string"
}
}
]
},
"Job": {
"type": "array",
"description": "Identifies the variety of work that is required to operate, maintain, start up, shut down, or troubleshoot a given Component in the facility, structure, or group of structures.",
"items": [
{
"type": "object",
"required": [
"Name",
"Description",
"Duration",
"DurationUnit",
"Interval",
"IntervalUnit",
"Priors",
"Resource_Ref"
],
"properties": {
"Name": {
"type": "string",
"title": "The name of the Job.",
"description": "This is the primary key for this data table and each must be unique."
},
"Description": {
"type": "string",
"description": "A general text description of the Job."
},
"TaskNumber": {
"type": "string"
},
"Category": {
"type": "string",
"enum": [
"Adjustment",
"Calibration",
"Emergency",
"Inspection",
"Operation",
"Project Management",
"Safety",
"ShutDown",
"StartUp",
"Testing",
"Trouble"
],
"description": "The classification for the Job. This data field value comes from one of the values in COBie.PickList.Job.Category data field.",
"examples": [
"Inspection",
"ShutDown"
]
},
"Status": {
"type": "string",
"enum": [
"Not Yet Started",
"Started",
"Completed"
],
"description": "Status of the job.",
"examples": [
"Not Yet Started",
"Completed"
]
},
"Table_Ref": {
"type": "array",
"minItems": 1,
"description": "An array of json-pointer references to items from other tables that are part of the job.",
"items": {
"type": "string",
"format": "json-pointer"
},
"examples": [
[
"Company/21",
"Space/105",
"Component/237"
]
]
},
"PartOf": {
"type": "string",
"format": "json-pointer",
"description": "A json-pointer reference to another Job item on this table to represent that this item is a subset of that one. For example, adding a reusable sub-task such as shutdown to a larger job such as inspection.",
"examples": [
"Space/105"
]
},
"ExtIdentifier": {
"type": "string",
"description": "The unique identifier of the identified ExternalObject that would allow COBie data to be matched back to the data from which it was developed in the named ExternalSystem. This might be a GUID or ElementID.",
"examples": [
"4ec17585-c36e-4cc3-8301-61df48a06d7e-000c89be"
]
},
"ExtObject": {
"type": "string",
"description": "The name of the data object within the computer system that holds the data provided in a given row of COBie data. The default values are the associated IFC entities that are mapped (and those that are excluded) when transforming IFC data to a given row of COBie data.",
"examples": [
"IfcSpace"
]
},
"ExtSystem": {
"type": "string",
"description": "The name of the computer system generating the row of COBie data.",
"examples": [
"Autodesk Revit 2023, Build: 20220429_1500(x64)",
"ArchiCAD 19 Full (USA) / Build: 5005",
"IBM Maximo"
]
},
"Duration": {
"type": "number"
},
"DurationUnit": {
"type": "string",
"enum": [
"Day",
"Minute",
"Month",
"Quarter",
"Week",
"Year"
],
"description": "The unit of measure associated with values found in COBie.Job.Duration. If allowable values are not specified by contract, the default values are Month and Year. This data field value comes from one of the values in COBie.PickList.Units.Duration data field."
},
"Interval": {
"type": "string"
},
"IntervalUnit": {
"type": "string",
"enum": [
"As required",
"Day",
"Minute",
"Month",
"Quarter",
"Week",
"Year"
]
},
"Priors": {
"type": "array",
"minItems": 1,
"description": "An array of json-pointer references to items from the TaskNumber field of the Job table.",
"items": {
"type": "string",
"format": "json-pointer"
},
"examples": [
[
"Resource/2108",
"Resource/237"
]
]
}
"Resource_Ref": {
"type": "array",
"minItems": 1,
"description": "An array of json-pointer references to items from the Resource table that are part of the job.",
"items": {
"type": "string",
"format": "json-pointer"
},
"examples": [
[
"Resource/2108",
"Resource/237"
]
]
}
},
“additionalProperties”: {
"type": "string"
}
}
]
},
"Event": {
"type": "array",
"description": "Events represent a single occurrence of a task as part of a Job.",
"items": [
{
"type": "object",
"required": [
"Name",
"Description",
"StartDate"
],
"properties": {
"Name": {
"type": "string",
"title": "The name of the Event.",
"description": "The name of the Event. This value does not need to be unique."
},
"Description": {
"type": "string",
"description": "A general text description of the Event."
},
"Category": {
"type": "string",
"enum": [
"One Time",
"Planned",
"Repeating"
],
"description": "The classification for the Event. This data field value comes from one of the values in COBie.PickList.Event.Category data field.",
"examples": [
"One Time",
"Planned",
"Repeating"
]
},
"Company_Ref": {
"type": "string",
"format": "json-pointer",
"examples": [
"/Company/3"
]
},
"Jpb_Ref": {
"type": "string",
"format": "json-pointer",
"examples": [
"/Job/11"
]
},
"Table_Ref": {
"type": "array",
"minItems": 1,
"description": "An array of json-pointer references to items from other tables that are part of the event.",
"items": {
"type": "string",
"format": "json-pointer"
},
"examples": [
[
"Company/21",
"Space/105",
"Component/237"
]
]
},
"ExtIdentifier": {
"type": "string",
"description": "The unique identifier of the identified ExternalObject that would allow COBie data to be matched back to the data from which it was developed in the named ExternalSystem. This might be a GUID or ElementID.",
"examples": [
"4ec17585-c36e-4cc3-8301-61df48a06d7e-000c89be"
]
},
"ExtObject": {
"type": "string",
"description": "The name of the data object within the computer system that holds the data provided in a given row of COBie data. The default values are the associated IFC entities that are mapped (and those that are
excluded) when transforming IFC data to a given row of COBie data.",
"examples": [
"IfcSpace"
]
},
"ExtSystem": {
"type": "string",
"description": "The name of the computer system generating the row of COBie data.",
"examples": [
"Autodesk Revit 2023, Build: 20220429_1500(x64)",
"ArchiCAD 19 Full (USA) / Build: 5005",
"IBM Maximo"
]
},
"StartDate": {
"type": "string",
"format": "date-time"
},
"EndDate": {
"type": "string",
"format": "date-time"
}
},
“additionalProperties”: {
"type": "string"
}
}
]
},
"Package": {
"type": "array",
"description": "Includes information about the legal contract that required the COBie deliverable.",
"items": [
{
"type": "object",
"required": [
"Name",
"Description",
"StartDate"
],
"properties": {
"Name": {
"type": "string",
"title": "The name of the Package.",
"description": "This is the primary key for this data table and each must be unique."
},
"Description": {
"type": "string",
"description": "A general text description of the Package."
},
"Category": {
"type": "string",
"description": "The classification for the Package. This data field value comes from one of the values in COBie.PickList.Package.Category data field."
},
"Company_Ref": {
"type": "string",
"format": "json-pointer",
"examples": [
"/Company/3"
]
},
"Event_Ref": {
"type": "string",
"format": "json-pointer",
"examples": [
"/Event/909"
]
},
"ExtIdentifier": {
"type": "string",
"description": "The unique identifier of the identified ExternalObject that would allow COBie data to be matched back to the data from which it was developed in the named ExternalSystem. This might be a GUID or ElementID.",
"examples": [
"4ec17585-c36e-4cc3-8301-61df48a06d7e-000c89be"
]
},
"ExtObject": {
"type": "string",
"description": "The name of the data object within the computer system that holds the data provided in a given row of COBie data. The default values are the associated IFC entities that are mapped (and those that are excluded) when transforming IFC data to a given row of COBie data.",
"examples": [
"IfcSpace"
]
},
"ExtSystem": {
"type": "string",
"description": "The name of the computer system generating the row of COBie data.",
"examples": [
"Autodesk Revit 2023, Build: 20220429_1500(x64)",
"ArchiCAD 19 Full (USA) / Build: 5005",
"IBM Maximo"
]
},
"StartDate": {
"type": "string",
"format": "date-time"
},
"EndDate": {
"type": "string",
"format": "date-time"
}
},
“additionalProperties”: {
"type": "string"
}
}
]
},
"Risk": {
"type": "array",
"description": "Identifies the exchange of business process and exception reporting information related to other parts of a COBie deliverable.",
"items": [
{
"type": "object",
"required": [
"Name",
"Description",
"Consequence",
"LevelOfRisk",
"Likelihood"
],
"properties": {
"Name": {
"type": "string",
"title": "The name of the Risk.",
"description": "This is the primary key for this data table and each must be unique."
},
"Description": {
"type": "string",
"description": "A general text description of the Risk."
},
"Category": {
"type": "string",
"enum": [
"Change",
"Claim",
"Coordination",
"Environmental",
"Function",
"IndoorAirQuality",
"Installation",
"RFI",
"Safety",
"Specification"
],
"description": "The classification for the Risk. This data field value comes from one of the values in COBie.PickList.Risk.Category data field.",
"examples": [
[
"Environmental",
"Safety"
]
]
},
"Spatial_Ref": {
"type": "string",
"format": "json-pointer",
"examples": [
"/Space/909"
]
},
"Physical_Ref": {
"type": "string",
"format": "json-pointer",
"examples": [
"/Component/909"
]
},
"Process_Ref": {
"type": "string",
"format": "json-pointer",
"examples": [
"/Event/909"
]
},
"ExtIdentifier": {
"type": "string",
"description": "The unique identifier of the identified ExternalObject that would allow COBie data to be matched back to the data from which it was developed in the named ExternalSystem. This might be a GUID or ElementID.",
"examples": [
"4ec17585-c36e-4cc3-8301-61df48a06d7e-000c89be"
]
},
"ExtObject": {
"type": "string",
"description": "The name of the data object within the computer system that holds the data provided in a given row of COBie data. The default values are the associated IFC entities that are mapped (and those that are excluded) when transforming IFC data to a given row of COBie data.",
"examples": [
"IfcSpace"
]
},
"ExtSystem": {
"type": "string",
"description": "The name of the computer system generating the row of COBie data.",
"examples": [
"Autodesk Revit 2023, Build: 20220429_1500(x64)",
"ArchiCAD 19 Full (USA) / Build: 5005",
"IBM Maximo"
]
},
"Company_Ref": {
"type": "string",
"format": "json-pointer",
"examples": [
"/Company/3"
]
},
"Consequence": {
"type": "string",
"enum": [
"Very High",
"High",
"Moderate",
"Low",
"Unknown"
]
},
"LevelOfRisk": {
"type": "string",
"enum": [
"Very High",
"High",
"Moderate",
"Low",
"Unknown"
]
},
"Likelihood": {
"type": "string",
"enum": [
"Has Occurred",
"High",
"Moderate",
"Low",
"Unknown"
]
},
"Mitigation": {
"type": "string"
}
},
“additionalProperties”: {
"type": "string"
}
}
]
},
"Document": {
"type": "array",
"description": "Document records identify external files that provide information associated with data in a COBie deliverable.",
"items": [
{
"type": "object",
"required": [
"Name",
"Description",
"Table_Ref",
"ApprovalBy",
"Path"
],
"properties": {
"Name": {
"type": "string",
"title": "The name of the Document.",
"description": "The name of the Document. This value does not need to be unique."
},
"Description": {
"type": "string",
"description": "A general text description of the Document."
},
"Category": {
"type": "string",
"enum": [
"Certificates",
"Client Requirements",
"Closeout Submittals",
"Contract Drawings",
"Contract Modifications",
"Contract Specifications",
"Design Data",
"Design Review Comment",
"Manufacturer Field Reports",
"Manufacturer Instructions",
"Operation and Maintenance",
"Preconstruction Submittals",
"Product Data",
"Punch List Items",
"Request for Information",
"Requests for Information",
"Samples",
"Shop Drawings",
"Specifications",
"Test Reports"
],
"description": "The classification for the Document. This data field value comes from one of the values in COBie.PickList.Document.Category data field.",
"examples": [
"Contract Drawings",
"Specifications"
]
},
"Table_Ref": {
"type": "string",
"format": "json-pointer",
"description": "The element to which the document applies.",
"examples": [
"/Event/909"
]
},
"ExtIdentifier": {
"type": "string",
"description": "The unique identifier of the identified ExternalObject that would allow COBie data to be matched back to the data from which it was developed in the named ExternalSystem. This might be a GUID or ElementID.",
"examples": [
"4ec17585-c36e-4cc3-8301-61df48a06d7e-000c89be"
]
},
"ExtObject": {
"type": "string",
"description": "The name of the data object within the computer system that holds the data provided in a given row of COBie data. The default values are the associated IFC entities that are mapped (and those that are excluded) when transforming IFC data to a given row of COBie data.",
"examples": [
"IfcSpace"
]
},
"ExtSystem": {
"type": "string",
"description": "The name of the computer system generating the row of COBie data.",
"examples": [
"Autodesk Revit 2023, Build: 20220429_1500(x64)",
"ArchiCAD 19 Full (USA) / Build: 5005",
"IBM Maximo"
]
},
"ApprovalBy": {
"type": "string"
},
"Path": {
"type": "string",
"format": "uri"
},
"File": {
"type": "string",
"examples": [
"123Main_Arch_R23.rvt",
"ComissioningReport.pdf",
"n/a"
]
},
"Reference": {
"type": "string"
}
},
“additionalProperties”: {
"type": "string"
}
}
]
},
"Attribute": {
"type": "array",
"description": "Used to store custom data fields for the COBie deliverable.",
"items": [
{
"type": "object",
"required": [
"Name",
"Table_Ref",
"type",
"Unit"
],
"properties": {
"Name": {
"type": "string",
"title": "The name of the Attribute.",
"description": "The name of the Attribute. This value does not need to be unique."
},
"Description": {
"type": "string",
"description": "A general text description of the Attribute."
},
"Category": {
"type": "string",
"description": "The classification for the Attribute."
},
"Table_Ref": {
"type": "string",
"format": "json-pointer",
"description": "The element to which the attribute applies.",
"examples": [
"/Space/42"
]
},
"ExtIdentifier": {
"type": "string",
"description": "The unique identifier of the identified ExternalObject that would allow COBie data to be matched back to the data from which it was developed in the named ExternalSystem. This might be a GUID or ElementID.",
"examples": [
"4ec17585-c36e-4cc3-8301-61df48a06d7e-000c89be"
]
},
"ExtObject": {
"type": "string",
"description": "The name of the data object within the computer system that holds the data provided in a given row of COBie data. The default values are the associated IFC entities that are mapped (and those that are excluded) when transforming IFC data to a given row of COBie data.",
"examples": [
"IfcSpace"
]
},
"ExtSystem": {
"type": "string",
"description": "The name of the computer system generating the row of COBie data.",
"examples": [
"Autodesk Revit 2023, Build: 20220429_1500(x64)",
"ArchiCAD 19 Full (USA) / Build: 5005",
"IBM Maximo"
]
},
"Value": {
"type": "string",
"examples": [
"123",
"1200.56"
]
},
"Unit": {
"type": "string",
"examples": [
"meter"
]
},
"AllowedValues": {
"type": "string",
"description": "A comma separated list of one or more allowed values for the “Value” data field of a particular item on the “Attribute” data table.",
"examples": [
"Inlet, Outlet",
"5kVA, 10kVA, 15kVA",
"Fixed, Variable",
"n/a"
]
}
},
“additionalProperties”: {
"type": "string"
}
}
]
},
"Coordinate": {
"type": "array",
"description": "Represents the simple geometric information associated with data in a COBie deliverable.",
"items": [
{
"type": "object",
"required": [
"Name",
"Table_Ref",
"CoordinateXAxis",
"CoordinateYAxis",
"CoordinateZAxis",
"ClockwiseRotation",
"ElevationalRotation",
"YawRotation"
],
"properties": {
"Name": {
"type": "string",
"title": "The name of the Coordinate.",
"description": "The name of the Coordinate. This value does not need to be unique."
},
"Category": {
"type": "string",
"enum": [
"Point",
"Line-end-one",
"Line-end-two",
"Box-lowerleft",
"Box-upperright"
],
"description": "The classification for the Coordinate. This data field value comes from one of the values in COBie.PickList.Coordinate.Category data field."
},
"Table_Ref": {
"type": "string",
"format": "json-pointer",
"description": "The element to which the coordinate applies.",
"examples": [
"/Space/42"
]
},
"ExtIdentifier": {
"type": "string",
"description": "The unique identifier of the identified ExternalObject that would allow COBie data to be matched back to the data from which it was developed in the named ExternalSystem. This might be a GUID or ElementID.",
"examples": [
"4ec17585-c36e-4cc3-8301-61df48a06d7e-000c89be"
]
},
"CoordinateXAxis": {
"type": "number"
},
"CoordinateYAxis": {
"type": "number"
},
"CoordinateZAxis": {
"type": "number"
},
"ClockwiseRotation": {
"type": "number"
},
"ElevationalRotation": {
"type": "number"
},
"YawRotation": {
"type": "number"
},
"RelativeTo": {
"type": "string"
},
"ExtObject": {
"type": "string",
"description": "The name of the data object within the computer system that holds the data provided in a given row of COBie data. The default values are the associated IFC entities that are mapped (and those that are excluded) when transforming IFC data to a given row of COBie data.",
"examples": [
"IfcSpace"
]
},
"ExtSystem": {
"type": "string",
"description": "The name of the computer system generating the row of COBie data.",
"examples": [
"Autodesk Revit 2023, Build: 20220429_1500(x64)",
"ArchiCAD 19 Full (USA) / Build: 5005",
"IBM Maximo"
]
}
},
“additionalProperties”: {
"type": "string"
}
}
]
}
}
}
National BIM Standard-United States® (NBIMS-US™) Version 4
The NBIMS-US™ v4 is a consensus-based national-level standard focused on defining standard approaches and guidelines to defining requirements, planning BIM adoption, and exchanging information between project team members. MORE
