Schemas / BIM / OpenBIM

rig.bim.pset

v0.31.0 · draft 1 field 1 required

Fields

FieldTypeMeaning
sets array<object> required Property sets; each has name and properties

Property sets on a BIM element or type. Format when present.

Each set:

Each property:

Serialize name, type, and only the value field that type selects. Omit the others.

Do not reuse rig.node.param’s f / i / s / v slots. Area, volume, fire rating, and other typed parameters belong here - not on rig.meta.tags.

JSON Schema

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.bim.pset.schema.json",
  "title": "rig.bim.pset",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "sets": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "name",
          "properties"
        ],
        "properties": {
          "name": {
            "$ref": "./_defs.schema.json#/$defs/string"
          },
          "properties": {
            "type": "array",
            "items": {
              "type": "object",
              "oneOf": [
                {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "name",
                    "type",
                    "flag"
                  ],
                  "properties": {
                    "name": {
                      "$ref": "./_defs.schema.json#/$defs/string"
                    },
                    "type": {
                      "const": "bool"
                    },
                    "flag": {
                      "$ref": "./_defs.schema.json#/$defs/bool"
                    },
                    "unit": {
                      "$ref": "./_defs.schema.json#/$defs/string"
                    }
                  }
                },
                {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "name",
                    "type",
                    "integer"
                  ],
                  "properties": {
                    "name": {
                      "$ref": "./_defs.schema.json#/$defs/string"
                    },
                    "type": {
                      "const": "int"
                    },
                    "integer": {
                      "$ref": "./_defs.schema.json#/$defs/int"
                    },
                    "unit": {
                      "$ref": "./_defs.schema.json#/$defs/string"
                    }
                  }
                },
                {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "name",
                    "type",
                    "number"
                  ],
                  "properties": {
                    "name": {
                      "$ref": "./_defs.schema.json#/$defs/string"
                    },
                    "type": {
                      "const": "float"
                    },
                    "number": {
                      "$ref": "./_defs.schema.json#/$defs/float"
                    },
                    "unit": {
                      "$ref": "./_defs.schema.json#/$defs/string"
                    }
                  }
                },
                {
                  "type": "object",
                  "additionalProperties": false,
                  "required": [
                    "name",
                    "type",
                    "text"
                  ],
                  "properties": {
                    "name": {
                      "$ref": "./_defs.schema.json#/$defs/string"
                    },
                    "type": {
                      "const": "string"
                    },
                    "text": {
                      "$ref": "./_defs.schema.json#/$defs/string"
                    },
                    "unit": {
                      "$ref": "./_defs.schema.json#/$defs/string"
                    }
                  }
                }
              ]
            }
          }
        }
      }
    }
  },
  "required": [
    "sets"
  ]
}

Seen in

bim-model.json