|
|
| (5 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| | {| class="wikitable" | | {| class="wikitable" |
| − | | [[BaSyx.HowTo.AAS | Overview]] <nowiki>|</nowiki> [[BaSyx.AssetAdministrationShell | Interface]] <nowiki>|</nowiki> [[BaSyx.AAS.Implementation | 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]] |
| | |} | | |} |
| | | | |
| Line 8: |
Line 8: |
| | 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, [https://www.plattform-i40.de/PI40/Redaktion/DE/Downloads/Publikation/2018-verwaltungsschale-im-detail.pdf]) | | 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, [https://www.plattform-i40.de/PI40/Redaktion/DE/Downloads/Publikation/2018-verwaltungsschale-im-detail.pdf]) |
| | | | |
| − | The BaSyx Asset Administration Shell Service Provider in HTTP/REST technology is defined as follows: | + | The '''BaSyx Asset Administration Shell Repository''' HTTP/REST API is explained [https://app.swaggerhub.com/apis/BaSyx/basyx_asset_administration_shell_repository_http_rest_api/v1 here]. |
| | | | |
| − | {| class="wikitable"
| |
| | | | |
| − | |-
| + | 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]. |
| − | | colspan="3" | '''Asset Administration Shell Aggregator Services'''
| + | |
| − | | + | |
| − | |- style="border: 2px solid #61affe; background-color:rgba(97,175,254,.1);"
| + | |
| − | | style="color:black" | GET
| + | |
| − | | /aasList
| + | |
| − | | '''Description'''
| + | |
| − | * Retrieves all Asset Administration Shells from the endpoint
| + | |
| − | | + | |
| − | | + | |
| − | '''Response codes'''
| + | |
| − | * 200: Returns a list of found Asset Administration Shells
| + | |
| − | * 404: No Asset Administration Shells found
| + | |
| − | * 400: Bad Request
| + | |
| − | * 502: Bad Gateway
| + | |
| − | | + | |
| − | |- style="border: 2px solid #49cc90; background-color:rgba(73,204,144,.1);"
| + | |
| − | | style="color:black" | POST
| + | |
| − | | /aasList
| + | |
| − | | '''Description'''
| + | |
| − | * Creates a new Asset Administration Shell at the endpoint
| + | |
| − | | + | |
| − | | + | |
| − | '''Parameter'''
| + | |
| − | * ''(body)'': The AAS's description object
| + | |
| − | | + | |
| − | | + | |
| − | '''Response codes''' | + | |
| − | * 201: Asset Administration Shell created successfully
| + | |
| − | * 400: Bad Request
| + | |
| − | * 502: Bad Gateway
| + | |
| − | | + | |
| − | |- style="border: 2px solid #61affe; background-color:rgba(97,175,254,.1);"
| + | |
| − | | style="color:black" | GET
| + | |
| − | | /aasList/{aasId}
| + | |
| − | | '''Description'''
| + | |
| − | * Retrieves a specific Asset Administration Shell
| + | |
| − | | + | |
| − | | + | |
| − | '''Parameter'''
| + | |
| − | * ''aasId'': The AAS's unique id
| + | |
| − | | + | |
| − | | + | |
| − | '''Response codes'''
| + | |
| − | * 200: Returns the requested Asset Administration Shell
| + | |
| − | * 404: No Asset Administration Shell found
| + | |
| − | * 400: Bad Request
| + | |
| − | * 502: Bad Gateway
| + | |
| − | | + | |
| − | |- style="border: 2px solid #fca130; background-color:rgba(252,161,48,.1);"
| + | |
| − | | style="color:black" | PUT
| + | |
| − | | /aasList/{aasId}
| + | |
| − | | '''Description'''
| + | |
| − | * Updates a specific Asset Administration Shell
| + | |
| − | | + | |
| − | | + | |
| − | '''Parameter'''
| + | |
| − | * ''aasId'': The AAS's unique id
| + | |
| − | * ''(body)'': The updated AAS
| + | |
| − | | + | |
| − | | + | |
| − | '''Response codes'''
| + | |
| − | * 200: Asset Administration Shell updated successfully
| + | |
| − | * 400: Bad Request
| + | |
| − | * 502: Bad Gateway
| + | |
| − | | + | |
| − | |- style="border: 2px solid #f93e3e; background-color:rgba(249,62,62,.1);"
| + | |
| − | | style="color:black" | DELETE
| + | |
| − | | /aasList/{aasId}
| + | |
| − | | '''Description'''
| + | |
| − | * Deletes a specific Asset Administration Shell
| + | |
| − | | + | |
| − | | + | |
| − | '''Parameter'''
| + | |
| − | * ''aasId'': The AAS's unique id
| + | |
| − | | + | |
| − | | + | |
| − | '''Response codes'''
| + | |
| − | * 200: Asset Administration Shell deleted successfully
| + | |
| − | * 400: Bad Request
| + | |
| − | * 502: Bad Gateway
| + | |
| − | | + | |
| − | | + | |
| − | |-
| + | |
| − | | 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
| + | |
| − | | + | |
| − | | + | |
| − | |-
| + | |
| − | | colspan="3" | '''Submodel Binding'''
| + | |
| − | | + | |
| − | |- style="border: 2px solid #61affe; background-color:rgba(97,175,254,.1);"
| + | |
| − | | style="color:black" | GET
| + | |
| − | | /aas/submodels/bindings
| + | |
| − | | '''Description'''
| + | |
| − | * Retrieves all registered Submodel Service Providers within an Asset Administation Shell Service Provider
| + | |
| − | | + | |
| − | | + | |
| − | '''Response codes'''
| + | |
| − | * 200: Returns the all registered Submodel Service Provider
| + | |
| − | * 404: No Submodel Service Provider found
| + | |
| − | * 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}/binding
| + | |
| − | | '''Description'''
| + | |
| − | * Retrieves a specific Submodel Service Provider from its containing Asset Administration Shell Service Provider
| + | |
| − | | + | |
| − | | + | |
| − | '''Parameter'''
| + | |
| − | | + | |
| − | | + | |
| − | '''Response codes'''
| + | |
| − | * 200: Returns the requested Submodel Service Provider
| + | |
| − | * 404: No Submodel Service Provider found
| + | |
| − | * 400: Bad Request
| + | |
| − | * 502: Bad Gateway
| + | |
| − | | + | |
| − | |- style="border: 2px solid #49cc90; background-color:rgba(73,204,144,.1);"
| + | |
| − | | style="color:black" | POST
| + | |
| − | | /aas/submodels/{submodelId}/binding
| + | |
| − | | '''Description'''
| + | |
| − | * Registers a new Distributed Submodel Service Provider at the Asset Administration Shell Service Provider
| + | |
| − | | + | |
| − | | + | |
| − | '''Parameter'''
| + | |
| − | * ''(body)'': The Submodel Service Provider' service descriptor object
| + | |
| − | | + | |
| − | | + | |
| − | '''Response codes'''
| + | |
| − | * 201: Submodel Service Provider registered successfully
| + | |
| − | * 400: Bad Request
| + | |
| − | * 502: Bad Gateway
| + | |
| − | | + | |
| − | |- style="border: 2px solid #f93e3e; background-color:rgba(249,62,62,.1);"
| + | |
| − | | style="color:black" | DELETE
| + | |
| − | | /aas/submodels/{submodelId}/binding
| + | |
| − | | '''Description'''
| + | |
| − | * Unregisters a specific Submodel Service Provider from its containing Asset Administration Shell Service Provider
| + | |
| − | | + | |
| − | | + | |
| − | '''Parameter'''
| + | |
| − | | + | |
| − | | + | |
| − | '''Response codes'''
| + | |
| − | * 200: Submodel Service Provider unregistered successfully
| + | |
| − | * 400: Bad Request
| + | |
| − | * 502: Bad Gateway
| + | |
| − | | + | |
| − | |}
| + | |
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])
