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
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]]
 
|}
 
|}
  

Revision as of 04:30, 18 November 2020

Overview | Interface | Implementation | Component

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 below.

Asset Administration Shell Services
GET /aas Description
  • Retrieves the Asset Administration Shell


Response codes

  • 200: Success
  • 502: Bad Gateway - Asset Administration Shell not available
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
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
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
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

Back to the top