POST v1/setting/search

配置查询

Request Information

URI Parameters

None.

Body Parameters

查询条件

SearchModel
NameDescriptionTypeAdditional information
PageNo

当前页码

integer

None.

PageSize

分页大小

integer

None.

Sorts

排序条件

Collection of SortDescriptor

None.

Filters

过滤条件

Collection of FilterDescriptor

None.

Request Formats

application/json, text/json

Sample:
{
  "pageNo": 1,
  "pageSize": 2,
  "sorts": [
    {
      "member": "sample string 1",
      "direction": "Ascending"
    },
    {
      "member": "sample string 1",
      "direction": "Ascending"
    }
  ],
  "filters": [
    {
      "member": "sample string 1",
      "operator": "IsLessThan",
      "value": {}
    },
    {
      "member": "sample string 1",
      "operator": "IsLessThan",
      "value": {}
    }
  ]
}

application/xml, text/xml

Sample:
<SearchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BgOA.Models.SearchModels">
  <Filters>
    <FilterDescriptor>
      <Member>sample string 1</Member>
      <Operator>IsLessThan</Operator>
      <Value />
    </FilterDescriptor>
    <FilterDescriptor>
      <Member>sample string 1</Member>
      <Operator>IsLessThan</Operator>
      <Value />
    </FilterDescriptor>
  </Filters>
  <PageNo>1</PageNo>
  <PageSize>2</PageSize>
  <Sorts>
    <SortDescriptor>
      <Member>sample string 1</Member>
      <SortDirection>Ascending</SortDirection>
    </SortDescriptor>
    <SortDescriptor>
      <Member>sample string 1</Member>
      <SortDirection>Ascending</SortDirection>
    </SortDescriptor>
  </Sorts>
</SearchModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiListResultOfSettingModel
NameDescriptionTypeAdditional information
Result

Collection of SettingModel

None.

Total

integer

None.

PageCount

integer

None.

ResultCode

string

None.

ErrorMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "result": [
    {
      "key": "sample string 1",
      "name": "sample string 2",
      "value": "sample string 3",
      "displayOrder": 4,
      "id": 5,
      "createdTime": "2026-07-28 16:49:43",
      "createdBy": "sample string 7",
      "updatedTime": "2026-07-28 16:49:43",
      "updatedBy": "sample string 8",
      "isDeleted": true,
      "deletedTime": "2026-07-28 16:49:43",
      "deletedBy": "sample string 10"
    },
    {
      "key": "sample string 1",
      "name": "sample string 2",
      "value": "sample string 3",
      "displayOrder": 4,
      "id": 5,
      "createdTime": "2026-07-28 16:49:43",
      "createdBy": "sample string 7",
      "updatedTime": "2026-07-28 16:49:43",
      "updatedBy": "sample string 8",
      "isDeleted": true,
      "deletedTime": "2026-07-28 16:49:43",
      "deletedBy": "sample string 10"
    }
  ],
  "total": 1,
  "pageCount": 1,
  "resultCode": "sample string 1",
  "errorMessage": "sample string 2"
}

application/xml, text/xml

Sample:
<ApiListResultOfSettingModelINxgc_P41 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BgOA.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <ResultCode>sample string 1</ResultCode>
  <PageCount>1</PageCount>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/BgOA.Models.ViewModels">
    <d2p1:SettingModel>
      <d2p1:CreatedBy>sample string 7</d2p1:CreatedBy>
      <d2p1:CreatedTime>2026-07-28T16:49:43.1650593+08:00</d2p1:CreatedTime>
      <d2p1:DeletedBy>sample string 10</d2p1:DeletedBy>
      <d2p1:DeletedTime>2026-07-28T16:49:43.1650593+08:00</d2p1:DeletedTime>
      <d2p1:Id>5</d2p1:Id>
      <d2p1:IsDeleted>true</d2p1:IsDeleted>
      <d2p1:UpdatedBy>sample string 8</d2p1:UpdatedBy>
      <d2p1:UpdatedTime>2026-07-28T16:49:43.1650593+08:00</d2p1:UpdatedTime>
      <d2p1:DisplayOrder>4</d2p1:DisplayOrder>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:SettingModel>
    <d2p1:SettingModel>
      <d2p1:CreatedBy>sample string 7</d2p1:CreatedBy>
      <d2p1:CreatedTime>2026-07-28T16:49:43.1650593+08:00</d2p1:CreatedTime>
      <d2p1:DeletedBy>sample string 10</d2p1:DeletedBy>
      <d2p1:DeletedTime>2026-07-28T16:49:43.1650593+08:00</d2p1:DeletedTime>
      <d2p1:Id>5</d2p1:Id>
      <d2p1:IsDeleted>true</d2p1:IsDeleted>
      <d2p1:UpdatedBy>sample string 8</d2p1:UpdatedBy>
      <d2p1:UpdatedTime>2026-07-28T16:49:43.1650593+08:00</d2p1:UpdatedTime>
      <d2p1:DisplayOrder>4</d2p1:DisplayOrder>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Value>sample string 3</d2p1:Value>
    </d2p1:SettingModel>
  </Result>
  <Total>1</Total>
</ApiListResultOfSettingModelINxgc_P41>