Api Home > Settings > GetAllSettings

GET api/V3/Settings/GetAllSettings?tenantId={tenantId} Gets all settings by tenant.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
tenantId

The tenant Id

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of SettingsItem
NameDescriptionTypeAdditional information
Key

string

None.

Value

string

None.

TenantId

integer

None.

Id

integer

None.

ModifiedDate

date

None.

ModifiedBy

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Key": "sample string 1",
    "Value": "sample string 2",
    "TenantId": 3,
    "Id": 4,
    "ModifiedDate": "2019-12-08T10:04:57.130Z",
    "ModifiedBy": "463baaee-2cfe-4c5a-95f7-625db7f994ed"
  },
  {
    "Key": "sample string 1",
    "Value": "sample string 2",
    "TenantId": 3,
    "Id": 4,
    "ModifiedDate": "2019-12-08T10:04:57.130Z",
    "ModifiedBy": "463baaee-2cfe-4c5a-95f7-625db7f994ed"
  }
]

application/xml, text/xml

Sample:
<ArrayOfSettingsItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Library.InfoObjects">
  <SettingsItem>
    <Id>4</Id>
    <ModifiedBy>463baaee-2cfe-4c5a-95f7-625db7f994ed</ModifiedBy>
    <ModifiedDate>2019-12-08T10:04:57.1306068+00:00</ModifiedDate>
    <Key>sample string 1</Key>
    <TenantId>3</TenantId>
    <Value>sample string 2</Value>
  </SettingsItem>
  <SettingsItem>
    <Id>4</Id>
    <ModifiedBy>463baaee-2cfe-4c5a-95f7-625db7f994ed</ModifiedBy>
    <ModifiedDate>2019-12-08T10:04:57.1306068+00:00</ModifiedDate>
    <Key>sample string 1</Key>
    <TenantId>3</TenantId>
    <Value>sample string 2</Value>
  </SettingsItem>
</ArrayOfSettingsItem>