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.
Difference between revisions of "BaSyx / Documentation / API / Registry"
Line 1: | Line 1: | ||
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. | 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. | ||
− | '''Asset Administration Shell Registration''' | + | {| class="wikitable" |
+ | |- | ||
+ | | colspan="3" | '''Asset Administration Shell Registration''' | ||
− | + | |- style="background-color:LightCyan;" | |
| style="color:blue" | GET | | style="color:blue" | GET | ||
| /api/v1/registry | | /api/v1/registry | ||
Line 84: | Line 86: | ||
* 404: No Asset Administration Shell with passed id found | * 404: No Asset Administration Shell with passed id found | ||
* 502: Bad Gateway | * 502: Bad Gateway | ||
+ | |||
+ | |- | ||
+ | | colspan="3" | '''Submodel Registration''' | ||
|- style="background-color:LightCyan;" | |- style="background-color:LightCyan;" |
Revision as of 10:15, 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.
Asset Administration Shell Registration | ||
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
|
Submodel Registration | ||
GET | /api/v1/registry/{aasId}/submodels | Description
|
POST | /api/v1/registry/{aasId}/submodels | Description
Parameter
|
GET | /api/v1/registry/{aasId}/submodels/{submodelIdShort} | Description
|
DELETE | /api/v1/registry/{aasId}/submodels/{submodelIdShort} | Description
Response codes
|
BaSyx project links: Project BaSyx main wiki page | What is BaSyx? | BaSyx Developer Documentation |