/assets/Comment/search/

post

https://{sub_domain}.enablemyteam.com/aimsapi/assets/Comment/search/

Filter the existing comment assets. Filtering can be done for nested fields also.e.g: attribute.Document, relations.tag_code

Query Params

filter

string

give attributes to filter in json format. e.g:{'contract': 'AV5wg5Mr35xqwtsjC8Yu','class': {'fieldValue':['Battery Recessed Lamp'],'contains':'s'}}

Body Params

contract

string

required

length ≥ 1

filter assets using the contractId

relationsLevel

integer

Defaults to 1

You can specify max number of relationship levels to search.

module_name

string

length ≥ 1

module name is only required, when actions is needed

pageSize

integer

Defaults to 500

give the number of documents you want.

page

integer

Defaults to 1

Give the page number

sortKey

string

length ≥ 1

To sort the results by given key

sortOrder

string

enum

Defaults to asc

asc - asc
desc - desc

Allowed:

fieldsIncluded

array of strings

Give the extra fields(Other than given in response documentation) you want in response. For attributes, mention the attribute you want By default all attributes will be retrieved.

example:

1: To get specific attributes: ["attribute.Document Name"]

2: To get geometry field: ["geometry"]

3: To get only specific geometry field: ["geometry.type"]

4: To get all attributes: ["attribute.*"]

fieldsIncluded

search_text

string

length ≥ 1

Get assets according to given value matched with any field

. We need to pass the strings inside \ "(With no space between these two characters), Operators like AND, OR, and NOT can be used to combine multiple terms.

e.g:

1.\ "Battery Recessed Lamp\ ".

2.\ "M.E.P Facilities & Its Maintenance\ " OR \ "Centralized Battery Lighting\ ".

allowedAssetClassCode

array of strings

class_codes which you want in relations data.

Three flags available as:

--orphaned=Get orphaned assets only,

--without_children=Get assets which doesnt have children,

--without_parent=Get assets which doesnt have parent assets.

Combination of --without_children and --without_parent gives orphaned assets.

--without_children and --without_parent can be combined with class_codes to allow in relations.

allowedAssetClassCode

filteredAssetClassCode

array of strings

class_codes which needs to be excluded from relations data

filteredAssetClassCode

class_code

object

filterOptions to give as type text

changeset

object

User can filter assets according to a given changeset. If changeset provided, then it will give assets of all change_flag(We can further apply filter on change_flag to fetch a specific one of that changeset). If changeset not provided, it will give assets of change_flag latest, pending, archived only

change_flag

object

Filter assets according to change_flag. If changeset and change_flag not given, then default change_flags returned are latest, pending, archived

function

object

filterOptions to give as type text

discipline

object

filterOptions to give as type text

sub_discipline

object

filterOptions to give as type text

sub_functional_unit

object

filterOptions to give as type text

matchingOperator

string

enum

Defaults to AND

AND - AND
OR - OR
NOT - NOT

Allowed:

doc_tag_codes

array of strings

List of document tag_codes to load the comment related to them. Either it will contain a single pack tag_code, or one or more individual document tag_code

doc_tag_codes

Response

200