Skip to content

Oms web service API

Jump to bottom
amc1999 edited this page Aug 5, 2021 · 55 revisions

Web-service methods arguments

:model   - model digest or model name 
:lang    - language code 
:run     - model run digest or 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 /api/model-list-text?lang=en

GET model definition metadata

GET /api/model/:model
GET /api/model?model=modelNameOrDigest

GET model metadata including text (description and notes)

GET /api/model/:model/text
GET /api/model/:model/text/lang/:lang
GET /api/model-text?model=modelNameOrDigest&lang=en

GET model metadata including text in all languages

GET /api/model/:model/text/all
GET /api/model-text-all?model=modelNameOrDigest

GET Model Extras

GET model languages

GET /api/model/:model/lang-list
GET /api/lang-list?model=modelNameOrDigest

GET model language-specific strings

GET /api/model/:model/word-list
GET /api/model/:model/word-list/lang/:lang
GET /api/word-list?model=modelNameOrDigest&lang=en

GET model profile

GET /api/model/:model/profile/:profile
GET /api/model-profile?model=modelNameOrDigest&profile=profileName

GET list of profiles

GET /api/model/:model/profile-list
GET /api/model-profile-list?model=modelNameOrDigest

GET Model Run results metadata

GET list of model runs

GET /api/model/:model/run-list
GET /api/model-run-list?model=modelNameOrDigest

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 /api/model-run-list-text?model=modelNameOrDigest&lang=en

GET status of model run

GET /api/model/:model/run/:run/status
GET /api/model-run-status?model=modelNameOrDigest&run=runDigestOrStampOrName

GET status of model run list

GET /api/model/:model/run/:run/status/list
GET /api/model-run-status-list?model=modelNameOrDigest&run=runDigestOrStampOrName

GET status of first model run

GET /api/model/:model/run/status/first
GET /api/model-run-first-status?model=modelNameOrDigest

GET status of last model run

GET /api/model/:model/run/status/last
GET /api/model-run-last-status?model=modelNameOrDigest

GET status of last completed model run

GET /api/model/:model/run/status/last-completed
GET /api/model-run-last-completed-status?model=modelNameOrDigest

GET model run metadata and status

GET /api/model/:model/run/:run
GET /api/model-run-text?model=modelNameOrDigest&run=runDigestOrStampOrName

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 /api/model-run-text?model=modelNameOrDigest&run=runDigestOrStampOrName&lang=en

GET model run including text in all languages

GET /api/model/:model/run/:run/text/all
GET /api/model-run-text-all?model=modelNameOrDigest&run=runDigestOrStampOrName

GET Model Workset metadata: set of input parameters

GET list of model worksets

GET /api/model/:model/workset-list
GET /api/workset-list?model=modelNameOrDigest

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 /api/workset-list-text?model=modelNameOrDigest&lang=en

GET workset status

GET /api/model/:model/workset/:set/status
GET /api/model/:model/workset/:set
GET /api/workset-status?model=modelNameOrDigest&set=setName

GET model default workset status

GET /api/model/:model/workset/status/default
GET /api/workset-default-status?model=modelNameOrDigest

GET workset including text (description and notes)

GET /api/model/:model/workset/:set/text
GET /api/model/:model/workset/:set/text/lang/:lang
GET /api/workset-text?model=modelNameOrDigest&set=setName
GET /api/workset-text?model=modelNameOrDigest&set=setName&lang=en

GET workset including text in all languages

GET /api/model/:model/workset/:set/text/all
GET /api/workset-text-all?model=modelNameOrDigest&set=setName

Read Parameters or Output Tables 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

GET Parameters or Output Tables 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 /api/workset-parameter-value?model=modelNameOrDigest&set=setName&name=parameterName&start=0&count=100

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 /api/run-parameter-value?model=modelNameOrDigest&run=runDigestOrStampOrName&name=parameterName&start=0&count=100

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 /api/run-table-expr?model=modelNameOrDigest&run=runDigestOrStampOrName&name=salarySex&start=0&count=100

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 /api/run-table-acc?model=modelNameOrDigest&run=runDigestOrStampOrName&name=salarySex&start=0&count=100

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 /api/run-table-all-acc?model=modelNameOrDigest&run=runDigestOrStampOrName&name=salarySex&start=0&count=100

GET Parameters or Output Tables 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 /api/workset-parameter-csv?model=modelNameOrDigest&set=setName&name=parameterName&bom=true

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 /api/workset-parameter-csv-id?model=modelNameOrDigest&set=setName&name=parameterName&bom=true

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 /api/run-parameter-csv?model=modelNameOrDigest&run=runDigestOrStampOrName&name=parameterName&bom=true

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 /api/run-parameter-csv-id?model=modelNameOrDigest&run=runDigestOrStampOrName&name=parameterName&bom=true

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 /api/run-table-expr-csv?model=modelNameOrDigest&run=runDigestOrStampOrName&name=tableName&bom=true

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 /api/run-table-expr-csv-id?model=modelNameOrDigest&run=runDigestOrStampOrName&name=tableName&bom=true

GET csv output table accumulators from model run

GET /api/run-table-acc-csv?model=modelNameOrDigest&run=runDigestOrStampOrName&name=tableName&bom=true
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/run-table-acc-csv-id?model=modelNameOrDigest&run=runDigestOrStampOrName&name=tableName&bom=true
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/run-table-all-acc-csv?model=modelNameOrDigest&run=runDigestOrStampOrName&name=tableName&bom=true
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/run-table-all-acc-csv-id?model=modelNameOrDigest&run=runDigestOrStampOrName&name=tableName&bom=true
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 Modeling Task metadata and task run history

GET list of modeling tasks

GET /api/model/:model/task-list
GET /api/task-list?model=modelNameOrDigest

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 /api/task-list-text?model=modelNameOrDigest&lang=en

GET modeling task input worksets

GET /api/model/:model/task/:task/sets
GET /api/task-sets?model=modelNameOrDigest&task=taskName

GET modeling task run history

GET /api/model/:model/task/:task/runs
GET /api/task-runs?model=modelNameOrDigest&task=taskName

GET status of modeling task run

GET /api/model/:model/task/:task/run-status/run/:run
GET /api/task-run-status?model=modelNameOrDigest&task=taskName&run=taskRunStampOrName

GET status of modeling task run list

GET /api/model/:model/task/:task/run-status/list/:run
GET /api/task-run-status-list?model=modelNameOrDigest&task=taskName&run=taskRunStampOrName

GET status of modeling task first run

GET /api/model/:model/task/:task/run-status/first
GET /api/task-first-run-status?model=modelNameOrDigest&task=taskName

GET status of modeling task last run

GET /api/model/:model/task/:task/run-status/last
GET /api/task-last-run-status?model=modelNameOrDigest&task=taskName

GET status of modeling task last completed run

GET /api/model/:model/task/:task/run-status/last-completed
GET /api/task-last-completed-run-status?model=modelNameOrDigest&task=taskName

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 /api/task-text?model=modelNameOrDigest&task=taskName&lang=en

GET modeling task text in all languages

GET /api/model/:model/task/:task/text/all
GET /api/task-text-all?model=modelNameOrDigest&task=taskName

Update Model Profile: set of key-value options

POST create or replace profile

PATCH /api/model/:model/profile
POST /api/model-profile?model=modelNameOrDigest

DELETE profile

DELETE /api/model/:model/profile/:profile
POST /api/model-profile-delete?model=modelNameOrDigest&profile=profileName

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
POST /api/model-profile-key-delete?model=modelNameOrDigest&profile=profileName&key=someKey

Update Model Workset: set of input parameters

POST update workset read-only status

POST /api/model/:model/workset/:set/readonly/:readonly
POST /api/workset-readonly?model=modelNameOrDigest&set=setName&readonly=true

PUT create new workset

PUT  /api/workset-create

PUT create or replace workset

PUT /api/workset-new

PATCH create or merge workset

PATCH /api/workset

DELETE workset

DELETE /api/model/:model/workset/:set
POST /api/workset-delete?model=modelNameOrDigest&set=setName

DELETE parameter from workset

DELETE /api/model/:model/workset/:set/parameter/:name
POST /api/workset-parameter-delete?model=modelNameOrDigest&set=setName&parameter=name

PATCH update workset parameter values

PATCH /api/model/:model/workset/:set/parameter/:name/new/value
POST /api/workset-parameter-new-value?model=modelNameOrDigest&set=setName&name=parameterName

PATCH update workset parameter values (enum id's)

PATCH /api/model/:model/workset/:set/parameter/:name/new/value-id
POST /api/workset-parameter-new-value-id?model=modelNameOrDigest&set=setName&name=parameterName

PUT copy parameter from model run into workset

PUT /api/model/:model/workset/:set/copy/parameter/:name/from-run/:run
POST /api/copy-parameter-from-run?model=modelNameOrDigest&set=setName&name=parameterName&run=runDigestOrStampOrName"

PUT copy parameter from workset to another

PUT /api/model/:model/workset/:set/copy/parameter/:name/from-workset/:from-set
POST /api/copy-parameter-from-workset?model=modelNameOrDigest&set=dstSetName&name=parameterName&from-set=srcSetName"

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   /api/run-delete?model=modelNameOrDigest&run=runDigestOrStampOrName

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
POST   /api/task-delete?model=modelNameOrDigest&task=taskName

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
GET /api/run-log?model=modelNameOrDigest&stamp=runStamp&start=0&count=0

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

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 run download

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

POST initiate model workset download

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

POST initiate model download

POST /api/download/model/:model

Administrative: manage web-service state

GET web-service configuration

GET /api/service/config

GET web-service state

GET /api/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

PUT a request to shutdown web-service

PUT /api/admin/shutdown

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