Oms API Read Run Output table value Ids - openmpp/openmpp.github.io GitHub Wiki
Read a "page" of output table values from model run.
-
Page is part of output table values defined by zero-based "start" row number and row count. If row count <= 0 then all rows below start row number returned.
-
Dimension(s) returned as enum id, not enum codes.
-
Values can be from output table expressions, accumulators or derived accumulators.
-
Method verb must be POST and Content-Type header "application/json".
JSON body POSTed to specify output table name, page size, row count, filters and row order. It is expected to be JSON representation of db.ReadLayout structure from Go library.
Method:
POST /api/model/:model/run/:run/table/value-id
For example:
curl -v -X POST -H "Content-Type: application/json" http://localhost:4040/api/model/modelOne/run/Default/table/value-id -d @test.json
curl -v -X POST -H "Content-Type: application/json" http://localhost:4040/api/model/modelOne/run/2019_01_17_19_59_52_998/table/value-id -d @test.json
Arguments:
:model - (required) model digest or model name
Model can be identified by digest or by model name. It is recommended to use digest because it is uniquely identifies model. It is possible to use model name, which is more human readable than digest, but if there are multiple models with same name in database than result is undefined.
:run - (required) model run digest, run stamp or run name
Model run can be identified by run digest, run stamp or run name. It is recommended to use digest because it is uniquely identifies model run. Run stamp, if not explicitly specified as model run option, automatically generated as timestamp string, ex.: 2016_08_17_21_07_55_123. It is also possible to use name, which is more human readable than digest, but if there are multiple runs with same name in database than result is undefined.
JSON body arguments:
For example:
{
"Name": "salarySex",
"Offset": 0,
"Size": 100,
"IsFullPage": true,
"IsSubId": true,
"SubId": 2,
"FilterById": [{
"Name": "AgeGroup",
"Op": "IN",
"EnumIds": [100, 300]
}, {
"Name": "Province",
"Op": "BETWEEN",
"EnumIds": [1, 800]
}
],
"OrderBy": [{
"IndexOne": 2,
"IsDesc": true
}, {
"IndexOne": 3,
"IsDesc": true
}
],
"ValueName": "acc2",
"IsAccum": true,
"IsAllAccum": true
}
Name - (required) output table name
Offset - (optional) zero-based start row to select output table values
Size - (optional) max row count to select output table values, if size <= 0 then all rows selected
IsFullPage - (optional) if true then always return non-empty last page of data
IsSubId - (optional) if true then select only single sub-value, default: all sub-values
SubId - (optional) sub-value id to select if IsSubId is true
FilterById - (optional) conditions to filter dimension enum id's
OrderBy - (optional) list of columns indexes (one based) to order by
ValueName - (optional) if not empty then only that value selected (ex.: "acc2"), default: all values
IsAccum - (optional) if true then select accumulators
IsAllAccum - (optional) if true then select from "all accumulators" view else from accumulators table
Filter conditions joined by AND and can have following operations:
= - enum id equal to: AgeGroup = 20
!= - enum id not equal to: AgeGroup <> 20
> - enum id greater than: AgeGroup > 20
>= - enum id greater or equal: AgeGroup >= 20
< - enum id less than: AgeGroup < 20
<= - enum id less or equal: AgeGroup <= 20
IN - in the list of id's: AgeGroup IN (20, 30, 40)
BETWEEN - between min and max: AgeGroup BETWEEN 20 AND 40
IN_AUTO - automatically choose most suitable: = or != or IN or BETWEEN
Order by specified by one-based column(s) index(es) in result. Columns always contain enum id's, not enum codes and therefore result ordered by id's
In case of output table expressions columns are:
SELECT expr_id, dim0, dim1, ..., expr_value FROM valueTable ORDER BY 1, 2,...
In case of output table accumulators columns are:
SELECT acc_id, sub_id, dim0, dim1, ..., acc_value FROM accumulatorTable ORDER BY 1, 2,...
In case of "all accumulators" columns are:
SELECT sub_id, dim0, dim1, ..., acc0, acc1,... FROM allAccumulatorsView ORDER BY 1, 2,...
Example 1:
JSON body:
{
"Name": "salarySex"
}
Result:
< Access-Control-Allow-Origin: *
< Content-Type: application/json
< Date: Tue, 19 Dec 2017 19:04:15 GMT
< Transfer-Encoding: chunked
<
{"Layout":{"Offset":0,"Size":36,"IsFullPage":false,"IsLastPage":true}
,"Page":[{"DimIds":[100,0],"Value":50,"IsNull":false,"ExprId":0}
,{"DimIds":[100,1],"Value":60,"IsNull":false,"ExprId":0}
,{"DimIds":[100,800],"Value":1,"IsNull":false,"ExprId":0}
,{"DimIds":[200,0],"Value":51.599999999999994,"IsNull":false,"ExprId":0}
,{"DimIds":[200,1],"Value":62,"IsNull":false,"ExprId":0}
,{"DimIds":[200,800],"Value":2,"IsNull":false,"ExprId":0}
,{"DimIds":[300,0],"Value":53.2,"IsNull":false,"ExprId":0}
,{"DimIds":[300,1],"Value":64,"IsNull":false,"ExprId":0}
,{"DimIds":[300,800],"Value":3,"IsNull":false,"ExprId":0}
,{"DimIds":[100,0],"Value":1,"IsNull":false,"ExprId":1}
,{"DimIds":[100,1],"Value":2,"IsNull":false,"ExprId":1}
,{"DimIds":[100,800],"Value":801,"IsNull":false,"ExprId":1}
,{"DimIds":[200,0],"Value":3,"IsNull":false,"ExprId":1}
,{"DimIds":[200,1],"Value":4,"IsNull":false,"ExprId":1}
,{"DimIds":[200,800],"Value":803,"IsNull":false,"ExprId":1}
,{"DimIds":[300,0],"Value":4,"IsNull":false,"ExprId":1}
,{"DimIds":[300,1],"Value":5,"IsNull":false,"ExprId":1}
,{"DimIds":[300,800],"Value":804,"IsNull":false,"ExprId":1}
,{"DimIds":[100,0],"Value":50,"IsNull":false,"ExprId":2}
,{"DimIds":[100,1],"Value":60,"IsNull":false,"ExprId":2}
,{"DimIds":[100,800],"Value":1,"IsNull":false,"ExprId":2}
,{"DimIds":[200,0],"Value":51.599999999999994,"IsNull":false,"ExprId":2}
,{"DimIds":[200,1],"Value":62,"IsNull":false,"ExprId":2}
,{"DimIds":[200,800],"Value":2,"IsNull":false,"ExprId":2}
,{"DimIds":[300,0],"Value":53.2,"IsNull":false,"ExprId":2}
,{"DimIds":[300,1],"Value":64,"IsNull":false,"ExprId":2}
,{"DimIds":[300,800],"Value":3,"IsNull":false,"ExprId":2}
,{"DimIds":[100,0],"Value":50,"IsNull":false,"ExprId":3}
,{"DimIds":[100,1],"Value":120,"IsNull":false,"ExprId":3}
,{"DimIds":[100,800],"Value":801,"IsNull":false,"ExprId":3}
,{"DimIds":[200,0],"Value":154.79999999999998,"IsNull":false,"ExprId":3}
,{"DimIds":[200,1],"Value":248,"IsNull":false,"ExprId":3}
,{"DimIds":[200,800],"Value":1606,"IsNull":false,"ExprId":3}
,{"DimIds":[300,0],"Value":212.8,"IsNull":false,"ExprId":3}
,{"DimIds":[300,1],"Value":320,"IsNull":false,"ExprId":3}
,{"DimIds":[300,800],"Value":2412,"IsNull":false,"ExprId":3}
]}
Example 2:
JSON body:
{
"Name": "salarySex",
"Offset": 32,
"Size": 8,
"IsFullPage": true
}
Result:
{"Layout":{"Offset":32,"Size":4,"IsFullPage":true,"IsLastPage":true}
,"Page":[{"DimIds":[200,800],"Value":1606,"IsNull":false,"ExprId":3}
,{"DimIds":[300,0],"Value":212.8,"IsNull":false,"ExprId":3}
,{"DimIds":[300,1],"Value":320,"IsNull":false,"ExprId":3}
,{"DimIds":[300,800],"Value":2412,"IsNull":false,"ExprId":3}
]}
Example 3:
JSON body:
{
"Name": "salarySex",
"FilterById": [],
"OrderBy": [{
"IndexOne": 2,
"IsDesc": true
}, {
"IndexOne": 3,
"IsDesc": true
}
],
"IsAccum": true,
"IsAllAccum": false
}
Result:
{"Layout":{"Offset":0,"Size":18,"IsFullPage":false,"IsLastPage":true}
,"Page":[{"DimIds":[300,0],"Value":53.2,"IsNull":false,"AccId":0,"SubId":0}
,{"DimIds":[300,1],"Value":64,"IsNull":false,"AccId":0,"SubId":0}
,{"DimIds":[300,800],"Value":3,"IsNull":false,"AccId":0,"SubId":0}
,{"DimIds":[300,0],"Value":4,"IsNull":false,"AccId":1,"SubId":0}
,{"DimIds":[300,1],"Value":5,"IsNull":false,"AccId":1,"SubId":0}
,{"DimIds":[300,800],"Value":804,"IsNull":false,"AccId":1,"SubId":0}
,{"DimIds":[200,0],"Value":51.599999999999994,"IsNull":false,"AccId":0,"SubId":0}
,{"DimIds":[200,1],"Value":62,"IsNull":false,"AccId":0,"SubId":0}
,{"DimIds":[200,800],"Value":2,"IsNull":false,"AccId":0,"SubId":0}
,{"DimIds":[200,0],"Value":3,"IsNull":false,"AccId":1,"SubId":0}
,{"DimIds":[200,1],"Value":4,"IsNull":false,"AccId":1,"SubId":0}
,{"DimIds":[200,800],"Value":803,"IsNull":false,"AccId":1,"SubId":0}
,{"DimIds":[100,0],"Value":50,"IsNull":false,"AccId":0,"SubId":0}
,{"DimIds":[100,1],"Value":60,"IsNull":false,"AccId":0,"SubId":0}
,{"DimIds":[100,800],"Value":1,"IsNull":false,"AccId":0,"SubId":0}
,{"DimIds":[100,0],"Value":1,"IsNull":false,"AccId":1,"SubId":0}
,{"DimIds":[100,1],"Value":2,"IsNull":false,"AccId":1,"SubId":0}
,{"DimIds":[100,800],"Value":801,"IsNull":false,"AccId":1,"SubId":0}
]}
Example 3:
JSON body:
{
"Name": "salarySex",
"Offset": 0,
"Size": 0,
"IsSubId": true,
"SubId": 2,
"FilterById": [{
"Name": "dim0",
"Op": "IN",
"EnumIds": [100, 300]
}, {
"Name": "dim1",
"Op": "BETWEEN",
"EnumIds": [1, 800]
}
],
"OrderBy": [{
"IndexOne": 2,
"IsDesc": true
}, {
"IndexOne": 3,
"IsDesc": true
}
],
"ValueName": "acc1",
"IsAccum": true,
"IsAllAccum": true
}
Result:
{
"Page":[
{"DimIds":[300,800],"SubId":2,"IsNull":[false],"Value":[804]}
,{"DimIds":[300,1],"SubId":2,"IsNull":[false],"Value":[5]}
,{"DimIds":[100,800],"SubId":2,"IsNull":[false],"Value":[802]}
,{"DimIds":[100,1],"SubId":2,"IsNull":[false],"Value":[3]}
],
"Layout":{"Offset":0,"Size":4,"IsLastPage":true,"IsFullPage":false}
}