Returns a list of items with complex filtering.

POST

/{workspaceIdOrAlias}/projects/{projectIdOrAlias}/models/{modelIdOrKey}/items/filter

Returns a list of items with complex filtering in request body.

Authorizations

• bearerAuth

Parameters

Path Parameters

workspaceIdOrAlias

required

string

ID or alias of the workspace

projectIdOrAlias

required

string

ID or alias of the project

modelIdOrKey

required

string

ID or key of the model in the project

Query Parameters

sort

string

default: createdAt

Allowed values: createdAt updatedAt

Used to define the order of the response list

dir

string

default: desc

Allowed values: asc desc

Used to define the order direction of the response list, will be ignored if the order is not presented

page

integer

default: 1 >= 1

Used to select the page

perPage

integer

default: 50 >= 1 <= 100

Used to select the page

ref

string

default: latest

Allowed values: latest public

Used to select a ref or ver

asset

string

Allowed values: all true false

Specifies whether asset data are embedded in the results

keyword

string

Keyword string

Request Body ^required

object

filter

object

and

Array<object> recursive

or

Array<object> recursive

basic

object

fieldId

object

fieldId

string

type

string

Allowed values: id creationDate creationUser modificationDate modificationUser status field metaField

operator

string

Allowed values: equals notEquals

value

nullable

object

fieldId

object

fieldId

string

type

string

Allowed values: id creationDate creationUser modificationDate modificationUser status field metaField

operator

string

Allowed values: empty notEmpty

multiple

object

fieldId

required

object

fieldId

string

type

string

Allowed values: id creationDate creationUser modificationDate modificationUser status field metaField

operator

required

string

Allowed values: includesAny notIncludesAny includesAll notIncludesAll

value

required

Array

bool

object

fieldId

required

object

fieldId

string

type

string

Allowed values: id creationDate creationUser modificationDate modificationUser status field metaField

operator

required

string

Allowed values: equals notEquals

value

required

boolean

string

object

fieldId

required

object

fieldId

string

type

string

Allowed values: id creationDate creationUser modificationDate modificationUser status field metaField

operator

required

string

Allowed values: contains notContains startsWith endsWith notStartsWith notEndsWith

value

required

string

number

object

fieldId

required

object

fieldId

string

type

string

Allowed values: id creationDate creationUser modificationDate modificationUser status field metaField

operator

required

string

Allowed values: greaterThan lessThan greaterThanOrEqualTo lessThanOrEqualTo

value

required

number

time

object

fieldId

required

object

fieldId

string

type

string

Allowed values: id creationDate creationUser modificationDate modificationUser status field metaField

operator

required

string

Allowed values: before after beforeOrOn afterOrOn ofThisWeek ofThisMonth ofThisYear

value

required

string format: date-time

Responses

200

Paginated list of items

object

items

Array

object

id

string

metadataItemId

string

originalItemId

string

modelId

string

fields

Array<object>

object

id

string

type

string

Allowed values: text textArea richText markdown checkbox asset date bool select integer number reference url group tag geometryObject geometryEditor

value

key

string

group

string

metadataFields

Array<object>

object

id

string

type

string

Allowed values: text textArea richText markdown checkbox asset date bool select integer number reference url group tag geometryObject geometryEditor

value

key

string

group

string

referencedItems

Array<object>

object

id

string

metadataItemId

string

originalItemId

string

modelId

string

fields

Array<object>

object

id

string

type

string

Allowed values: text textArea richText markdown checkbox asset date bool select integer number reference url group tag geometryObject geometryEditor

value

key

string

group

string

metadataFields

Array<object>

object

id

string

type

string

Allowed values: text textArea richText markdown checkbox asset date bool select integer number reference url group tag geometryObject geometryEditor

value

key

string

group

string

referencedItems

Array<object> recursive

createdAt

string format: date-time

isMetadata

boolean

updatedAt

string format: date-time

createdAt

string format: date-time

isMetadata

boolean

updatedAt

string format: date-time

version

string format: uuid

parents

Array<string>

refs

Array<string>

referencedItems

Array recursive

totalCount

integer

page

integer

>= 1

perPage

integer

>= 1

400

Invalid request parameter value

401

Access token is missing or invalid

404

Not found

500

Internal server error