Schemas / BIM / OpenBIM

rig.bim.topic

v0.31.0 · draft 11 fields 0 required

Fields

FieldTypeMeaning
topicType string optional Optional. Topic type (Clash, Issue, ...); absent = unset
topicStatus string optional Optional. Status (Open, Closed, ...); absent = unset
priority string optional Optional. Priority label; absent = unset
assignedTo string optional Optional. Assignee; absent = unset
labels array<string> optional Optional. Labels; order carries no meaning
stage string optional Optional. Project stage; absent = unset
description string optional Optional. Body text; absent = empty
dueAt string optional Optional. Due date/time (ISO-8601); absent = unset
createdBy string optional Optional. Author; absent = unset
createdAt string optional Optional. Creation time (ISO-8601); absent = unset
modifiedAt string optional Optional. Last modification (ISO-8601); absent = unset

BCF issue / topic. Format when present.

Compose rig.meta.named for the topic title; BCF guid becomes stableId. Comments and viewpoints reference this entity.

JSON Schema

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.bim.topic.schema.json",
  "title": "rig.bim.topic",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "topicType": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "topicStatus": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "priority": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "assignedTo": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "labels": {
      "type": "array",
      "items": {
        "$ref": "./_defs.schema.json#/$defs/string"
      }
    },
    "stage": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "description": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "dueAt": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "createdBy": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "createdAt": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "modifiedAt": {
      "$ref": "./_defs.schema.json#/$defs/string"
    }
  }
}

Seen in

bim-bcf.json