-
Notifications
You must be signed in to change notification settings - Fork 0
Oms API GET model text
amc1999 edited this page Mar 5, 2024
·
3 revisions
Get model metadata including text (description and notes) in current user language.
Methods:
GET /api/model/:model/text
GET /api/model/:model/text/lang/:lang
GET /api/model/:model/pack/text
GET /api/model/:model/pack/text/lang/:lang
The /pack/ version of the method produce more compact output results.
For example range types are retrurned as [min, max] enum id's only:
{
"Type": {
"ModelId": 101,
"TypeId": 103,
"TypeHid": 101,
"Name": "LIFE",
"Digest": "90bc3191bed66b07d1c7b9f88c42584c",
"DicId": 3,
"TotalEnumId": 101,
"IsRange": true,
"MinEnumId": 0,
"MaxEnumId": 100
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Simulated age range",
"Note": ""
},
"TypeEnumTxt": []
},
And a regular method (without /pack/) return a full list of enum type values:
{
"Type": {
"ModelId": 101,
"TypeId": 103,
"TypeHid": 101,
"Name": "LIFE",
"Digest": "90bc3191bed66b07d1c7b9f88c42584c",
"DicId": 3,
"TotalEnumId": 101,
"IsRange": true,
"MinEnumId": 0,
"MaxEnumId": 100
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Simulated age range",
"Note": ""
},
"TypeEnumTxt": [{
"Enum": {
"ModelId": 101,
"TypeId": 103,
"EnumId": 0,
"Name": "0"
},
"DescrNote": {
"LangCode": "EN",
"Descr": "0",
"Note": ""
}
}, {
................
................
}, {
"Enum": {
"ModelId": 101,
"TypeId": 103,
"EnumId": 100,
"Name": "100"
},
"DescrNote": {
"LangCode": "EN",
"Descr": "100",
"Note": ""
}
}
]
}
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.
:lang - (optional) language code
If optional lang argument specified then result in that language else in browser language or model default.
If no such language exist then result in model default language or can be empty.
Call examples:
http://localhost:4040/api/model/modelOne/text
http://localhost:4040/api/model/modelOne/text/lang/en
http://localhost:4040/api/model/_201208171604590148_/text/lang/en_CA
http://localhost:4040/api/model/RiskPaths/pack/text
Return example:
{
"Model": {
"ModelId": 1,
"Name": "modelOne",
"Digest": "_201208171604590148_",
"Type": 0,
"Version": "1.0",
"CreateDateTime": "2012-08-17 16:04:59.148",
"DefaultLangCode": "EN"
},
"DescrNote": {
"LangCode": "EN",
"Descr": "First model",
"Note": "First model: openM++ development test model"
},
"TypeTxt": [
{
"Type": {
"ModelId": 1,
"TypeId": 4,
"TypeHid": 4,
"Name": "int",
"Digest": "_int_",
"DicId": 0,
"TotalEnumId": 1
},
"DescrNote": {
"LangCode": "",
"Descr": "",
"Note": ""
},
"TypeEnumTxt": []
},
{
"Type": {
"ModelId": 1,
"TypeId": 7,
"TypeHid": 7,
"Name": "bool",
"Digest": "_bool_",
"DicId": 1,
"TotalEnumId": 2
},
"DescrNote": {
"LangCode": "EN",
"Descr": "logical type",
"Note": ""
},
"TypeEnumTxt": [
{
"Enum": {
"ModelId": 1,
"TypeId": 7,
"EnumId": 0,
"Name": "false"
},
"DescrNote": {
"LangCode": "EN",
"Descr": "False",
"Note": ""
}
},
{
"Enum": {
"ModelId": 1,
"TypeId": 7,
"EnumId": 1,
"Name": "true"
},
"DescrNote": {
"LangCode": "EN",
"Descr": "True",
"Note": ""
}
}
]
},
{
"Type": {
"ModelId": 1,
"TypeId": 14,
"TypeHid": 14,
"Name": "double",
"Digest": "_double_",
"DicId": 0,
"TotalEnumId": 1
},
"DescrNote": {
"LangCode": "",
"Descr": "",
"Note": ""
},
"TypeEnumTxt": []
},
{
"Type": {
"ModelId": 1,
"TypeId": 21,
"TypeHid": 21,
"Name": "file",
"Digest": "_file_",
"DicId": 0,
"TotalEnumId": 1
},
"DescrNote": {
"LangCode": "",
"Descr": "",
"Note": ""
},
"TypeEnumTxt": []
},
{
"Type": {
"ModelId": 1,
"TypeId": 101,
"TypeHid": 96,
"Name": "age",
"Digest": "_20128171604590121",
"DicId": 2,
"TotalEnumId": 500
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Age",
"Note": ""
},
"TypeEnumTxt": [
{
"Enum": {
"ModelId": 1,
"TypeId": 101,
"EnumId": 10,
"Name": "10-20"
},
"DescrNote": {
"LangCode": "EN",
"Descr": "age 10-20",
"Note": ""
}
},
{
"Enum": {
"ModelId": 1,
"TypeId": 101,
"EnumId": 20,
"Name": "20-30"
},
"DescrNote": {
"LangCode": "EN",
"Descr": "age 20-30",
"Note": ""
}
},
{
"Enum": {
"ModelId": 1,
"TypeId": 101,
"EnumId": 30,
"Name": "30-40"
},
"DescrNote": {
"LangCode": "EN",
"Descr": "age 30-40",
"Note": ""
}
},
{
"Enum": {
"ModelId": 1,
"TypeId": 101,
"EnumId": 40,
"Name": "40+"
},
"DescrNote": {
"LangCode": "EN",
"Descr": "age 40+",
"Note": ""
}
}
]
},
{
"Type": {
"ModelId": 1,
"TypeId": 102,
"TypeHid": 97,
"Name": "sex",
"Digest": "_20128171604590122",
"DicId": 2,
"TotalEnumId": 800
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Sex",
"Note": ""
},
"TypeEnumTxt": [
{
"Enum": {
"ModelId": 1,
"TypeId": 102,
"EnumId": 0,
"Name": "M"
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Male",
"Note": ""
}
},
{
"Enum": {
"ModelId": 1,
"TypeId": 102,
"EnumId": 1,
"Name": "F"
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Female",
"Note": ""
}
}
]
},
{
"Type": {
"ModelId": 1,
"TypeId": 103,
"TypeHid": 98,
"Name": "salary",
"Digest": "_20128171604590123",
"DicId": 2,
"TotalEnumId": 400
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Salary",
"Note": ""
},
"TypeEnumTxt": [
{
"Enum": {
"ModelId": 1,
"TypeId": 103,
"EnumId": 100,
"Name": "L"
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Low",
"Note": ""
}
},
{
"Enum": {
"ModelId": 1,
"TypeId": 103,
"EnumId": 200,
"Name": "M"
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Medium",
"Note": ""
}
},
{
"Enum": {
"ModelId": 1,
"TypeId": 103,
"EnumId": 300,
"Name": "H"
},
"DescrNote": {
"LangCode": "EN",
"Descr": "High",
"Note": ""
}
}
]
},
{
"Type": {
"ModelId": 1,
"TypeId": 104,
"TypeHid": 99,
"Name": "full",
"Digest": "_20128171604590124",
"DicId": 2,
"TotalEnumId": 44
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Full or part time",
"Note": ""
},
"TypeEnumTxt": [
{
"Enum": {
"ModelId": 1,
"TypeId": 104,
"EnumId": 22,
"Name": "Full"
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Full-time",
"Note": ""
}
},
{
"Enum": {
"ModelId": 1,
"TypeId": 104,
"EnumId": 33,
"Name": "Part"
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Part-time",
"Note": ""
}
}
]
}
],
"ParamTxt": [
{
"Param": {
"ModelId": 1,
"ParamId": 0,
"ParamHid": 44,
"Name": "ageSex",
"Digest": "_20128171604590131",
"Rank": 2,
"TypeId": 14,
"IsExtendable": true,
"IsHidden": false,
"NumCumulated": 0,
"DbRunTable": "ageSex_p_2012817",
"DbSetTable": "ageSex_w_2012817",
"ImportDigest": "_i0128171604590131"
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Age by Sex",
"Note": "Age by Sex note"
},
"ParamDimsTxt": [
{
"Dim": {
"ModelId": 1,
"ParamId": 0,
"DimId": 0,
"Name": "dim0",
"TypeId": 101
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Age Dim",
"Note": "Age Dim notes"
}
},
{
"Dim": {
"ModelId": 1,
"ParamId": 0,
"DimId": 1,
"Name": "dim1",
"TypeId": 102
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Sex Dim",
"Note": "Sex Dim notes"
}
}
]
},
{
"Param": {
"ModelId": 1,
"ParamId": 1,
"ParamHid": 45,
"Name": "salaryAge",
"Digest": "_20128171604590132",
"Rank": 2,
"TypeId": 4,
"IsExtendable": false,
"IsHidden": false,
"NumCumulated": 0,
"DbRunTable": "salaryAge_p_2012818",
"DbSetTable": "salaryAge_w_2012818",
"ImportDigest": "_i0128171604590132"
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Salary by Age",
"Note": "Salary by Age note"
},
"ParamDimsTxt": [
{
"Dim": {
"ModelId": 1,
"ParamId": 1,
"DimId": 0,
"Name": "dim0",
"TypeId": 103
},
"DescrNote": {
"LangCode": "",
"Descr": "",
"Note": ""
}
},
{
"Dim": {
"ModelId": 1,
"ParamId": 1,
"DimId": 1,
"Name": "dim1",
"TypeId": 101
},
"DescrNote": {
"LangCode": "",
"Descr": "",
"Note": ""
}
}
]
},
{
"Param": {
"ModelId": 1,
"ParamId": 2,
"ParamHid": 46,
"Name": "StartingSeed",
"Digest": "_20128171604590133",
"Rank": 0,
"TypeId": 4,
"IsExtendable": false,
"IsHidden": false,
"NumCumulated": 0,
"DbRunTable": "StartingSeed_p_2012819",
"DbSetTable": "StartingSeed_w_2012819",
"ImportDigest": "_i0128171604590133"
},
"DescrNote": {
"LangCode": "FR",
"Descr": "Starting Seed",
"Note": "Random numbers generator starting seed value"
},
"ParamDimsTxt": []
},
{
"Param": {
"ModelId": 1,
"ParamId": 3,
"ParamHid": 47,
"Name": "salaryFull",
"Digest": "_20128171604590134",
"Rank": 1,
"TypeId": 104,
"IsExtendable": false,
"IsHidden": false,
"NumCumulated": 0,
"DbRunTable": "salaryFull_p_2012812",
"DbSetTable": "salaryFull_w_2012812",
"ImportDigest": "_i0128171604590134"
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Full or part time by Salary level",
"Note": ""
},
"ParamDimsTxt": [
{
"Dim": {
"ModelId": 1,
"ParamId": 3,
"DimId": 0,
"Name": "dim0",
"TypeId": 103
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Full Dim",
"Note": ""
}
}
]
},
{
"Param": {
"ModelId": 1,
"ParamId": 4,
"ParamHid": 48,
"Name": "baseSalary",
"Digest": "_20128171604590135",
"Rank": 0,
"TypeId": 104,
"IsExtendable": false,
"IsHidden": false,
"NumCumulated": 0,
"DbRunTable": "baseSalary_p_2012811",
"DbSetTable": "baseSalary_w_2012811",
"ImportDigest": "_i0128171604590135"
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Base salary level",
"Note": ""
},
"ParamDimsTxt": []
},
{
"Param": {
"ModelId": 1,
"ParamId": 5,
"ParamHid": 49,
"Name": "filePath",
"Digest": "_20128171604590136",
"Rank": 0,
"TypeId": 21,
"IsExtendable": false,
"IsHidden": false,
"NumCumulated": 0,
"DbRunTable": "filePath_p_2012814",
"DbSetTable": "filePath_w_2012814",
"ImportDigest": "_i0128171604590136"
},
"DescrNote": {
"LangCode": "EN",
"Descr": "File path string",
"Note": ""
},
"ParamDimsTxt": []
},
{
"Param": {
"ModelId": 1,
"ParamId": 6,
"ParamHid": 50,
"Name": "isOldAge",
"Digest": "_20128171604590137",
"Rank": 1,
"TypeId": 7,
"IsExtendable": false,
"IsHidden": false,
"NumCumulated": 0,
"DbRunTable": "isOldAge_p_2012815",
"DbSetTable": "isOldAge_w_2012815",
"ImportDigest": "_i0128171604590137"
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Is Old Age",
"Note": "Is Old Age notes"
},
"ParamDimsTxt": [
{
"Dim": {
"ModelId": 1,
"ParamId": 6,
"DimId": 0,
"Name": "dim0",
"TypeId": 101
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Age Dim",
"Note": "Age Dim notes"
}
}
]
}
],
"TableTxt": [
{
"Table": {
"ModelId": 1,
"TableId": 0,
"TableHid": 82,
"Name": "salarySex",
"Digest": "_20128171604590182",
"IsUser": false,
"Rank": 2,
"IsSparse": true,
"DbExprTable": "salarySex_v_2012882",
"DbAccTable": "salarySex_a_2012882",
"DbAccAllView": "salarySex_d_2012882",
"ExprPos": 1,
"IsHidden": false,
"ImportDigest": "_i0128171604590182"
},
"LangCode": "EN",
"TableDescr": "Salary by Sex",
"TableNote": "Salary by Sex notes",
"ExprDescr": "Measure",
"ExprNote": "Measure notes",
"TableDimsTxt": [
{
"Dim": {
"ModelId": 1,
"TableId": 0,
"DimId": 0,
"Name": "dim0",
"TypeId": 103,
"IsTotal": false,
"DimSize": 3
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Salary Dim",
"Note": "Salary Dim notes"
}
},
{
"Dim": {
"ModelId": 1,
"TableId": 0,
"DimId": 1,
"Name": "dim1",
"TypeId": 102,
"IsTotal": true,
"DimSize": 3
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Sex Dim",
"Note": "Sex Dim notes"
}
}
],
"TableAccTxt": [
{
"Acc": {
"ModelId": 1,
"TableId": 0,
"AccId": 0,
"Name": "acc0",
"IsDerived": false,
"SrcAcc": "value_sum()",
"AccSql": ""
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Sum of salary by sex",
"Note": ""
}
},
{
"Acc": {
"ModelId": 1,
"TableId": 0,
"AccId": 1,
"Name": "acc1",
"IsDerived": false,
"SrcAcc": "value_count()",
"AccSql": ""
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Count of salary by sex",
"Note": ""
}
},
{
"Acc": {
"ModelId": 1,
"TableId": 0,
"AccId": 2,
"Name": "acc2",
"IsDerived": true,
"SrcAcc": "acc0 + acc1",
"AccSql": ""
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Derived accumulator",
"Note": ""
}
}
],
"TableExprTxt": [
{
"Expr": {
"ModelId": 1,
"TableId": 0,
"ExprId": 0,
"Name": "expr0",
"Decimals": 4,
"SrcExpr": "OM_AVG(acc0)",
"ExprSql": ""
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Average acc0",
"Note": "Average on acc0 notes"
}
},
{
"Expr": {
"ModelId": 1,
"TableId": 0,
"ExprId": 1,
"Name": "expr1",
"Decimals": 4,
"SrcExpr": "OM_SUM(acc1)",
"ExprSql": ""
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Sum acc1",
"Note": ""
}
},
{
"Expr": {
"ModelId": 1,
"TableId": 0,
"ExprId": 2,
"Name": "expr2",
"Decimals": 2,
"SrcExpr": "OM_MIN(acc0)",
"ExprSql": ""
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Min acc0",
"Note": ""
}
},
{
"Expr": {
"ModelId": 1,
"TableId": 0,
"ExprId": 3,
"Name": "expr3",
"Decimals": 3,
"SrcExpr": "OM_AVG(acc0 * acc1)",
"ExprSql": ""
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Average acc0 * acc1",
"Note": ""
}
}
]
},
{
"Table": {
"ModelId": 1,
"TableId": 1,
"TableHid": 83,
"Name": "fullAgeSalary",
"Digest": "_20128171604590183",
"IsUser": false,
"Rank": 3,
"IsSparse": false,
"DbExprTable": "fullAgeSalary_v_2012883",
"DbAccTable": "fullAgeSalary_a_2012883",
"DbAccAllView": "fullAgeSalary_d_2012883",
"ExprPos": 1,
"IsHidden": false,
"ImportDigest": "_i0128171604590183"
},
"LangCode": "EN",
"TableDescr": "Full Time by Age by Salary Group",
"TableNote": "Full Time by Age by Salary Group notes",
"ExprDescr": "Measure",
"ExprNote": "Measure notes",
"TableDimsTxt": [
{
"Dim": {
"ModelId": 1,
"TableId": 1,
"DimId": 0,
"Name": "dim0",
"TypeId": 104,
"IsTotal": false,
"DimSize": 2
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Full Time",
"Note": "Full or Part Time Dim notes"
}
},
{
"Dim": {
"ModelId": 1,
"TableId": 1,
"DimId": 1,
"Name": "dim1",
"TypeId": 101,
"IsTotal": true,
"DimSize": 5
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Age Dim",
"Note": "Age Dim notes"
}
},
{
"Dim": {
"ModelId": 1,
"TableId": 1,
"DimId": 2,
"Name": "dim2",
"TypeId": 103,
"IsTotal": false,
"DimSize": 3
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Salary Dim",
"Note": "Salary Dim notes"
}
}
],
"TableAccTxt": [
{
"Acc": {
"ModelId": 1,
"TableId": 1,
"AccId": 0,
"Name": "acc0",
"IsDerived": false,
"SrcAcc": "raw_value()",
"AccSql": ""
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Full time salary by age",
"Note": "Full time salary by age notes"
}
}
],
"TableExprTxt": [
{
"Expr": {
"ModelId": 1,
"TableId": 1,
"ExprId": 0,
"Name": "expr0",
"Decimals": 2,
"SrcExpr": "OM_AVG(acc0)",
"ExprSql": ""
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Average acc0",
"Note": "Average on acc0 notes"
}
}
]
},
{
"Table": {
"ModelId": 1,
"TableId": 2,
"TableHid": 84,
"Name": "ageSexIncome",
"Digest": "_20128171604590184",
"IsUser": false,
"Rank": 2,
"IsSparse": false,
"DbExprTable": "ageSexIncome_v_2012884",
"DbAccTable": "ageSexIncome_a_2012884",
"DbAccAllView": "ageSexIncome_d_2012884",
"ExprPos": 0,
"IsHidden": false,
"ImportDigest": "_i0128171604590131"
},
"LangCode": "EN",
"TableDescr": "Age by Sex Income",
"TableNote": "Age by Sex Income notes",
"ExprDescr": "Income Measure",
"ExprNote": "Income Measure notes",
"TableDimsTxt": [
{
"Dim": {
"ModelId": 1,
"TableId": 2,
"DimId": 0,
"Name": "dim0",
"TypeId": 101,
"IsTotal": false,
"DimSize": 4
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Age Dim",
"Note": "Age Dim notes"
}
},
{
"Dim": {
"ModelId": 1,
"TableId": 2,
"DimId": 1,
"Name": "dim1",
"TypeId": 102,
"IsTotal": false,
"DimSize": 2
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Sex Dim",
"Note": "Sex Dim notes"
}
}
],
"TableAccTxt": [
{
"Acc": {
"ModelId": 1,
"TableId": 2,
"AccId": 0,
"Name": "acc0",
"IsDerived": false,
"SrcAcc": "raw_value()",
"AccSql": ""
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Income",
"Note": "Income notes"
}
},
{
"Acc": {
"ModelId": 1,
"TableId": 2,
"AccId": 1,
"Name": "acc1",
"IsDerived": false,
"SrcAcc": "adjust_value()",
"AccSql": ""
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Income adjusted",
"Note": "Income adjusted notes"
}
}
],
"TableExprTxt": [
{
"Expr": {
"ModelId": 1,
"TableId": 2,
"ExprId": 0,
"Name": "expr0",
"Decimals": 2,
"SrcExpr": "OM_AVG(acc0)",
"ExprSql": ""
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Average acc0",
"Note": "Average on acc0 notes"
}
},
{
"Expr": {
"ModelId": 1,
"TableId": 2,
"ExprId": 1,
"Name": "expr1",
"Decimals": 3,
"SrcExpr": "OM_AVG(acc1)",
"ExprSql": ""
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Average acc1",
"Note": "Average on acc1 notes"
}
}
]
},
{
"Table": {
"ModelId": 1,
"TableId": 3,
"TableHid": 85,
"Name": "seedOldAge",
"Digest": "_20128171604590185",
"IsUser": false,
"Rank": 0,
"IsSparse": false,
"DbExprTable": "seedOldAge_v_2012885",
"DbAccTable": "seedOldAge_a_2012885",
"DbAccAllView": "seedOldAge_d_2012885",
"ExprPos": 0,
"IsHidden": false,
"ImportDigest": "_i0128171604590185"
},
"LangCode": "EN",
"TableDescr": "Seed Old Age",
"TableNote": "Seed Old Age notes",
"ExprDescr": "Seed Old Age Measure",
"ExprNote": "Measure notes",
"TableDimsTxt": [],
"TableAccTxt": [
{
"Acc": {
"ModelId": 1,
"TableId": 3,
"AccId": 0,
"Name": "acc0",
"IsDerived": false,
"SrcAcc": "raw_value()",
"AccSql": ""
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Seed",
"Note": "Seed notes"
}
}
],
"TableExprTxt": [
{
"Expr": {
"ModelId": 1,
"TableId": 3,
"ExprId": 0,
"Name": "expr0",
"Decimals": 5,
"SrcExpr": "OM_AVG(acc0)",
"ExprSql": ""
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Average acc0",
"Note": "Average on acc0 notes"
}
}
]
}
],
"GroupTxt": [
{
"Group": {
"ModelId": 1,
"GroupId": 1,
"IsParam": true,
"Name": "AllParameters",
"IsHidden": false,
"GroupPc": [
{
"ModelId": 1,
"GroupId": 1,
"ChildPos": 0,
"ChildGroupId": 2,
"ChildLeafId": -1
},
{
"ModelId": 1,
"GroupId": 1,
"ChildPos": 1,
"ChildGroupId": 3,
"ChildLeafId": -1
},
{
"ModelId": 1,
"GroupId": 1,
"ChildPos": 2,
"ChildGroupId": -1,
"ChildLeafId": 2
},
{
"ModelId": 1,
"GroupId": 1,
"ChildPos": 3,
"ChildGroupId": -1,
"ChildLeafId": 5
}
]
},
"DescrNote": {
"LangCode": "EN",
"Descr": "All parameters",
"Note": "All model parameters group"
}
},
{
"Group": {
"ModelId": 1,
"GroupId": 2,
"IsParam": true,
"Name": "AgeSexParameters",
"IsHidden": false,
"GroupPc": [
{
"ModelId": 1,
"GroupId": 2,
"ChildPos": 0,
"ChildGroupId": -1,
"ChildLeafId": 0
},
{
"ModelId": 1,
"GroupId": 2,
"ChildPos": 1,
"ChildGroupId": -1,
"ChildLeafId": 1
},
{
"ModelId": 1,
"GroupId": 2,
"ChildPos": 2,
"ChildGroupId": -1,
"ChildLeafId": 6
}
]
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Age and Sex parameters",
"Note": "Age and Sex model parameters group"
}
},
{
"Group": {
"ModelId": 1,
"GroupId": 3,
"IsParam": true,
"Name": "SalaryParameters",
"IsHidden": false,
"GroupPc": [
{
"ModelId": 1,
"GroupId": 3,
"ChildPos": 0,
"ChildGroupId": -1,
"ChildLeafId": 1
},
{
"ModelId": 1,
"GroupId": 3,
"ChildPos": 1,
"ChildGroupId": -1,
"ChildLeafId": 3
},
{
"ModelId": 1,
"GroupId": 3,
"ChildPos": 2,
"ChildGroupId": -1,
"ChildLeafId": 4
}
]
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Salary parameters",
"Note": "Salary model parameters group"
}
},
{
"Group": {
"ModelId": 1,
"GroupId": 10,
"IsParam": false,
"Name": "AdditionalTables",
"IsHidden": false,
"GroupPc": [
{
"ModelId": 1,
"GroupId": 10,
"ChildPos": 0,
"ChildGroupId": -1,
"ChildLeafId": 1
},
{
"ModelId": 1,
"GroupId": 10,
"ChildPos": 1,
"ChildGroupId": -1,
"ChildLeafId": 2
},
{
"ModelId": 1,
"GroupId": 10,
"ChildPos": 2,
"ChildGroupId": -1,
"ChildLeafId": 3
}
]
},
"DescrNote": {
"LangCode": "EN",
"Descr": "Additional output tables",
"Note": "Additional output tables group notes"
}
}
]
}
- Windows: Quick Start for Model Users
- Windows: Quick Start for Model Developers
- Linux: Quick Start for Model Users
- Linux: Quick Start for Model Developers
- MacOS: Quick Start for Model Users
- MacOS: Quick Start for Model Developers
- Model Run: How to Run the Model
- MIT License, Copyright and Contribution
- Model Code: Programming a model
- Windows: Create and Debug Models
- Linux: Create and Debug Models
- MacOS: Create and Debug Models
- MacOS: Create and Debug Models using Xcode
- Modgen: Convert case-based model to openM++
- Modgen: Convert time-based model to openM++
- Modgen: Convert Modgen models and usage of C++ in openM++ code
- Model Localization: Translation of model messages
- How To: Set Model Parameters and Get Results
- Model Run: How model finds input parameters
- Model Output Expressions
- Model Run Options and ini-file
- OpenM++ Compiler (omc) Run Options
- OpenM++ ini-file format
- UI: How to start user interface
- UI: openM++ user interface
- UI: Create new or edit scenario
- UI: Upload input scenario or parameters
- UI: Run the Model
- UI: Use ini-files or CSV parameter files
- UI: Compare model run results
- UI: Aggregate and Compare Microdata
- UI: Filter run results by value
- UI: Disk space usage and cleanup
- UI Localization: Translation of openM++
- Authored Model Documentation
- Built-in Attributes
- Censor Event Time
- Create Import Set
- Derived Tables
- Entity Attributes in C++
- Entity Function Hooks
- Entity Member Packing
- Entity Tables
- Enumerations
- Events
- Event Trace
- External Names
- Generated Model Documentation
- Groups
- Illustrative Model
Align1 - Lifecycle Attributes
- Local Random Streams
- Memory Use
- Microdata Output
- Model Code
- Model Documentation
- Model Languages
- Model Localization
- Model Metrics Report
- Model Resource Use
- Model Symbols
- Parameter and Table Display and Content
- Population Size and Scaling
- Screened Tables
- Symbol Labels and Notes
- Tables
- Test Models
- Time-like and Event-like Attributes
- Use Modules
- Weighted Tabulation
- File-based Parameter Values
- Oms: openM++ web-service
- Oms: openM++ web-service API
- Oms: How to prepare model input parameters
- Oms: Cloud and model runs queue
- Use R to save output table into CSV file
- Use R to save output table into Excel
- Run model from R: simple loop in cloud
- Run RiskPaths model from R: advanced run in cloud
- Run RiskPaths model in cloud from local PC
- Run model from R and save results in CSV file
- Run model from R: simple loop over model parameter
- Run RiskPaths model from R: advanced parameters scaling
- Run model from Python: simple loop over model parameter
- Run RiskPaths model from Python: advanced parameters scaling
- Windows: Use Docker to get latest version of OpenM++
- Linux: Use Docker to get latest version of OpenM++
- RedHat 8: Use Docker to get latest version of OpenM++
- Quick Start for OpenM++ Developers
- Setup Development Environment
- 2018, June: OpenM++ HPC cluster: Test Lab
- Development Notes: Defines, UTF-8, Databases, etc.
- 2012, December: OpenM++ Design
- 2012, December: OpenM++ Model Architecture, December 2012
- 2012, December: Roadmap, Phase 1
- 2013, May: Prototype version
- 2013, September: Alpha version
- 2014, March: Project Status, Phase 1 completed
- 2016, December: Task List
- 2017, January: Design Notes. Subsample As Parameter problem. Completed
GET Model Metadata
- GET model list
- GET model list including text (description and notes)
- GET model definition metadata
- GET model metadata including text (description and notes)
- GET model metadata including text in all languages
GET Model Extras
GET Model Run results metadata
- GET list of model runs
- GET list of model runs including text (description and notes)
- GET status of model run
- GET status of model run list
- GET status of first model run
- GET status of last model run
- GET status of last completed model run
- GET model run metadata and status
- GET model run including text (description and notes)
- GET model run including text in all languages
GET Model Workset metadata: set of input parameters
- GET list of model worksets
- GET list of model worksets including text (description and notes)
- GET workset status
- GET model default workset status
- GET workset including text (description and notes)
- GET workset including text in all languages
Read Parameters, Output Tables or Microdata values
- Read parameter values from workset
- Read parameter values from workset (enum id's)
- Read parameter values from model run
- Read parameter values from model run (enum id's)
- Read output table values from model run
- Read output table values from model run (enum id's)
- Read output table calculated values from model run
- Read output table calculated values from model run (enum id's)
- Read output table values and compare model runs
- Read output table values and compare model runs (enun id's)
- Read microdata values from model run
- Read microdata values from model run (enum id's)
- Read aggregated microdata from model run
- Read aggregated microdata from model run (enum id's)
- Read microdata run comparison
- Read microdata run comparison (enum id's)
GET Parameters, Output Tables or Microdata values
- GET parameter values from workset
- GET parameter values from model run
- GET output table expression(s) from model run
- GET output table calculated expression(s) from model run
- GET output table values and compare model runs
- GET output table accumulator(s) from model run
- GET output table all accumulators from model run
- GET microdata values from model run
- GET aggregated microdata from model run
- GET microdata run comparison
GET Parameters, Output Tables or Microdata as CSV
- GET csv parameter values from workset
- GET csv parameter values from workset (enum id's)
- GET csv parameter values from model run
- GET csv parameter values from model run (enum id's)
- GET csv output table expressions from model run
- GET csv output table expressions from model run (enum id's)
- GET csv output table accumulators from model run
- GET csv output table accumulators from model run (enum id's)
- GET csv output table all accumulators from model run
- GET csv output table all accumulators from model run (enum id's)
- GET csv calculated table expressions from model run
- GET csv calculated table expressions from model run (enum id's)
- GET csv model runs comparison table expressions
- GET csv model runs comparison table expressions (enum id's)
- GET csv microdata values from model run
- GET csv microdata values from model run (enum id's)
- GET csv aggregated microdata from model run
- GET csv aggregated microdata from model run (enum id's)
- GET csv microdata run comparison
- GET csv microdata run comparison (enum id's)
GET Modeling Task metadata and task run history
- GET list of modeling tasks
- GET list of modeling tasks including text (description and notes)
- GET modeling task input worksets
- GET modeling task run history
- GET status of modeling task run
- GET status of modeling task run list
- GET status of modeling task first run
- GET status of modeling task last run
- GET status of modeling task last completed run
- GET modeling task including text (description and notes)
- GET modeling task text in all languages
Update Model Profile: set of key-value options
- PATCH create or replace profile
- DELETE profile
- POST create or replace profile option
- DELETE profile option
Update Model Workset: set of input parameters
- POST update workset read-only status
- PUT create new workset
- PUT create or replace workset
- PATCH create or merge workset
- DELETE workset
- POST delete multiple worksets
- DELETE parameter from workset
- PATCH update workset parameter values
- PATCH update workset parameter values (enum id's)
- PATCH update workset parameter(s) value notes
- PUT copy parameter from model run into workset
- PATCH merge parameter from model run into workset
- PUT copy parameter from workset to another
- PATCH merge parameter from workset to another
Update Model Runs
- PATCH update model run text (description and notes)
- DELETE model run
- POST delete model runs
- PATCH update run parameter(s) value notes
Update Modeling Tasks
Run Models: run models and monitor progress
Download model, model run results or input parameters
- GET download log file
- GET model download log files
- GET all download log files
- GET download files tree
- POST initiate entire model download
- POST initiate model run download
- POST initiate model workset download
- DELETE download files
- DELETE all download files
Upload model runs or worksets (input scenarios)
- GET upload log file
- GET all upload log files for the model
- GET all upload log files
- GET upload files tree
- POST initiate model run upload
- POST initiate workset upload
- DELETE upload files
- DELETE all upload files
Download and upload user files
- GET user files tree
- POST upload to user files
- PUT create user files folder
- DELETE file or folder from user files
- DELETE all user files
User: manage user settings
Model run jobs and service state
- GET service configuration
- GET job service state
- GET disk usage state
- POST refresh disk space usage info
- GET state of active model run job
- GET state of model run job from queue
- GET state of model run job from history
- PUT model run job into other queue position
- DELETE state of model run job from history
Administrative: manage web-service state
- POST a request to refresh models catalog
- POST a request to close models catalog
- POST a request to close model database
- POST a request to open database file
- POST a request to cleanup database file
- GET the list of database cleanup log(s)
- GET database cleanup log file(s)
- POST a request to pause model run queue
- POST a request to pause all model runs queue
- PUT a request to shutdown web-service