Process

Process key is a generic definition of possible processing capabilities of an API with a flexible way to describe an endpoint with their processing parameters. These parameters are then translated to UI input fields by a jsonform definition.

Outputs of a process can be for example a set of geometries which needs a styling definition as a separate linked style file or a vega definition for configuring a chart for a time series analysis of temperature variable for a user-chosen bounding box.

Process

Element	Type	Description
Name	string	required Name describing the process
JsonForm	string	required Url to the Json form definition file
VegaDefinition	string	optional: Url to VEGA Chart definition file, only needed if results are to be visualized in chart
EndPoints	[EndPoint]	List of (API) processing Endpoints

EndPoint

Element	Type	Description
Identifier	string	required Identifier string used for EndPoint
Url	string	required Url to the EndPoint API
Type	string	required media type expected for result, e.g. image/tiff, application/json
Method	string	optional: defaults to GET, method used for query
EndPoint	string	optional: string used to identify the endpoint, e.g. eoxhub_workspaces
Body	string	optional: if POST method used, Url to template to be used for request body
Flatstyle	string/[Flatstyle]	optional: Either a string with url to flatstyle definition that defines rendering of file on map (e.g. raster or vector results) or an array of Flatstyle objects with mapping of

Flatstyle

Element	Type	Description
Identifier	string	required Identifier string used for Output mapping - must match the key in process output JSON
Url	string	required Flatstyle URL

Example

Process:
  Name: harshness
  JsonForm: https://santilland.github.io/process_example/definitions/harshness_form.json
  EndPoints:
    - Identifier: harshnesscollection
      Url: https://harshness-map.gtif.eox.at/processes/execute-create-harshness/execution
      Method: POST
      EndPoint: eoxhub_workspaces
      Body: https://santilland.github.io/process_example/definitions/harshness_body.json
      Type: image/tiff
      Flatstyle: https://santilland.github.io/process_example/definitions/harshness_style.json