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 81: | Line 81: | ||
* 400: Bad Request | * 400: Bad Request | ||
* 404: No Asset Administration Shell with passed id found | * 404: No Asset Administration Shell with passed id found | ||
+ | * 502: Bad Gateway | ||
+ | |} | ||
+ | |||
+ | _____________________________________________________________ | ||
+ | |||
+ | {| class="wikitable" style="background-color:LightCyan;" | ||
+ | | style="color:blue" | GET | ||
+ | | /api/v1/registry/{aasId}/submodels | ||
+ | | '''Description''' | ||
+ | * Retrieves all Submodels from a specific Asset Administration Shell | ||
+ | |||
+ | |||
+ | '''Response codes''' | ||
+ | * 200: Returns a list of found Submodels | ||
+ | * 400: Bad Request | ||
+ | * 404: No Asset Administration Shell with passed id found | ||
+ | * 502: Bad Gateway | ||
+ | |||
+ | |- style="background-color:#d3f8d3;" | ||
+ | | style="color:SeaGreen" | POST | ||
+ | | /api/v1/registry/{aasId}/submodels | ||
+ | | '''Description''' | ||
+ | * Adds a new Submodel to an existing resp. registered Asset Administration Shell | ||
+ | |||
+ | '''Parameter''' | ||
+ | * ''(body)'': The serialized information model of the Submodel to be added | ||
+ | |||
+ | |||
+ | '''Response codes''' | ||
+ | * 201: The Submodel was created successfully | ||
+ | * 400: The syntax of the passed Submodel is not valid or malformed request | ||
+ | * 422: The passed Submodel conflicts with already registered Submodels | ||
+ | * 502: Bad Gateway | ||
+ | |||
+ | |- style="background-color:LightCyan;" | ||
+ | | style="color:blue" | GET | ||
+ | | /api/v1/registry/{aasId}/submodels/{submodelIdShort} | ||
+ | | '''Description''' | ||
+ | * Retrieves a specific Submodel from a specific Asset Administration Shell | ||
+ | |||
+ | |||
+ | '''Parameter''' | ||
+ | * ''aasId'': The Asset Administration Shell's unique id | ||
+ | * ''submodelIdShort'': The Submodel's short id (idShort) | ||
+ | |||
+ | |||
+ | '''Response codes''' | ||
+ | * 200: Returns the requested Submodel | ||
+ | * 400: Bad Request | ||
+ | * 404: No Submodel with passed id found | ||
+ | * 502: Bad Gateway | ||
+ | |||
+ | |- style="background-color:#ffe6ea;" | ||
+ | | style="color:DarkRed" | DELETE | ||
+ | | /api/v1/registry/{aasId}/submodels/{submodelIdShort} | ||
+ | | '''Description''' | ||
+ | * Deletes a specific Submodel from a specific Asset Administration Shell | ||
+ | |||
+ | |||
+ | '''Parameter''' | ||
+ | * ''aasId'': The Asset Administration Shell's unique id | ||
+ | * ''submodelIdShort'': The Submodel's short id (idShort) | ||
+ | |||
+ | '''Response codes''' | ||
+ | * 200: The Submodel was deleted successfully | ||
+ | * 400: Bad Request | ||
+ | * 404: No Asset Administration Shell / Submodel with passed id found | ||
* 502: Bad Gateway | * 502: Bad Gateway | ||
|} | |} |
Revision as of 10:05, 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
|
_____________________________________________________________
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 |