1. Common Features Reference
  2. Reference Topics
  3. GET_SEARCH_RESULTS

GET_SEARCH_RESULTS

Service that returns a list of content items that match specific search criteria.

Access Level: Read (1)

Calls SubService: SUB

Location: IdcHomeDir/resources/core/tables/std_services.htm

Additional Required Service Parameters

  • QueryText: The search expression.

You can append values for Title, Content ID, and so forth, on the QueryText parameter to refine this service.

Optional Service Parameters

  • ResultCount: The number of results to return. Defaults to 25.

  • SearchEngineName: The name of the search engine to be used. The default is the value specified in the config/config.cfg file.

    Values can be databasefulltext or database. If set to database or databasefulltext, you must pass SQL in the QueryText parameter, as in this example: 

    dDocTitle like 'test'

    This is equivalent to the Verity query:

    dDocTitle <substring> 'test'

    • SortField: The name of the metadata field to sort on.

      • Examples: dInDate, dDocTitle, Score.

      • Defaults to dInDate.

    • SortOrder: The sort order. Allowed values are ASC (ascending) and DESC (descending).

    • SortSpec: Enables sorting on more than one field. Set this parameter to the following sequence:

      <sort field> <sort order> <sort field> <sort order>...

    For example, SortSpec=dDocTitle ASC dInDate DESC.

    • StartRow: The row to begin the search results display. For example, if ResultCount=25, setting StartRow=26 displays the second page of results.

    • EndRow: The row to end the search results display.

  • vcrContentType: The name of a searchable content type. The server modifies the query text of the search to limit the results to documents of that type. For example, if the content type specified is one describing a profile, then the query text is modified to limit the documents returned to those whose profile trigger value matches that of the profile.

  • vcrAppendObjectClassInfo: When set to true, the server adds an additional column to the SearchResults ResultSet called vcrObjectClass. This column lists the content type associated with each document in the results. The default is true.

Example

IdcService=GET_SEARCH_RESULTS
QueryText=benefits