Oms API GET run text all - openmpp/openmpp.github.io GitHub Wiki
Get model run results, including text (description and notes) in all languages
Methods:
GET /api/model/:model/run/:run/text-all
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.
Call examples:
http://localhost:4040/api/model/modelOne/run/Default/text-all
http://localhost:4040/api/model/_201208171604590148_/run/Default/text-all
http://localhost:4040/api/model/modelOne/run/6fbad822cb9ae42deea1ede626890711/text-all
http://localhost:4040/api/model/modelOne/run/2019_01_17_19_59_52_998/text-all
Return example:
{
"ModelName": "modelOne",
"ModelDigest": "_201208171604590148_",
"Name": "Default",
"SubCount": 1,
"SubStarted": 1,
"SubCompleted": 1,
"CreateDateTime": "2021-11-10 19:07:56.864",
"Status": "s",
"UpdateDateTime": "2021-11-10 19:08:00.537",
"RunDigest": "b2b0878d5b6740983429a06cd856a9b0",
"ValueDigest": "a1c9a056f2ee40fcc1e07471097845a7",
"RunStamp": "2021_11_10_19_07_56_837",
"Txt": [
{
"LangCode": "EN",
"Descr": "Model One default set of parameters",
"Note": ""
},
{
"LangCode": "FR",
"Descr": "Modèle Un ensemble de paramètres par défaut",
"Note": ""
}
],
"Opts": {
"OpenM.LogFilePath": "modelOne.log",
"OpenM.RunName": "Default",
"OpenM.RunStamp": "2021_11_10_19_07_56_837",
"OpenM.SetId": "2",
"OpenM.SetName": "Default"
},
"Param": [
{
"Name": "ageSex",
"Txt": [
{
"LangCode": "EN",
"Note": "Age by Sex default values"
},
{
"LangCode": "FR",
"Note": "Valeurs par défaut de l'Âge par Sexe"
}
],
"SubCount": 1,
"DefaultSubId": 0,
"ValueDigest": "ca3edf7630fae786c75f10781a664933"
},
{
"Name": "salaryAge",
"Txt": [
{
"LangCode": "EN",
"Note": "Salary by Age default values"
},
{
"LangCode": "FR",
"Note": "Salaire par Âge valeurs par défaut"
}
],
"SubCount": 1,
"DefaultSubId": 0,
"ValueDigest": "0becae6201e424a1f3b66e421864b4b3"
},
{
"Name": "StartingSeed",
"Txt": [
{
"LangCode": "EN",
"Note": "Starting seed default value"
}
],
"SubCount": 1,
"DefaultSubId": 0,
"ValueDigest": "cb565f810da2b25939d0bd958cb5392a"
},
{
"Name": "salaryFull",
"Txt": [
{
"LangCode": "EN",
"Note": "Full or part time by Salary default values"
}
],
"SubCount": 1,
"DefaultSubId": 0,
"ValueDigest": "a2f1ce089553caf3f7fb080aa170507d"
},
{
"Name": "baseSalary",
"Txt": [],
"SubCount": 1,
"DefaultSubId": 0,
"ValueDigest": "1541b570479f12a40b9d8a782795c7c2"
},
{
"Name": "filePath",
"Txt": [],
"SubCount": 1,
"DefaultSubId": 0,
"ValueDigest": "f5d536e282b0941dc84f17cc11a94091"
},
{
"Name": "isOldAge",
"Txt": [
{
"LangCode": "EN",
"Note": "Is old age default values"
}
],
"SubCount": 1,
"DefaultSubId": 0,
"ValueDigest": "ef4288d0277e97b1b8a2009ce962323b"
},
{
"Name": "salaryByYears",
"Txt": [
{
"LangCode": "EN",
"Note": "Salary by Years default values"
}
],
"SubCount": 1,
"DefaultSubId": 0,
"ValueDigest": "41934eed3ed19a88b3cb346e447f689f"
},
{
"Name": "salaryByPeriod",
"Txt": [
{
"LangCode": "EN",
"Note": "Salary by Period default values"
}
],
"SubCount": 1,
"DefaultSubId": 0,
"ValueDigest": "3871b18ad0ae36bab0a5badd5bcaab6f"
},
{
"Name": "salaryByLow",
"Txt": [
{
"LangCode": "EN",
"Note": "Salary by Low Period default values"
}
],
"SubCount": 1,
"DefaultSubId": 0,
"ValueDigest": "b93c3f85f3259f2ad709f39403e7fac9"
},
{
"Name": "salaryByMiddle",
"Txt": [
{
"LangCode": "EN",
"Note": "Salary by Middle Period default values"
}
],
"SubCount": 1,
"DefaultSubId": 0,
"ValueDigest": "6e0d6bf8f96c2d89ff2d2ae2fd82997b"
}
],
"Table": [
{
"Name": "salarySex",
"ValueDigest": "2d860e00b49881ed802377529236fc0e"
},
{
"Name": "fullAgeSalary",
"ValueDigest": "6f55fbd529a126a6d5ac6a6e855476ce"
},
{
"Name": "ageSexIncome",
"ValueDigest": "72121007312255cdcad7a82b46e6aa9c"
},
{
"Name": "seedOldAge",
"ValueDigest": "df4c82301d470072348f996b7d75424d"
},
{
"Name": "incomeByYear",
"ValueDigest": "83b59f82f2b57268886db6fad85bf423"
},
{
"Name": "incomeByLow",
"ValueDigest": "d4fac571f0a6943afb96ab428ac79b4a"
},
{
"Name": "incomeByMiddle",
"ValueDigest": "818c1b6a7ee16d13377e6ffb5355948f"
},
{
"Name": "incomeByPeriod",
"ValueDigest": "5379aabc2d6ca654c6e28766ca597d20"
}
],
"Progress": [
{
"SubId": 0,
"CreateDateTime": "2021-11-10 19:08:00.399",
"Status": "s",
"UpdateDateTime": "2021-11-10 19:08:00.433",
"Count": 100,
"Value": 0
}
]
}