Skip to main content
Jump to: navigation, search

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

Line 1: Line 1:
 
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.  
 
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.  
  
{| class="wikitable"  
+
{| class="wikitable"
 +
 
 
|-
 
|-
| colspan="3" | '''Asset Administration Shell Registration'''
+
| colspan="3" | '''Asset Administration Shell Registry'''
  
|- style="background-color:LightCyan;"
+
|- style="border: 2px solid #61affe; background-color:rgba(97,175,254,.1);"
| style="color:blue" | GET  
+
| style="color:black" | GET  
| /api/v1/registry  
+
| /api/v1/registry
 
| '''Description'''
 
| '''Description'''
 
* Retrieves all registered Asset Administration Shells within a defined system (e.g. site, area, production line, station)
 
* Retrieves all registered Asset Administration Shells within a defined system (e.g. site, area, production line, station)
Line 17: Line 18:
 
* 502: Bad Gateway
 
* 502: Bad Gateway
  
|- style="background-color:#d3f8d3;"
+
|- style="border: 2px solid #49cc90; background-color:rgba(73,204,144,.1);"
| style="color:SeaGreen" | POST  
+
| style="color:black" | POST  
| /api/v1/registry  
+
| /api/v1/registry
 
| '''Description'''
 
| '''Description'''
 
* Registers a new Asset Administration Shell
 
* Registers a new Asset Administration Shell
Line 25: Line 26:
  
 
'''Parameter'''
 
'''Parameter'''
* ''(body)'': The serialized information model of the Asset Administration Shell to be registered
+
* ''(body)'': The Asset Administration Shell descriptor object
  
  
Line 34: Line 35:
 
* 502: Bad Gateway
 
* 502: Bad Gateway
  
|- style="background-color:LightCyan;"
+
|- style="border: 2px solid #61affe; background-color:rgba(97,175,254,.1);"
| style="color:blue" | GET  
+
| style="color:black" | GET  
| /api/v1/registry/{aasId}  
+
| /api/v1/registry/{aasId}
 
| '''Description'''
 
| '''Description'''
 
* Retrieves a specific Asset Administration Shell
 
* Retrieves a specific Asset Administration Shell
Line 51: Line 52:
 
* 502: Bad Gateway
 
* 502: Bad Gateway
  
|- style="background-color:LemonChiffon;"
+
|- style="border: 2px solid #fca130; background-color:rgba(252,161,48,.1);"
| style="color:Sienna" | PUT  
+
| style="color:black" | PUT  
| /api/v1/registry/{aasId}  
+
| /api/v1/registry/{aasId}
 
| '''Description'''
 
| '''Description'''
 
* Renews a specific Asset Administration Shell's registration
 
* Renews a specific Asset Administration Shell's registration
Line 60: Line 61:
 
'''Parameter'''
 
'''Parameter'''
 
* ''aasId'': The Asset Administration Shell's unique id
 
* ''aasId'': The Asset Administration Shell's unique id
* ''(body)'': The serialized information model of the Asset Administration Shell
 
  
  
 
'''Response codes'''
 
'''Response codes'''
* 200: The Asset Administration Shell’s registration was successfully renewed
+
* 204: Success
 +
* 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
 
* 400: The syntax of the passed Asset Administration Shell is not valid or malformed request
 
* 404: No Asset Administration Shell with passed id found
 
* 404: No Asset Administration Shell with passed id found
 
* 502: Bad Gateway
 
* 502: Bad Gateway
  
 
+
|- style="border: 2px solid #f93e3e; background-color:rgba(249,62,62,.1);"
|- style="background-color:#ffe6ea;"
+
| style="color:black" | DELETE  
| style="color:DarkRed" | DELETE  
+
| /api/v1/registry/{aasId}
| /api/v1/registry/{aasId}  
+
 
| '''Description'''
 
| '''Description'''
 
* Deletes a specific Asset Administration Shell
 
* Deletes a specific Asset Administration Shell
Line 82: Line 82:
  
 
'''Response codes'''
 
'''Response codes'''
 +
* 204: Success
 
* 200: The Asset Administration Shell was deleted successfully
 
* 200: The Asset Administration Shell was deleted successfully
 
* 400: Bad Request
 
* 400: Bad Request
Line 87: Line 88:
 
* 502: Bad Gateway
 
* 502: Bad Gateway
  
|-
+
|- style="border: 2px solid #61affe; background-color:rgba(97,175,254,.1);"
| colspan="3" | '''Submodel Registration'''
+
| style="color:black" | GET  
 
+
|- style="background-color:LightCyan;"
+
| style="color:blue" | GET  
+
 
| /api/v1/registry/{aasId}/submodels
 
| /api/v1/registry/{aasId}/submodels
 
| '''Description'''
 
| '''Description'''
 
* Retrieves all Submodels from a specific Asset Administration Shell
 
* Retrieves all Submodels from a specific Asset Administration Shell
 +
 +
 +
'''Parameter'''
 +
* ''aasId'': The Asset Administration Shell's unique id
  
  
Line 103: Line 105:
 
* 502: Bad Gateway
 
* 502: Bad Gateway
  
|- style="background-color:#d3f8d3;"
+
|- style="border: 2px solid #49cc90; background-color:rgba(73,204,144,.1);"
| style="color:SeaGreen" | POST  
+
| style="color:black" | POST  
| /api/v1/registry/{aasId}/submodels  
+
| /api/v1/registry/{aasId}/submodels
 
| '''Description'''
 
| '''Description'''
 
* Adds a new Submodel to an existing resp. registered Asset Administration Shell
 
* Adds a new Submodel to an existing resp. registered Asset Administration Shell
 +
  
 
'''Parameter'''
 
'''Parameter'''
* ''(body)'': The serialized information model of the Submodel to be added
+
* ''aasId'': The Asset Administration Shell's unique id
 +
* ''(body)'': The Submodel descriptor object
  
  
Line 116: Line 120:
 
* 201: The Submodel was created successfully
 
* 201: The Submodel was created successfully
 
* 400: The syntax of the passed Submodel is not valid or malformed request
 
* 400: The syntax of the passed Submodel is not valid or malformed request
 +
* 404: No Asset Administration Shell with passed id found
 
* 422: The passed Submodel conflicts with already registered Submodels
 
* 422: The passed Submodel conflicts with already registered Submodels
 
* 502: Bad Gateway
 
* 502: Bad Gateway
  
|- style="background-color:LightCyan;"
+
|- style="border: 2px solid #61affe; background-color:rgba(97,175,254,.1);"
| style="color:blue" | GET  
+
| style="color:black" | GET  
| /api/v1/registry/{aasId}/submodels/{submodelIdShort}  
+
| /api/v1/registry/{aasId}/submodels/{submodelIdShort}
 
| '''Description'''
 
| '''Description'''
 
* Retrieves a specific Submodel from a specific Asset Administration Shell
 
* Retrieves a specific Submodel from a specific Asset Administration Shell
Line 132: Line 137:
  
 
'''Response codes'''
 
'''Response codes'''
* 200: Returns the requested Submodel
+
* 200: Returns the requested Submodels
 
* 400: Bad Request
 
* 400: Bad Request
* 404: No Submodel with passed id found
+
* 404: No Asset Administration Shell / Submodel with passed id found
 
* 502: Bad Gateway
 
* 502: Bad Gateway
  
|- style="background-color:#ffe6ea;"
+
|- style="border: 2px solid #f93e3e; background-color:rgba(249,62,62,.1);"
| style="color:DarkRed" | DELETE  
+
| style="color:black" | DELETE  
| /api/v1/registry/{aasId}/submodels/{submodelIdShort}  
+
| /api/v1/registry/{aasId}/submodels/{submodelIdShort}
 
| '''Description'''
 
| '''Description'''
 
* Deletes a specific Submodel from a specific Asset Administration Shell
 
* Deletes a specific Submodel from a specific Asset Administration Shell
Line 147: Line 152:
 
* ''aasId'': The Asset Administration Shell's unique id
 
* ''aasId'': The Asset Administration Shell's unique id
 
* ''submodelIdShort'': The Submodel's short id (idShort)
 
* ''submodelIdShort'': The Submodel's short id (idShort)
 +
  
 
'''Response codes'''
 
'''Response codes'''
 +
* 204: Success
 
* 200: The Submodel was deleted successfully
 
* 200: The Submodel was deleted successfully
 
* 400: Bad Request
 
* 400: Bad Request
 
* 404: No Asset Administration Shell / Submodel with passed id found
 
* 404: No Asset Administration Shell / Submodel with passed id found
 
* 502: Bad Gateway
 
* 502: Bad Gateway
 +
 
|}
 
|}
 +
  
  

Revision as of 08:09, 22 June 2019

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 Registry
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 Asset Administration Shell descriptor object


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


Response codes

  • 204: Success
  • 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

  • 204: Success
  • 200: The Asset Administration Shell was deleted successfully
  • 400: Bad Request
  • 404: No Asset Administration Shell with passed id found
  • 502: Bad Gateway
GET /api/v1/registry/{aasId}/submodels Description
  • Retrieves all Submodels from a specific Asset Administration Shell


Parameter

  • aasId: The Asset Administration Shell's unique id


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

  • aasId: The Asset Administration Shell's unique id
  • (body): The Submodel descriptor object


Response codes

  • 201: The Submodel was created successfully
  • 400: The syntax of the passed Submodel is not valid or malformed request
  • 404: No Asset Administration Shell with passed id found
  • 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 Submodels
  • 400: Bad Request
  • 404: No Asset Administration Shell / 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

  • 204: Success
  • 200: The Submodel was deleted successfully
  • 400: Bad Request
  • 404: No Asset Administration Shell / Submodel with passed id found
  • 502: Bad Gateway


BaSyx project links: Project BaSyx main wiki page | What is BaSyx? | BaSyx Developer Documentation

Back to the top