Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

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

m (Replaces API with swagger hub link)
m
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{| class="wikitable"
 
{| class="wikitable"
| [[BaSyx_/_Documentation_/_AssetAdministrationShell | Overview]]  <nowiki>|</nowiki>  [[BaSyx_/_Documentation_/_API_/_AssetAdministrationShell| Interface]]  <nowiki>|</nowiki>  [[BaSyx_/_Documentation_/_Implementation_/_AssetAdministrationShell | Implementation]]
+
| [[BaSyx_/_Documentation_/_AssetAdministrationShell | Overview]]  <nowiki>|</nowiki>  [[BaSyx_/_Documentation_/_API_/_AssetAdministrationShell| Interface]]  <nowiki>|</nowiki>  [[BaSyx_/_Documentation_/_Implementation_/_AssetAdministrationShell | Implementation]]  <nowiki>|</nowiki>  [[BaSyx_/_Documentation_/_Components_/_AAS_Server | Component]] <nowiki>|</nowiki> [[BaSyx_/_Documentation_/_Components_/_AAS_Server_/_Features | Features]]
 
|}
 
|}
  
Line 11: Line 11:
  
  
The '''BaSyx Asset Administration Shell''' HTTP/REST API is given below.
+
The '''BaSyx Asset Administration Shell''' HTTP/REST API is given [https://app.swaggerhub.com/apis/BaSyx/basyx_asset_administration_shell_http_rest_api/v1 here].
{| class="wikitable"
+
| colspan="3" | '''Asset Administration Shell Services'''
+
 
+
|- style="border: 2px solid #61affe; background-color:rgba(97,175,254,.1);"
+
| style="color:black" | GET
+
| /aas
+
| '''Description'''
+
* Retrieves the Asset Administration Shell
+
 
+
 
+
'''Response codes'''
+
* 200: Success
+
* 502: Bad Gateway - Asset Administration Shell not available
+
 
+
|- style="border: 2px solid #61affe; background-color:rgba(97,175,254,.1);"
+
| style="color:black" | GET
+
| /aas/submodels
+
| '''Description'''
+
* Retrieves all Submodels from the  Asset Administration Shell
+
 
+
 
+
'''Response codes'''
+
* 200: Returns a list of found Submodels
+
* 404: No Submodel Service Providers found
+
* 502: Bad Gateway
+
 
+
|- style="border: 2px solid #49cc90; background-color:rgba(73,204,144,.1);"
+
| style="color:black" | POST
+
| /aas/submodels
+
| '''Description'''
+
* Adds a new Submodel to an existing Asset Administration Shell
+
 
+
 
+
'''Parameter'''
+
* ''(body)'': The Submodel's description object
+
 
+
 
+
'''Response codes'''
+
* 201: Submodel created successfully
+
* 400: Bad Request
+
* 502: Bad Gateway
+
 
+
|- style="border: 2px solid #61affe; background-color:rgba(97,175,254,.1);"
+
| style="color:black" | GET
+
| /aas/submodels/{submodelId}
+
| '''Description'''
+
* Retrieves the Submodel from the Asset Administration Shell
+
 
+
 
+
'''Parameter'''
+
* ''submodelId'': The Submodel's unique id
+
 
+
 
+
'''Response codes'''
+
* 200: Submodel retrieved successfully
+
* 404: No Submodel Service Provider found
+
* 502: Bad Gateway
+
 
+
|- style="border: 2px solid #f93e3e; background-color:rgba(249,62,62,.1);"
+
| style="color:black" | DELETE
+
| /aas/submodels/{submodelId}
+
| '''Description'''
+
* Deletes a specific Submodel from the Asset Administration Shell
+
 
+
 
+
'''Parameter'''
+
* ''submodelId'': The Submodel's idShort
+
 
+
 
+
'''Response codes'''
+
* 200: Submodel deleted successfully
+
* 400: Bad Request
+
* 502: Bad Gateway
+
 
+
|}
+

Latest revision as of 14:52, 26 November 2022

Overview | Interface | Implementation | Component | Features

An Asset Administration Shell is a "standardized digital representation of the asset, corner stone of the interoperability between the applications managing the manufacturing systems. It identifies the Administration Shell and the assets represented by it, holds digital models of various aspects (submodels) and describes technical functionality exposed by the Administration Shell or respective assets." (Details of the Asset Administration Shell, 2018, p. 13, [1])

An Asset is defined as "physical or logical object owned by or under the custodial duties of an organization, having either a perceived or actual value to the organization" (Details of the Asset Administration Shell, 2018, p. 12, [2])

The BaSyx Asset Administration Shell Repository HTTP/REST API is explained here.


The BaSyx Asset Administration Shell HTTP/REST API is given here.

Back to the top