POST api/moduleSettings/select

Retrieves a list of module settings that match the given criteria.

Request Information

URI Parameters

None.

Body Parameters

The criteria model to filter module settings by.

Name	Type	Additional information
Name	string	None.
TenantId	globally unique identifier	None.
UserJourneyId	globally unique identifier	None.
ServiceType	ModuleSettingServiceTypeDto	None.

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "TenantId": "18fd9db2-22db-40e6-b217-5069f7766d93",
  "UserJourneyId": "1a047c5b-af0a-4131-a421-5fe02d222b60",
  "ServiceType": 0
}

application/xml, text/xml

Sample:

<ModuleSettingsFilterCriteriaDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Settings.Models.FilterCriteria">
  <Name>sample string 1</Name>
  <ServiceType>None</ServiceType>
  <TenantId>18fd9db2-22db-40e6-b217-5069f7766d93</TenantId>
  <UserJourneyId>1a047c5b-af0a-4131-a421-5fe02d222b60</UserJourneyId>
</ModuleSettingsFilterCriteriaDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of ModuleSettingDto

Name	Type	Additional information
Id	globally unique identifier	None.
Name	string	Required
Url	string	Required
DisplayName	string	Required
ServiceType	ModuleSettingServiceTypeDto	None.
CreationDate	date	None.
TenantId	globally unique identifier	None.
UserJourneyId	globally unique identifier	None.
Bypassable	boolean	None.
DefaultValue	string	None.
SortIndex	integer	None.
ModuleSettingProperties	Collection of ModuleSettingPropertyDto	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "c29c3f46-c862-41d4-98ac-55a18b642446",
    "Name": "sample string 2",
    "Url": "sample string 3",
    "DisplayName": "sample string 4",
    "ServiceType": 0,
    "CreationDate": "2026-01-11T20:54:52.1182581+00:00",
    "TenantId": "46f37142-4bf5-404e-bc51-71f55fd26e97",
    "UserJourneyId": "f1a17715-cd64-40d0-80bf-175c0507e9fd",
    "Bypassable": true,
    "DefaultValue": "sample string 9",
    "SortIndex": 10,
    "ModuleSettingProperties": [
      {
        "Id": "19f93f78-7bb4-4094-a937-06a53a6e27d5",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "CreationDate": "2026-01-11T20:54:52.1182581+00:00",
        "ModuleSettingId": "484a5acd-6933-4428-b02f-62d992edaecc"
      },
      {
        "Id": "19f93f78-7bb4-4094-a937-06a53a6e27d5",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "CreationDate": "2026-01-11T20:54:52.1182581+00:00",
        "ModuleSettingId": "484a5acd-6933-4428-b02f-62d992edaecc"
      }
    ]
  },
  {
    "Id": "c29c3f46-c862-41d4-98ac-55a18b642446",
    "Name": "sample string 2",
    "Url": "sample string 3",
    "DisplayName": "sample string 4",
    "ServiceType": 0,
    "CreationDate": "2026-01-11T20:54:52.1182581+00:00",
    "TenantId": "46f37142-4bf5-404e-bc51-71f55fd26e97",
    "UserJourneyId": "f1a17715-cd64-40d0-80bf-175c0507e9fd",
    "Bypassable": true,
    "DefaultValue": "sample string 9",
    "SortIndex": 10,
    "ModuleSettingProperties": [
      {
        "Id": "19f93f78-7bb4-4094-a937-06a53a6e27d5",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "CreationDate": "2026-01-11T20:54:52.1182581+00:00",
        "ModuleSettingId": "484a5acd-6933-4428-b02f-62d992edaecc"
      },
      {
        "Id": "19f93f78-7bb4-4094-a937-06a53a6e27d5",
        "Name": "sample string 2",
        "Value": "sample string 3",
        "CreationDate": "2026-01-11T20:54:52.1182581+00:00",
        "ModuleSettingId": "484a5acd-6933-4428-b02f-62d992edaecc"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfModuleSettingDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Settings.Models">
  <ModuleSettingDto>
    <Bypassable>true</Bypassable>
    <CreationDate>2026-01-11T20:54:52.1182581+00:00</CreationDate>
    <DefaultValue>sample string 9</DefaultValue>
    <DisplayName>sample string 4</DisplayName>
    <Id>c29c3f46-c862-41d4-98ac-55a18b642446</Id>
    <ModuleSettingProperties>
      <ModuleSettingPropertyDto>
        <CreationDate>2026-01-11T20:54:52.1182581+00:00</CreationDate>
        <Id>19f93f78-7bb4-4094-a937-06a53a6e27d5</Id>
        <ModuleSettingId>484a5acd-6933-4428-b02f-62d992edaecc</ModuleSettingId>
        <Name>sample string 2</Name>
        <Value>sample string 3</Value>
      </ModuleSettingPropertyDto>
      <ModuleSettingPropertyDto>
        <CreationDate>2026-01-11T20:54:52.1182581+00:00</CreationDate>
        <Id>19f93f78-7bb4-4094-a937-06a53a6e27d5</Id>
        <ModuleSettingId>484a5acd-6933-4428-b02f-62d992edaecc</ModuleSettingId>
        <Name>sample string 2</Name>
        <Value>sample string 3</Value>
      </ModuleSettingPropertyDto>
    </ModuleSettingProperties>
    <Name>sample string 2</Name>
    <ServiceType>None</ServiceType>
    <SortIndex>10</SortIndex>
    <TenantId>46f37142-4bf5-404e-bc51-71f55fd26e97</TenantId>
    <Url>sample string 3</Url>
    <UserJourneyId>f1a17715-cd64-40d0-80bf-175c0507e9fd</UserJourneyId>
  </ModuleSettingDto>
  <ModuleSettingDto>
    <Bypassable>true</Bypassable>
    <CreationDate>2026-01-11T20:54:52.1182581+00:00</CreationDate>
    <DefaultValue>sample string 9</DefaultValue>
    <DisplayName>sample string 4</DisplayName>
    <Id>c29c3f46-c862-41d4-98ac-55a18b642446</Id>
    <ModuleSettingProperties>
      <ModuleSettingPropertyDto>
        <CreationDate>2026-01-11T20:54:52.1182581+00:00</CreationDate>
        <Id>19f93f78-7bb4-4094-a937-06a53a6e27d5</Id>
        <ModuleSettingId>484a5acd-6933-4428-b02f-62d992edaecc</ModuleSettingId>
        <Name>sample string 2</Name>
        <Value>sample string 3</Value>
      </ModuleSettingPropertyDto>
      <ModuleSettingPropertyDto>
        <CreationDate>2026-01-11T20:54:52.1182581+00:00</CreationDate>
        <Id>19f93f78-7bb4-4094-a937-06a53a6e27d5</Id>
        <ModuleSettingId>484a5acd-6933-4428-b02f-62d992edaecc</ModuleSettingId>
        <Name>sample string 2</Name>
        <Value>sample string 3</Value>
      </ModuleSettingPropertyDto>
    </ModuleSettingProperties>
    <Name>sample string 2</Name>
    <ServiceType>None</ServiceType>
    <SortIndex>10</SortIndex>
    <TenantId>46f37142-4bf5-404e-bc51-71f55fd26e97</TenantId>
    <Url>sample string 3</Url>
    <UserJourneyId>f1a17715-cd64-40d0-80bf-175c0507e9fd</UserJourneyId>
  </ModuleSettingDto>
</ArrayOfModuleSettingDto>