Skip to content

Oms API GET job active state

amc1999 edited this page Jul 25, 2022 · 5 revisions

GET state of active model run job.

This method allow get state of model run job which is running now, results include:

  • model run request options, for example: run name, number of sub-values (sub-samples);
  • model run progress and sub-values progress information;
  • model run log content.

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

Method:

GET /api/service/job/active/:job

Arguments:

:job - (required) model run submission time stamp

Call examples:

http://localhost:4040/api/service/job/active/2022_07_08_22_36_46_203
http://localhost:4040/api/service/job/active/2022_07_08_22_36_46_203-%23-_4040

Example:

{
  "SubmitStamp": "2022_07_08_22_36_46_203",
  "JobStatus": "",
  "ModelName": "RiskPaths",
  "ModelDigest": "d90e1e9a49a06d972ecf1d50e684c62b",
  "RunStamp": "2022_07_08_22_36_46_214",
  "Opts": {
    "OpenM.BaseRunDigest": "d1b00505496e7865002681654bba59d3",
    "OpenM.MessageLanguage": "en-CA",
    "OpenM.RunName": "RiskPaths_New_2022_07_05_11_10_24_111_2022_07_08_22_36_45_218",
    "OpenM.SetName": "New_2022_07_05_11_10_24_111"
  },
  "Threads": 1,
  "Mpi": {
    "Np": 0
  },
  "Template": "",
  "Tables": [
    "TG03_Union_Tables"
  ],
  "RunNotes": [],
  "LogFileName": "RiskPaths.2022_07_08_22_36_46_214.console.log",
  "RunStatus": [
    {
      "ModelName": "RiskPaths",
      "ModelDigest": "d90e1e9a49a06d972ecf1d50e684c62b",
      "ModelVersion": "3.0.0.0",
      "ModelCreateDateTime": "2022-05-05 17:37:15.114",
      "Name": "RiskPaths_New_2022_07_05_11_10_24_111_2022_07_08_22_36_45_218",
      "SubCount": 1,
      "SubStarted": 1,
      "SubCompleted": 0,
      "CreateDateTime": "2022-07-08 22:36:46.231",
      "Status": "p",
      "UpdateDateTime": "2022-07-08 22:37:17.644",
      "RunDigest": "1c3926cbe6c6775e78fbd1791823b866",
      "ValueDigest": "",
      "RunStamp": "2022_07_08_22_36_46_214",
      "Txt": [],
      "Opts": {},
      "Param": [],
      "Table": [],
      "Progress": [
        {
          "SubId": 0,
          "CreateDateTime": "2022-07-08 22:36:46.243",
          "Status": "p",
          "UpdateDateTime": "2022-07-08 22:37:17.644",
          "Count": 5,
          "Value": 701334
        }
      ]
    }
  ],
  "Lines": [
    "2022-07-08 22:36:46.225 RiskPaths",
    "2022-07-08 22:36:46.230 Model version  : 3.0.0.0",
    "2022-07-08 22:36:46.230 Model created  : 2022-05-05 17:37:15.114",
    "2022-07-08 22:36:46.230 Model digest   : d90e1e9a49a06d972ecf1d50e684c62b",
    "2022-07-08 22:36:46.230 OpenM++ version: 2022-05-05 003df091e5b05b7208562c626e7dd72b4dd5055e v1.9.9",
    "2022-07-08 22:36:46.230 OpenM++ build  : Windows 64 bit Release",
    "2022-07-08 22:36:46.230 Model build    : Windows 64 bit Release",
    "2022-07-08 22:36:46.230 Prepare fixed and missing parameters",
    "2022-07-08 22:36:46.230 Run: 2022_07_08_22_36_46_214",
    "2022-07-08 22:36:46.241 Run: 128 RiskPaths_New_2022_07_05_11_10_24_111_2022_07_08_22_36_45_218",
    "2022-07-08 22:36:46.241 Get scenario parameters for process",
    "2022-07-08 22:36:46.243 member=0 Bind scenario parameters",
    "2022-07-08 22:36:46.243 member=0 Compute derived parameters",
    "2022-07-08 22:36:46.243 member=0 Prepare for simulation",
    "2022-07-08 22:36:46.243 member=0 Simulation progress=0% cases=0",
    "2022-07-08 22:36:51.856 member=0 Simulation progress=1% cases=123450",
    "2022-07-08 22:36:57.421 member=0 Simulation progress=2% cases=246900",
    "2022-07-08 22:37:02.941 member=0 Simulation progress=3% cases=370350",
    "2022-07-08 22:37:08.446 member=0 Simulation progress=4% cases=493800",
    "2022-07-08 22:37:13.916 member=0 Simulation progress=5% cases=617250",
    "2022-07-08 22:37:19.401 member=0 Simulation progress=6% cases=740700"
  ]
}

Example: empty response if model run job not found on server

{
  "SubmitStamp": "2022_07_08_22_36_46_123",
  "JobStatus": "",
  "ModelName": "",
  "ModelDigest": "",
  "RunStamp": "",
  "Dir": "",
  "Opts": {},
  "Threads": 0,
  "Mpi": {
    "Np": 0
  },
  "Template": "",
  "Tables": [],
  "RunNotes": [],
  "LogFileName": "",
  "RunStatus": [],
  "Lines": []
}

Home

Getting Started

Model development in OpenM++

Using OpenM++

Model Development Topics

OpenM++ web-service: API and cloud setup

Using OpenM++ from Python and R

Docker

OpenM++ Development

OpenM++ Design, Roadmap and Status

OpenM++ web-service API

GET Model Metadata

GET Model Extras

GET Model Run results metadata

GET Model Workset metadata: set of input parameters

Read Parameters, Output Tables or Microdata values

GET Parameters, Output Tables or Microdata values

GET Parameters, Output Tables or Microdata as CSV

GET Modeling Task metadata and task run history

Update Model Profile: set of key-value options

Update Model Workset: set of input parameters

Update Model Runs

Update Modeling Tasks

Run Models: run models and monitor progress

Download model, model run results or input parameters

Upload model runs or worksets (input scenarios)

Download and upload user files

User: manage user settings

Model run jobs and service state

Administrative: manage web-service state

Clone this wiki locally