API Overview and Access
API Overview
The FMSF API includes functionality required for running fire behavior and effects models. This includes the ability to upload files required by the models, running the models, downloading files, and obtaining status updates and metadata. The FMSF does not include GUI or viewer to visualize inputs and outputs.
|
Functionality |
Method |
URL |
Short Description |
|---|---|---|---|
|
POST |
/model/run |
Run a fire behavior or effects model |
|
|
GET |
/model/metadata/{Run ID} |
Retrieve model run metadata |
|
|
GET |
/model/status/{Run ID} |
Retrieve model run status |
|
|
GET |
/model/cancel/{Run ID} |
Cancel a model run request |
|
|
GET |
/model/output/{Run ID} |
Retrieve model run output |
|
|
GET |
/model/modelLandscape/{Run ID} |
Retrieve model run input GeoTIFF |
|
|
GET |
/model/userInput/{Run ID} |
Retrieve user uploaded input file |
|
|
GET |
/model/fmsfInput/{Run ID} |
Retrieve FMSF generated input file |
|
|
POST |
/model/landscapeUpload |
Upload a GeoTIFF for running a model |
|
|
POST |
/model/landfireCreate |
Request a TreeMap GeoTIFF be created for use with SpatialFOFEM Tree Mortality |
|
|
GET |
/model/landscapeMetadata/{Landscape ID} |
Retrieve GeoTIFF metadata |
|
|
GET |
/model/landscapeDownload/{Landscape ID} |
Retrieve GeoTIFF |
|
|
GET |
/model/limits/{Landscape ID} |
Retrieve minimum model run resolution for a GeoTIFF |
|
|
POST |
/model/shapeUpload |
Upload a shapefile for use as an ignition or barrier for running specific models |
|
|
GET |
/model/shapeMetadata/{Shape ID} |
Retrieve shapefile metadata |
|
|
GET |
/model/shapeDownload/{Shape ID} |
Retrieve shapefile |