Job Management API Map

This document shows a map of the API design. Resources are the nodes and links are edges with their corresponding labels.

Root nodes

There are several special nodes in the API called Root nodes e.g. WorkDataRoot. These nodes share a similar pattern by providing access to a list of nodes e.g. WorkDataRoot provides access to WorkData nodes. All action which are not related to a specific instance are located on the Root node. This includes creating new instances and querying instances.

Errors

If an error occurs or an operation is not permitted to a user or in the current state the API will always return a Problem Details object. This allows for consistent error handling for clients.

API Map legend

Job Management API Map without Actions which return no links for simplicity