Oms web service API - openmpp/openmpp.github.io GitHub Wiki

Web-service methods arguments

: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 Model Metadata

GET model list

GET /api/model-list

GET model list including text (description and notes)

GET /api/model-list/text
GET /api/model-list/text/lang/:lang

GET model definition metadata

GET /api/model/:model
GET /api/model/:model/pack

GET model metadata including text (description and notes)

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 model metadata including text in all languages

GET /api/model/:model/text-all

GET Model Extras

GET model languages

GET /api/model/:model/lang-list

GET model language-specific strings

GET /api/model/:model/word-list
GET /api/model/:model/word-list/lang/:lang

GET model profile

GET /api/model/:model/profile/:profile

GET list of profiles

GET /api/model/:model/profile-list

GET Model Run results metadata

GET list of model runs

GET /api/model/:model/run-list

GET list of model runs including text (description and notes)

GET /api/model/:model/run-list/text
GET /api/model/:model/run-list/text/lang/:lang

GET status of model run

GET /api/model/:model/run/:run/status

GET status of model run list

GET /api/model/:model/run/:run/status/list

GET status of first model run

GET /api/model/:model/run/status/first

GET status of last model run

GET /api/model/:model/run/status/last

GET status of last completed model run

GET /api/model/:model/run/status/last-completed

GET model run metadata and status

GET /api/model/:model/run/:run

GET model run including text (description and notes)

GET /api/model/:model/run/:run/text
GET /api/model/:model/run/:run/text/lang/:lang

GET model run including text in all languages

GET /api/model/:model/run/:run/text-all

GET Model Workset metadata: set of input parameters

GET list of model worksets

GET /api/model/:model/workset-list

GET list of model worksets including text (description and notes)

GET /api/model/:model/workset-list/text
GET /api/model/:model/workset-list/text/lang/:lang

GET workset status

GET /api/model/:model/workset/:set/status
GET /api/model/:model/workset/:set

GET model default workset status

GET /api/model/:model/workset/status/default

GET workset including text (description and notes)

GET /api/model/:model/workset/:set/text
GET /api/model/:model/workset/:set/text/lang/:lang

GET workset including text in all languages

GET /api/model/:model/workset/:set/text-all

Read Parameters, Output Tables or Microdata values

Read parameter values from workset

POST /api/model/:model/workset/:set/parameter/value

Read parameter values from workset (enum id's)

POST /api/model/:model/workset/:set/parameter/value-id

Read parameter values from model run

POST /api/model/:model/run/:run/parameter/value

Read parameter values from model run (enum id's)

POST /api/model/:model/run/:run/parameter/value-id

Read output table values from model run

POST /api/model/:model/run/:run/table/value

Read output table values from model run (enum id's)

POST /api/model/:model/run/:run/table/value-id

Read output table calculated values from model run

POST /api/model/:model/run/:run/table/calc

Read output table calculated values from model run (enum id's)

POST /api/model/:model/run/:run/table/calc-id

Read output table values and compare model runs

POST /api/model/:model/run/:run/table/compare

Read output table values and compare model runs (enun id's)

POST /api/model/:model/run/:run/table/compare-id

Read microdata values from model run

POST /api/model/:model/run/:run/microdata/value

Read microdata values from model run (enum id's)

POST /api/model/:model/run/:run/microdata/value-id

Read aggregated microdata from model run

POST /api/model/:model/run/:run/microdata/calc

Read aggregated microdata from model run (enum id's)

POST /api/model/:model/run/:run/microdata/calc-id

Read microdata run comparison

POST /api/model/:model/run/:run/microdata/compare

Read microdata run comparison (enum id's)

POST /api/model/:model/run/:run/microdata/compare-id

GET Parameters, Output Tables or Microdata values

GET parameter values from workset

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 parameter values from model run

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 output table expression(s) from model run

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 output table calculated expression(s) from model run

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 output table values and compare model runs

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 output table accumulator(s) from model run

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 output table all accumulators from model run

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 microdata values from model run

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 aggregated microdata from model run

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 microdata run comparison

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 Parameters, Output Tables or Microdata values as CSV

GET csv parameter values from workset

GET /api/model/:model/workset/:set/parameter/:name/csv
GET /api/model/:model/workset/:set/parameter/:name/csv-bom

GET csv parameter values from workset (enum id's)

GET /api/model/:model/workset/:set/parameter/:name/csv-id
GET /api/model/:model/workset/:set/parameter/:name/csv-id-bom

GET csv parameter values from model run

GET /api/model/:model/run/:run/parameter/:name/csv
GET /api/model/:model/run/:run/parameter/:name/csv-bom

GET csv parameter values from model run (enum id's)

GET /api/model/:model/run/:run/parameter/:name/csv-id
GET /api/model/:model/run/:run/parameter/:name/csv-id-bom

GET csv output table expressions from model run

GET /api/model/:model/run/:run/table/:name/expr/csv
GET /api/model/:model/run/:run/table/:name/expr/csv-bom

GET csv output table expressions from model run (enum id's)

GET /api/model/:model/run/:run/table/:name/expr/csv-id
GET /api/model/:model/run/:run/table/:name/expr/csv-id-bom

GET csv calculated table expressions from model run

GET /api/model/:model/run/:run/table/:name/calc/:calc/csv
GET /api/model/:model/run/:run/table/:name/calc/:calc/csv-bom

GET csv calculated table expressions from model run (enum id's)

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 csv model runs comparison table expressions

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 csv model runs comparison table expressions (enum id's)

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 csv output table accumulators from model run

GET /api/model/:model/run/:run/table/:name/acc/csv
GET /api/model/:model/run/:run/table/:name/acc/csv-bom

GET csv output table accumulators from model run (enum id's)

GET /api/model/:model/run/:run/table/:name/acc/csv-id
GET /api/model/:model/run/:run/table/:name/acc/csv-id-bom

GET csv output table all accumulators from model run

GET /api/model/:model/run/:run/table/:name/all-acc/csv
GET /api/model/:model/run/:run/table/:name/all-acc/csv-bom

GET csv output table all accumulators from model run (enum id's)

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 csv microdata values from model run

GET /api/model/:model/run/:run/microdata/:name/csv
GET /api/model/:model/run/:run/microdata/:name/csv-bom

GET csv microdata values from model run (enum id's)

GET /api/model/:model/run/:run/microdata/:name/csv-id
GET /api/model/:model/run/:run/microdata/:name/csv-id-bom

GET csv aggregated microdata from model run

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 csv aggregated microdata from model run (enum id's)

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 csv microdata run comparison

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 csv microdata run comparison (enum id's)

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 Modeling Task metadata and task run history

GET list of modeling tasks

GET /api/model/:model/task-list

GET list of modeling tasks including text (description and notes)

GET /api/model/:model/task-list/text
GET /api/model/:model/task-list/text/lang/:lang

GET modeling task input worksets

GET /api/model/:model/task/:task/sets

GET modeling task run history

GET /api/model/:model/task/:task/runs

GET status of modeling task run

GET /api/model/:model/task/:task/run-status/run/:run

GET status of modeling task run list

GET /api/model/:model/task/:task/run-status/list/:run

GET status of modeling task first run

GET /api/model/:model/task/:task/run-status/first

GET status of modeling task last run

GET /api/model/:model/task/:task/run-status/last

GET status of modeling task last completed run

GET /api/model/:model/task/:task/run-status/last-completed

GET modeling task including text (description and notes)

GET /api/model/:model/task/:task/text
GET /api/model/:model/task/:task/text/lang/:lang

GET modeling task text in all languages

GET /api/model/:model/task/:task/text-all

Update Model Profile: set of key-value options

PATCH create or replace profile

PATCH /api/model/:model/profile

DELETE profile

DELETE /api/model/:model/profile/:profile

POST create or replace profile option

POST /api/model/:model/profile/:profile/key/:key/value/:value

DELETE profile option

DELETE /api/model/:model/profile/:profile/key/:key

Update Model Workset: set of input parameters

POST update workset read-only status

POST /api/model/:model/workset/:set/readonly/:readonly

PUT create new workset

PUT  /api/workset-create

PUT create or replace workset

PUT /api/workset-replace

PATCH create or merge workset

PATCH /api/workset-merge

DELETE workset

DELETE /api/model/:model/workset/:set

POST delete multiple worksets

POST /api/model/:model/delete-worksets

DELETE parameter from workset

DELETE /api/model/:model/workset/:set/parameter/:name

PATCH update workset parameter values

PATCH /api/model/:model/workset/:set/parameter/:name/new/value

PATCH update workset parameter values (enum id's)

PATCH /api/model/:model/workset/:set/parameter/:name/new/value-id

PATCH update workset parameter(s) value notes

PATCH /api/model/:model/workset/:set/parameter-text

PUT copy parameter from model run into workset

PUT /api/model/:model/workset/:set/copy/parameter/:name/from-run/:run

PATCH merge parameter from model run into workset

PATCH /api/model/:model/workset/:set/merge/parameter/:name/from-run/:run

PUT copy parameter from workset to another

PUT /api/model/:model/workset/:set/copy/parameter/:name/from-workset/:from-set

PATCH merge parameter from workset to another

PATCH /api/model/:model/workset/:set/merge/parameter/:name/from-workset/:from-set

Update Model Runs

PATCH update model run text (description and notes)

PATCH /api/run/text

DELETE model run

DELETE /api/model/:model/run/:run

POST delete model runs

POST /api/model/:model/delete-runs

PATCH update run parameter(s) value notes

PATCH /api/model/:model/run/:run/parameter-text

Update Modeling Tasks

PUT create or replace modeling task

PUT  /api/task-new

PATCH create or update modeling task

PATCH /api/task

DELETE modeling task

DELETE /api/model/:model/task/:task

Run Models: run models and monitor progress

POST a request to run the model

POST /api/run

GET state of current model run

GET /api/run/log/model/:model/stamp/:stamp
GET /api/run/log/model/:model/stamp/:stamp/start/:start/count/:count

PUT stop model run

PUT /api/run/stop/model/:model/stamp/:stamp

Download model, model run results or input parameters

GET download log file

GET /api/download/log/file/:name

GET all download log files for the model

GET /api/download/log/model/:model

GET all download log files

GET /api/download/log-all

GET download files tree

GET /api/download/file-tree/:folder

POST initiate model download

POST /api/download/model/:model

POST initiate model run download

POST /api/download/model/:model/run/:run

POST initiate model workset download

POST /api/download/model/:model/workset/:set

DELETE download files

DELETE /api/download/delete/:folder
DELETE /api/download/start/delete/:folder

DELETE all download files

DELETE /api/download/delete-all
DELETE /api/download/start/delete-all

Upload model runs or worksets

GET upload log file

GET /api/upload/log/file/:name

GET all upload log files for the model

GET /api/upload/log/model/:model

GET all upload log files

GET /api/upload/log-all

GET upload files tree

GET /api/upload/file-tree/:folder

POST initiate model run upload

POST /api/upload/model/:model/run
POST /api/upload/model/:model/run/:run

POST initiate workset upload

POST /api/upload/model/:model/workset
POST /api/upload/model/:model/workset/:set

DELETE upload files

DELETE /api/upload/delete/:folder
DELETE /api/upload/start/delete/:folder

DELETE all upload files

DELETE /api/upload/delete-all
DELETE /api/upload/start/delete-all

User: manage user settings and data

GET user views for the model

GET /api/user/view/model/:model

PUT user views for the model

PUT /api/user/view/model/:model

DELETE user views for the model

DELETE /api/user/view/model/:model

Model run jobs and service state

GET service configuration

GET /api/service/config

GET job service state

GET /api/service/state

GET disk usage state

GET /api/service/disk-use

POST refresh disk space usage info

POST /api/service/disk-use/refersh

GET state of active model run job

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

GET state of model run job from queue

GET /api/service/job/queue/:job

GET state of model run job from history

GET /api/service/job/history/:job

PUT model run job into other queue position

PUT /api/service/job/move/:pos/:job

DELETE state of model run job from history

DELETE /api/service/job/delete/history/:job
DELETE /api/service/job/delete/history-all-success
DELETE /api/service/job/delete/history-all-not-success

Administrative: manage web-service state

POST a request to refresh models catalog

POST /api/admin/all-models/refresh

POST a request to close models catalog

POST /api/admin/all-models/close

POST a request to close model database

POST /api/admin/model/:model/close

POST a request to open database file

POST /api/admin/db-file-open/:path

POST a request to cleanup database file

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 the list of database cleanup logs

GET /api/admin/db-cleanup/log-all

GET database cleanup log file

GET /api/admin/db-cleanup/log/:name

POST a request to pause model run queue

POST /api/admin/jobs-pause/:pause

POST a request to pause all queues of model runs

POST /api/admin-all/jobs-pause/:pause

PUT a request to shutdown web-service

PUT /shutdown