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"
m (Frank.schnicke.iese.fraunhofer.de moved page BaSyx.Registry to BaSyx / Documentation / API / Registry) |
m (Adds example body for PUT/POST) |
||
Line 162: | Line 162: | ||
|} | |} | ||
+ | |||
+ | |||
+ | |||
+ | In the following, an example body for the PUT/POST request is shown. Parameters with a ''$'' prefix should be modified according to the specific AAS to be registered. | ||
+ | |||
+ | { | ||
+ | "idShort" : "$aasName", | ||
+ | "identification" : { | ||
+ | "id" : "$aasId", | ||
+ | "idType" : "Custom" | ||
+ | }, | ||
+ | "endpoints" : [ | ||
+ | { | ||
+ | "type" : "http", | ||
+ | "address" : "$http://localhost:5080" | ||
+ | }], | ||
+ | "submodels" : [{ | ||
+ | "idShort" : "$submodelName", | ||
+ | "identification" : { | ||
+ | "id" : "$submodelId", | ||
+ | "idType" : "Custom" | ||
+ | }, | ||
+ | "endpoints" : [ | ||
+ | { | ||
+ | "type" : "http", | ||
+ | "address" : "$http://localhost:5080/aas/submodels/submodelName" | ||
+ | }] | ||
+ | }] | ||
+ | } | ||
Revision as of 02:51, 14 January 2020
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 Registry | ||
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
|
GET | /api/v1/registry/{aasId}/submodels/{submodelIdShort} | Description
|
DELETE | /api/v1/registry/{aasId}/submodels/{submodelIdShort} | Description
|
In the following, an example body for the PUT/POST request is shown. Parameters with a $ prefix should be modified according to the specific AAS to be registered.
{ "idShort" : "$aasName", "identification" : { "id" : "$aasId", "idType" : "Custom" }, "endpoints" : [ { "type" : "http", "address" : "$http://localhost:5080" }], "submodels" : [{ "idShort" : "$submodelName", "identification" : { "id" : "$submodelId", "idType" : "Custom" }, "endpoints" : [ { "type" : "http", "address" : "$http://localhost:5080/aas/submodels/submodelName" }] }] }
BaSyx project links: Project BaSyx main wiki page | What is BaSyx? | BaSyx Developer Documentation |