API

The Registry allows accessing the data via REST-API.

Please be aware, that HTTPS is used.

The Registry uses a configurable API prefix for all API calls. By default, the prefix is “/api/v3.0”. The prefix can be changed in the Configuration.

Supported API calls

  • Asset Administration Shell Registry Interface

    • /shell-descriptors GET POST

    • /shell-descriptors/{aasIdentifier} GET PUT DELETE

    • /shell-descriptors/{aasIdentifier}/submodel-descriptors GET POST

    • /shell-descriptors/{aasIdentifier}/submodel-descriptors/{submodelIdentifier} GET PUT DELETE

  • Submodel Registry Interface

    • /submodel-descriptors GET POST

    • /submodel-descriptors/{submodelIdentifier} GET PUT DELETE

  • Description Interface

    • /description GET

  • Discovery Interface

    • /lookup/shells GET

    • /lookup/shells/{aasIdentifier} GET POST DELETE

  • Async Bulk Asset Administration Shell Registry API

    • /bulk/shell-descriptors POST PUT DELETE

  • Async Bulk Submodel Registry API

    • /bulk/submodel-descriptors POST PUT DELETE

  • Async Bulk Status API

    • /bulk/status/{handleId} GET

  • Async Bulk Result API

    • /bulk/result/{handleId} GET

Example

In the default configuration, the base URL for the API is e.g.:

https://localhost:8090/api/v3.0/shell-descriptors