Oms API GET download file tree - openmpp/openmpp.github.io GitHub Wiki

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 .csv files for parameters and output tables in RiskPaths.run.102 folder
  • model run .json metadata 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
  }
]
⚠️ **GitHub.com Fallback** ⚠️