Digital Twin Registry#

GitHub Metamodel API

Contents#

The BaSyx Digital Twin Registry combines Asset Administration Shell Registry and Basic Discovery capabilities in one component. In this repository, it exposes a combined API and adds Digital Twin Registry-specific query/filter extensions on top of the standard endpoints.

Included API Areas#

  • AAS Registry endpoints (/shell-descriptors, including AAS-scoped submodel descriptor endpoints)

  • Basic Discovery Component endpoints (/lookup/shells, /lookup/shellsByAssetLink, /lookup/shells/{aasIdentifier})

  • Description endpoint (/description)

Digital Twin Registry Extensions#

Query Endpoint for AAS Descriptors#

  • POST /query/shell-descriptors: Queries AAS Descriptors using the query language and supports pagination (limit, cursor).

Optional Header for Filtering / Access Control Integration#

  • Edc-Bpn (optional request header): Used by the Digital Twin Registry API for query filtering / access control integration in the combined API.

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:

Component-Specific Notes#

  • The Digital Twin Registry service in this repository always runs with discovery integration enabled.

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