mod-dlm logo
API docs by Redocly

mod-dlm API (1.0.7)

Download OpenAPI specification:Download

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",
  • "name": "string",
  • "description": "string",
  • "boundingBox": {
    },
  • "images": [
    ],
  • "buildingSystem": "Wall",
  • "productCategory": "Boarding",
  • "material": {
    },
  • "dimensional": {
    },
  • "structuralProperties": {
    },
  • "performance": {
    },
  • "sustainability": {
    },
  • "documentationAndCompliance": {
    },
  • "installationAndConnectivity": {
    },
  • "lifecycleAndMaintenance": {
    },
  • "aestheticAndCustomizationOptions": {
    },
  • "economicFactors": {
    }
}

Create a new element

Creates a new element in the database.

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

The element to create.

name
required
string
description
required
string
required
object

The bounding box of an element in millimeters.

images
required
Array of strings
buildingSystem
required
string
Enum: "Wall" "Balcony" "Pod" "Frame" "Facade" "Floors" "Modules" "Plants" "Roofs" "Stairs"
productCategory
required
string
Enum: "Boarding" "Solid Wall Panels" "Closed Wall Panels" "Twinwall" "Open Wall Panels" "Structural Insulated Panels (SIPs)" "Insulated Concrete Panels" "Prefabricated Balcony" "Pod" "Whole Building System" "Structural Frame" "Facade System" "Hollowcore Floor" "Concrete Lattice Floor" "Floor Cassettes" "Solid Floor Panels" "Volumetric module" "Prefabricated Plant" "Roof Panel" "Roof Truss" "Prefabricated Stairs"
required
object
required
object
object
object
object
object
object
object
object
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "boundingBox": {
    },
  • "images": [
    ],
  • "buildingSystem": "Wall",
  • "productCategory": "Boarding",
  • "material": {
    },
  • "dimensional": {
    },
  • "structuralProperties": {
    },
  • "performance": {
    },
  • "sustainability": {
    },
  • "documentationAndCompliance": {
    },
  • "installationAndConnectivity": {
    },
  • "lifecycleAndMaintenance": {
    },
  • "aestheticAndCustomizationOptions": {
    },
  • "economicFactors": {
    }
}

Response samples

Content type
application/json
{
  • "id": "4dd643ff-7ec7-4666-9c88-50b7d3da34e4",
  • "name": "string",
  • "description": "string",
  • "boundingBox": {
    },
  • "images": [
    ],
  • "buildingSystem": "Wall",
  • "productCategory": "Boarding",
  • "material": {
    },
  • "dimensional": {
    },
  • "structuralProperties": {
    },
  • "performance": {
    },
  • "sustainability": {
    },
  • "documentationAndCompliance": {
    },
  • "installationAndConnectivity": {
    },
  • "lifecycleAndMaintenance": {
    },
  • "aestheticAndCustomizationOptions": {
    },
  • "economicFactors": {
    }
}