Oms API Read Run Parameter value Ids - openmpp/openmpp.github.io GitHub Wiki
Read a "page" of parameter values from model run.
Page is part of parameter 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) and enum-based parameters returned as enum id, not enum codes.
Method verb must be POST and Content-Type header "application/json". JSON body POSTed to specify parameter 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/parameter/value-id
For example:
curl -v -X POST -H "Content-Type: application/json" http://localhost:4040/api/model/modelOne/run/Default/parameter/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/parameter/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": "ageSex",
"Offset": 0,
"Size": 100,
"IsFullPage": true,
"IsSubId": true,
"SubId": 2,
"FilterById": [{
"Name": "AgeGroup",
"Op": "IN",
"EnumIds": [20, 40]
}, {
"Name": "Sex",
"Op": "=",
"EnumIds": [1]
}
],
"OrderBy": [{
"IndexOne": 2,
"IsDesc": true
}, {
"IndexOne": 3,
"IsDesc": true
}
]
}
Name - (required) parameter name
Offset - (optional) zero-based start row to select parameter values
Size - (optional) max row count to select parameter 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 code(s)
OrderBy - (optional) list of columns indexes (one based) to order by
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. In case of parameters columns are:
SELECT sub_id, dim0, dim1, ..., value FROM parameterTable ORDER BY 1, 2,...
Columns always contain enum id's, not enum codes and therefore result ordered by id's
JSON response:
{
Layout: {
Offset: actual first row number of the page data (zero-base),
Size: actual data page row count,
IsLastPage: true if this is last page of data
},
Page: [....page of data...]
}
Example 1:
JSON body:
{
"Name": "ageSex"
}
Result:
< HTTP/1.1 200 OK
< Content-Type: application/json
< Date: Fri, 14 Dec 2018 01:56:34 GMT
< Content-Length: 508
<
{"Layout":{"Offset":0,"Size":8,"IsFullPage":false,"IsLastPage":true}
,"Page":[{"DimIds":[10,0],"IsNull":false,"Value":0.1,"SubId":0}
,{"DimIds":[10,1],"IsNull":false,"Value":0.2,"SubId":0}
,{"DimIds":[20,0],"IsNull":false,"Value":0.3,"SubId":0}
,{"DimIds":[20,1],"IsNull":false,"Value":0.4,"SubId":0}
,{"DimIds":[30,0],"IsNull":false,"Value":0.5,"SubId":0}
,{"DimIds":[30,1],"IsNull":false,"Value":0.6,"SubId":0}
,{"DimIds":[40,0],"IsNull":false,"Value":0.7,"SubId":0}
,{"DimIds":[40,1],"IsNull":false,"Value":0.8,"SubId":0}
]}
Example 2:
JSON body:
{
"Name": "ageSex",
"Offset": 6,
"Size": 4,
"IsFullPage": true
}
Result:
{"Layout":{"Offset":6,"Size":2,"IsFullPage":true,"IsLastPage":true}
,"Page":[{"DimIds":[40,0],"IsNull":false,"Value":0.7,"SubId":0}
,{"DimIds":[40,1],"IsNull":false,"Value":0.8,"SubId":0}
]}
Example 3:
JSON body:
{
"Name": "ageSex",
"Offset": 2,
"OrderBy": [{
"IndexOne": 2,
"IsDesc": true
}, {
"IndexOne": 3,
"IsDesc": true
}
]
}
Result:
{"Layout":{"Offset":2,"Size":6,"IsFullPage":false,"IsLastPage":true}
,"Page":[{"DimIds":[30,1],"IsNull":false,"Value":0.6,"SubId":0}
,{"DimIds":[30,0],"IsNull":false,"Value":0.5,"SubId":0}
,{"DimIds":[20,1],"IsNull":false,"Value":0.4,"SubId":0}
,{"DimIds":[20,0],"IsNull":false,"Value":0.3,"SubId":0}
,{"DimIds":[10,1],"IsNull":false,"Value":0.2,"SubId":0}
,{"DimIds":[10,0],"IsNull":false,"Value":0.1,"SubId":0}
]}
Example 4:
JSON body:
{
"Name": "isOldAge",
"Offset": 0,
"Size": 0,
"IsSubId": true,
"SubId": 2,
"FilterById": [{
"Name": "dim0",
"Op": "IN",
"EnumIds": [20, 40]
}
],
"OrderBy": [{
"IndexOne": 2,
"IsDesc": true
}, {
"IndexOne": 3,
"IsDesc": true
}
]
}
Result:
{
"Page":[
{"DimIds":[40],"IsNull":false,"Value":true,"SubId":2}
,{"DimIds":[20],"IsNull":false,"Value":false,"SubId":2}
],
"Layout":{"Offset":0,"Size":2,"IsLastPage":true,"IsFullPage":false}
}