Skip to content

Oms API GET job history state

amc1999 edited this page Jul 25, 2022 · 5 revisions

GET state of model run job from history.

This method allow get a history of model run job, results include:

  • model run request options, for example: run name, number of sub-values (sub-samples);
  • model run status (success or error) 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/history/:job

Arguments:

:job - (required) model run submission time stamp

Call examples:

http://localhost:4040/api/service/job/history/2022_07_05_19_55_38_626
http://localhost:4040/api/service/job/history/2022_07_05_19_55_38_626-%23-_4040

Example:

{
  "SubmitStamp": "2022_07_07_15_01_04_557",
  "JobStatus": "success",
  "ModelName": "RiskPaths",
  "ModelDigest": "d90e1e9a49a06d972ecf1d50e684c62b",
  "RunStamp": "2022_07_07_15_01_04_558",
  "Opts": {
    "EN.RunDescription": "run desription in English",
    "FR.RunDescription": "run desription in French",
    "OpenM.BaseRunDigest": "bc5ada86d3f9ec460f4e3599fdcf398b",
    "OpenM.MessageLanguage": "en-us",
    "OpenM.RunName": "RiskPaths_Default_2022_07_07_14_58_29_850",
    "OpenM.SetName": "Default",
    "OpenM.SubValues": "16"
  },
  "Threads": 3,
  "Mpi": {
    "Np": 0
  },
  "Template": "",
  "Tables": [
    "TG03_Union_Tables"
  ],
  "RunNotes": [
    {
      "LangCode": "EN",
      "Note": "Run notes (English)"
    },
    {
      "LangCode": "FR",
      "Note": "Run notes (French)"
    }
  ],
  "LogFileName": "RiskPaths.2022_07_07_15_01_04_558.console.log",
  "RunStatus": [
    {
      "ModelName": "RiskPaths",
      "ModelDigest": "d90e1e9a49a06d972ecf1d50e684c62b",
      "ModelVersion": "3.0.0.0",
      "ModelCreateDateTime": "2022-05-05 17:37:15.114",
      "Name": "RiskPaths_Default_2022_07_07_14_58_29_850",
      "SubCount": 16,
      "SubStarted": 16,
      "SubCompleted": 16,
      "CreateDateTime": "2022-07-07 15:01:04.961",
      "Status": "s",
      "UpdateDateTime": "2022-07-07 15:01:05.391",
      "RunDigest": "9a26d67e2eb95372b378e63c7f5f1f4c",
      "ValueDigest": "14555ba4e1c0c31df0635968a3cd7996",
      "RunStamp": "2022_07_07_15_01_04_558",
      "Txt": [],
      "Opts": {},
      "Param": [],
      "Table": [],
      "Progress": [
        {
          "SubId": 0,
          "CreateDateTime": "2022-07-07 15:01:04.977",
          "Status": "s",
          "UpdateDateTime": "2022-07-07 15:01:05.073",
          "Count": 100,
          "Value": 313
        },
        ......................
        ........ skip ........
        ......................
        {
          "SubId": 15,
          "CreateDateTime": "2022-07-07 15:01:05.336",
          "Status": "s",
          "UpdateDateTime": "2022-07-07 15:01:05.373",
          "Count": 100,
          "Value": 312
        }
      ]
    }
  ],
  "Lines": [
    "2022-07-07 15:01:04.940 RiskPaths",
    "2022-07-07 15:01:04.960 Model version  : 3.0.0.0",
    "2022-07-07 15:01:04.960 Model created  : 2022-05-05 17:37:15.114",
    "2022-07-07 15:01:04.960 Model digest   : d90e1e9a49a06d972ecf1d50e684c62b",
    ......................
    ........ skip ........
    ......................
    "2022-07-07 15:01:05.393 Done."
  ]
}
}

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