Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "BaSyx / Documentation / API / Registry"
< BaSyx | Documentation | API
m (Constantin.ziesche.bosch.com moved page Basyx.Discovery to BaSyx.Registry: Wrong naming) |
|||
| Line 5: | Line 5: | ||
| /api/v1/registry | | /api/v1/registry | ||
| '''Description''' | | '''Description''' | ||
| − | * Retrieves all | + | * Retrieves all registered Asset Administration Shells within a defined system (e.g. site, area, production line, station) |
'''Response codes''' | '''Response codes''' | ||
| − | * 200: Returns | + | * 200: Returns a list of found Asset Administration Shells |
* 400: Bad Request | * 400: Bad Request | ||
* 502: Bad Gateway | * 502: Bad Gateway | ||
| Line 21: | Line 21: | ||
'''Parameter''' | '''Parameter''' | ||
| − | * ''(body)'': | + | * ''(body)'': The serialized information model of the Asset Administration Shell to be registered |
'''Response codes''' | '''Response codes''' | ||
* 201: The Asset Administration Shell was created successfully | * 201: The Asset Administration Shell was created successfully | ||
| − | * 400: | + | * 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 | * 502: Bad Gateway | ||
| Line 37: | Line 38: | ||
'''Parameter''' | '''Parameter''' | ||
| − | * ''aasId'': | + | * ''aasId'': The Asset Administration Shell's unique id |
| Line 43: | Line 44: | ||
* 200: Returns the requested Asset Administration Shell | * 200: Returns the requested Asset Administration Shell | ||
* 400: Bad Request | * 400: Bad Request | ||
| − | * 404: No Asset Administration Shell found | + | * 404: No Asset Administration Shell with passed id found |
* 502: Bad Gateway | * 502: Bad Gateway | ||
| Line 54: | Line 55: | ||
'''Parameter''' | '''Parameter''' | ||
| − | * ''aasId'': | + | * ''aasId'': The Asset Administration Shell's unique id |
| − | * ''(body)'': | + | * ''(body)'': The serialized information model of the Asset Administration Shell |
'''Response codes''' | '''Response codes''' | ||
* 204: The Asset Administration Shell’s registration was successfully renewed | * 204: The Asset Administration Shell’s registration was successfully renewed | ||
| − | * 400: | + | * 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 | * 502: Bad Gateway | ||
| Line 72: | Line 74: | ||
'''Parameter''' | '''Parameter''' | ||
| − | * ''aasId'': | + | * ''aasId'': The Asset Administration Shell's unique id |
| Line 78: | Line 80: | ||
* 204: The Asset Administration Shell was deleted successfully | * 204: The Asset Administration Shell was deleted successfully | ||
* 400: Bad Request | * 400: Bad Request | ||
| + | * 404: No Asset Administration Shell with passed id found | ||
* 502: Bad Gateway | * 502: Bad Gateway | ||
|} | |} | ||
Revision as of 09:26, 11 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.
| GET | /api/v1/registry | Description
|
| POST | /api/v1/registry | Description
|
| GET | /api/v1/registry/{aasId} | Description
|
| PUT | /api/v1/registry/{aasId} | Description
|
| DELETE | /api/v1/registry/{aasId} | Description
|
| BaSyx project links: Project BaSyx main wiki page | What is BaSyx? | BaSyx Developer Documentation |