mod-dlm logo
API docs by Redocly

mod-dlm API (1.1.0)

Download OpenAPI specification:

Contact us: info@mod.construction URL: https://mod.construction License: MIT

mod-dlm is an open source domain specific language to describe prefab construction elements. This project provides tools for defining entity models and automatically generating CRUD APIs, enabling suppliers to create and manage catalogs of their products easily.

Get an element

Gets an element from the database.

Authorizations:
(apiKeybearer)
path Parameters
id
required
string <uuid> (ElementId)
Example: 4dd643ff-7ec7-4666-9c88-50b7d3da34e4

A unique identifier for an element

Responses

Response samples

Content type
application/json
{
  • "id": "4dd643ff-7ec7-4666-9c88-50b7d3da34e4",
  • "versionMetadata": {
    },
  • "name": "Cross-Laminated Timber Wall Panel",
  • "description": "This CLT wall panel is suitable for multi-story residential buildings and meets fire resistance standards.",
  • "boundingBox": {
    },
  • "images": [],
  • "productCategory": {
    },
  • "material": {
    },
  • "dimensional": {
    },
  • "structuralProperties": {
    },
  • "performance": {
    },
  • "sustainability": {
    },
  • "documentationAndCompliance": {
    },
  • "installationAndConnectivity": {
    },
  • "lifecycleAndMaintenance": {
    },
  • "aestheticAndCustomizationOptions": {
    },
  • "economicFactors": {
    },
  • "ifcType": "IfcWallStandardCase",
  • "bimModelUrl": "https://example.com/models/clt-wall.ifc"
}

Create a new element

Creates a new element in the database.

Authorizations:
(apiKeybearer)
Request Body schema: application/json

The element to create.

required
object

Versioning and publishing status metadata of the element.

name
required
string non-empty

Human-readable name of the prefab element.

description
required
string non-empty

Detailed description of the prefab element, including its intended use or application.

required
object

3D bounding dimensions of the prefab element, defining its spatial envelope.

images
required
Array of strings non-empty

List of image URLs showing the prefab element from various angles.

required
object

Product category classification (e.g., Wall Panels, Stairs, Facade Elements).

required
object

Material and physical properties of the prefab element.

required
object

Dimensional characteristics of the prefab element.

object

Optional structural performance details like capacity, stiffness, or seismic resistance.

object

Optional performance metrics related to strength, insulation, or soundproofing.

object

Sustainability attributes of the element.

object

Optional metadata linking to certificates, spec sheets, or regulatory documents.

object

Describes how the prefab element is installed and what structural systems it is compatible with.

object

Optional data describing maintenance schedules or expected lifecycle.

object

Optional aesthetic options like finishes or material variations.

object

Optional cost estimation, lead time, and supply constraints.

ifcType
string
Enum: "IfcBeam" "IfcChimney" "IfcColumn" "IfcCovering" "IfcCurtainWall" "IfcDoor" "IfcFooting" "IfcMember" "IfcPile" "IfcPlate" "IfcRailing" "IfcRamp" "IfcRampFlight" "IfcRoof" "IfcShadingDevice" "IfcSlab" "IfcStair" "IfcStairFlight" "IfcWall" "IfcWallStandardCase" "IfcWindow" "IfcBuildingElementProxy"

IFC Building Element types based on IFC 4.3 used in BIM tools for semantic classification. (e.g., IfcWall, IfcSlab).

bimModelUrl
string <uri>

Optional URL pointing to a downloadable BIM model or online viewer for the element.

Responses

Request samples

Content type
application/json
{
  • "versionMetadata": {
    },
  • "name": "Cross-Laminated Timber Wall Panel",
  • "description": "This CLT wall panel is suitable for multi-story residential buildings and meets fire resistance standards.",
  • "boundingBox": {
    },
  • "images": [],
  • "productCategory": {
    },
  • "material": {
    },
  • "dimensional": {
    },
  • "structuralProperties": {
    },
  • "performance": {
    },
  • "sustainability": {
    },
  • "documentationAndCompliance": {
    },
  • "installationAndConnectivity": {
    },
  • "lifecycleAndMaintenance": {
    },
  • "aestheticAndCustomizationOptions": {
    },
  • "economicFactors": {
    },
  • "ifcType": "IfcWallStandardCase",
  • "bimModelUrl": "https://example.com/models/clt-wall.ifc"
}

Response samples

Content type
application/json
{
  • "id": "4dd643ff-7ec7-4666-9c88-50b7d3da34e4",
  • "versionMetadata": {
    },
  • "name": "Cross-Laminated Timber Wall Panel",
  • "description": "This CLT wall panel is suitable for multi-story residential buildings and meets fire resistance standards.",
  • "boundingBox": {
    },
  • "images": [],
  • "productCategory": {
    },
  • "material": {
    },
  • "dimensional": {
    },
  • "structuralProperties": {
    },
  • "performance": {
    },
  • "sustainability": {
    },
  • "documentationAndCompliance": {
    },
  • "installationAndConnectivity": {
    },
  • "lifecycleAndMaintenance": {
    },
  • "aestheticAndCustomizationOptions": {
    },
  • "economicFactors": {
    },
  • "ifcType": "IfcWallStandardCase",
  • "bimModelUrl": "https://example.com/models/clt-wall.ifc"
}