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 Service Provider in HTTP/REST technology is defined as follows:
Asset Administration Shell Aggregator Services
|
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
|
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
|
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
|
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
|
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
|
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
|
Submodel Binding
|
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
|
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
|
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
|
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
|