SearchRequest

FieldTypeDescription

fulltext

String

Fulltext criteria for query

Note:

Supports the same search operators as search dialog: "+", "|", "-", etc.

preResultSpaceId

String

Reserved for future use, leave empty

objectTypes

String[...]

List of object types for search, using the specialization name

Note:

Topic specialization will not return concepts, and to find all types of topics, you must specify them all.

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

status

String[...]

List of statuses for search, using the full status name, such as "Authoring:work"

Note:

If this field is empty, the search includes all status types.

lock

LockState

List of the specific lock states for search

Note:

Lock states values are:

  • NOT_LOCKED
  • LOCKED_BY_ME
  • LOCKED_BY_OTHERS
Note:

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

branches

String[...]

List of branches for search, with each branch represented by the full path of the branch object (*.version)

Note:

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

Note:

For example, a sub-query can include one or more maps in which to run the search.

Note:

Set to null if not used.

criteria

SortCriteria[…]

Sort criteria used for search

Note:

Sort criteria values are:

  • SORT_RELEVANCY
  • SORT_TITLE
  • SORT_TITLE_REVERSE
  • SORT_MOD_DATE
  • SORT_MOD_DATE_REVERSE

returnDocumentFragment

Boolean

Indicates whether the CCMS should return the elements with IDs in each topic

Note:

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.

Note:

  • Applies when searching topics for content to insert as a conref or a cross-reference.

  • Only applies to topics with the referable-content type.