POST api/settings/select

Retrieves a list of settings that match the given criteria.

Request Information

URI Parameters

None.

Body Parameters

The criteria model to filter settings by.

SettingsFilterCriteriaDto
NameDescriptionTypeAdditional information
Name

string

None.

TenantId

globally unique identifier

None.

DataType

SettingDataTypeDto

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "TenantId": "c27f1fe3-0819-41f7-bb80-8918095fd3de",
  "DataType": 0
}

application/xml, text/xml

Sample:
<SettingsFilterCriteriaDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Settings.Models.FilterCriteria">
  <DataType>Bool</DataType>
  <Name>sample string 1</Name>
  <TenantId>c27f1fe3-0819-41f7-bb80-8918095fd3de</TenantId>
</SettingsFilterCriteriaDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of SettingDto
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Name

string

Required

Value

string

Required

CreationDate

date

None.

DataType

SettingDataTypeDto

None.

TenantId

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "17d2cbb1-b362-46ba-b8a1-d00827ddb062",
    "Name": "sample string 2",
    "Value": "sample string 3",
    "CreationDate": "2025-12-06T04:45:59.3626173+00:00",
    "DataType": 0,
    "TenantId": "d21f79cb-3c91-4ba1-959f-e0f047c340ec"
  },
  {
    "Id": "17d2cbb1-b362-46ba-b8a1-d00827ddb062",
    "Name": "sample string 2",
    "Value": "sample string 3",
    "CreationDate": "2025-12-06T04:45:59.3626173+00:00",
    "DataType": 0,
    "TenantId": "d21f79cb-3c91-4ba1-959f-e0f047c340ec"
  }
]

application/xml, text/xml

Sample:
<ArrayOfSettingDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Settings.Models">
  <SettingDto>
    <CreationDate>2025-12-06T04:45:59.3626173+00:00</CreationDate>
    <DataType>Bool</DataType>
    <Id>17d2cbb1-b362-46ba-b8a1-d00827ddb062</Id>
    <Name>sample string 2</Name>
    <TenantId>d21f79cb-3c91-4ba1-959f-e0f047c340ec</TenantId>
    <Value>sample string 3</Value>
  </SettingDto>
  <SettingDto>
    <CreationDate>2025-12-06T04:45:59.3626173+00:00</CreationDate>
    <DataType>Bool</DataType>
    <Id>17d2cbb1-b362-46ba-b8a1-d00827ddb062</Id>
    <Name>sample string 2</Name>
    <TenantId>d21f79cb-3c91-4ba1-959f-e0f047c340ec</TenantId>
    <Value>sample string 3</Value>
  </SettingDto>
</ArrayOfSettingDto>