{"openapi":"3.0.0","servers":[{"description":"SwaggerHub API Auto Mocking","url":"https://virtserver.swaggerhub.com/1165329870/AAS_Server_API_by_SIEMENS_and_HUST/1.0.0"},{"description":"SwaggerHub API Auto Mocking","url":"http://localhost:8080"}],"info":{"version":"1.0.0","title":"AAS Server APi","description":"The API for the AAS Server Developed by SIEMENS and HUST"},"paths":{"/packages":{"get":{"tags":["AASX Package"],"description":"Returns a list of available aasx packages at the server","operationId":"GetPackages","responses":{"200":{"description":"All the devices","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackageDict"}}}}}}},"/packages/{aasIdShort}":{"post":{"tags":["AASX Package"],"operationId":"CreatePackage","description":"Create a new aasx package","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"binary":{"schema":{"example":"Binary format of aasx file"}}}},"responses":{"200":{"description":"response","content":{"application/text":{"schema":{"type":"string","example":"ok(created)"}}}}},"x-swagger-router-controller":"ZWave"},"get":{"tags":["AASX Package"],"operationId":"GetSinglePackage","description":"Download the aasx package with the specified aasIdShort","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"response","content":{"application/json":{"schema":{"example":null}}}}},"x-swagger-router-controller":"ZWave"},"put":{"tags":["AASX Package"],"operationId":"UpdatePackage","description":"Update an existing aasx package","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"binary":{"schema":{"example":"Binary format of aasx file"}}}},"responses":{"200":{"description":"response","content":{"application/text":{"schema":{"type":"string","example":"ok(updated)"}}}}},"x-swagger-router-controller":"ZWave"},"delete":{"tags":["AASX Package"],"operationId":"DeletePackage","description":"Delete an aasx package","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"response","content":{"application/text":{"schema":{"type":"string","example":"ok(deleted)"}}}}},"x-swagger-router-controller":"ZWave"}},"/shells":{"post":{"tags":["AAS"],"operationId":"CreateAAS","description":"Create a new AAS on the Server(without aasx package)","requestBody":{"required":true,"content":{"application/json":{"schema":{"example":"Here needs the JSON format of an AAS. You can learn this format through the {Save as} function in AAS Package Explorer or through the GET API."}}}},"responses":{"200":{"description":"response","content":{"application/text":{"schema":{"type":"string","example":"ok(created)"}}}}},"x-swagger-router-controller":"ZWave"},"get":{"tags":["AAS"],"operationId":"GetAllAAS","description":"Retrive all AASs on the Server","responses":{"200":{"description":"response","content":{"application/json":{"schema":{"example":"A dict of the JSON format of all AASs"}}}}},"x-swagger-router-controller":"ZWave"}},"/shells/{aasIdShort}":{"get":{"tags":["AAS"],"operationId":"GetSingleAAS_1","description":"Retrive an AAS on the Server","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"response","content":{"application/json":{"schema":{"example":"The JSON format of an AAS"}}}}},"x-swagger-router-controller":"ZWave"},"put":{"tags":["AAS"],"operationId":"UpdateAAS_1","description":"Update an existing AAS on the Server","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":"Here needs the JSON format of an AAS. You can learn this format through the {Save as} function in AAS Package Explorer or through the GET API."}}}},"responses":{"200":{"description":"response","content":{"application/text":{"schema":{"type":"string","example":"ok(updated)"}}}}},"x-swagger-router-controller":"ZWave"},"delete":{"tags":["AAS"],"operationId":"DeleteAAS","description":"Delete an AAS on the Server","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"response","content":{"application/text":{"schema":{"type":"string","example":"ok(deleted)"}}}}},"x-swagger-router-controller":"ZWave"}},"/shells/{aasIdShort}/aas":{"get":{"tags":["AAS"],"operationId":"GetSingleAAS_2","description":"Retrive an AAS on the Server","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"response","content":{"application/json":{"schema":{"example":"The JSON format of an AAS"}}}}},"x-swagger-router-controller":"ZWave"},"put":{"tags":["AAS"],"operationId":"UpdateAAS_2","description":"Update an existing AAS on the Server","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":"Here needs the JSON format of an AAS. You can learn this format through the {Save as} function in AAS Package Explorer or through the GET API."}}}},"responses":{"200":{"description":"response","content":{"application/text":{"schema":{"type":"string","example":"ok(updated)"}}}}},"x-swagger-router-controller":"ZWave"}},"/shells/{aasIdShort}/aas/asset-information":{"get":{"tags":["Asset"],"operationId":"GetAsset","description":"Retrive the asset information in an AAS","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"response","content":{"application/json":{"schema":{"example":"The JSON format of an Asset"}}}}},"x-swagger-router-controller":"ZWave"},"put":{"tags":["Asset"],"operationId":"UpdateAsset","description":"Update the asset information in an AAS","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":"Here needs the JSON format of an Asset. You can learn this format through the GET API."}}}},"responses":{"200":{"description":"response","content":{"application/text":{"schema":{"type":"string","example":"ok(updated)"}}}}},"x-swagger-router-controller":"ZWave"}},"/shells/{aasIdShort}/submodels":{"post":{"tags":["Submodel"],"operationId":"CreateSubmodel_1","description":"Create a new submodel","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":"Here needs the JSON format of a submodel. You can learn this format through the {Export- Export Submodel to JSON} function in AAS Package Explorer or through the GET API."}}}},"responses":{"200":{"description":"response","content":{"application/text":{"schema":{"type":"string","example":"ok(new)"}}}}},"x-swagger-router-controller":"ZWave"},"get":{"tags":["Submodel"],"operationId":"GetAllSubmodels_1","description":"Retrive all submodels in an AAS","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"response","content":{"application/json":{"schema":{"example":"A list of the JSON format of all submodels"}}}}},"x-swagger-router-controller":"ZWave"},"put":{"tags":["Submodel"],"operationId":"UpdateSubmodel_1","description":"Update an existing submodel in the AAS","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":"Here needs the JSON format of a submodel. You can learn this format through the {Export- Export Submodel to JSON} function in AAS Package Explorer or through the GET API."}}}},"responses":{"200":{"description":"response","content":{"application/text":{"schema":{"type":"string","example":"ok(updated)"}}}}},"x-swagger-router-controller":"ZWave"}},"/shells/{aasIdShort}/aas/submodels":{"post":{"tags":["Submodel"],"operationId":"CreateSubmodel_2","description":"Create a new submodel","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":"Here needs the JSON format of a submodel. You can learn this format through the {Export- Export Submodel to JSON} function in AAS Package Explorer or through the GET API."}}}},"responses":{"200":{"description":"response","content":{"application/text":{"schema":{"type":"string","example":"ok(new)"}}}}},"x-swagger-router-controller":"ZWave"},"get":{"tags":["Submodel"],"operationId":"GetAllSubmodels_2","description":"Retrive all submodels in an AAS","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"response","content":{"application/json":{"schema":{"example":"A list of the JSON format of all submodels"}}}}},"x-swagger-router-controller":"ZWave"},"put":{"tags":["Submodel"],"operationId":"UpdateSubmodel_2","description":"Update an existing submodel in the AAS","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":"Here needs the JSON format of a submodel. You can learn this format through the {Export- Export Submodel to JSON} function in AAS Package Explorer or through the GET API."}}}},"responses":{"200":{"description":"response","content":{"application/text":{"schema":{"type":"string","example":"ok(updated)"}}}}},"x-swagger-router-controller":"ZWave"}},"/shells/{aasIdShort}/submodels/{submodelIdShort}":{"get":{"tags":["Submodel"],"operationId":"GetSingleSubmodel_1","description":"Retrive a submodel","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"submodelIdShort","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"response","content":{"application/json":{"schema":{"example":"The JSON format of a submodel"}}}}},"x-swagger-router-controller":"ZWave"},"delete":{"tags":["Submodel"],"operationId":"DeleteSingleSubmodel_1","description":"Delete a submodel","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"submodelIdShort","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"response","content":{"application/text":{"schema":{"type":"string","example":"OK(Submodel deleted)"}}}}},"x-swagger-router-controller":"ZWave"}},"/shells/{aasIdShort}/aas/submodels/{submodelIdShort}":{"get":{"tags":["Submodel"],"operationId":"GetSingleSubmodel_2","description":"Retrive a submodel","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"submodelIdShort","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"response","content":{"application/json":{"schema":{"example":"The JSON format of a submodel"}}}}},"x-swagger-router-controller":"ZWave"},"delete":{"tags":["Submodel"],"operationId":"DeleteSingleSubmodel_2","description":"Delete a submodel","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"submodelIdShort","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"response","content":{"application/text":{"schema":{"type":"string","example":"OK(Submodel deleted)"}}}}},"x-swagger-router-controller":"ZWave"}},"/shells/{aasIdShort}/aas/submodels/{submodelIdShort}/submodel":{"get":{"tags":["Submodel"],"operationId":"GetSingleSubmodel_3","description":"Retrive a submodel","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"submodelIdShort","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"response","content":{"application/json":{"schema":{"example":"The JSON format of a submodel"}}}}},"x-swagger-router-controller":"ZWave"},"delete":{"tags":["Submodel"],"operationId":"DeleteSingleSubmodel_3","description":"Delete a submodel","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"submodelIdShort","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"response","content":{"application/text":{"schema":{"type":"string","example":"OK(Submodel deleted)"}}}}},"x-swagger-router-controller":"ZWave"}},"/shells/{aasIdShort}/submodels/{submodelIdShort}/submodel-elments":{"get":{"tags":["Submodel Element"],"operationId":"GetAllSubmodelElements_1","description":"Retrive all submodel elements under a submodel","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"submodelIdShort","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"response","content":{"application/json":{"schema":{"example":"A list of the JSON format of all submodels elements in a submodel"}}}}},"x-swagger-router-controller":"ZWave"}},"/shells/{aasIdShort}/aas/submodels/{submodelIdShort}/submodel/submodel-elments":{"get":{"tags":["Submodel Element"],"operationId":"GetAllSubmodelElements_2","description":"Retrive all submodel elements under a submodel","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"submodelIdShort","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"response","content":{"application/json":{"schema":{"example":"A list of the JSON format of all submodels elements in a submodel"}}}}},"x-swagger-router-controller":"ZWave"}},"/shells/{aasIdShort}/submodels/{submodelIdShort}/submodel-elments/{submodelElementIdPath}":{"post":{"tags":["Submodel Element"],"operationId":"CreateNewSubmodelElement_1","description":"Create a single submodel element under the specified path","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"submodelIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"submodelElementIdPath","in":"path","required":true,"description":"The idPath to the parent submodel element of the new submodel. If you want to add the submodel element directly under the submodel, this value could be null.","schema":{"type":"string","example":"/{SMECIdShort}/{SMECIdShort}"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":"Here needs the JSON format of a submodel element. You can learn this format through the GET API."}}}},"responses":{"200":{"description":"response","content":{"application/text":{"schema":{"example":"OK(created)"}}}}},"x-swagger-router-controller":"ZWave"},"put":{"tags":["Submodel Element"],"operationId":"UpdateSubmodelElement_1","description":"Update an existing submodel element under the specified path","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"submodelIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"submodelElementIdPath","in":"path","required":true,"description":"The idPath to the parent submodel element of the new submodel. If you want to update the submodel element directly under the submodel, this value could be null.","schema":{"type":"string","example":"/{SMECIdShort}/{SMECIdShort}"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":"Here needs the JSON format of a submodel element. You can learn this format through the GET API."}}}},"responses":{"200":{"description":"response","content":{"application/text":{"schema":{"example":"OK(updated)"}}}}},"x-swagger-router-controller":"ZWave"}},"/shells/{aasIdShort}/submodels/{submodelIdShort}/submodel-elments/{submodelElementIdPath}/{submodelElementIdShort}":{"get":{"tags":["Submodel Element"],"operationId":"GetNewSubmodelElement_1","description":"Retrive a submodel element under the specified path","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"submodelIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"submodelElementIdPath","in":"path","required":true,"description":"The idPath to the parent submodel element of the new submodel. If you want to retrive the submodel element directly under the submodel, this value could be null.","schema":{"type":"string","example":"/{SMECIdShort}/{SMECIdShort}"}},{"name":"submodelElementIdShort","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"response","content":{"application/json":{"schema":{"example":"The JSON format of a submodel element"}}}}},"x-swagger-router-controller":"ZWave"},"delete":{"tags":["Submodel Element"],"operationId":"DeleteSubmodelElement_1","description":"Delete a submodel element under the specified path","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"submodelIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"submodelElementIdPath","in":"path","required":true,"description":"The idPath to the parent submodel element of the new submodel. If you want to update the submodel element directly under the submodel, this value could be null.","schema":{"type":"string","example":"/{SMECIdShort}/{SMECIdShort}"}},{"name":"submodelElementIdShort","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"response","content":{"application/text":{"schema":{"example":"OK"}}}}},"x-swagger-router-controller":"ZWave"}},"/shells/{aasIdShort}/aas/submodels/{submodelIdShort}/submodel/submodel-elments/{submodelElementIdPath}":{"post":{"tags":["Submodel Element"],"operationId":"CreateNewSubmodelElement_2","description":"Create a single submodel element under the specified path","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"submodelIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"submodelElementIdPath","in":"path","required":true,"description":"The idPath to the parent submodel element of the new submodel. If you want to add the submodel element directly under the submodel, this value could be null.","schema":{"type":"string","example":"/{SMECIdShort}/{SMECIdShort}"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":"Here needs the JSON format of a submodel element. You can learn this format through the GET API."}}}},"responses":{"200":{"description":"response","content":{"application/text":{"schema":{"example":"OK(created)"}}}}},"x-swagger-router-controller":"ZWave"},"put":{"tags":["Submodel Element"],"operationId":"UpdateSubmodelElement_2","description":"Update an existing submodel element under the specified path","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"submodelIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"submodelElementIdPath","in":"path","required":true,"description":"The idPath to the parent submodel element of the new submodel. If you want to update the submodel element directly under the submodel, this value could be null.","schema":{"type":"string","example":"/{SMECIdShort}/{SMECIdShort}"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":"Here needs the JSON format of a submodel element. You can learn this format through the GET API."}}}},"responses":{"200":{"description":"response","content":{"application/text":{"schema":{"example":"OK(updated)"}}}}},"x-swagger-router-controller":"ZWave"}},"/shells/{aasIdShort}/aas/submodels/{submodelIdShort}/submodel/submodel-elments/{submodelElementIdPath}/{submodelElementIdShort}":{"get":{"tags":["Submodel Element"],"operationId":"GetNewSubmodelElement_2","description":"Retrive a submodel element under the specified path","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"submodelIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"submodelElementIdPath","in":"path","required":true,"description":"The idPath to the parent submodel element of the new submodel. If you want to retrive the submodel element directly under the submodel, this value could be null.","schema":{"type":"string","example":"/{SMECIdShort}/{SMECIdShort}"}},{"name":"submodelElementIdShort","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"response","content":{"application/json":{"schema":{"example":"The JSON format of a submodel element"}}}}},"x-swagger-router-controller":"ZWave"},"delete":{"tags":["Submodel Element"],"operationId":"DeleteSubmodelElement_2","description":"Delete a submodel element under the specified path","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"submodelIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"submodelElementIdPath","in":"path","required":true,"description":"The idPath to the parent submodel element of the new submodel. If you want to update the submodel element directly under the submodel, this value could be null.","schema":{"type":"string","example":"/{SMECIdShort}/{SMECIdShort}"}},{"name":"submodelElementIdShort","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"response","content":{"application/text":{"schema":{"example":"OK"}}}}},"x-swagger-router-controller":"ZWave"}},"/shells/{aasIdShort}/concept-descriptions":{"post":{"tags":["Concept Description"],"operationId":"CreateConceptDescription","description":"Create a new concept description","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":"Here needs the JSON format of a concept description. You can learn this format through the GET API."}}}},"responses":{"200":{"description":"response","content":{"application/text":{"schema":{"type":"string","example":"OK (created)"}}}}},"x-swagger-router-controller":"ZWave"},"get":{"tags":["Concept Description"],"operationId":"GetAllConceptDescription","description":"Retrive all concept descriptions in an AAS","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"response","content":{"application/json":{"schema":{"example":"A list of the JSON format of all concept descriptions"}}}}},"x-swagger-router-controller":"ZWave"},"put":{"tags":["Concept Description"],"operationId":"UpdateConceptDescription","description":"Update an existing concept description in the AAS","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":"Here needs the JSON format of a concept description. You can learn this format through the GET API."}}}},"responses":{"200":{"description":"response","content":{"application/text":{"schema":{"type":"string","example":"ok(updated)"}}}}},"x-swagger-router-controller":"ZWave"}},"/shells/{aasIdShort}/submodels/{conceptDescriptionIdShort}":{"get":{"tags":["Concept Description"],"operationId":"GetSingleConceptDescription","description":"Retrive a concept description","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"conceptDescriptionIdShort","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"response","content":{"application/json":{"schema":{"example":"The JSON format of a concept description"}}}}},"x-swagger-router-controller":"ZWave"},"delete":{"tags":["Concept Description"],"operationId":"DeleteSingleConceptDescription","description":"Delete a concept description","parameters":[{"name":"aasIdShort","in":"path","required":true,"schema":{"type":"string"}},{"name":"conceptDescriptionIdShort","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"response","content":{"application/text":{"schema":{"type":"string","example":"OK"}}}}},"x-swagger-router-controller":"ZWave"}}},"components":{"schemas":{"PackageName":{"type":"object","properties":{"PackageName":{"type":"string","format":"int64","example":"http://localhost:8080/packages/AssembleStation"}}},"PackageDict":{"type":"object","properties":{"PackageDict":{"type":"object","format":"PackageName"}}}}}}