Search

The Search API allows you to search for a current or scheduled setting using common and/or setting-specific searchable fields.

Search Results

All search-by-IDs endpoints return complete result sets without pagination. This means that all matching settings will be returned in a single response, without the need for page navigation.

Search Current Setting

The following endpoints allow searching for a current setting:

GET/settings-objects/{settingType}

GET/settings-objects/{settingType}/getIds

The activeFrom parameter filters results to include only settings that are active at the specified date-time. In order to return a current setting the activeFrom value must be at or after the activeFromDate of the current setting, but before the activeFromDate of a scheduled setting (if it exists).

  • If activeFrom is set to a date-time after the activation of a scheduled setting, the scheduled setting is returned.

  • If activeFrom is set to a date-time after the activeFromDate of a current setting but before the activeFromDate of a scheduled setting, the current setting is returned.

  • If activeFrom is set to a date-time before the activeFromDate of a current setting, no results are returned.

The optional processingEntity parameter, if provided in the request, ensures that only the setting’s owning Processing Entity can fetch its own settings.

Search Scheduled Settings

The two endpoints below allow searching for a scheduled setting, but the 'activeFrom' value must be at or after the activeFromDate of the scheduled setting.

GET/settings-objects/{settingType}

GET/settings-objects/{settingType}/getIds

It is far easier to search for a scheduled setting via an alternative endpoint dedicated only for schedule settings:

GET/settings-objects/scheduled-settings/{settingType}

This endpoint does not support the activeFrom parameter supported therefore all scheduled settings that match the search criteria are returned.

Common Searchable Fields

  • status

  • processingEntity

  • source

  • id

  • idList

  • activeFrom

Setting Specific Searchable Fields

Each setting can define a subset of its fields which can be used as searchable fields.

To see how to define setting-specific searchable fields go to Searchable Fields