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

Name	Type	Additional information
Predicates	Collection of SI.Model.Simfund.Generic.LiteDataItem	None.
RowFilters	Collection of SI.Model.Simfund.Generic.LiteDataItem	None.
Columns	Collection of SI.Model.Simfund.Generic.LiteDataItem	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:

{
  "Predicates": [
    {
      "Aggregate": null,
      "AggregateFunction": 1,
      "Alias": "sample string 1",
      "Category": {
        "IsUsedByGroupingItems": true,
        "IsUsedBySelectionItems": true,
        "IsUsedByDisplayItems": true,
        "Id": 1,
        "CategoryName": "sample string 4",
        "ProductId": 5
      },
      "ColumnOffset": 2,
      "ContainerId": 3,
      "DataProvider": "sample string 4",
      "DataTypeId": 5,
      "DefaultAggregate": null,
      "FieldId": 6,
      "FieldTypeId": 7,
      "Format": "sample string 8",
      "HeaderPrefix": "sample string 9",
      "HeaderSuffix": "sample string 10",
      "HeaderText": "sample string 11",
      "Id": "ebfe07ce-9ddb-43f4-b030-3f0d66147693",
      "IgnoreSearchField": true,
      "IsCommonDisplay": true,
      "IsCommonGroup": true,
      "IsCommonSelect": true,
      "IsLogicalContainer": true,
      "IsOr": true,
      "ItemKey": "sample string 19",
      "ItemName": "sample string 20",
      "ObservationHeader": "sample string 21",
      "ObservationKey": "sample string 22",
      "ObservationName": "sample string 23",
      "Operator": 0,
      "RateTargetKey": "sample string 24",
      "SubCategory": {
        "Id": 1,
        "SubCategoryName": "sample string 1",
        "CategoryName": "sample string 2",
        "CategoryId": 1,
        "ProductId": 3
      },
      "Target": null,
      "Value": {},
      "WeightedAverageItems": [],
      "WeightedAverageTargetKey": "sample string 26",
      "WeightedAverageTargetObservationKey": "sample string 27",
      "Width": 28,
      "WindowFunction": null
    },
    {
      "Aggregate": null,
      "AggregateFunction": 1,
      "Alias": "sample string 1",
      "Category": {
        "IsUsedByGroupingItems": true,
        "IsUsedBySelectionItems": true,
        "IsUsedByDisplayItems": true,
        "Id": 1,
        "CategoryName": "sample string 4",
        "ProductId": 5
      },
      "ColumnOffset": 2,
      "ContainerId": 3,
      "DataProvider": "sample string 4",
      "DataTypeId": 5,
      "DefaultAggregate": null,
      "FieldId": 6,
      "FieldTypeId": 7,
      "Format": "sample string 8",
      "HeaderPrefix": "sample string 9",
      "HeaderSuffix": "sample string 10",
      "HeaderText": "sample string 11",
      "Id": "ebfe07ce-9ddb-43f4-b030-3f0d66147693",
      "IgnoreSearchField": true,
      "IsCommonDisplay": true,
      "IsCommonGroup": true,
      "IsCommonSelect": true,
      "IsLogicalContainer": true,
      "IsOr": true,
      "ItemKey": "sample string 19",
      "ItemName": "sample string 20",
      "ObservationHeader": "sample string 21",
      "ObservationKey": "sample string 22",
      "ObservationName": "sample string 23",
      "Operator": 0,
      "RateTargetKey": "sample string 24",
      "SubCategory": {
        "Id": 1,
        "SubCategoryName": "sample string 1",
        "CategoryName": "sample string 2",
        "CategoryId": 1,
        "ProductId": 3
      },
      "Target": null,
      "Value": {},
      "WeightedAverageItems": [],
      "WeightedAverageTargetKey": "sample string 26",
      "WeightedAverageTargetObservationKey": "sample string 27",
      "Width": 28,
      "WindowFunction": null
    }
  ],
  "RowFilters": [
    {
      "Aggregate": null,
      "AggregateFunction": 1,
      "Alias": "sample string 1",
      "Category": {
        "IsUsedByGroupingItems": true,
        "IsUsedBySelectionItems": true,
        "IsUsedByDisplayItems": true,
        "Id": 1,
        "CategoryName": "sample string 4",
        "ProductId": 5
      },
      "ColumnOffset": 2,
      "ContainerId": 3,
      "DataProvider": "sample string 4",
      "DataTypeId": 5,
      "DefaultAggregate": null,
      "FieldId": 6,
      "FieldTypeId": 7,
      "Format": "sample string 8",
      "HeaderPrefix": "sample string 9",
      "HeaderSuffix": "sample string 10",
      "HeaderText": "sample string 11",
      "Id": "ebfe07ce-9ddb-43f4-b030-3f0d66147693",
      "IgnoreSearchField": true,
      "IsCommonDisplay": true,
      "IsCommonGroup": true,
      "IsCommonSelect": true,
      "IsLogicalContainer": true,
      "IsOr": true,
      "ItemKey": "sample string 19",
      "ItemName": "sample string 20",
      "ObservationHeader": "sample string 21",
      "ObservationKey": "sample string 22",
      "ObservationName": "sample string 23",
      "Operator": 0,
      "RateTargetKey": "sample string 24",
      "SubCategory": {
        "Id": 1,
        "SubCategoryName": "sample string 1",
        "CategoryName": "sample string 2",
        "CategoryId": 1,
        "ProductId": 3
      },
      "Target": null,
      "Value": {},
      "WeightedAverageItems": [],
      "WeightedAverageTargetKey": "sample string 26",
      "WeightedAverageTargetObservationKey": "sample string 27",
      "Width": 28,
      "WindowFunction": null
    },
    {
      "Aggregate": null,
      "AggregateFunction": 1,
      "Alias": "sample string 1",
      "Category": {
        "IsUsedByGroupingItems": true,
        "IsUsedBySelectionItems": true,
        "IsUsedByDisplayItems": true,
        "Id": 1,
        "CategoryName": "sample string 4",
        "ProductId": 5
      },
      "ColumnOffset": 2,
      "ContainerId": 3,
      "DataProvider": "sample string 4",
      "DataTypeId": 5,
      "DefaultAggregate": null,
      "FieldId": 6,
      "FieldTypeId": 7,
      "Format": "sample string 8",
      "HeaderPrefix": "sample string 9",
      "HeaderSuffix": "sample string 10",
      "HeaderText": "sample string 11",
      "Id": "ebfe07ce-9ddb-43f4-b030-3f0d66147693",
      "IgnoreSearchField": true,
      "IsCommonDisplay": true,
      "IsCommonGroup": true,
      "IsCommonSelect": true,
      "IsLogicalContainer": true,
      "IsOr": true,
      "ItemKey": "sample string 19",
      "ItemName": "sample string 20",
      "ObservationHeader": "sample string 21",
      "ObservationKey": "sample string 22",
      "ObservationName": "sample string 23",
      "Operator": 0,
      "RateTargetKey": "sample string 24",
      "SubCategory": {
        "Id": 1,
        "SubCategoryName": "sample string 1",
        "CategoryName": "sample string 2",
        "CategoryId": 1,
        "ProductId": 3
      },
      "Target": null,
      "Value": {},
      "WeightedAverageItems": [],
      "WeightedAverageTargetKey": "sample string 26",
      "WeightedAverageTargetObservationKey": "sample string 27",
      "Width": 28,
      "WindowFunction": null
    }
  ],
  "Columns": [
    {
      "Aggregate": null,
      "AggregateFunction": 1,
      "Alias": "sample string 1",
      "Category": {
        "IsUsedByGroupingItems": true,
        "IsUsedBySelectionItems": true,
        "IsUsedByDisplayItems": true,
        "Id": 1,
        "CategoryName": "sample string 4",
        "ProductId": 5
      },
      "ColumnOffset": 2,
      "ContainerId": 3,
      "DataProvider": "sample string 4",
      "DataTypeId": 5,
      "DefaultAggregate": null,
      "FieldId": 6,
      "FieldTypeId": 7,
      "Format": "sample string 8",
      "HeaderPrefix": "sample string 9",
      "HeaderSuffix": "sample string 10",
      "HeaderText": "sample string 11",
      "Id": "ebfe07ce-9ddb-43f4-b030-3f0d66147693",
      "IgnoreSearchField": true,
      "IsCommonDisplay": true,
      "IsCommonGroup": true,
      "IsCommonSelect": true,
      "IsLogicalContainer": true,
      "IsOr": true,
      "ItemKey": "sample string 19",
      "ItemName": "sample string 20",
      "ObservationHeader": "sample string 21",
      "ObservationKey": "sample string 22",
      "ObservationName": "sample string 23",
      "Operator": 0,
      "RateTargetKey": "sample string 24",
      "SubCategory": {
        "Id": 1,
        "SubCategoryName": "sample string 1",
        "CategoryName": "sample string 2",
        "CategoryId": 1,
        "ProductId": 3
      },
      "Target": null,
      "Value": {},
      "WeightedAverageItems": [],
      "WeightedAverageTargetKey": "sample string 26",
      "WeightedAverageTargetObservationKey": "sample string 27",
      "Width": 28,
      "WindowFunction": null
    },
    {
      "Aggregate": null,
      "AggregateFunction": 1,
      "Alias": "sample string 1",
      "Category": {
        "IsUsedByGroupingItems": true,
        "IsUsedBySelectionItems": true,
        "IsUsedByDisplayItems": true,
        "Id": 1,
        "CategoryName": "sample string 4",
        "ProductId": 5
      },
      "ColumnOffset": 2,
      "ContainerId": 3,
      "DataProvider": "sample string 4",
      "DataTypeId": 5,
      "DefaultAggregate": null,
      "FieldId": 6,
      "FieldTypeId": 7,
      "Format": "sample string 8",
      "HeaderPrefix": "sample string 9",
      "HeaderSuffix": "sample string 10",
      "HeaderText": "sample string 11",
      "Id": "ebfe07ce-9ddb-43f4-b030-3f0d66147693",
      "IgnoreSearchField": true,
      "IsCommonDisplay": true,
      "IsCommonGroup": true,
      "IsCommonSelect": true,
      "IsLogicalContainer": true,
      "IsOr": true,
      "ItemKey": "sample string 19",
      "ItemName": "sample string 20",
      "ObservationHeader": "sample string 21",
      "ObservationKey": "sample string 22",
      "ObservationName": "sample string 23",
      "Operator": 0,
      "RateTargetKey": "sample string 24",
      "SubCategory": {
        "Id": 1,
        "SubCategoryName": "sample string 1",
        "CategoryName": "sample string 2",
        "CategoryId": 1,
        "ProductId": 3
      },
      "Target": null,
      "Value": {},
      "WeightedAverageItems": [],
      "WeightedAverageTargetKey": "sample string 26",
      "WeightedAverageTargetObservationKey": "sample string 27",
      "Width": 28,
      "WindowFunction": null
    }
  ],
  "SortKeys": [
    {
      "ItemKey": "sample string 1",
      "ObservationKey": "sample string 2",
      "Direction": 0
    },
    {
      "ItemKey": "sample string 1",
      "ObservationKey": "sample string 2",
      "Direction": 0
    }
  ],
  "GroupKeys": [
    {
      "ItemKey": "sample string 1",
      "ObservationKey": "sample string 2",
      "Direction": 0
    },
    {
      "ItemKey": "sample string 1",
      "ObservationKey": "sample string 2",
      "Direction": 0
    }
  ],
  "StartAt": 1,
  "Take": 2,
  "ProductId": 3,
  "EntityName": "sample string 4",
  "Options": [
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Value": "sample string 2"
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'SI.Model.Simfund.Generic.QueryCriteria'.

Response Information

Resource Description

Specified Column values

Collection of SI.Model.Simfund.Generic.CustomItem

Name	Type	Additional 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
  }
]