Get project object metadata

GET 
/projects/:projectId/metadata/:objectId

Get project object metadata

Request

Path Parameters

projectId stringrequired
objectId int32required

Responses

200

Success

application/json

Schema

Schema

id int64required

Object id in database

path stringrequired

Object path in hierarchy

type NodeTyperequired

Possible values: [Internal, Leaf]

Object hierarchy node type.

bounds object

Object's bounding volume.

box objectrequired

Axis-aligned bounding box

min double[]required

minimum coordinates

max double[]required

maximum coordinates

sphere objectrequired

Bounding sphere

center double[]required

Sphere center.

radius doublerequired

Sphere radius.

name stringrequired

Name of object (typically a GUID from IFC database)

description stringnullable

Description of object (typically from IFC database)

url stringnullable

Url associated with object

properties array[]nullable

String dictionary of any additional metadata properties associated with object

Example (from schema)

{
  "name": "string",
  "description": "string",
  "url": "string",
  "properties": [
    [
      "Property 1",
      "Value 1"
    ],
    [
      "Property 2",
      "2"
    ]
  ],
  "id": 1234,
  "path": "Path0/Subpath0/ObjectName",
  "type": "Internal",
  "bounds": {
    "box": {
      "min": [
        -1,
        -1,
        -1
      ],
      "max": [
        1,
        1,
        1
      ]
    },
    "sphere": {
      "center": [
        0,
        0,
        0
      ],
      "radius": 1
    }
  }
}

401

Unauthorized

404

Not Found

500

Server Error

Loading...