Search objects in project

POST 
/projects/:sceneId/search

Returns subset of objects matched complicated search criterias with optional continuation token if needed

Request

Path Parameters

sceneId stringrequired

application/json

Body

path stringnullable

Path to search start from.

descendants int32nullable

How many generations of descendants to include in search.

search

object[]

nullable

Property pattern to search for.

Array [

property stringnullable

Property name to find.

value string[]nullable

Value to find.

exact booleannullable

Require exact match or not.

exclude booleannullable

Exclude this match from result.

range

object

Values range

min stringnullable

Minimal value.

max stringnullable

Maxumum value.

planes array[]nullable

Clipping planes.

Example: [[1,0,0,0],[0,1,0,0]]

]

full booleannullable

Preload all matching objects.

continuation stringnullable

Continuation token.

Responses

200

Success

application/json

Schema

Schema

results

object[]

required

Search results array.

Depending on "full" request param:

true - Server.Models.ObjectMetadata,

false/undefined - Server.Models.ObjectReference

Array [

oneOf

ObjectReference

Object's reference.

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

ObjectMetadata

Object's metadata.

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

]

continuation stringnullable

Continuation token

Example (from schema)

{
  "results": [
    {},
    {}
  ],
  "continuation": "string"
}

text/plain

Schema

Schema

results

object[]

required

Search results array.

Depending on "full" request param:

true - Server.Models.ObjectMetadata,

false/undefined - Server.Models.ObjectReference

Array [

oneOf

ObjectReference

Object's reference.

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

ObjectMetadata

Object's metadata.

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

]

continuation stringnullable

Continuation token

Example (from schema)

{
  "results": [
    {},
    {}
  ],
  "continuation": "string"
}

401

Unauthorized

404

Not Found

500

Server Error

Loading...