IPM Decisions DSS Service

This service is part of the Horizon 2020 IPM Decisions project. The service provides the system with sufficient information for a client to be able to connect to and get information from any registered DSS (Decision Support System)

The source code for this service can be found here: https://github.com/H2020-IPM-Decisions/DSSService

1. A catalogue of DSSs and their models available to the platform

The catalogue is a list of DSSs available to the platform. Each DSS may contain one or more models. So even we are describing a standalone model, in our data structure we have a DSS and one model.
The catalogue is searchable, primarily using crops, pests and (TODO) geography as criteria. This is part of the DSSService

2. A standard for result data returned from DSS models

In order to present result data from potentially several models to the user (e.g. farmer or advisor), the data must be provided from the models in a uniform way. The data structure is described in a Json schema. This - along with the validation service for such data - is part of the MetaDataService

3. A standard for field observations sent as input data to DSS models

Field observations of pests and diseases are required as inputs in some DSS models. The common properties of such data is described in a Json schema. This is part of the MetaDataService

Documentation

API documentation is auto generated with Enunciate, and should be available from a deployed version at the url [HOST]/[APP_PREFIX]/apidocs/. If you are in fact at that place, keep on reading. In the source code, there is also more documentation in the /docs folder, which can be read on GitHub

Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
AdminService
  • /rest/admin/heartbeat
  • /rest/admin/dss/add
  • /rest/admin/dss/{DSSId}/i18n/csv
  • /rest/admin/dss/{DSSId}/i18n/csv/platform_validated/{platformValidated}
  • GET
  • POST
  • GET
  • GET
Endpoints for admin operations
DSSService
  • /rest/countries
  • /rest/crop
  • /rest/dss
  • /rest/pest
  • /rest/dss/location
  • /rest/dss/{DSSId}
  • /rest/crop/execution_type/{executionType}
  • /rest/crop/platform_validated/{platformValidated}
  • /rest/dss/crop/{cropCode}
  • /rest/dss/crops/{cropCodes}
  • /rest/dss/location/point
  • /rest/dss/logo/{logoFileName}
  • /rest/dss/pest/{pestCode}
  • /rest/dss/platform_validated/{platformValidated}
  • /rest/dss/summary/csv
  • /rest/dss/{DSSId}/yaml
  • /rest/model/{DSSId}/{ModelId}
  • /rest/dss/{DSSId}/platform_validated/{platformValidated}
  • /rest/model/{DSSId}/{ModelId}/input_schema
  • /rest/dss/crop/{cropCode}/pest/{pestCode}
  • /rest/dss/crop/{cropCode}/platform_validated/{platformValidated}
  • /rest/dss/crops/{cropCodes}/platform_validated/{platformValidated}
  • /rest/dss/pest/{pestCode}/platform_validated/{platformValidated}
  • /rest/model/{DSSId}/{ModelId}/input_schema/ui_form
  • /rest/dss/crop/{cropCode}/pest/{pestCode}/platform_validated/{platformValidated}
  • GET
  • GET
  • GET
  • GET
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
Web services for listing and querying the DSS Catalogue. For a more thorough description of the concepts, please read the user guide @copyright 2022 NIBIO
EPPOClient
  • /tools/codes2prefnames
  • POST
MetaDataService
  • /rest/schema/dss
  • /rest/schema/fieldobservation
  • /rest/schema/geojson
  • /rest/schema/modeloutput
  • /rest/schema/fieldobservation/nolocation
  • /rest/schema/modeloutput/validate
  • /rest/schema/dss/yaml/validate
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • POST
Provides schemas and validation thereof
RiskMapService
  • /rest/risk_maps/list
  • GET
Web services for getting information about available risk maps following the VIPS risk maps WMS standard: https://gitlab.nibio.no/VIPS/documentation/-/blob/master/grid_models.md

Data Types

JSON

type description
Author Represents a person responsible for the prediction model
ChartGroup
Chart_info
DSS This data object is the Decision Support System that contains one or more DSS Models. So if we are describing a system that has only one model, we still will use this "umbrella" object.
DSSDate
DSSModel Represents a pest prediction model belonging to a DSS. The data in this object should be sufficient for the platform to describe to the client (farmer, advisor) what the model does and how it does it. It should also provide the platform with enough information/meta data for the platform to be able to execute the model.
Execution Meta data about how to run the model
FieldObservation List of species for which a field observation required by the model. Not to be confused with the fieldObservation property in an input_schema
Input Description of this model's requirement for weather data and field observations Must be used in conjunction with the model's input_schema
InputSchemaCategories
Organization Representing DSS provider organization
Output Describes the output returned by the DSS model. The output must conform to the Json schema https://platform.ipmdecisions.net/api/dss/rest/schema/modeloutput
ResultParameter A result or intermediary from a DSS model. These are distinct for each DSS model
RiskMap A risk map is a WMS service that conforms to the VIPS risk maps standard: https://gitlab.nibio.no/VIPS/documentation/-/blob/master/grid_models.md
RiskMapProvider A risk map provider is an organization that has made one or more risk maps available in the platform
RiskMaps Data object structuring the list of risk maps available in the platform.
Valid_Spatial Where is the model considered valid to run? This can be specified either by a list of countries (using ISO-3166-1 Three-letter country codes https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) OR by specifying a custom polygon using GeoJSON https://geojson.org/ Or both! Check out: https://github.com/datasets/geo-countries / https://datahub.io/core/geo-countries
WarningStatusInterpretation
WeatherParameter Description of the weather result_parameters needed by the model