-
Notifications
You must be signed in to change notification settings - Fork 0
Oms API GET download file tree
amc1999 edited this page Aug 10, 2021
·
2 revisions
GET download files tree from download directory on the server.
This method only avaliable if server configured to create downloads for user.
This is a beta version and may change in the future.
Download can be initiated through UI or by direct API call:
For each above method oms service will create:
- download archive, for example:
RiskPaths.run.102.zip - model run
.csvfiles for parameters and output tables inRiskPaths.run.102folder - model run
.jsonmetadata files
This method retruns file tree in download folder, for exmaple in RiskPaths.run.102 folder.
Method:
GET /api/download/file-tree/:folder
Arguments:
:folder - (required) download folder file name, for example: `RiskPaths.run.102`
Call example from browser:
http://localhost:4040/api/download/file-tree/RiskPaths.run.102
Return example:
[
{
"Path": "RiskPaths.run.102",
"IsDir": true,
"Size": 0,
"ModTime": 1627769590376
},
{
"Path": "RiskPaths.run.102/RiskPaths.run.102.Default.json",
"IsDir": false,
"Size": 1880,
"ModTime": 1627769590376
},
{
"Path": "RiskPaths.run.102/run.102.Default",
"IsDir": true,
"Size": 0,
"ModTime": 1627769590374
},
{
"Path": "RiskPaths.run.102/run.102.Default/AgeBaselineForm1.csv",
"IsDir": false,
"Size": 283,
"ModTime": 1627769590340
},
{
"Path": "RiskPaths.run.102/run.102.Default/AgeBaselinePreg1.csv",
"IsDir": false,
"Size": 265,
"ModTime": 1627769590341
},
{
"Path": "RiskPaths.run.102/run.102.Default/CanDie.csv",
"IsDir": false,
"Size": 27,
"ModTime": 1627769590344
},
{
"Path": "RiskPaths.run.102/run.102.Default/ProbMort.csv",
"IsDir": false,
"Size": 1022,
"ModTime": 1627769590347
},
{
"Path": "RiskPaths.run.102/run.102.Default/SeparationDurationBaseline.csv",
"IsDir": false,
"Size": 133,
"ModTime": 1627769590347
},
{
"Path": "RiskPaths.run.102/run.102.Default/SimulationCases.csv",
"IsDir": false,
"Size": 26,
"ModTime": 1627769590349
},
{
"Path": "RiskPaths.run.102/run.102.Default/SimulationSeed.csv",
"IsDir": false,
"Size": 23,
"ModTime": 1627769590350
},
{
"Path": "RiskPaths.run.102/run.102.Default/T01_LifeExpectancy.acc-all.csv",
"IsDir": false,
"Size": 65,
"ModTime": 1627769590356
},
{
"Path": "RiskPaths.run.102/run.102.Default/T01_LifeExpectancy.acc.csv",
"IsDir": false,
"Size": 52,
"ModTime": 1627769590352
},
{
"Path": "RiskPaths.run.102/run.102.Default/T01_LifeExpectancy.csv",
"IsDir": false,
"Size": 55,
"ModTime": 1627769590352
},
{
"Path": "RiskPaths.run.102/run.102.Default/T02_TotalPopulationByYear.acc-all.csv",
"IsDir": false,
"Size": 2544,
"ModTime": 1627769590361
},
{
"Path": "RiskPaths.run.102/run.102.Default/T02_TotalPopulationByYear.acc.csv",
"IsDir": false,
"Size": 3040,
"ModTime": 1627769590359
},
{
"Path": "RiskPaths.run.102/run.102.Default/T02_TotalPopulationByYear.csv",
"IsDir": false,
"Size": 2833,
"ModTime": 1627769590357
},
{
"Path": "RiskPaths.run.102/run.102.Default/T03_FertilityByAge.acc-all.csv",
"IsDir": false,
"Size": 1665,
"ModTime": 1627769590364
},
{
"Path": "RiskPaths.run.102/run.102.Default/T03_FertilityByAge.acc.csv",
"IsDir": false,
"Size": 2080,
"ModTime": 1627769590362
},
{
"Path": "RiskPaths.run.102/run.102.Default/T03_FertilityByAge.csv",
"IsDir": false,
"Size": 1532,
"ModTime": 1627769590362
},
{
"Path": "RiskPaths.run.102/run.102.Default/T04_FertilityRatesByAgeGroup.acc-all.csv",
"IsDir": false,
"Size": 4583,
"ModTime": 1627769590367
},
{
"Path": "RiskPaths.run.102/run.102.Default/T04_FertilityRatesByAgeGroup.acc.csv",
"IsDir": false,
"Size": 6905,
"ModTime": 1627769590366
},
{
"Path": "RiskPaths.run.102/run.102.Default/T04_FertilityRatesByAgeGroup.csv",
"IsDir": false,
"Size": 3676,
"ModTime": 1627769590365
},
{
"Path": "RiskPaths.run.102/run.102.Default/T05_CohortFertility.acc-all.csv",
"IsDir": false,
"Size": 100,
"ModTime": 1627769590369
},
{
"Path": "RiskPaths.run.102/run.102.Default/T05_CohortFertility.acc.csv",
"IsDir": false,
"Size": 74,
"ModTime": 1627769590368
},
{
"Path": "RiskPaths.run.102/run.102.Default/T05_CohortFertility.csv",
"IsDir": false,
"Size": 70,
"ModTime": 1627769590368
},
{
"Path": "RiskPaths.run.102/run.102.Default/T06_BirthsByUnion.acc-all.csv",
"IsDir": false,
"Size": 218,
"ModTime": 1627769590371
},
{
"Path": "RiskPaths.run.102/run.102.Default/T06_BirthsByUnion.acc.csv",
"IsDir": false,
"Size": 234,
"ModTime": 1627769590371
},
{
"Path": "RiskPaths.run.102/run.102.Default/T06_BirthsByUnion.csv",
"IsDir": false,
"Size": 222,
"ModTime": 1627769590370
},
{
"Path": "RiskPaths.run.102/run.102.Default/T07_FirstUnionFormation.acc-all.csv",
"IsDir": false,
"Size": 604,
"ModTime": 1627769590374
},
{
"Path": "RiskPaths.run.102/run.102.Default/T07_FirstUnionFormation.acc.csv",
"IsDir": false,
"Size": 707,
"ModTime": 1627769590374
},
{
"Path": "RiskPaths.run.102/run.102.Default/T07_FirstUnionFormation.csv",
"IsDir": false,
"Size": 428,
"ModTime": 1627769590373
},
{
"Path": "RiskPaths.run.102/run.102.Default/UnionDurationBaseline.csv",
"IsDir": false,
"Size": 395,
"ModTime": 1627769590350
},
{
"Path": "RiskPaths.run.102/run.102.Default/UnionStatusPreg1.csv",
"IsDir": false,
"Size": 196,
"ModTime": 1627769590352
}
]
- 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
- Groups
- 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
- Screened Tables
- 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