Submodel Registry

Contents

• Creating your own Set-Up

The BaSyx Submodel Registry implements the Submodel Registry API. It stores and serves Submodel Descriptors as standalone registry entries.

API Endpoints

• GET /submodel-descriptors: Returns all Submodel Descriptors (supports pagination via limit and cursor).

• POST /submodel-descriptors: Registers a new Submodel Descriptor.

• GET /submodel-descriptors/{submodelIdentifier}: Returns a specific Submodel Descriptor.

• PUT /submodel-descriptors/{submodelIdentifier}: Creates or updates a Submodel Descriptor.

• DELETE /submodel-descriptors/{submodelIdentifier}: De-registers a Submodel Descriptor.

Component-Specific Notes

• The registry is focused on Submodel Descriptor lifecycle operations only (standalone submodel registration and lookup).

• Path identifiers (submodelIdentifier) must be UTF8 base64 URL encoded.

Common Documentation

This component uses shared BaSyx Go infrastructure for Swagger/OpenAPI and configuration. For components using the shared security setup, OIDC trustlist and ABAC access-rules handling is documented in the shared docs:

• General Configuration

• Swagger UI Docs

• Common / Shared Features