Skip to main content
Jump to: navigation, search

Difference between revisions of "BaSyx / Documentation / API / Registry"

m (Added text reference to swagger)
 
(14 intermediate revisions by 4 users not shown)
Line 1: Line 1:
The BaSyx discovery API is implemented by BaSyx discovery services. Discovery services enable the discovery of conforming production entities, which are production entities that export an Asset Administration Shell (AAS). The Asset Administration Shell is a data structure that describes the production entity. It provides basic data and a directory of sub models that describe specific aspects of production entities. Production entities may be any entity that is relevant to production. This includes products under production, devices, workers, but also non-physical entites such as placed orders, and as well products that have been sold. The discrovery service enables discovery and management of Asset Administration Shells via a defined HTTP REST interface.
+
{| class="wikitable"
 
+
| [[BaSyx_/_Documentation_/_Registry | Overview]]  <nowiki>|</nowiki>  [[BaSyx_/_Documentation_/_API_/_Registry| Interface]]  <nowiki>|</nowiki>  [[BaSyx_/_Documentation_/_Components_/_Registry | Component]]
 
+
{| class="wikitable" style="background-color:LightCyan;"
+
| style="color:blue" | 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
+
 
+
|- style="background-color:#d3f8d3;"
+
| style="color:SeaGreen" | 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
+
 
+
|- style="background-color:LightCyan;"
+
| style="color:blue" | 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
+
 
+
|- style="background-color:LemonChiffon;"
+
| style="color:Sienna" | 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
+
 
+
 
+
|- style="background-color:#ffe6ea;"
+
| style="color:DarkRed" | 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
+
 
|}
 
|}
  
 +
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 Asset Administration Shell and its respective Asset, endpoint information regarding the Asset Administration Shell's API and its submodels service providers.
  
{| class="wikitable"
+
We use Swagger to document our core APIs. The complete registry API is documented [https://app.swaggerhub.com/apis/BaSyx/BaSyx_Registry_API/v1#/ here]
| BaSyx project links: [[BaSyx | Project BaSyx main wiki page]]  <nowiki>|</nowiki>  [[BaSyx.WhatIsBasyx | What is BaSyx?]]  <nowiki>|</nowiki>  [[BaSyx.Documentation | BaSyx Developer Documentation]]
+
|}
+

Latest revision as of 10:43, 13 November 2020

Overview | Interface | Component

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 Asset Administration Shell and its respective Asset, endpoint information regarding the Asset Administration Shell's API and its submodels service providers.

We use Swagger to document our core APIs. The complete registry API is documented here

Back to the top