POST api/Data/Custom

Queries the database with specified Columns to return.

Request Information

URI Parameters

None.

Body Parameters

A QueryCriteria object which includes Columns

SI.Model.Simfund.Generic.QueryCriteria
NameDescriptionTypeAdditional information
Filters

Collection of SI.Model.Simfund.Generic.SearchPredicate

None.

RowFilters

Collection of SI.Model.Simfund.Generic.SearchPredicate

None.

Columns

Collection of SI.Configuration.Simfund.DataItem

None.

SortKeys

Collection of SI.Model.Simfund.Generic.SortKey

None.

GroupKeys

Collection of SI.Model.Simfund.Generic.SortKey

None.

StartAt

integer

None.

Take

integer

None.

ProductId

integer

None.

EntityName

string

None.

Options

Collection of SI.Model.Simfund.Generic.CustomOption

None.

Request Formats

application/json, text/json

Sample:
{
  "<Filters>k__BackingField": [
    {
      "Id": "a9591577-e69e-47b5-bb0d-b030b5914e24",
      "ItemKey": "sample string 2",
      "ObservationKey": "sample string 3",
      "ObservationName": "sample string 4",
      "Value": {},
      "IsOr": true,
      "Operator": 0,
      "IsLogicalContainer": true,
      "IgnoreSearchField": true,
      "Negate": true,
      "Predicates": [],
      "ClassName": "sample string 10",
      "IsDefaultLogicalOr": true,
      "Level": 12,
      "ProductId": 13,
      "ItemName": "sample string 14"
    },
    {
      "Id": "a9591577-e69e-47b5-bb0d-b030b5914e24",
      "ItemKey": "sample string 2",
      "ObservationKey": "sample string 3",
      "ObservationName": "sample string 4",
      "Value": {},
      "IsOr": true,
      "Operator": 0,
      "IsLogicalContainer": true,
      "IgnoreSearchField": true,
      "Negate": true,
      "Predicates": [],
      "ClassName": "sample string 10",
      "IsDefaultLogicalOr": true,
      "Level": 12,
      "ProductId": 13,
      "ItemName": "sample string 14"
    }
  ],
  "<RowFilters>k__BackingField": [
    {
      "Id": "a9591577-e69e-47b5-bb0d-b030b5914e24",
      "ItemKey": "sample string 2",
      "ObservationKey": "sample string 3",
      "ObservationName": "sample string 4",
      "Value": {},
      "IsOr": true,
      "Operator": 0,
      "IsLogicalContainer": true,
      "IgnoreSearchField": true,
      "Negate": true,
      "Predicates": [],
      "ClassName": "sample string 10",
      "IsDefaultLogicalOr": true,
      "Level": 12,
      "ProductId": 13,
      "ItemName": "sample string 14"
    },
    {
      "Id": "a9591577-e69e-47b5-bb0d-b030b5914e24",
      "ItemKey": "sample string 2",
      "ObservationKey": "sample string 3",
      "ObservationName": "sample string 4",
      "Value": {},
      "IsOr": true,
      "Operator": 0,
      "IsLogicalContainer": true,
      "IgnoreSearchField": true,
      "Negate": true,
      "Predicates": [],
      "ClassName": "sample string 10",
      "IsDefaultLogicalOr": true,
      "Level": 12,
      "ProductId": 13,
      "ItemName": "sample string 14"
    }
  ],
  "<Columns>k__BackingField": null,
  "<SortKeys>k__BackingField": [
    {
      "ItemKey": "sample string 1",
      "ObservationKey": "sample string 2",
      "Direction": 0
    },
    {
      "ItemKey": "sample string 1",
      "ObservationKey": "sample string 2",
      "Direction": 0
    }
  ],
  "<GroupKeys>k__BackingField": [
    {
      "ItemKey": "sample string 1",
      "ObservationKey": "sample string 2",
      "Direction": 0
    },
    {
      "ItemKey": "sample string 1",
      "ObservationKey": "sample string 2",
      "Direction": 0
    }
  ],
  "<StartAt>k__BackingField": 1,
  "<Take>k__BackingField": 2,
  "<ProductId>k__BackingField": 3,
  "<EntityName>k__BackingField": "sample string 4",
  "<Options>k__BackingField": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Specified Column values

Collection of SI.Model.Simfund.Generic.CustomItem
NameDescriptionTypeAdditional information
CustomId

string

None.

Name

string

None.

Type

SI.Model.Simfund.Generic.SearchType

None.

Option

string

None.

Value

decimal number

None.

Custom

Collection of SI.Model.Simfund.Generic.CustomOption

None.

ProductId

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "CustomId": "sample string 1",
    "Name": "sample string 2",
    "Type": 1,
    "Option": "sample string 3",
    "Value": 1.0,
    "Custom": [
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      }
    ],
    "ProductId": 1
  },
  {
    "CustomId": "sample string 1",
    "Name": "sample string 2",
    "Type": 1,
    "Option": "sample string 3",
    "Value": 1.0,
    "Custom": [
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Value": "sample string 2"
      }
    ],
    "ProductId": 1
  }
]