BaSyx / Documentation / API / Registry

The BaSys 4.0 Registry enables registration and lookup of Asset Administration Shells within defined system boundaries. Entities that provide Asset Administration Shells including their submodels may register and hence enable other participants to find them. The necessary information required for registration amongst others are unique identifiers for the Administration Shell and her respective Asset, endpoint information regarding the Asset Administration Shell's API and their submodel service provider.

Asset Administration Shell Registration

GET	/api/v1/registry	Description Retrieves all registered Asset Administration Shells within a defined system (e.g. site, area, production line, station) Response codes 200: Returns a list of found Asset Administration Shells 400: Bad Request 502: Bad Gateway
POST	/api/v1/registry	Description Registers a new Asset Administration Shell Parameter (body): The serialized information model of the Asset Administration Shell to be registered Response codes 201: The Asset Administration Shell was created successfully 400: The syntax of the passed Asset Administration Shell is not valid or malformed request 422: The passed Asset Administration Shell conflicts with already registered Asset Administration Shells 502: Bad Gateway
GET	/api/v1/registry/{aasId}	Description Retrieves a specific Asset Administration Shell Parameter aasId: The Asset Administration Shell's unique id Response codes 200: Returns the requested Asset Administration Shell 400: Bad Request 404: No Asset Administration Shell with passed id found 502: Bad Gateway
PUT	/api/v1/registry/{aasId}	Description Renews a specific Asset Administration Shell's registration Parameter aasId: The Asset Administration Shell's unique id (body): The serialized information model of the Asset Administration Shell Response codes 200: The Asset Administration Shell’s registration was successfully renewed 400: The syntax of the passed Asset Administration Shell is not valid or malformed request 404: No Asset Administration Shell with passed id found 502: Bad Gateway
DELETE	/api/v1/registry/{aasId}	Description Deletes a specific Asset Administration Shell Parameter aasId: The Asset Administration Shell's unique id Response codes 200: The Asset Administration Shell was deleted successfully 400: Bad Request 404: No Asset Administration Shell with passed id found 502: Bad Gateway

Submodel registration

GET	/api/v1/registry/{aasId}/submodels	Description Retrieves all Submodels from a specific Asset Administration Shell Response codes 200: Returns a list of found Submodels 400: Bad Request 404: No Asset Administration Shell with passed id found 502: Bad Gateway
POST	/api/v1/registry/{aasId}/submodels	Description Adds a new Submodel to an existing resp. registered Asset Administration Shell Parameter (body): The serialized information model of the Submodel to be added Response codes 201: The Submodel was created successfully 400: The syntax of the passed Submodel is not valid or malformed request 422: The passed Submodel conflicts with already registered Submodels 502: Bad Gateway
GET	/api/v1/registry/{aasId}/submodels/{submodelIdShort}	Description Retrieves a specific Submodel from a specific Asset Administration Shell Parameter aasId: The Asset Administration Shell's unique id submodelIdShort: The Submodel's short id (idShort) Response codes 200: Returns the requested Submodel 400: Bad Request 404: No Submodel with passed id found 502: Bad Gateway
DELETE	/api/v1/registry/{aasId}/submodels/{submodelIdShort}	Description Deletes a specific Submodel from a specific Asset Administration Shell Parameter aasId: The Asset Administration Shell's unique id submodelIdShort: The Submodel's short id (idShort) Response codes 200: The Submodel was deleted successfully 400: Bad Request 404: No Asset Administration Shell / Submodel with passed id found 502: Bad Gateway