Oms API GET Run Microdata value - openmpp/openmpp.github.io GitHub Wiki

Read a "page" of microdata values from model run.

Page is part of microdata values defined by zero-based "start" row number and row count. If row count <= 0 then all rows returned.

Enum-based microdata attributes returned as enum codes.

Methods:

GET /api/model/:model/run/:run/microdata/:name/value
GET /api/model/:model/run/:run/microdata/:name/value/start/:start
GET /api/model/:model/run/:run/microdata/:name/value/start/:start/count/:count

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.

:name - (required) microdata entity name

:start - (optional) start "page" row number, zero-based.
:count - (optional) "page" size, number of rows to select, if count <= 0 then all rows selected

Call examples:

http://localhost:4040/api/model/modelOne/run/Microdata%20in%20database/microdata/Person/value
http://localhost:4040/api/model/modelOne/run/Microdata%20in%20database/microdata/Person/value/start/131040
http://localhost:4040/api/model/modelOne/run/Microdata%20in%20database/microdata/Person/value/start/131040/count/4
http://localhost:4040/api/model/_201208171604590148_/run/Microdata%20in%20database/microdata/Person/value
http://localhost:4040/api/model/_201208171604590148_/run/2019_01_17_19_59_52_998/microdata/Person/value

Return example:

[{
        "Key": 844424930164716,
        "Attr": [{
                "IsNull": false,
                "Value": "32"
            }, {
                "IsNull": false,
                "Value": "30-40"
            }, {
                "IsNull": false,
                "Value": "M"
            }, {
                "IsNull": false,
                "Value": "268271632"
            }, {
                "IsNull": false,
                "Value": "201203724"
            }, {
                "IsNull": false,
                "Value": "H"
            }, {
                "IsNull": false,
                "Value": "Full"
            }, {
                "IsNull": false,
                "Value": "false"
            }, {
                "IsNull": false,
                "Value": "0"
            }
        ]
    }, {
        "Key": 844424930164717,
        "Attr": [{
                "IsNull": false,
                "Value": "23"
            }, {
                "IsNull": false,
                "Value": "20-30"
            }, {
                "IsNull": false,
                "Value": "F"
            }, {
                "IsNull": false,
                "Value": "268279823"
            }, {
                "IsNull": false,
                "Value": "201209867.25"
            }, {
                "IsNull": false,
                "Value": "H"
            }, {
                "IsNull": false,
                "Value": "Full"
            }, {
                "IsNull": false,
                "Value": "false"
            }, {
                "IsNull": false,
                "Value": "0"
            }
        ]
    }, {
        "Key": 844424930164718,
        "Attr": [{
                "IsNull": false,
                "Value": "14"
            }, {
                "IsNull": false,
                "Value": "10-20"
            }, {
                "IsNull": false,
                "Value": "M"
            }, {
                "IsNull": false,
                "Value": "0"
            }, {
                "IsNull": false,
                "Value": "0"
            }, {
                "IsNull": false,
                "Value": "L"
            }, {
                "IsNull": false,
                "Value": "Part"
            }, {
                "IsNull": false,
                "Value": "false"
            }, {
                "IsNull": false,
                "Value": "0"
            }
        ]
    }, {
        "Key": 844424930164719,
        "Attr": [{
                "IsNull": false,
                "Value": "5"
            }, {
                "IsNull": false,
                "Value": "10-20"
            }, {
                "IsNull": false,
                "Value": "F"
            }, {
                "IsNull": false,
                "Value": "0"
            }, {
                "IsNull": false,
                "Value": "0"
            }, {
                "IsNull": false,
                "Value": "L"
            }, {
                "IsNull": false,
                "Value": "Part"
            }, {
                "IsNull": false,
                "Value": "false"
            }, {
                "IsNull": false,
                "Value": "0"
            }
        ]
    }
]
⚠️ **GitHub.com Fallback** ⚠️