SearchHmQuery is used to search HM Entities or Relationships. The filter, aggregate and sort criteria can reference any columns in the Display Packages associated with Entity Type / Relationship Type in the search request. The criteria can use any operators supported by the underlying database.
The value stored in GETLIST_LIMIT column of CMX_SYSTEM.C_REPOS_DATABASE table for the ORS determines the maximum number of records that can be returned. GetSearchResultsRequest can be used to get subsequent pages of records.
The request contains the HM configuration, the type of the entity or relationship sought, and an SQL specification of the query. The response contains the sought records and a search token to use to fetch additional data.
Use Case
This is the common scenario for using the SearchHmQuery request:
Search for specific HM entity or entities
— If you have Hierarchy Manager and have populated it with data, you can use SearchHmQuery to search for entities and relationships associated with one or more entities.