SearchRequest

FieldTypeDescription

fulltext

String

Fulltext criteria for the query. It supports the same search operators as the search dialog: "+", "|", "-", etc.

preResultSpaceId

String

Leave empty.

objectTypes

String[]

List of types to search for. Uses the specialization name. For example, "topic" will not return concepts. To find all types of topics, you must specifies them all.

If this field is empty, the search includes all objects.

status

String[]

List of statuses to search for. Use the full status name such as "Authoring:work".

If this field is empty, the search includes all statuses.

lock

LockState[]

List of the specific lock state to search for. The lock states are:

  • NOT_LOCKED

  • LOCKED_BY_ME

  • LOCKED_BY_OTHERS

If this field is empty, the search includes all lock states.

branches

String[]

List of branches to search in. Each branch is represented by the full path of the branch object (*.version).

If this field is empty, the search applies to the entire repository.

This field applies to DRM only: it has no effect when used in Standard mode.

subQuery

SubQuery

Query to execute first to provide a context for the main query. For example, a sub-query can be one or more maps in which to run the search.

Set to null if not used.

criteria

SortCriteria[]

Sort criteria to use for the search. The sort criteria are:

  • SORT_RELEVANCY

  • SORT_TITLE

  • SORT_TITLE_REVERSE

  • SORT_MOD_DATE

  • SORT_MOD_DATE_REVERSE

Although this field is defined as an array, it supports only one value.

returnDocumentFragment

Boolean

Indicates whether the CCMS should return the elements with IDs in each topic. This applies when searching topics for content to insert as a conref or a cross-reference.

This only applies to topics of type "referable-content".

Requesting the document fragment requires additional processing of the search results so it can impact the time of the search operation if the results contain a lot of referable-content topics.