Who is this article for?

Users who need to search records that meet a variety of requirements and assist with populating data repositories

Restricted access to Users with interface development roles. It is a read-only HTTP/JSON API.

Search API is a publicly accessible HTTP/JSON API designed to facilitate robust read-only search capabilities. The Search API is a read-only interface designed for querying search conditions and executing search results efficiently. To utilize this API, certain requirements must be met: the Module Package Cache must be enabled, a valid user account is required, and the IP address must be whitelisted. These requirements ensure secure and optimized access to the search functionalities.

Global and System Fields

Global and System fields are always available to be searched against and can be found within a subscriber's cross module functions screen.

For single module searches, all fields in the module are available for searching and filtering

For multi module searches, only Global, System, and Custom Common Fields are available.

• "Global" fields will be identified by '_' preceding the field name
• "Common" fields are fields that can be mapped to other Data fields in modules. This allows for searching across multiple modules and getting meaningful values returned for that module.
• "Common" fields will be identified by '_Common' preceding the fieldName.
• "Global" and "Common" fields can be found in the subscriber cross module functions screen.
• All Date operators currently only filter down to the Day value. Working with dates will be in the format of "YYYYMMDD" This design is optimized for performance, it also means that virtual fields won't be available.
• The "Name" column will list the names of the fields.

Continuous improvement of BI Reporting tools
The Search API currently returns header-level field data. We are working on a series of enhancements to provide support for querying and returning task and child level field data and integrated into the Ideagen Platform. Ideagen has already released many of the JasperSoft features into the Miramar UI, such as charts and report grouping, into native BI search and filters. Additional support for child-level reporting will be introduced in future releases.

Global Common Fields

These common fields are available for all objects.

System Common Fields

These fields represent common concepts across modules and contain data from various module fields that have been mapped (to these fields) by module developers.

Parameters

There are multiple parameters that can be set on a query. Not all the parameters are required and some have default values that will be used.

The following is a list of parameters that are available and what their functions are. The parameters are case sensitive and will need to be set as shown below.

Return Fields

It's recommended for the body payload to contain a returnFields entry with the list of the necessary fields to be returned from the query (such as a SELECT portion of a SQL query).

{
    …
    "returnFields": [
        "FieldName_A",
        "FieldName_B",
        "…",
        "FieldName_Z"
    ]
    …
}