TgREST
Sun May 04 09:03:17 CEST 2025TgRest is a tool for owners of private and communal forests. Since this is relatively small parcelled, it is often difficult to find the optimal treatment methods for it. But also state forests can use this system without any problems. This tool is an API which acts as an interface for the underlying forest growth simulator (Treegross) of the NW-FVA. The growth of the stand entered by the user is simulated in accordance with further specifications and the necessary treatment steps will be shown. The methods available for this are described in this document.
https://www.nw-fva.de/TgRest/api/rest
Contact: Jan Hansen
Services
| BaEm | https://www.nw-fva.de/TgRest/api/rest/baem |
| TgEvaluations | https://www.nw-fva.de/TgRest/api/rest/evaluation |
| TgRestMeta | https://www.nw-fva.de/TgRest/api/rest/meta |
| TreegrossBase | https://www.nw-fva.de/TgRest/api/rest/treegross/base |
| YieldTables | https://www.nw-fva.de/TgRest/api/rest/yieldtable |
BaEm
https://www.nw-fva.de/TgRest/api/rest/baem
Methods| getTargetType | GET | https://www.nw-fva.de/TgRest/api/rest/baem/targettypes |
getTargetType —> jakarta.ws.rs.core.Response
GET https://www.nw-fva.de/TgRest/api/rest/baem/targettypes
Generiert eine Liste von empfohlenen, klimaangepassten Zieltypen zu einer gegebenen Koordinate. Vgl. https://www.nw-fva.de/BaEm
| Name | Style | Type | Default | Remarks |
|---|---|---|---|---|
| srid | query | int | 25832 | |
| x | query | double | ||
| y | query | double |
| mediaType of request |
|---|
| application/xml |
TgEvaluations
https://www.nw-fva.de/TgRest/api/rest/evaluation
Methods| summary | POST | https://www.nw-fva.de/TgRest/api/rest/evaluation/stand/summary |
POST https://www.nw-fva.de/TgRest/api/rest/evaluation/stand/summary
Diese Methode erzeugt eine sehr einfache Zusammenfassung für einen TreeGrOSS-Bestand.
mediaType of request body representing de.nwfva.tgrest.services.types.TgRestStand |
|---|
| application/xml |
| mediaType of request |
|---|
| application/json |
| application/xml |
TgRestMeta
https://www.nw-fva.de/TgRest/api/rest/meta
Methods| getApiDocu | GET | https://www.nw-fva.de/TgRest/api/rest/meta/documentation |
| getContact | GET | https://www.nw-fva.de/TgRest/api/rest/meta/contact |
| getForestSimulatorSettingsXsl | GET | https://www.nw-fva.de/TgRest/api/rest/meta/ForestSimulatorSettings.xsl |
| getMd | GET | https://www.nw-fva.de/TgRest/api/rest/meta/modelsettings |
| getMdVersion | GET | https://www.nw-fva.de/TgRest/api/rest/meta/version/md |
| getScVersion | GET | https://www.nw-fva.de/TgRest/api/rest/meta/version/sc |
| getTgRestVersion | GET | https://www.nw-fva.de/TgRest/api/rest/meta/version/tgrest |
| getTgVersion | GET | https://www.nw-fva.de/TgRest/api/rest/meta/version/tg |
| getTypeDescription | GET | https://www.nw-fva.de/TgRest/api/rest/meta/type/{class} |
getApiDocu —> de.nwfva.tgrest.documentation.ApiDocumentation
GET https://www.nw-fva.de/TgRest/api/rest/meta/documentation
Erstellt automatisch diese Dokumentation der API. Es werden solche Klassen und Methoden berücksichtigt, die mit einer @Path-Annotation vershen sind und nicht expliziet über eine @ApiDocuExclude-Annotation ausgeschlossen werden.
| mediaType of request |
|---|
| text/html |
| application/xml |
| text/xml |
getContact —> de.nwfva.tgrest.services.types.TgRestContactInfo
GET https://www.nw-fva.de/TgRest/api/rest/meta/contact
Diese Methode gibt einen Kontakt zurück.
| mediaType of request |
|---|
| application/xml |
| application/json |
getForestSimulatorSettingsXsl —> jakarta.ws.rs.core.Response
GET https://www.nw-fva.de/TgRest/api/rest/meta/ForestSimulatorSettings.xsl
ForestSimulatorSettings.xsl
| mediaType of request |
|---|
| text/plain |
getMd —> jakarta.ws.rs.core.Response
GET https://www.nw-fva.de/TgRest/api/rest/meta/modelsettings
Diese Methode gibt die Standard-Modell-Einstellungen zurück.
| mediaType of request |
|---|
| application/xml |
getMdVersion —> de.nwfva.tgrest.services.types.TgRestVersionInfo
GET https://www.nw-fva.de/TgRest/api/rest/meta/version/md
Diese Methode gibt Informationen zum verwendeten Modell zurück.
| mediaType of request |
|---|
| application/xml |
| application/json |
getScVersion —> de.nwfva.tgrest.services.types.TgRestVersionInfo
GET https://www.nw-fva.de/TgRest/api/rest/meta/version/sc
Diese Methode gibt die Silviculture-Version zurück.
| mediaType of request |
|---|
| application/xml |
| application/json |
getTgRestVersion —> de.nwfva.tgrest.services.types.TgRestVersionInfo
GET https://www.nw-fva.de/TgRest/api/rest/meta/version/tgrest
Diese Methode gibt die Version der REST-API zurück.
| mediaType of request |
|---|
| application/xml |
| application/json |
getTgVersion —> de.nwfva.tgrest.services.types.TgRestVersionInfo
GET https://www.nw-fva.de/TgRest/api/rest/meta/version/tg
Diese Methode gibt die TreeGrOSS-Version zurück.
| mediaType of request |
|---|
| application/xml |
| application/json |
getTypeDescription —> de.nwfva.tgrest.services.types.TgRestClassDescription
GET https://www.nw-fva.de/TgRest/api/rest/meta/type/{class}
Diese Methode gibt eine Beschreibung von request- bzw. response-Datentypen zurück
| Name | Style | Type | Default | Remarks |
|---|---|---|---|---|
| class | path | java.lang.String |
| mediaType of request |
|---|
| application/xml |
| application/json |
TreegrossBase
https://www.nw-fva.de/TgRest/api/rest/treegross/base
Methods| biomassLogs | POST | https://www.nw-fva.de/TgRest/api/rest/treegross/base/stand/biomass/logs |
| biomassStand | POST | https://www.nw-fva.de/TgRest/api/rest/treegross/base/stand/biomass/stand |
| biomassTrees | POST | https://www.nw-fva.de/TgRest/api/rest/treegross/base/stand/biomass/trees |
| getSpeciesInformation | GET | https://www.nw-fva.de/TgRest/api/rest/treegross/base/species/{artCode}/{is_nds_format} |
| getSpeciesInformationList | GET | https://www.nw-fva.de/TgRest/api/rest/treegross/base/species/list |
| getTgSpeciesInformationList | GET | https://www.nw-fva.de/TgRest/api/rest/treegross/base/species/tglist |
| getWET | POST | https://www.nw-fva.de/TgRest/api/rest/treegross/base/stand/wet |
| growReturingFoeData | POST | https://www.nw-fva.de/TgRest/api/rest/treegross/base/stand/grow/inventory |
| growReturningStand | POST | https://www.nw-fva.de/TgRest/api/rest/treegross/base/stand/grow/stand |
| makeInventory | POST | https://www.nw-fva.de/TgRest/api/rest/treegross/base/stand/make/inventory |
| makeStand | POST | https://www.nw-fva.de/TgRest/api/rest/treegross/base/inventory/make/stand |
| makeStandWithLayers | POST | https://www.nw-fva.de/TgRest/api/rest/treegross/base/inventory/make/standandlayers |
| sort | POST | https://www.nw-fva.de/TgRest/api/rest/treegross/base/stand/sort |
| treatReturningFoeData | POST | https://www.nw-fva.de/TgRest/api/rest/treegross/base/stand/treat/inventory |
| treatReturningStand | POST | https://www.nw-fva.de/TgRest/api/rest/treegross/base/stand/treat/stand |
| treatScenarioReturningFoeData | POST | https://www.nw-fva.de/TgRest/api/rest/treegross/base/stand/treat/scenario/inventory |
| treatScenarioReturningStand | POST | https://www.nw-fva.de/TgRest/api/rest/treegross/base/stand/treat/scenario/stand |
POST https://www.nw-fva.de/TgRest/api/rest/treegross/base/stand/biomass/logs
Diese Methode liefert für alle Sortimente eines Bestandes Biomassen und Nährstoffe.
mediaType of request body representing de.nwfva.tgrest.services.types.requests.TgRestStandSortRequest |
|---|
| application/xml |
| mediaType of request |
|---|
| application/json |
| application/xml |
POST https://www.nw-fva.de/TgRest/api/rest/treegross/base/stand/biomass/stand
Diese Methode liefert für einen Bestand Biomassen und Nährstoffe für verschiedenen Sortimente und Kompartimente.
mediaType of request body representing de.nwfva.tgrest.services.types.TgRestStand |
|---|
| application/xml |
| mediaType of request |
|---|
| application/json |
| application/xml |
POST https://www.nw-fva.de/TgRest/api/rest/treegross/base/stand/biomass/trees
Diese Methode liefert für alle Bäume eines Bestandes Biomassen und Nährstoffe für verschiedenen Sortimente und Kompartimente.
mediaType of request body representing de.nwfva.tgrest.services.types.TgRestStand |
|---|
| application/xml |
| mediaType of request |
|---|
| application/json |
| application/xml |
getSpeciesInformation —> java.util.List<de.nwfva.tgrest.services.types.TgRestSpeciesInfo>
GET https://www.nw-fva.de/TgRest/api/rest/treegross/base/species/{artCode}/{is_nds_format}
This function returns detailed data on a specific Art-Code (nds or bwi). information contained: NDS-Code, BWI-Code, Name (short), Name (long), Genus, Species
Requiered parameters:
- ArtCode: Art-Code in one of the previously specified formats;
- NDS_format: Whether the Art-Code will be provided in NDS format or not;
| Name | Style | Type | Default | Remarks |
|---|---|---|---|---|
| artCode | path | int | ||
| is_nds_format | path | boolean |
| mediaType of request |
|---|
| application/json |
| application/xml |
getSpeciesInformationList —> java.util.List<de.nwfva.tgrest.services.types.TgRestSpeciesInfo>
GET https://www.nw-fva.de/TgRest/api/rest/treegross/base/species/list
This function returns detailed data for all implemented species.
| mediaType of request |
|---|
| application/json |
| application/xml |
getTgSpeciesInformationList —> java.util.List<de.nwfva.tgrest.services.types.TgRestSpeciesInfo>
GET https://www.nw-fva.de/TgRest/api/rest/treegross/base/species/tglist
This function returns detailed data for all implemented treegross species.
| mediaType of request |
|---|
| application/json |
| application/xml |
POST https://www.nw-fva.de/TgRest/api/rest/treegross/base/stand/wet
Accepts an XML String representing a Stand in the internal TgRest Stand Format. Returns the corresponding WET.
mediaType of request body representing de.nwfva.tgrest.services.types.TgRestStand |
|---|
| application/xml |
| mediaType of request |
|---|
| application/xml |
| application/json |
growReturingFoeData —> de.nwfva.tgrest.services.types.TgRestInventory
POST https://www.nw-fva.de/TgRest/api/rest/treegross/base/stand/grow/inventory
Diese Methode verarbeitet ein TgRestStandGrowRequest.
mediaType of request body representing de.nwfva.tgrest.services.types.requests.TgRestStandGrowRequest |
|---|
| application/xml |
| mediaType of request |
|---|
| application/json |
| application/xml |
growReturningStand —> de.nwfva.tgrest.services.types.TgRestStand
POST https://www.nw-fva.de/TgRest/api/rest/treegross/base/stand/grow/stand
Diese Methode verarbeitet ein TgRestStandGrowRequest.
mediaType of request body representing de.nwfva.tgrest.services.types.requests.TgRestStandGrowRequest |
|---|
| application/xml |
| mediaType of request |
|---|
| application/xml |
makeInventory —> de.nwfva.tgrest.services.types.TgRestInventory
POST https://www.nw-fva.de/TgRest/api/rest/treegross/base/stand/make/inventory
Accepts an XML String representing a Stand in the internal TgRest Stand Format. Returns the corresponding FoE-Data for a specified time period. Output can be sorted by Layer or Species.
Requiered parameters:
- Stand: A Stand XML;
- SortByLayer: Whether to sort the output by layers or not. If set to
falsethe output will get separated by Species
| Name | Style | Type | Default | Remarks |
|---|---|---|---|---|
| sortByLayer | query | boolean | true | |
| useHeightProfile | query | boolean | false | |
| yearsOut | query | int | 0 |
mediaType of request body representing de.nwfva.tgrest.services.types.TgRestStand |
|---|
| text/xml |
| application/xml |
| mediaType of request |
|---|
| application/json |
| application/xml |
makeStand —> de.nwfva.tgrest.services.types.TgRestStand
POST https://www.nw-fva.de/TgRest/api/rest/treegross/base/inventory/make/stand
Creates a stand in the internal TgRest Format out of provided FoE-Data. Returns the stand as XML String.
mediaType of request body representing java.lang.String |
|---|
| text/plain |
| text/csv |
| mediaType of request |
|---|
| text/xml |
| application/xml |
makeStandWithLayers —> de.nwfva.tgrest.services.types.TgRestStand
POST https://www.nw-fva.de/TgRest/api/rest/treegross/base/inventory/make/standandlayers
Creates a stand in the internal TgRest Format out of provided FoE-Data and computes the layers by WPEngine height profile. Returns the stand as XML String.
mediaType of request body representing java.lang.String |
|---|
| text/plain |
| text/csv |
| mediaType of request |
|---|
| text/xml |
| application/xml |
POST https://www.nw-fva.de/TgRest/api/rest/treegross/base/stand/sort
Diese Methode verarbeitet ein TgRestStandSortRequest.
mediaType of request body representing de.nwfva.tgrest.services.types.requests.TgRestStandSortRequest |
|---|
| application/xml |
| mediaType of request |
|---|
| application/json |
| application/xml |
treatReturningFoeData —> de.nwfva.tgrest.services.types.TgRestInventory
POST https://www.nw-fva.de/TgRest/api/rest/treegross/base/stand/treat/inventory
Diese Methode verarbeitet ein TgRestStandGrowAndTreatRequest. Dieser Request fasst einen Bestand eine optionale Treatment-Chain und weitere Parameter (Mortalität, Anzahl Jahre bzw. Simulationsdauer etc.) zusammen. Wird eine WET = 0 angegeben wird keine Behandlung simuliert.
mediaType of request body representing de.nwfva.tgrest.services.types.requests.TgRestStandGrowAndTreatRequest |
|---|
| application/xml |
| mediaType of request |
|---|
| application/json |
| application/xml |
treatReturningStand —> de.nwfva.tgrest.services.types.TgRestStand
POST https://www.nw-fva.de/TgRest/api/rest/treegross/base/stand/treat/stand
Diese Methode verarbeitet ein TgRestStandGrowAndTreatRequest. Dieser Request fasst einen Bestand eine optionale Treatment-Chain und weitere Parameter (Mortalität, Anzahl Jahre bzw. Simulationsdauer etc.) zusammen
mediaType of request body representing de.nwfva.tgrest.services.types.requests.TgRestStandGrowAndTreatRequest |
|---|
| application/xml |
| mediaType of request |
|---|
| application/xml |
treatScenarioReturningFoeData —> de.nwfva.tgrest.services.types.TgRestInventory
POST https://www.nw-fva.de/TgRest/api/rest/treegross/base/stand/treat/scenario/inventory
Diese Methode verarbeitet ein TgRestStandGrowAndTreatRequest für einen Standardszenario (naturnah, naturschutz, ertrag). Dieser Request fasst einen Bestand und weitere Parameter (Szenarioname, Mortalität, Anzahl Jahre bzw. Simulationsdauer etc.) zusammen.
mediaType of request body representing de.nwfva.tgrest.services.types.requests.TgRestStandGrowAndTreatRequest |
|---|
| application/xml |
| mediaType of request |
|---|
| application/xml |
| application/json |
treatScenarioReturningStand —> de.nwfva.tgrest.services.types.TgRestStand
POST https://www.nw-fva.de/TgRest/api/rest/treegross/base/stand/treat/scenario/stand
Diese Methode verarbeitet ein TgRestStandGrowAndTreatRequest für einen Standardszenario (naturnah, naturschutz, ertrag). Dieser Request fasst einen Bestand und weitere Parameter (Szenarioname, Mortalität, Anzahl Jahre bzw. Simulationsdauer etc.) zusammen.
mediaType of request body representing de.nwfva.tgrest.services.types.requests.TgRestStandGrowAndTreatRequest |
|---|
| application/xml |
| mediaType of request |
|---|
| application/xml |
YieldTables
https://www.nw-fva.de/TgRest/api/rest/yieldtable
Methods| getTableByIndex | GET | https://www.nw-fva.de/TgRest/api/rest/yieldtable/{index} |
| getTableByPosition | GET | https://www.nw-fva.de/TgRest/api/rest/yieldtable/{species}/{lat}/{lon} |
| getTableIDByPosition | GET | https://www.nw-fva.de/TgRest/api/rest/yieldtable/id/{species}/{lat}/{lon} |
| getTableInfoByIndex | GET | https://www.nw-fva.de/TgRest/api/rest/yieldtable/info/{index} |
| getTableList | GET | https://www.nw-fva.de/TgRest/api/rest/yieldtable/list |
| getYTRow | GET | https://www.nw-fva.de/TgRest/api/rest/yieldtable/row/{tableid}/{age}/{yield} |
getTableByIndex —> de.nwfva.tgrest.services.tools.yieldtables.TgRestYieldTable
GET https://www.nw-fva.de/TgRest/api/rest/yieldtable/{index}
Diese Methode liefert eine Ertragstafel.
| Name | Style | Type | Default | Remarks |
|---|---|---|---|---|
| index | path | int | -1 |
| mediaType of request |
|---|
| application/xml |
getTableByPosition —> de.nwfva.tgrest.services.tools.yieldtables.TgRestYieldTable
GET https://www.nw-fva.de/TgRest/api/rest/yieldtable/{species}/{lat}/{lon}
Diese Methode liefert eine Ertragstafel zu einer Koordinate.
| Name | Style | Type | Default | Remarks |
|---|---|---|---|---|
| species | path | int | -1 | |
| lon | path | double | -1 | |
| lat | path | double | -1 |
| mediaType of request |
|---|
| application/xml |
GET https://www.nw-fva.de/TgRest/api/rest/yieldtable/id/{species}/{lat}/{lon}
Diese Methode liefert eine Ertragstafel zu einer Koordinate.
| Name | Style | Type | Default | Remarks |
|---|---|---|---|---|
| species | path | int | -1 | |
| lon | path | double | -1 | |
| lat | path | double | -1 |
getTableInfoByIndex —> de.nwfva.tgrest.services.tools.yieldtables.TgRestYieldTable
GET https://www.nw-fva.de/TgRest/api/rest/yieldtable/info/{index}
Diese Methode liefert Infos zu einer Ertragstafel.
| Name | Style | Type | Default | Remarks |
|---|---|---|---|---|
| index | path | int | -1 |
| mediaType of request |
|---|
| application/xml |
GET https://www.nw-fva.de/TgRest/api/rest/yieldtable/list
Diese Methode liefert eine Lister aller unterstützten Ertragstafeln
| mediaType of request |
|---|
| application/xml |
GET https://www.nw-fva.de/TgRest/api/rest/yieldtable/row/{tableid}/{age}/{yield}
Creates a yield table row for given parameters (table id, age, yield).
| Name | Style | Type | Default | Remarks |
|---|---|---|---|---|
| tableid | path | int | 20 | |
| age | path | int | 20 | |
| yield | path | double | 1.0 |
| mediaType of request |
|---|
| application/xml |