POST api/DataObservation

Request Information

URI Parameters

None.

Body Parameters

SI.Model.Simfund.Retirement.DTO.DataObservationRequest

Name	Type	Additional information
ItemKey	string	None.
ObservationKeys	Collection of string	None.
AggregateFunctions	Collection of integer	None.
WindowFunctions	Collection of integer	None.
GroupKey	string	None.
SelectionCriteria	SI.Model.Simfund.Retirement.DTO.AdvancedSearchCriteria	None.
ProductId	integer	None.
WindowRangeFilter	SI.Model.Simfund.Retirement.DTO.SearchPredicate	None.

Request Formats

application/json, text/json

Sample:

{
  "ItemKey": "sample string 1",
  "ObservationKeys": [
    "sample string 1",
    "sample string 2"
  ],
  "AggregateFunctions": [
    1,
    2
  ],
  "WindowFunctions": [
    1,
    2
  ],
  "GroupKey": "sample string 2",
  "SelectionCriteria": {
    "Predicates": [
      {
        "ItemKey": "sample string 1",
        "ObservationKey": "sample string 2",
        "Value": {},
        "IsOr": true,
        "Operator": 0,
        "ContainerId": 5,
        "IsLogicalContainer": true,
        "IgnoreSearchField": true
      },
      {
        "ItemKey": "sample string 1",
        "ObservationKey": "sample string 2",
        "Value": {},
        "IsOr": true,
        "Operator": 0,
        "ContainerId": 5,
        "IsLogicalContainer": true,
        "IgnoreSearchField": true
      }
    ],
    "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"
  },
  "ProductId": 3,
  "WindowRangeFilter": {
    "ItemKey": "sample string 1",
    "ObservationKey": "sample string 2",
    "Value": {},
    "IsOr": true,
    "Operator": 0,
    "ContainerId": 5,
    "IsLogicalContainer": true,
    "IgnoreSearchField": true
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of SI.Model.Simfund.Retirement.GroupObservation

Name	Description	Type	Additional information
Name		string	None.
Values		Collection of SI.Model.Simfund.Retirement.ItemObservation	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Name": "sample string 1",
    "Values": [
      {
        "ObservationKey": "sample string 1",
        "ObservationEndDate": "2025-04-27T18:49:24.7903087-04:00",
        "ObservationStartDate": "2025-04-27T18:49:24.7903087-04:00",
        "Header": "sample string 2",
        "ItemValue": 1.0
      },
      {
        "ObservationKey": "sample string 1",
        "ObservationEndDate": "2025-04-27T18:49:24.7903087-04:00",
        "ObservationStartDate": "2025-04-27T18:49:24.7903087-04:00",
        "Header": "sample string 2",
        "ItemValue": 1.0
      }
    ]
  },
  {
    "Name": "sample string 1",
    "Values": [
      {
        "ObservationKey": "sample string 1",
        "ObservationEndDate": "2025-04-27T18:49:24.7903087-04:00",
        "ObservationStartDate": "2025-04-27T18:49:24.7903087-04:00",
        "Header": "sample string 2",
        "ItemValue": 1.0
      },
      {
        "ObservationKey": "sample string 1",
        "ObservationEndDate": "2025-04-27T18:49:24.7903087-04:00",
        "ObservationStartDate": "2025-04-27T18:49:24.7903087-04:00",
        "Header": "sample string 2",
        "ItemValue": 1.0
      }
    ]
  }
]