Oms API GET service config - openmpp/openmpp.github.io GitHub Wiki

GET web-service configuration.

This method return web-service configuration and environment variables which names started from OM_CFG_ prefix.

This is a beta version and may change in the future.

Method:

GET /api/service/config

Call examples:

http://localhost:4040/api/service/config

Example:

{
  "OmsName": "_4040",
  "DoubleFmt": "%.15g",
  "LoginUrl": "",
  "LogoutUrl": "",
  "AllowUserHome": true,
  "AllowDownload": true,
  "AllowUpload": true,
  "AllowMicrodata": true,
  "IsJobControl": true,
  "IsModelDoc": true,
  "IsDiskUse": true,
  "DiskUse": {
      "DiskScanMs": 11000,
      "Limit": 12884901888,
      "AllLimit": 85899345920
  },
  "Env": {
    "OM_CFG_INI_ALLOW": "true",
    "OM_CFG_INI_ANY_KEY": "true"
  },
  "ModelCatalog": {
    "ModelDir": "models/bin",
    "ModelLogDir": "models/log",
    "IsLogDirEnabled": true,
    "LastTimeStamp": ""
  },
  "RunCatalog": {
    "RunTemplates": [
      "run.Debug.template.txt"
    ],
    "DefaultMpiTemplate": "mpi.ModelRun.template.txt",
    "MpiTemplates": [
      "mpi.ModelRun.template.txt",
      "mpi.RiskPaths.template.txt"
    ],
    "Presets": [
      {
        "Name": "any_model.1.Use_Defaults",
        "Options": "{\r\n  \"Text\": [{\r\n      \"LangCode\": \"EN\",\r\n      \"ShortLabel\": \"Default Options\",\r\n      \"Descr\": \"Use default model run options\"\r\n    }, {\r\n      \"LangCode\": \"FR\",\r\n      \"ShortLabel\": \"Options par défaut\",\r\n      \"Descr\": \"Utiliser les options d'exécution du modèle par défaut\"\r\n    }\r\n  ],\r\n  \"subCount\": 1,\r\n  \"threadCount\": 1,\r\n  \"workDir\": \"\",\r\n  \"csvDir\": \"\",\r\n  \"csvCodeId\": \"enumCode\",\r\n  \"useIni\": false,\r\n  \"iniAnyKey\": false,\r\n  \"profile\": \"\",\r\n  \"sparseOutput\": false,\r\n  \"progressPercent\": 1,\r\n  \"progressStep\": 0.0,\r\n  \"runTmpl\": \"\",\r\n  \"mpiNpCount\": 0,\r\n  \"mpiOnRoot\": false,\r\n  \"mpiTmpl\": \"\"\r\n}\r\n"
      },
      {
        "Name": "any_model.2.Large_Run",
        "Options": "{\r\n  \"Text\": [{\r\n      \"LangCode\": \"EN\",\r\n      \"ShortLabel\": \"Large Run\",\r\n      \"Descr\": \"Large model run: use back-end MPI Cluster\"\r\n    }, {\r\n      \"LangCode\": \"FR\",\r\n      \"ShortLabel\": \"Grande Course\",\r\n      \"Descr\": \"Grande exécution de modèle : utilisez le cluster MPI back-end\"\r\n    }\r\n  ],\r\n  \"threadCount\": 3,\r\n  \"mpiNpCount\": 5,\r\n  \"mpiOnRoot\": false,\r\n  \"mpiTmpl\": \"mpi.c-all4.template.txt\"\r\n}\r\n"
      }
    ]
  }
}
⚠️ **GitHub.com Fallback** ⚠️