Sign in

v1

latestOpenAPI 3.0.2Apache 2.02026-07-1739106293.5 KB
User-Defined Processes

Store a user-defined process

Stores a provided user-defined process with process graph that can be reused in other processes.

If a process with the specified process_graph_id exists, the process is fully replaced. The id can not be changed for existing user-defined processes. The id MUST be unique across its namespace.

Partially updating user-defined processes is not supported.

To simplify exchanging user-defined processes, the property id can be part of the request body. If the values do not match, the value for id gets replaced with the value from the process_graph_id parameter in the path.

put/process_graphs/{process_graph_id}

Request body

idstring

The identifier for the process. It MUST be unique across its namespace (e.g. predefined processes or user-defined processes).

Clients SHOULD warn the user if a user-defined process is added with the same identifier as one of the predefined process.

summarystring

A short summary of what the process does.

descriptionstring commonmark

Detailed description to explain the entity.

CommonMark 0.29 syntax MAY be used for rich text representation. In addition to the CommonMark syntax, clients can convert process IDs that are formatted as in the following example into links instead of code blocks: ``process_id()``

categoriesstring[]

A list of categories.

deprecatedboolean

Declares that the specified entity is deprecated with the potential to be removed in any of the next versions. It should be transitioned out of usage as soon as possible and users should refrain from using it in new implementations.

experimentalboolean

Declares that the specified entity is experimental, which means that it is likely to change or may produce unpredictable behavior. Users should refrain from using it in production, but still feel encouraged to try it out and give feedback.

exceptionsProcessExceptions

Declares exceptions (errors) that might occur during execution of this process. This list is just for informative purposes and may be incomplete. This list MUST only contain exceptions that stop the execution of a process and MUST NOT contain warnings, notices or debugging messages. It is meant to primarily contain errors that have been caused by the user. It is RECOMMENDED that exceptions are referred to and explained in process or parameter descriptions.

The keys define the error code and MUST match the following pattern: ^\w+$

This schema follows the schema of the general openEO error list (see errors.json).

process_graphProcessGraph

A process graph defines a graph-like structure as a connected set of executable processes. Each key is a unique identifier (node ID) that is used to refer to the process in the graph.

Response

The user-defined process has been stored successfully.