POST api/Data/Sql

Queries the database based on a QueryCriteria object (Columns, Predicates, SortKeys, GroupKeys, RowFilters, Options, StartAt, Take, ProductId, EntityName). Returns an HttpResponseMessage with string SQL as Content

Request Information

URI Parameters

None.

Body Parameters

QueryCriteria object

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": "89c399a8-fa10-4fb3-b405-8c71686c7479",
      "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": "89c399a8-fa10-4fb3-b405-8c71686c7479",
      "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": "89c399a8-fa10-4fb3-b405-8c71686c7479",
      "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": "89c399a8-fa10-4fb3-b405-8c71686c7479",
      "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

HttpResponseMessage with string SQL as Content

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.