Skip to main content

Get project object metadata

GET 
/projects/:sceneId/metadata/:objectId

Get project object metadata

Request​

Path Parameters

    sceneId stringrequired
    objectId int32required

Responses​

Success

Schema

    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: [["Property 1","Value 1"],["Property 2","2"]]
    id int64required

    Object id in database

    Example: 1234
    path stringrequired

    Object path in hierarchy

    Example: Path0/Subpath0/ObjectName
    type NodeType (string)required

    Object hierarchy node type.

    Possible values: [Internal, Leaf]

    bounds

    object

    Object's bounding volume.

    box

    object

    required

    Axis-aligned bounding box

    min double[]required

    minimum coordinates

    Example: [-1,-1,-1]
    max double[]required

    maximum coordinates

    Example: [1,1,1]

    sphere

    object

    required

    Bounding sphere

    center double[]required

    Sphere center.

    Example: [0,0,0]
    radius doublerequired

    Sphere radius.

    Example: 1
Loading...