-
Notifications
You must be signed in to change notification settings - Fork 0
Oms web service API
:model - model digest or model name
:lang - language code
:run - model run digest, run stamp or run name, modeling task run stamp or task run name
:set - name of workset (input set of model parameters)
:profile - profile name
:task - modeling task
See more details at: Arguments of web-service methods.
GET /api/model-list
GET /api/model-list/text
GET /api/model-list/text/lang/:lang
GET /api/model/:model
GET /api/model/:model/pack
GET /api/model/:model/text
GET /api/model/:model/text/lang/:lang
GET /api/model/:model/pack/text
GET /api/model/:model/pack/text/lang/:lang
GET /api/model/:model/text-all
GET /api/model/:model/lang-list
GET /api/model/:model/word-list
GET /api/model/:model/word-list/lang/:lang
GET /api/model/:model/profile/:profile
GET /api/model/:model/profile-list
GET /api/model/:model/run-list
GET /api/model/:model/run-list/text
GET /api/model/:model/run-list/text/lang/:lang
GET /api/model/:model/run/:run/status
GET /api/model/:model/run/:run/status/list
GET /api/model/:model/run/status/first
GET /api/model/:model/run/status/last
GET /api/model/:model/run/status/last-completed
GET /api/model/:model/run/:run
GET /api/model/:model/run/:run/text
GET /api/model/:model/run/:run/text/lang/:lang
GET /api/model/:model/run/:run/text-all
GET /api/model/:model/workset-list
GET /api/model/:model/workset-list/text
GET /api/model/:model/workset-list/text/lang/:lang
GET /api/model/:model/workset/:set/status
GET /api/model/:model/workset/:set
GET /api/model/:model/workset/status/default
GET /api/model/:model/workset/:set/text
GET /api/model/:model/workset/:set/text/lang/:lang
GET /api/model/:model/workset/:set/text-all
POST /api/model/:model/workset/:set/parameter/value
POST /api/model/:model/workset/:set/parameter/value-id
POST /api/model/:model/run/:run/parameter/value
POST /api/model/:model/run/:run/parameter/value-id
POST /api/model/:model/run/:run/table/value
POST /api/model/:model/run/:run/table/value-id
POST /api/model/:model/run/:run/table/calc
POST /api/model/:model/run/:run/table/calc-id
POST /api/model/:model/run/:run/table/compare
POST /api/model/:model/run/:run/table/compare-id
POST /api/model/:model/run/:run/microdata/value
POST /api/model/:model/run/:run/microdata/value-id
POST /api/model/:model/run/:run/microdata/calc
POST /api/model/:model/run/:run/microdata/calc-id
POST /api/model/:model/run/:run/microdata/compare
POST /api/model/:model/run/:run/microdata/compare-id
GET /api/model/:model/workset/:set/parameter/:name/value
GET /api/model/:model/workset/:set/parameter/:name/value/start/:start
GET /api/model/:model/workset/:set/parameter/:name/value/start/:start/count/:count
GET /api/model/:model/run/:run/parameter/:name/value
GET /api/model/:model/run/:run/parameter/:name/value/start/:start
GET /api/model/:model/run/:run/parameter/:name/value/start/:start/count/:count
GET /api/model/:model/run/:run/table/:name/expr
GET /api/model/:model/run/:run/table/:name/expr/start/:start
GET /api/model/:model/run/:run/table/:name/expr/start/:start/count/:count
GET /api/model/:model/run/:run/table/:name/calc/:calc
GET /api/model/:model/run/:run/table/:name/calc/:calc/start/:start
GET /api/model/:model/run/:run/table/:name/calc/:calc/start/:start/count/:count
GET /api/model/:model/run/:run/table/:name/compare/:compare/variant/:variant
GET /api/model/:model/run/:run/table/:name/compare/:compare/variant/:variant/start/:start
GET /api/model/:model/run/:run/table/:name/compare/:compare/variant/:variant/start/:start/count/:count
GET /api/model/:model/run/:run/table/:name/acc
GET /api/model/:model/run/:run/table/:name/acc/start/:start
GET /api/model/:model/run/:run/table/:name/acc/start/:start/count/:count
GET /api/model/:model/run/:run/table/:name/all-acc
GET /api/model/:model/run/:run/table/:name/all-acc/start/:start
GET /api/model/:model/run/:run/table/:name/all-acc/start/:start/count/:count
GET /api/model/:model/run/:run/microdata/:name/value
GET /api/model/:model/run/:run/microdata/:name/value/start/:start
GET /api/model/:model/run/:run/microdata/:name/value/start/:start/count/:count
GET /api/model/:model/run/:run/microdata/:name/group-by/:group-by/calc/:calc
GET /api/model/:model/run/:run/microdata/:name/group-by/:group-by/calc/:calc/start/:start
GET /api/model/:model/run/:run/microdata/:name/group-by/:group-by/calc/:calc/start/:start/count/:count
GET /api/model/:model/run/:run/microdata/:name/group-by/:group-by/compare/:compare/variant/:variant
GET /api/model/:model/run/:run/microdata/:name/group-by/:group-by/compare/:compare/variant/:variant/start/:start
GET /api/model/:model/run/:run/microdata/:name/group-by/:group-by/compare/:compare/variant/:variant/start/:start/count/:count
GET /api/model/:model/workset/:set/parameter/:name/csv
GET /api/model/:model/workset/:set/parameter/:name/csv-bom
GET /api/model/:model/workset/:set/parameter/:name/csv-id
GET /api/model/:model/workset/:set/parameter/:name/csv-id-bom
GET /api/model/:model/run/:run/parameter/:name/csv
GET /api/model/:model/run/:run/parameter/:name/csv-bom
GET /api/model/:model/run/:run/parameter/:name/csv-id
GET /api/model/:model/run/:run/parameter/:name/csv-id-bom
GET /api/model/:model/run/:run/table/:name/expr/csv
GET /api/model/:model/run/:run/table/:name/expr/csv-bom
GET /api/model/:model/run/:run/table/:name/expr/csv-id
GET /api/model/:model/run/:run/table/:name/expr/csv-id-bom
GET /api/model/:model/run/:run/table/:name/calc/:calc/csv
GET /api/model/:model/run/:run/table/:name/calc/:calc/csv-bom
GET /api/model/:model/run/:run/table/:name/calc/:calc/csv-id
GET /api/model/:model/run/:run/table/:name/calc/:calc/csv-id-bom
GET /api/model/:model/run/:run/table/:name/compare/:compare/variant/:variant/csv
GET /api/model/:model/run/:run/table/:name/compare/:compare/variant/:variant/csv-bom
GET /api/model/:model/run/:run/table/:name/compare/:compare/variant/:variant/csv-id
GET /api/model/:model/run/:run/table/:name/compare/:compare/variant/:variant/csv-id-bom
GET /api/model/:model/run/:run/table/:name/acc/csv
GET /api/model/:model/run/:run/table/:name/acc/csv-bom
GET /api/model/:model/run/:run/table/:name/acc/csv-id
GET /api/model/:model/run/:run/table/:name/acc/csv-id-bom
GET /api/model/:model/run/:run/table/:name/all-acc/csv
GET /api/model/:model/run/:run/table/:name/all-acc/csv-bom
GET /api/model/:model/run/:run/table/:name/all-acc/csv-id
GET /api/model/:model/run/:run/table/:name/all-acc/csv-id-bom
GET /api/model/:model/run/:run/microdata/:name/csv
GET /api/model/:model/run/:run/microdata/:name/csv-bom
GET /api/model/:model/run/:run/microdata/:name/csv-id
GET /api/model/:model/run/:run/microdata/:name/csv-id-bom
GET /api/model/:model/run/:run/microdata/:name/group-by/:group-by/calc/:calc/csv
GET /api/model/:model/run/:run/microdata/:name/group-by/:group-by/calc/:calc/csv-bom
GET /api/model/:model/run/:run/microdata/:name/group-by/:group-by/calc/:calc/csv-id
GET /api/model/:model/run/:run/microdata/:name/group-by/:group-by/calc/:calc/csv-id-bom
GET /api/model/:model/run/:run/microdata/:name/group-by/:group-by/compare/:compare/variant/:variant/csv
GET /api/model/:model/run/:run/microdata/:name/group-by/:group-by/compare/:compare/variant/:variant/csv-bom
GET /api/model/:model/run/:run/microdata/:name/group-by/:group-by/compare/:compare/variant/:variant/csv-id
GET /api/model/:model/run/:run/microdata/:name/group-by/:group-by/compare/:compare/variant/:variant/csv-id-bom
GET /api/model/:model/task-list
GET /api/model/:model/task-list/text
GET /api/model/:model/task-list/text/lang/:lang
GET /api/model/:model/task/:task/sets
GET /api/model/:model/task/:task/runs
GET /api/model/:model/task/:task/run-status/run/:run
GET /api/model/:model/task/:task/run-status/list/:run
GET /api/model/:model/task/:task/run-status/first
GET /api/model/:model/task/:task/run-status/last
GET /api/model/:model/task/:task/run-status/last-completed
GET /api/model/:model/task/:task/text
GET /api/model/:model/task/:task/text/lang/:lang
GET /api/model/:model/task/:task/text-all
PATCH /api/model/:model/profile
DELETE /api/model/:model/profile/:profile
POST /api/model/:model/profile/:profile/key/:key/value/:value
DELETE /api/model/:model/profile/:profile/key/:key
POST /api/model/:model/workset/:set/readonly/:readonly
PUT /api/workset-create
PUT /api/workset-replace
PATCH /api/workset-merge
DELETE /api/model/:model/workset/:set
POST /api/model/:model/delete-worksets
DELETE /api/model/:model/workset/:set/parameter/:name
PATCH /api/model/:model/workset/:set/parameter/:name/new/value
PATCH /api/model/:model/workset/:set/parameter/:name/new/value-id
PATCH /api/model/:model/workset/:set/parameter-text
PUT /api/model/:model/workset/:set/copy/parameter/:name/from-run/:run
PATCH /api/model/:model/workset/:set/merge/parameter/:name/from-run/:run
PUT /api/model/:model/workset/:set/copy/parameter/:name/from-workset/:from-set
PATCH /api/model/:model/workset/:set/merge/parameter/:name/from-workset/:from-set
PATCH /api/run/text
DELETE /api/model/:model/run/:run
POST /api/model/:model/delete-runs
PATCH /api/model/:model/run/:run/parameter-text
PUT /api/task-new
PATCH /api/task
DELETE /api/model/:model/task/:task
POST /api/run
GET /api/run/log/model/:model/stamp/:stamp
GET /api/run/log/model/:model/stamp/:stamp/start/:start/count/:count
PUT /api/run/stop/model/:model/stamp/:stamp
GET /api/download/log/file/:name
GET /api/download/log/model/:model
GET /api/download/log-all
GET /api/download/file-tree/:folder
POST /api/download/model/:model
POST /api/download/model/:model/run/:run
POST /api/download/model/:model/workset/:set
DELETE /api/download/delete/:folder
DELETE /api/download/start/delete/:folder
DELETE /api/download/delete-all
DELETE /api/download/start/delete-all
GET /api/upload/log/file/:name
GET /api/upload/log/model/:model
GET /api/upload/log-all
GET /api/upload/file-tree/:folder
POST /api/upload/model/:model/run
POST /api/upload/model/:model/run/:run
POST /api/upload/model/:model/workset
POST /api/upload/model/:model/workset/:set
DELETE /api/upload/delete/:folder
DELETE /api/upload/start/delete/:folder
DELETE /api/upload/delete-all
DELETE /api/upload/start/delete-all
GET /api/files/file-tree/:ext/path/:path
GET /api/files/file-tree/:ext/path/
GET /api/files/file-tree/:ext/path
GET /api/files/file-tree/:ext/path?path=....
POST /api/files/file/:path
POST /api/files/file?path=....
PUT /api/files/folder/:path
PUT /api/files/folder?path=...
DELETE /api/files/delete/:path
DELETE /api/files/delete?path=....
DELETE /api/files/delete-all
GET /api/user/view/model/:model
PUT /api/user/view/model/:model
DELETE /api/user/view/model/:model
GET /api/service/config
GET /api/service/state
GET /api/service/disk-use
POST /api/service/disk-use/refersh
GET /api/service/job/active/:job
GET /api/service/job/queue/:job
GET /api/service/job/history/:job
PUT /api/service/job/move/:pos/:job
DELETE /api/service/job/delete/history/:job
DELETE /api/service/job/delete/history-all/:success
POST /api/admin/all-models/refresh
POST /api/admin/all-models/close
POST /api/admin/model/:model/close
POST /api/admin/db-file-open/:path
POST /api/admin/db-cleanup/:path
POST /api/admin/db-cleanup/:path/name/:name
POST /api/admin/db-cleanup/:path/name/:name/digest/:digest
GET /api/admin/db-cleanup/log-all
GET /api/admin/db-cleanup/log/:name
POST /api/admin/jobs-pause/:pause
POST /api/admin-all/jobs-pause/:pause
PUT /shutdown
- Windows: Quick Start for Model Users
- Windows: Quick Start for Model Developers
- Linux: Quick Start for Model Users
- Linux: Quick Start for Model Developers
- MacOS: Quick Start for Model Users
- MacOS: Quick Start for Model Developers
- Model Run: How to Run the Model
- MIT License, Copyright and Contribution
- Model Code: Programming a model
- Windows: Create and Debug Models
- Linux: Create and Debug Models
- MacOS: Create and Debug Models
- MacOS: Create and Debug Models using Xcode
- Modgen: Convert case-based model to openM++
- Modgen: Convert time-based model to openM++
- Modgen: Convert Modgen models and usage of C++ in openM++ code
- Model Localization: Translation of model messages
- How To: Set Model Parameters and Get Results
- Model Run: How model finds input parameters
- Model Output Expressions
- Model Run Options and ini-file
- OpenM++ Compiler (omc) Run Options
- OpenM++ ini-file format
- UI: How to start user interface
- UI: openM++ user interface
- UI: Create new or edit scenario
- UI: Upload input scenario or parameters
- UI: Run the Model
- UI: Use ini-files or CSV parameter files
- UI: Compare model run results
- UI: Aggregate and Compare Microdata
- UI: Filter run results by value
- UI: Disk space usage and cleanup
- UI Localization: Translation of openM++
- Authored Model Documentation
- Built-in Attributes
- Censor Event Time
- Create Import Set
- Derived Tables
- Entity Attributes in C++
- Entity Function Hooks
- Entity Member Packing
- Entity Tables
- Enumerations
- Events
- Event Trace
- External Names
- Generated Model Documentation
- Illustrative Model
Align1
- Lifecycle Attributes
- Local Random Streams
- Memory Use
- Microdata Output
- Model Code
- Model Documentation
- Model Languages
- Model Localization
- Model Metrics Report
- Model Resource Use
- Model Symbols
- Parameter and Table Display and Content
- Population Size and Scaling
- Symbol Labels and Notes
- Tables
- Test Models
- Time-like and Event-like Attributes
- Use Modules
- Weighted Tabulation
- File-based Parameter Values
- Oms: openM++ web-service
- Oms: openM++ web-service API
- Oms: How to prepare model input parameters
- Oms: Cloud and model runs queue
- Use R to save output table into CSV file
- Use R to save output table into Excel
- Run model from R: simple loop in cloud
- Run RiskPaths model from R: advanced run in cloud
- Run RiskPaths model in cloud from local PC
- Run model from R and save results in CSV file
- Run model from R: simple loop over model parameter
- Run RiskPaths model from R: advanced parameters scaling
- Run model from Python: simple loop over model parameter
- Run RiskPaths model from Python: advanced parameters scaling
- Windows: Use Docker to get latest version of OpenM++
- Linux: Use Docker to get latest version of OpenM++
- RedHat 8: Use Docker to get latest version of OpenM++
- Quick Start for OpenM++ Developers
- Setup Development Environment
- 2018, June: OpenM++ HPC cluster: Test Lab
- Development Notes: Defines, UTF-8, Databases, etc.
- 2012, December: OpenM++ Design
- 2012, December: OpenM++ Model Architecture, December 2012
- 2012, December: Roadmap, Phase 1
- 2013, May: Prototype version
- 2013, September: Alpha version
- 2014, March: Project Status, Phase 1 completed
- 2016, December: Task List
- 2017, January: Design Notes. Subsample As Parameter problem. Completed
GET Model Metadata
- GET model list
- GET model list including text (description and notes)
- GET model definition metadata
- GET model metadata including text (description and notes)
- GET model metadata including text in all languages
GET Model Extras
GET Model Run results metadata
- GET list of model runs
- GET list of model runs including text (description and notes)
- GET status of model run
- GET status of model run list
- GET status of first model run
- GET status of last model run
- GET status of last completed model run
- GET model run metadata and status
- GET model run including text (description and notes)
- GET model run including text in all languages
GET Model Workset metadata: set of input parameters
- GET list of model worksets
- GET list of model worksets including text (description and notes)
- GET workset status
- GET model default workset status
- GET workset including text (description and notes)
- GET workset including text in all languages
Read Parameters, Output Tables or Microdata values
- Read parameter values from workset
- Read parameter values from workset (enum id's)
- Read parameter values from model run
- Read parameter values from model run (enum id's)
- Read output table values from model run
- Read output table values from model run (enum id's)
- Read output table calculated values from model run
- Read output table calculated values from model run (enum id's)
- Read output table values and compare model runs
- Read output table values and compare model runs (enun id's)
- Read microdata values from model run
- Read microdata values from model run (enum id's)
- Read aggregated microdata from model run
- Read aggregated microdata from model run (enum id's)
- Read microdata run comparison
- Read microdata run comparison (enum id's)
GET Parameters, Output Tables or Microdata values
- GET parameter values from workset
- GET parameter values from model run
- GET output table expression(s) from model run
- GET output table calculated expression(s) from model run
- GET output table values and compare model runs
- GET output table accumulator(s) from model run
- GET output table all accumulators from model run
- GET microdata values from model run
- GET aggregated microdata from model run
- GET microdata run comparison
GET Parameters, Output Tables or Microdata as CSV
- GET csv parameter values from workset
- GET csv parameter values from workset (enum id's)
- GET csv parameter values from model run
- GET csv parameter values from model run (enum id's)
- GET csv output table expressions from model run
- GET csv output table expressions from model run (enum id's)
- GET csv output table accumulators from model run
- GET csv output table accumulators from model run (enum id's)
- GET csv output table all accumulators from model run
- GET csv output table all accumulators from model run (enum id's)
- GET csv calculated table expressions from model run
- GET csv calculated table expressions from model run (enum id's)
- GET csv model runs comparison table expressions
- GET csv model runs comparison table expressions (enum id's)
- GET csv microdata values from model run
- GET csv microdata values from model run (enum id's)
- GET csv aggregated microdata from model run
- GET csv aggregated microdata from model run (enum id's)
- GET csv microdata run comparison
- GET csv microdata run comparison (enum id's)
GET Modeling Task metadata and task run history
- GET list of modeling tasks
- GET list of modeling tasks including text (description and notes)
- GET modeling task input worksets
- GET modeling task run history
- GET status of modeling task run
- GET status of modeling task run list
- GET status of modeling task first run
- GET status of modeling task last run
- GET status of modeling task last completed run
- GET modeling task including text (description and notes)
- GET modeling task text in all languages
Update Model Profile: set of key-value options
- PATCH create or replace profile
- DELETE profile
- POST create or replace profile option
- DELETE profile option
Update Model Workset: set of input parameters
- POST update workset read-only status
- PUT create new workset
- PUT create or replace workset
- PATCH create or merge workset
- DELETE workset
- POST delete multiple worksets
- DELETE parameter from workset
- PATCH update workset parameter values
- PATCH update workset parameter values (enum id's)
- PATCH update workset parameter(s) value notes
- PUT copy parameter from model run into workset
- PATCH merge parameter from model run into workset
- PUT copy parameter from workset to another
- PATCH merge parameter from workset to another
Update Model Runs
- PATCH update model run text (description and notes)
- DELETE model run
- POST delete model runs
- PATCH update run parameter(s) value notes
Update Modeling Tasks
Run Models: run models and monitor progress
Download model, model run results or input parameters
- GET download log file
- GET model download log files
- GET all download log files
- GET download files tree
- POST initiate entire model download
- POST initiate model run download
- POST initiate model workset download
- DELETE download files
- DELETE all download files
Upload model runs or worksets (input scenarios)
- GET upload log file
- GET all upload log files for the model
- GET all upload log files
- GET upload files tree
- POST initiate model run upload
- POST initiate workset upload
- DELETE upload files
- DELETE all upload files
Download and upload user files
- GET user files tree
- POST upload to user files
- PUT create user files folder
- DELETE file or folder from user files
- DELETE all user files
User: manage user settings
Model run jobs and service state
- GET service configuration
- GET job service state
- GET disk usage state
- POST refresh disk space usage info
- GET state of active model run job
- GET state of model run job from queue
- GET state of model run job from history
- PUT model run job into other queue position
- DELETE state of model run job from history
Administrative: manage web-service state
- POST a request to refresh models catalog
- POST a request to close models catalog
- POST a request to close model database
- POST a request to open database file
- POST a request to cleanup database file
- GET the list of database cleanup log(s)
- GET database cleanup log file(s)
- POST a request to pause model run queue
- POST a request to pause all model runs queue
- PUT a request to shutdown web-service