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.

Method:

GET /api/service/config

Call examples:

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

Example:

{
  "OmsName": "admin_4040",
  "DoubleFmt": "%.15g",
  "LoginUrl": "",
  "LogoutUrl": "",
  "AllowUserHome": true,
  "AllowDownload": true,
  "AllowUpload": true,
  "AllowFiles": true,
  "AllowMicrodata": true,
  "IsJobControl": true,
  "IsModelDoc": true,
  "IsDiskUse": true,
  "IsDiskCleanup": true,
  "IsAdminAll": true,
  "IsQueuePaused": true,
  "IsAllQueuePaused": true,
  "JobUpdateDateTime": "2026-01-29 16:09:37.706",
  "MpiRes": {
    "Cpu": 7,
    "Mem": 10
  },
  "MaxOwnMpiRes": {
    "Cpu": 6,
    "Mem": 0
  },
  "ActiveTotalRes": {
    "Cpu": 6,
    "Mem": 0
  },
  "ActiveOwnRes": {
    "Cpu": 3,
    "Mem": 0
  },
  "QueueTotalRes": {
    "Cpu": 2,
    "Mem": 0
  },
  "QueueOwnRes": {
    "Cpu": 0,
    "Mem": 0
  },
  "MpiErrorRes": {
    "Cpu": 0,
    "Mem": 0
  },
  "MpiMaxThreads": 4,
  "LocalRes": {
    "Cpu": 8,
    "Mem": 8
  },
  "LocalActiveTotalRes": {
    "Cpu": 0,
    "Mem": 0
  },
  "LocalActiveRes": {
    "Cpu": 0,
    "Mem": 0
  },
  "LocalQueueTotalRes": {
    "Cpu": 0,
    "Mem": 0
  },
  "LocalQueueRes": {
    "Cpu": 0,
    "Mem": 0
  },
  "DiskUse": {
    "DiskScanMs": 67000,
    "Limit": 107374182400,
    "AllLimit": 0
  },
  "Env": {
    "OM_CFG_INI_ALLOW": "true",
    "OM_CFG_INI_ANY_KEY": "true",
    "OM_CFG_LOGIN_URL": "http://localhost:4040",
    "OM_CFG_LOGOUT_URL": "http://localhost:4040",
    "OM_CFG_TYPE_MAX_LEN": "366"
  },
  "UiExtra": "{\n  \"ModelTreeDescending\": true,\n  \"DefaultTitle\": [{\n      \"Link\": \"https://openmpp.org\",\n      \"LangCode\": \"en\",\n      \"Label\": \"OpenM++\"\n    }, {\n      \"Link\": \"https://openmpp.org\",\n      \"LangCode\": \"fr\",\n      \"Label\": \"OpenM++\"\n    }\n  ],\n  \"MoreMenu\": [{\n      \"Link\": \"https://github.com/openmpp/openmpp.github.io/wiki/Ompp-UI-User-Interface\",\n      \"LangCode\": \"en\",\n      \"Label\": \"UI Help\"\n    }, {\n      \"Link\": \"https://github.com/openmpp/openmpp.github.io/wiki/Ompp-UI-User-Interface\",\n      \"LangCode\": \"fr\",\n      \"Label\": \"Aide de l'interface\"\n    }, {\n      \"Link\": \"https://github.com/openmpp/openmpp.github.io/wiki/Ompp-UI-Create-New-or-Edit-Scenario\",\n      \"LangCode\": \"en\",\n      \"Label\": \"Create Scenario\"\n    }, {\n      \"Link\": \"https://github.com/openmpp/openmpp.github.io/wiki/Ompp-UI-Create-New-or-Edit-Scenario\",\n      \"LangCode\": \"fr\",\n      \"Label\": \"Créer un scénario\"\n    }, {\n      \"Link\": \"https://github.com/openmpp/openmpp.github.io/wiki/Ompp-UI-Disk-Space-Cleanup\",\n      \"LangCode\": \"en\",\n      \"Label\": \"Disk Cleanup\"\n    }, {\n      \"Link\": \"https://github.com/openmpp/openmpp.github.io/wiki/Ompp-UI-Disk-Space-Cleanup\",\n      \"LangCode\": \"fr\",\n      \"Label\": \"Nettoyage de disque\"\n    }, {\n      \"Link\": \"https://github.com/openmpp/openmpp.github.io/wiki\",\n      \"LangCode\": \"en\",\n      \"Label\": \"OpenM++ wiki\"\n    }, {\n      \"Link\": \"https://github.com/openmpp/openmpp.github.io/wiki\",\n      \"LangCode\": \"fr\",\n      \"Label\": \"Wiki d'OpenM++\"\n    }, {\n      \"Link\": \"https://openmpp.org\",\n      \"LangCode\": \"en\",\n      \"Label\": \"OpenM++ website\"\n    }, {\n      \"Link\": \"https://openmpp.org\",\n      \"LangCode\": \"fr\",\n      \"Label\": \"Site d'OpenM++\"\n    }\n  ]\n}\n",
  "ModelCatalog": {
    "ModelDir": "models\\bin",
    "ModelLogDir": "models\\log",
    "IsLogDirEnabled": true,
    "LastTimeStamp": "2026_01_29_16_03_56_663"
  },
  "RunCatalog": {
    "RunTemplates": [
      "run.Debug.template.txt"
    ],
    "DefaultMpiTemplate": "mpi.ModelRun.template.txt",
    "MpiTemplates": [
      "mpi.ModelDebug.template.txt",
      "mpi.ModelRun.template.txt",
      "mpi.RiskPaths.template.txt"
    ],
    "Presets": [
      {
        "Name": "RiskPaths.08.RiskPaths_on_Cluster",
        "Options": "{\n  \"Text\": [{\n      \"LangCode\": \"EN\",\n      \"ShortLabel\": \"Use RiskPaths Options\",\n      \"Descr\": \"RiskPaths model run: use back-end MPI Cluster\"\n    }, {\n      \"LangCode\": \"FR\",\n      \"ShortLabel\": \"Utiliser les options RiskPaths\",\n      \"Descr\": \"RiskPaths exécution de modèle : utilisez le cluster MPI back-end\"\n    }\n  ],\n  \"subCount\": 16,\n  \"threadCount\": 4,\n  \"mpiNpCount\": 5,\n  \"mpiUseJobs\": true,\n  \"mpiOnRoot\": false,\n  \"mpiTmpl\": \"mpi.RiskPaths.template.txt\"\n}\n"
      },
      {
        "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  \"threadCount\": 1,\r\n  \"workDir\": \"\",\r\n  \"useCsvDir\": false,\r\n  \"csvDir\": \"\",\r\n  \"csvId\": false,\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"
      }
    ]
  }
}
⚠️ **GitHub.com Fallback** ⚠️