API Traversal

The system represents the reference of an entity in the system as Hypermedia as the Engine of Application State (HATEOS). Each reference position is represented by an object pair pkid and href.

A client integrates with VOSS Automate entirely through hypermedia dynamically provided by the VOSS Automate application and does not need any prior knowledge about how to interact with the system other than a generic understanding of hypermedia. This means that no WADL is provided. This also means that the client and VOSS Automate can be decoupled in a way that allows VOSS Automate to evolve independently.

A client enters the VOSS Automate through a simple fixed URL. All future actions the client may take are discovered within resource representations returned from the server

The detailed URL tree endpoint information is available in the relevant API Reference Guides for the core and features.

This response emulates the HierarchyNode list response, and utilizes the parent and children in the meta references section of the response, as discussed in Meta Data References.