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.

GET	/api/v1/registry	Description Retrieves all (locally) registered Asset Administration Shells Response codes 200: Returns JSON-serialized 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): New Asset Administration Shell data is transmitted in body using JSON serialization Response codes 201: The Asset Administration Shell was created successfully 400: Bad Request 502: Bad Gateway
GET	/api/v1/registry/{aasId}	Description Retrieves a specific Asset Administration Shell Parameter aasId: ID of a registered Asset Administration Shell Response codes 200: Returns the requested Asset Administration Shell 400: Bad Request 404: No Asset Administration Shell found 502: Bad Gateway
PUT	/api/v1/registry/{aasId}	Description Renews a specific Asset Administration Shell's registration Parameter aasId: ID of a registered Asset Administration Shell (body): New Asset Administration Shell data is transmitted in body using JSON serialization Response codes 204: The Asset Administration Shell’s registration was successfully renewed 400: Bad Request 502: Bad Gateway
DELETE	/api/v1/registry/{aasId}	Description Deletes a specific Asset Administration Shell Parameter aasId: ID of a registered Asset Administration Shell Response codes 204: The Asset Administration Shell was deleted successfully 400: Bad Request 502: Bad Gateway