Search API

Abstract
REST API for searching in OMN (Online Media Net): full-text and combined queries, type-ahead, suggestions, stored searches and index management.

Access

  • Bearer Authentication

Endpoints

Documents

PATCH /api/v1/search/documents

Update documents

Description

Processes document updates for a specific index

Parameters
Body Parameter
Name Description Required Default Pattern

DocumentUpdateRequestDto

Document update request containing the documents to be updated DocumentUpdateRequestDto

X
Return Type

-

Responses
Table 1. HTTP Response Codes
Code Message Datatype

200

Documents updated successfully

POST /api/v1/search/documents/wait

Wait for documents

Description

Waits for document updates to be processed with configurable timeout

Parameters
Body Parameter
Name Description Required Default Pattern

DocumentWaitRequestDto

Document wait request containing the documents to wait for and timeout configuration DocumentWaitRequestDto

X
Return Type

-

Responses
Table 2. HTTP Response Codes
Code Message Datatype

200

Documents processed successfully

404

Documents not found or processing timed out

History

POST /api/v1/search/history

Add history entry

Description

Adds a new entry to the search history

Parameters
Body Parameter
Name Description Required Default Pattern

HistoryAddDto

History add request containing the entry to be added to search history HistoryAddDto

X
Return Type

HistoryAddResultDto

Content Type

  • application/json

Responses
Table 3. HTTP Response Codes
Code Message Datatype

200

History entry added successfully

HistoryAddResultDto

DELETE /api/v1/search/history

Delete history entries

Description

Deletes history entries based on user and context

Parameters
Body Parameter
Name Description Required Default Pattern

HistoryDeleteDto

History delete request containing parameters for deleting history entries HistoryDeleteDto

X
Return Type

HistoryDeleteResultDto

Content Type

  • application/json

Responses
Table 4. HTTP Response Codes
Code Message Datatype

200

History entries deleted successfully

HistoryDeleteResultDto

POST /api/v1/search/history/query

Query history entries

Description

Retrieves history entries based on the provided query parameters

Parameters
Body Parameter
Name Description Required Default Pattern

HistoryQueryDto

History query request containing parameters for retrieving history entries HistoryQueryDto

X
Return Type

HistoryQueryResultDto

Content Type

  • application/json

Responses
Table 5. HTTP Response Codes
Code Message Datatype

200

History entries retrieved successfully

HistoryQueryResultDto

Index

POST /api/v1/search/index

Process index command

Description

Processes an index command and returns the result

Parameters
Body Parameter
Name Description Required Default Pattern

IndexCommandDto

Index command request containing the command to be processed IndexCommandDto

X
Return Type

IndexResultDto

Content Type

  • application/json

Responses
Table 6. HTTP Response Codes
Code Message Datatype

200

Successful operation

IndexResultDto

GET /api/v1/search/index/state

List index states

Description

Returns a list of all index states

Return Type

IndexStateItemDto

Content Type

  • application/json

Responses
Table 7. HTTP Response Codes
Code Message Datatype

200

Successful operation

IndexStateItemDto[[AnyType]]

GET /api/v1/search/index

List indices

Description

Returns a list of all available indices

Return Type

IndexItemDto

Content Type

  • application/json

Responses
Table 8. HTTP Response Codes
Code Message Datatype

200

Successful operation

IndexItemDto[[AnyType]]

Search

GET /api/v1/search/search/fields

Fetch field configurations for index

Description

Returns field configurations for the specified index type

Parameters
Query Parameters
Name Description Required Default Pattern

indexType

X
Return Type

FieldCfgDto

Content Type

  • application/json

Responses
Table 9. HTTP Response Codes
Code Message Datatype

200

Successful operation

FieldCfgDto[[AnyType]]

POST /api/v1/search/search/fields

Fetch field configurations with operators

Description

Returns field configurations with operators based on the provided field information request

Parameters
Body Parameter
Name Description Required Default Pattern

FieldInfoRequestDto

Field information request containing parameters for retrieving field configurations with operators FieldInfoRequestDto

X
Return Type

FieldCfgDto

Content Type

  • application/json

Responses
Table 10. HTTP Response Codes
Code Message Datatype

200

Successful operation

FieldCfgDto[[AnyType]]

POST /api/v1/search/search

Perform search

Description

Executes a search based on the provided search criteria

Parameters
Body Parameter
Name Description Required Default Pattern

SearchDto

Search request containing the search criteria SearchDto

X
Return Type

SearchResultDto

Content Type

  • application/json

Responses
Table 11. HTTP Response Codes
Code Message Datatype

200

Successful operation

SearchResultDto

StoredSearch

DELETE /api/v1/search/storedsearch/{id}

Delete stored search

Description

Deletes a stored search by ID

Parameters
Path Parameters
Name Description Required Default Pattern

id

ID of the stored search to delete

X
Return Type

-

Responses
Table 12. HTTP Response Codes
Code Message Datatype

204

Stored search deleted successfully

404

Stored search not found

GET /api/v1/search/storedsearch/{id}

Load stored search by ID

Description

Retrieves a specific stored search by its ID

Parameters
Path Parameters
Name Description Required Default Pattern

id

ID of the stored search to retrieve

X
Return Type

SearchDto

Content Type

  • application/json

Responses
Table 13. HTTP Response Codes
Code Message Datatype

200

Stored search retrieved successfully

SearchDto

404

Stored search not found

SearchDto

GET /api/v1/search/storedsearch

Load stored searches

Description

Retrieves stored searches based on optional index type and configuration ID

Parameters
Query Parameters
Name Description Required Default Pattern

index

Index type to filter stored searches

-

configId

Configuration ID to filter stored searches

-
Return Type

StoredSearchListResultDto

Content Type

  • application/json

Responses
Table 14. HTTP Response Codes
Code Message Datatype

200

Stored searches retrieved successfully

StoredSearchListResultDto

POST /api/v1/search/storedsearch

Store a search

Description

Creates a new stored search

Parameters
Body Parameter
Name Description Required Default Pattern

StoredSearchInsertDto

Stored search insert request containing the search to be stored StoredSearchInsertDto

X
Return Type

StoredSearchOperationResultDto

Content Type

  • application/json

Responses
Table 15. HTTP Response Codes
Code Message Datatype

201

Search stored successfully

StoredSearchOperationResultDto

PATCH /api/v1/search/storedsearch/{id}

Update stored search

Description

Updates an existing stored search by ID

Parameters
Path Parameters
Name Description Required Default Pattern

id

ID of the stored search to update

X
Body Parameter
Name Description Required Default Pattern

StoredSearchDto

Stored search update request containing the updated search data StoredSearchDto

X
Return Type

StoredSearchOperationResultDto

Content Type

  • application/json

Responses
Table 16. HTTP Response Codes
Code Message Datatype

200

Stored search updated successfully

StoredSearchOperationResultDto

404

Stored search not found

StoredSearchOperationResultDto

Suggest

POST /api/v1/search/suggest

Get suggestions

Description

Retrieves search suggestions based on the provided criteria

Parameters
Body Parameter
Name Description Required Default Pattern

SuggestDto

Suggest request containing the criteria for retrieving suggestions SuggestDto

X
Return Type

SuggestResultDto

Content Type

  • application/json

Responses
Table 17. HTTP Response Codes
Code Message Datatype

200

Suggestions retrieved successfully

SuggestResultDto

TypeAhead

POST /api/v1/search/type-ahead

Get type-ahead suggestions

Description

Retrieves type-ahead suggestions based on the provided text and parameters

Parameters
Body Parameter
Name Description Required Default Pattern

TypeAheadDto

Type ahead request containing the text and parameters for retrieving type-ahead suggestions TypeAheadDto

X
Return Type

TypeAheadResultDto

Content Type

  • application/json

Responses
Table 18. HTTP Response Codes
Code Message Datatype

200

Suggestions retrieved successfully

TypeAheadResultDto

Version

GET /api/v1/search/omn-search-version

Get OMN Search API version

Description

Returns the current version information of the OMN Search API

Return Type

VersionDto

Content Type

  • application/json

Responses
Table 19. HTTP Response Codes
Code Message Datatype

200

Successful operation

VersionDto

Models

CombinedQueryDto

Query combining several queries with a boolean operator, for example a user's full-text input with the selected facets of a drill-down search. Combined queries may be nested.

Field Name Required Nullable Type Description Format

queryType

[String]

Type of the query, selecting the concrete query variant.

Enum: FULLTEXT, FIELD, COMBINED, TYPEAHEAD,

customProperty

String

Free-form property carried with the query for project-specific extensions. The standard OMN search does not evaluate it.

queries

List of [CombinedQueryDto_allOf_queries]

Queries to combine. Each entry may itself be a combined query, allowing nested query terms.

operator

[String]

Boolean operator used to combine the queries.

Enum: AND, OR,

CombinedQueryDtoAllOfQueries

Field Name Required Nullable Type Description Format

queryType

[String]

Type of the query, selecting the concrete query variant.

Enum: FULLTEXT, FIELD, COMBINED, TYPEAHEAD,

customProperty

String

Free-form property carried with the query for project-specific extensions. The standard OMN search does not evaluate it.

queries

List of [CombinedQueryDto_allOf_queries]

Queries to combine. Each entry may itself be a combined query, allowing nested query terms.

operator

[String]

Boolean operator used to combine the queries.

Enum: AND, OR,

name

String

Name of the field to match, in OMN expression format with dots replaced by tildes.

value

String

Search term to look for in the fulltext index.

comparator

[String]

Comparator used to match the field against the value.

Enum: EQ, NOT_EQ, LIKE, NOT_LIKE, GT, GE, LT, LE, TERM_STARTS_WITH, TERM_NOT_STARTS_WITH, TERM_ENDS_WITH, TERM_NOT_ENDS_WITH, TERM_WILDCARD, TERM_NOT_WILDCARD, IN, NOT_IN, IS_EMPTY, IS_NOT_EMPTY,

keyword

Boolean

Whether the value is matched as a single keyword instead of tokenized text. Must be true for string facet values, otherwise values containing separators such as blanks or hyphens produce wrong results. Ignored for the IN, NOT_IN, IS_EMPTY and IS_NOT_EMPTY comparators.

language

String

Content language of a multilingual field (format: <ISO-639-1 language code>_<ISO-3166-1 country code>, for example de_DE).

text

String

User input text to complete (minimum length 3).

count

Integer

Maximum number of suggestions to return.

int32

slop

Integer

Maximum allowed distance between the searched words.

int32

ConfigSearchDto

Search context for a CONFIG search, which applies the search configurations defined in the OMN config client.

Field Name Required Nullable Type Description Format

searchType

[String]

Search type to execute. CONFIG applies the search configuration of the OMN config client, INDEX searches directly in the index without plugin backend configurations.

Enum: CONFIG, INDEX,

configId

Long

Id of the AdvancedSearch or FormBasedSearch page plugin whose search configuration is applied.

int64

configIdentifier

String

Identifier of the page plugin whose search configuration is applied, as an alternative to configId.

labelLocalization

String

Content language used to localize search field and result view labels (format: <ISO-639-1 language code>_<ISO-3166-1 country code>, for example de_DE).

ContextDto

Context of a search request. CONFIG searches apply an OMN search backend configuration, INDEX searches query an index directly.

Field Name Required Nullable Type Description Format

searchType

[String]

Search type to execute. CONFIG applies the search configuration of the OMN config client, INDEX searches directly in the index without plugin backend configurations.

Enum: CONFIG, INDEX,

DocumentUpdateItmDto

Single document change to be applied to an index.

Field Name Required Nullable Type Description Format

id

Long

OMN identity of the document. Used when no guid is given.

int64

guid

String

Global identifier of the document. If given, it is resolved to an OMN identity, creating the mapping when the document is new.

event

[String]

Change that happened to the document.

Enum: CREATE, UPDATE, DELETE,

DocumentUpdateRequestDto

Request applying document changes to an index.

Field Name Required Nullable Type Description Format

index

[String]

Index the documents belong to.

Enum: ASSET, PRODUCT, CHANNEL, GLOBAL, HISTORY, FS_TABLE_WFL, CHANNEL_2_PRODUCT,

documents

List of DocumentUpdateItmDto

Documents that were created, updated or deleted.

DocumentWaitRequestDto

Request waiting until a set of documents has been indexed.

Field Name Required Nullable Type Description Format

index

[String]

Index the documents belong to.

Enum: ASSET, PRODUCT, CHANNEL, GLOBAL, HISTORY, FS_TABLE_WFL, CHANNEL_2_PRODUCT,

modifiedAt

Long

Modification timestamp the documents must have reached. The call returns once no listed document is older than this timestamp.

int64

maxWait

Long

Maximum time to wait, in milliseconds. If it elapses before all documents are indexed, the call reports that the documents were not found.

int64

documents

List of [long]

OMN identities of the documents to wait for.

int64

FacetDto

Single facet (aggregation bucket) of a search result.

Field Name Required Nullable Type Description Format

facetType

[String]

Type of the facet: NAMED for a discrete value, RANGED for a value range.

Enum: NAMED, RANGED,

attribute

String

Attribute the facet was aggregated for.

label

String

Localized label of the facet.

type

String

Data type of the facet value, for example string, boolean or date.

value

X

oas_any_type_not_mapped

count

Integer

Number of hits falling into this facet.

int32

from

String

Lower bound of a RANGED facet.

to

String

Upper bound of a RANGED facet.

children

List of FacetDto

Nested facets of this facet, for hierarchical aggregations.

FacetGroupDto

Group of facets aggregated for one attribute.

Field Name Required Nullable Type Description Format

name

String

Attribute the facets were aggregated for.

facets

List of FacetDto

Facets aggregated for the attribute.

FieldCfgDto

Configuration of a single field of an index, describing how it can be queried, sorted and aggregated.

Field Name Required Nullable Type Description Format

fieldName

String

Name of the field as defined in the index.

label

String

Localized label of the field.

fieldType

String

Data type of the field, for example string, double or boolean.

aggregatable

Boolean

Whether the field can be aggregated on. Fields of type ENUM, BOOLEAN and DATE are aggregatable by default; others must be configured as aggregatable.

sortable

Boolean

Whether the field can be sorted by.

multilingual

Boolean

Whether the field holds a separate value per content language.

attrIdentifier

String

Partial OMN expression identifying the attribute behind the field.

nestedFields

List of FieldCfgDto

Fields nested below this field.

allowedOperators

List of [string]

Comparators that may be used to query this field.

FieldInfoRequestDto

Request for the fields available in an index.

Field Name Required Nullable Type Description Format

index

[String]

Index to return the fields for.

Enum: ASSET, PRODUCT, CHANNEL, GLOBAL, HISTORY, FS_TABLE_WFL, CHANNEL_2_PRODUCT,

showAllowedOperators

Boolean

Whether the comparators allowed for each field are included in the response.

fields

List of [string]

Fields to restrict the response to. If empty, all fields of the index are returned.

FieldQueryDto

Query matching a single field against a value using a comparator.

Field Name Required Nullable Type Description Format

queryType

[String]

Type of the query, selecting the concrete query variant.

Enum: FULLTEXT, FIELD, COMBINED, TYPEAHEAD,

customProperty

String

Free-form property carried with the query for project-specific extensions. The standard OMN search does not evaluate it.

name

String

Name of the field to query, in OMN expression format with dots replaced by tildes, for example ISYImageimageStorageInfoheightInPixel.

value

X

oas_any_type_not_mapped

comparator

[String]

Comparator used to match the field against the value.

Enum: EQ, NOT_EQ, LIKE, NOT_LIKE, GT, GE, LT, LE, TERM_STARTS_WITH, TERM_NOT_STARTS_WITH, TERM_ENDS_WITH, TERM_NOT_ENDS_WITH, TERM_WILDCARD, TERM_NOT_WILDCARD, IN, NOT_IN, IS_EMPTY, IS_NOT_EMPTY,

keyword

Boolean

Whether the value is matched as a single keyword instead of tokenized text. Must be true for string facet values, otherwise values containing separators such as blanks or hyphens produce wrong results. Ignored for the IN, NOT_IN, IS_EMPTY and IS_NOT_EMPTY comparators.

language

String

Content language of a multilingual field (format: <ISO-639-1 language code>_<ISO-3166-1 country code>, for example de_DE).

FulltextQueryDto

Full-text query searching the fulltext index, which combines several OMN attributes into one field.

Field Name Required Nullable Type Description Format

queryType

[String]

Type of the query, selecting the concrete query variant.

Enum: FULLTEXT, FIELD, COMBINED, TYPEAHEAD,

customProperty

String

Free-form property carried with the query for project-specific extensions. The standard OMN search does not evaluate it.

value

String

Search term to look for in the fulltext index.

HighlightDto

Matching text fragments of a result item, with the matched terms marked up using em tags.

Field Name Required Nullable Type Description Format

name

String

Name of the field the fragments were taken from.

value

List of [string]

Text fragments containing the match, with the matched terms enclosed in em tags.

HistoryAddDto

Request adding a search text to the search history of a user. If the same history already exists, only its timestamp is updated.

Field Name Required Nullable Type Description Format

text

String

Search history entry to be saved.

user

String

User the history belongs to.

context

String

Search context the history is stored under, depending on the concrete use case (default DEFAULT).

HistoryAddResultAllOfAddedDto

Search history entry that was added.

Field Name Required Nullable Type Description Format

id

Long

Id of the stored history entry.

int64

text

String

Search history entry that was saved.

user

String

User the history belongs to.

context

String

Search context the history is stored under.

HistoryAddResultDto

Result of adding a search history entry.

Field Name Required Nullable Type Description Format

apiVersion

String

Version of the OMN Search API that produced the result.

processingTimeMillis

Long

Time the server needed to process the request, in milliseconds.

int64

added

HistoryAddResultAllOfAddedDto

Search history entry that was added.

HistoryDeleteDto

Request deleting the search history of a user.

Field Name Required Nullable Type Description Format

user

String

User whose histories are deleted.

context

String

Search context to delete the histories of (default DEFAULT). If not set, the histories of all contexts of the user are deleted.

HistoryDeleteResultAllOfDeletedDto

Summary of the deleted search history entries.

Field Name Required Nullable Type Description Format

user

String

User whose histories were deleted.

context

String

Search context the histories were deleted from.

count

Long

Number of deleted history entries.

int64

HistoryDeleteResultDto

Result of deleting search history entries.

Field Name Required Nullable Type Description Format

apiVersion

String

Version of the OMN Search API that produced the result.

processingTimeMillis

Long

Time the server needed to process the request, in milliseconds.

int64

deleted

HistoryDeleteResultAllOfDeletedDto

Summary of the deleted history entries.

HistoryQueryDto

Request for the stored search history of a user.

Field Name Required Nullable Type Description Format

text

String

Search text to filter the history by. If empty, all histories of the user are returned.

user

String

User the histories belong to.

context

String

Search context the histories are stored under, depending on the concrete use case (default DEFAULT). If not set, the histories of all contexts are returned.

count

Integer

Number of histories to return (default 10).

int32

HistoryQueryResultDto

Search histories of a user, sorted by the time they were added or updated.

Field Name Required Nullable Type Description Format

apiVersion

String

Version of the OMN Search API that produced the result.

processingTimeMillis

Long

Time the server needed to process the request, in milliseconds.

int64

histories

List of [string]

Search histories of the user, with the matched terms enclosed in em tags.

IndexCommandDto

Command starting an index rebuild or querying the state of the current rebuild.

Field Name Required Nullable Type Description Format

index

[String]

Index the command applies to.

Enum: ASSET, PRODUCT, CHANNEL, GLOBAL, HISTORY, FS_TABLE_WFL, CHANNEL_2_PRODUCT,

command

[String]

Command to execute: REBUILD starts a rebuild, STATE queries the current state, and the remaining commands switch incremental updates on or off.

Enum: REBUILD, STATE, ENABLE_INCREMENTAL_UPDATES, DISABLE_INCREMENTAL_UPDATES,

IndexItemDto

Mapping state of a single index.

Field Name Required Nullable Type Description Format

index

String

Index the state refers to.

outdated

Boolean

Whether the search index mapping is out of date.

createdAt

String

Time the current mapping was created.

IndexResultDto

State of an index rebuild.

Field Name Required Nullable Type Description Format

apiVersion

String

Version of the OMN Search API that produced the result.

processingTimeMillis

Long

Time the server needed to process the request, in milliseconds.

int64

index

String

Index the result refers to.

event

[String]

Event the rebuild is currently processing.

Enum: PREPARE, CREATE_INDEX, ADD_DOCUMENTS, SET_ALIAS, PROCESS_DELTA, DELETE_OLD_INDEX, END, ERROR, BUSY,

documentsProcessed

Long

Number of documents processed so far.

int64

totalDocuments

Long

Total number of documents to process.

int64

command

String

Command the result refers to.

IndexSearchDto

Search context for an INDEX search, which queries an index directly without applying any plugin backend configuration.

Field Name Required Nullable Type Description Format

searchType

[String]

Search type to execute. CONFIG applies the search configuration of the OMN config client, INDEX searches directly in the index without plugin backend configurations.

Enum: CONFIG, INDEX,

index

[String]

Index to search in.

Enum: ASSET, PRODUCT, CHANNEL, GLOBAL, HISTORY, FS_TABLE_WFL, CHANNEL_2_PRODUCT,

IndexStateItemDto

Mapping and indexing state of a single index.

Field Name Required Nullable Type Description Format

index

String

Index the state refers to.

mappingState

IndexStateItemMappingStateDto

State of the search index mapping.

indexingState

IndexStateItemIndexingStateDto

State of the indexing process.

IndexStateItemIndexingStateDto

State of an indexing process.

Field Name Required Nullable Type Description Format

state

[String]

State of the indexing process: BUSY while it is running, END when the last run finished, ERROR when the last run finished with an error.

Enum: PREPARE, CREATE_INDEX, ADD_DOCUMENTS, SET_ALIAS, PROCESS_DELTA, DELETE_OLD_INDEX, END, ERROR, BUSY,

documentsProcessed

Long

Number of documents processed so far.

int64

totalDocuments

Long

Total number of documents to process.

int64

IndexStateItemMappingStateDto

State of a search index mapping.

Field Name Required Nullable Type Description Format

outdated

Boolean

Whether the search index mapping is out of date.

createdAt

String

Time the current mapping was created.

JoinDto

Sub-search (join) that is executed before the main search and whose result is combined into it, comparable to an SQL sub-select. The sub-search must return exactly one attribute and is limited to 65000 results; pagination, maximum results, sorting and aggregation are ignored for it.

Field Name Required Nullable Type Description Format

joinOn

String

Field of the main search that the sub-search result is matched against.

search

SearchDto

Search that is executed before the main search. It must return exactly one result attribute.

QueryDto

Base type of a search query. The queryType selects the concrete query variant.

Field Name Required Nullable Type Description Format

queryType

[String]

Type of the query, selecting the concrete query variant.

Enum: FULLTEXT, FIELD, COMBINED, TYPEAHEAD,

customProperty

String

Free-form property carried with the query for project-specific extensions. The standard OMN search does not evaluate it.

ResultAttributeDto

Single attribute of a search result item.

Field Name Required Nullable Type Description Format

name

String

Name of the attribute, in OMN expression format with dots replaced by tildes, for example ISYImageimageStorageInfoheightInPixel.

label

String

Localized label of the attribute.

type

String

Data type of the attribute value, for example string, long, boolean or date.

value

X

oas_any_type_not_mapped

ResultItemDto

Single item of a search result.

Field Name Required Nullable Type Description Format

id

Long

OMN identity of the object.

int64

attributes

List of ResultAttributeDto

Attributes of the object, restricted to the requested result attributes.

highlights

List of HighlightDto

Matching text fragments of the object, with the matched terms marked up.

SearchDto

Search request describing what to search for, which results to return, and how to page, sort and aggregate them.

Field Name Required Nullable Type Description Format

context

[SearchDto_context]

query

[SearchDto_query]

maxResults

Integer

Maximum number of hits the search retrieves.

int32

pageIndex

Integer

One-based index of the result page to return.

int32

pageSize

Integer

Number of result items per page.

int32

sortOptions

List of SortOptionDto

Sort criteria to apply. The order of the entries defines their priority; an empty or missing list returns unsorted results.

aggregationEnabled

Boolean

Whether aggregations (facets) are calculated for the search.

aggregateEmptyValueEnabled

Boolean

Whether documents with an empty value are included as their own facet bucket.

aggregationMaxResults

Integer

Maximum number of aggregation (facet) results returned per attribute.

int32

resultAttributes

List of [string]

Attributes to include in each result item. If missing or empty, all attributes are returned; restricting them reduces processing time and response size.

storedFields

List of [string]

Names of index fields to be requested as stored fields. The standard OMN search does not evaluate this property.

aggregationAttributes

List of [string]

Attributes to aggregate on. The attributes must be aggregatable and aggregationEnabled must be true.

join

JoinDto

Sub-search whose result is joined into this search.

language

String

Content language of multilingual fields (format: <ISO-639-1 language code>_<ISO-3166-1 country code>, for example de_DE). Without it, multilingual fields are returned in every existing language variant.

customProperty

String

Free-form property carried with the request for project-specific extensions. The standard OMN search does not evaluate it.

SearchDtoContext

Context of the search, selecting either a CONFIG or an INDEX search.

Field Name Required Nullable Type Description Format

searchType

[String]

Search type to execute. CONFIG applies the search configuration of the OMN config client, INDEX searches directly in the index without plugin backend configurations.

Enum: CONFIG, INDEX,

configId

Long

Id of the AdvancedSearch or FormBasedSearch page plugin whose search configuration is applied.

int64

configIdentifier

String

Identifier of the page plugin whose search configuration is applied, as an alternative to configId.

labelLocalization

String

Content language used to localize search field and result view labels (format: <ISO-639-1 language code>_<ISO-3166-1 country code>, for example de_DE).

index

[String]

Index to search in.

Enum: ASSET, PRODUCT, CHANNEL, GLOBAL, HISTORY, FS_TABLE_WFL, CHANNEL_2_PRODUCT,

SearchDtoQuery

Query to execute.

Field Name Required Nullable Type Description Format

queryType

[String]

Type of the query, selecting the concrete query variant.

Enum: FULLTEXT, FIELD, COMBINED, TYPEAHEAD,

customProperty

String

Free-form property carried with the query for project-specific extensions. The standard OMN search does not evaluate it.

queries

List of [CombinedQueryDto_allOf_queries]

Queries to combine. Each entry may itself be a combined query, allowing nested query terms.

operator

[String]

Boolean operator used to combine the queries.

Enum: AND, OR,

name

String

Name of the field to match, in OMN expression format with dots replaced by tildes.

value

String

Search term to look for in the fulltext index.

comparator

[String]

Comparator used to match the field against the value.

Enum: EQ, NOT_EQ, LIKE, NOT_LIKE, GT, GE, LT, LE, TERM_STARTS_WITH, TERM_NOT_STARTS_WITH, TERM_ENDS_WITH, TERM_NOT_ENDS_WITH, TERM_WILDCARD, TERM_NOT_WILDCARD, IN, NOT_IN, IS_EMPTY, IS_NOT_EMPTY,

keyword

Boolean

Whether the value is matched as a single keyword instead of tokenized text. Must be true for string facet values, otherwise values containing separators such as blanks or hyphens produce wrong results. Ignored for the IN, NOT_IN, IS_EMPTY and IS_NOT_EMPTY comparators.

language

String

Content language of a multilingual field (format: <ISO-639-1 language code>_<ISO-3166-1 country code>, for example de_DE).

text

String

User input text to complete (minimum length 3).

count

Integer

Maximum number of suggestions to return.

int32

slop

Integer

Maximum allowed distance between the searched words.

int32

SearchResultDto

Result of a search request, containing the items of the requested page and the aggregated facets.

Field Name Required Nullable Type Description Format

apiVersion

String

Version of the OMN Search API that produced the result.

processingTimeMillis

Long

Time the server needed to process the request, in milliseconds.

int64

resultCount

Integer

Number of retrievable hits. Together with pageSize this gives the number of pages.

int32

totalHitCount

Long

Total number of hits found.

int64

exactHitCount

Boolean

Whether totalHitCount is exact. If false, the hits were only counted up to totalHitCount and more hits exist.

items

List of ResultItemDto

Result items of the requested page.

facets

List of FacetGroupDto

Aggregated facet groups, returned when aggregationEnabled is true.

suggest

SuggestResultDto

Completion suggestions for the query, when suggestions were requested.

SortOptionDto

Single sort criterion of a search request.

Field Name Required Nullable Type Description Format

attribute

String

Attribute to sort by, in OMN expression format with dots replaced by tildes.

direction

[String]

Sort direction.

Enum: ASC, DESC,

language

String

Content language used when sorting a multilingual attribute (format: <ISO-639-1 language code>_<ISO-3166-1 country code>, for example de_DE).

StoredSearchDto

Stored search (search profile) of a user.

Field Name Required Nullable Type Description Format

name

String

Name of the stored search. If missing or empty, the name is created automatically.

searchObject

SearchDto

Search that is stored and can be executed again.

StoredSearchEntryDto

Entry of the stored search list of a user.

Field Name Required Nullable Type Description Format

id

Long

Id of the stored search.

int64

index

String

Index the stored search runs against.

name

String

Name of the stored search.

pluginConfigurationId

Long

Id of the plugin backend configuration the stored search belongs to.

int64

pluginIdentifier

String

Identifier of the plugin the stored search belongs to.

StoredSearchInsertDto

Search to be stored as a search profile of the current user.

Field Name Required Nullable Type Description Format

name

String

Name of the stored search. If missing or empty, the name is created automatically.

searchObject

SearchDto

Search that is stored and can be executed again.

StoredSearchListResultDto

Stored searches of the current user.

Field Name Required Nullable Type Description Format

apiVersion

String

Version of the OMN Search API that produced the result.

processingTimeMillis

Long

Time the server needed to process the request, in milliseconds.

int64

storedSearchEntries

List of StoredSearchEntryDto

Stored searches of the current user.

StoredSearchOperationResultDto

Result of storing, updating or renaming a stored search.

Field Name Required Nullable Type Description Format

apiVersion

String

Version of the OMN Search API that produced the result.

processingTimeMillis

Long

Time the server needed to process the request, in milliseconds.

int64

id

Long

Id of the stored search.

int64

name

String

Name of the stored search.

SuggestDto

Request for completion suggestions for a user input, used to implement search-as-you-type.

Field Name Required Nullable Type Description Format

index

[String]

Index to take the suggestions from.

Enum: ASSET, PRODUCT, CHANNEL, GLOBAL, HISTORY, FS_TABLE_WFL, CHANNEL_2_PRODUCT,

text

String

User input text to complete (minimum length 3).

count

Integer

Number of suggestions to return (default 10, maximum 20).

int32

SuggestResultDto

Completion suggestions for a user input.

Field Name Required Nullable Type Description Format

apiVersion

String

Version of the OMN Search API that produced the result.

processingTimeMillis

Long

Time the server needed to process the request, in milliseconds.

int64

suggestions

List of [string]

Possible completions of the user input.

TypeAheadDto

Request for advanced completion suggestions. In contrast to the suggest resource it matches from any position of the text and allows a distance between the searched words.

Field Name Required Nullable Type Description Format

index

[String]

Index to take the suggestions from.

Enum: ASSET, PRODUCT, CHANNEL, GLOBAL, HISTORY, FS_TABLE_WFL, CHANNEL_2_PRODUCT,

name

String

Name of the field to match, in OMN expression format with dots replaced by tildes. If empty, the fulltext index is used.

text

String

User input text to complete (minimum length 3).

count

Integer

Number of suggestions to return (default 10).

int32

slop

Integer

Maximum allowed distance between the searched words (default 3).

int32

TypeAheadQueryDto

Query used for search-as-you-type matching within a search request.

Field Name Required Nullable Type Description Format

queryType

[String]

Type of the query, selecting the concrete query variant.

Enum: FULLTEXT, FIELD, COMBINED, TYPEAHEAD,

customProperty

String

Free-form property carried with the query for project-specific extensions. The standard OMN search does not evaluate it.

name

String

Name of the field to match, in OMN expression format with dots replaced by tildes.

text

String

User input text to complete (minimum length 3).

count

Integer

Maximum number of suggestions to return.

int32

slop

Integer

Maximum allowed distance between the searched words.

int32

TypeAheadResultDto

Advanced completion suggestions and spelling corrections for a user input.

Field Name Required Nullable Type Description Format

apiVersion

String

Version of the OMN Search API that produced the result.

processingTimeMillis

Long

Time the server needed to process the request, in milliseconds.

int64

suggestions

List of [string]

Possible completions of the user input, with the matched words enclosed in em tags.

advSuggestions

List of TypeAheadSuggestionDto

Possible completions of the user input, each with the index type it was found in.

corrections

List of [string]

Spelling corrections offered when the searched words could not be found.

TypeAheadSuggestionDto

Single advanced completion suggestion.

Field Name Required Nullable Type Description Format

text

String

Suggested text, with the matched words enclosed in em tags.

from

String

Index type the suggestion was found in, for example ASSET or PRODUCT.

VersionDto

Version information about the OMN Search REST API.

Field Name Required Nullable Type Description Format

apiVersion

String

Full version of the OMN Search API.

processingTimeMillis

Long

Time the server needed to process the request, in milliseconds.

int64

majorVersion

String

Major part of the API version.

minorVersion

String

Minor part of the API version.

patchVersion

String

Patch part of the API version.

qualifier

String

Build qualifier of the API version.

buildDate

String

Date the API was built.