Schemas / BIM / OpenBIM

rig.bim.spec

v0.31.0 · draft 5 fields 0 required

Fields

FieldTypeMeaning
ifcVersion enumifc2x3 · ifc4 · ifc4x3 optional Optional. ifc2x3, ifc4, or ifc4x3; absent = any
description string optional Optional. Human description; absent = empty
instructions string optional Optional. Authoring instructions; absent = empty
applicability array<entity> optional Optional. rig.bim.facet entities that select which elements apply; absent = none
requirements array<entity> optional Optional. rig.bim.facet entities that must hold; absent = none

One IDS specification (requirements check). Format when present.

A document may carry specs with no building model, or a model with no specs. Compose rig.meta.named for the specification name.

JSON Schema

Resolves at https://rig.works/schemas/rig.bim.spec.schema.jsonraw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.bim.spec.schema.json",
  "title": "rig.bim.spec",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ifcVersion": {
      "type": "string",
      "enum": [
        "ifc2x3",
        "ifc4",
        "ifc4x3"
      ]
    },
    "description": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "instructions": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "applicability": {
      "type": "array",
      "items": {
        "$ref": "./_defs.schema.json#/$defs/entity"
      }
    },
    "requirements": {
      "type": "array",
      "items": {
        "$ref": "./_defs.schema.json#/$defs/entity"
      }
    }
  }
}

Seen in

bim-ids.json