Nuclos REST architecture: camelCase, FQN, UID, attributes, links, rel, methods, subforms, JSON conventions.

Language: Deutsch · English

Architecture decisions (INTERNAL)

Internal design decisions for the REST JSON structure – camelCase, FQNs, attributes key and link rendering.

Auf dieser Seite

Internal design decisions (draft 2015) for the REST JSON structure. For using the service, the REST documentation is authoritative.

Conventions

JSON properties in camelCase (e.g. boMetaId instead of bo_meta_id), no underscores in keys.
FQNs instead of UIDs: the package and BO name instead of the BO-meta UID (de_test_Auftrag).
Attributes start lowercase (de_test_Auftrag_gesamtsumme) and – where possible – are not fully qualified (exceptions: VLP, layout-ML rules).
Separation of technical and business attributes: business content under the key attributes.
All links with a rel key, href and a methods array; subforms under subforms.

Non-fully-qualified attributes were preferred because they cause less traffic, are clearer and simplify test cases.

REST service.