Implemented Details of Asset Administration Shell 2.0.1
Fixed AAS-XML schema validation
Refactored versioning of AAS schemas
Packages updated
diff --git a/sdks/dotnet/basyx-core/BaSyx.API.Http.Controllers/BaSyx.API.Http.Controllers.xml b/sdks/dotnet/basyx-core/BaSyx.API.Http.Controllers/BaSyx.API.Http.Controllers.xml
index 6ee946d..175955e 100644
--- a/sdks/dotnet/basyx-core/BaSyx.API.Http.Controllers/BaSyx.API.Http.Controllers.xml
+++ b/sdks/dotnet/basyx-core/BaSyx.API.Http.Controllers/BaSyx.API.Http.Controllers.xml
@@ -9,7 +9,7 @@
The Asset Administration Shell Repository Controller
</summary>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRepositoryServices.RetrieveAllAssetAdministrationShells">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRepositoryServices.GetAllAssetAdministrationShells">
<summary>
Retrieves all Asset Administration Shells from the repository service endpoint
</summary>
@@ -19,31 +19,20 @@
<response code="400">Bad Request</response>
<response code="502">Bad Gateway</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRepositoryServices.RetrieveAssetAdministrationShellByIdShort(System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRepositoryServices.GetAssetAdministrationShellById(System.String)">
<summary>
- Retrieves a specific Asset Administration Shell from the repository service endpint
+ Retrieves a specific Asset Administration Shell from the repository service endpoint
</summary>
- <param name="aasId">The Asset Administration Shell's short id</param>
+ <param name="aasId">The Asset Administration Shell's unique id</param>
<returns></returns>
<response code="200">Returns the requested Asset Administration Shell</response>
<response code="404">No Asset Administration Shell found</response>
<response code="400">Bad Request</response>
<response code="502">Bad Gateway</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRepositoryServices.UpdateAssetAdministrationShellByIdShort(System.String,BaSyx.Models.Core.AssetAdministrationShell.Generics.IAssetAdministrationShell)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRepositoryServices.PutAssetAdministrationShell(BaSyx.Models.Core.AssetAdministrationShell.Generics.IAssetAdministrationShell)">
<summary>
- Updates a specific Asset Administration Shell at the repository service endpint
- </summary>
- <param name="aasId">The Asset Administration Shell's unique id</param>
- <param name="aas">The updated Asset Administration Shell</param>
- <returns></returns>
- <response code="200">Asset Administration Shell updated successfully</response>
- <response code="400">Bad Request</response>
- <response code="502">Bad Gateway</response>
- </member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRepositoryServices.CreateNewAssetAdministrationShell(BaSyx.Models.Core.AssetAdministrationShell.Generics.IAssetAdministrationShell)">
- <summary>
- Creates a new Asset Administration Shell at the repository service endpoint
+ Creates or updates a Asset Administration Shell at the repository service endpoint
</summary>
<param name="aas">The serialized Asset Administration Shell object</param>
<returns></returns>
@@ -51,7 +40,7 @@
<response code="400">Bad Request</response>
<response code="502">Bad Gateway</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRepositoryServices.DeleteAssetAdministrationShellByIdShort(System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRepositoryServices.DeleteAssetAdministrationShellById(System.String)">
<summary>
Deletes a specific Asset Administration Shell at the repository service endpoint
</summary>
@@ -66,7 +55,7 @@
All Asset Administration Shell Services provided by the component
</summary>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.GetAAS">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.GetAssetAdministrationShell">
<summary>
Retrieves the Asset Administration Shell
</summary>
@@ -74,29 +63,29 @@
<response code="200">Success</response>
<response code="502">Bad Gateway - Asset Administration Shell not available</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.PostSubmodel(BaSyx.Models.Core.AssetAdministrationShell.Generics.ISubmodel)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.PutSubmodel(BaSyx.Models.Core.AssetAdministrationShell.Generics.ISubmodel)">
<summary>
- Adds a new Submodel to an existing Asset Administration Shell
+ Creates or updates a Submodel to an existing Asset Administration Shell
</summary>
- <param name="submodel">The Submodel's description object</param>
+ <param name="submodel">The serialized Submodel object</param>
<returns></returns>
<response code="201">Submodel created successfully</response>
<response code="400">Bad Request</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.GetSubmodelById(System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.GetSubmodelByIdShort(System.String)">
<summary>
Retrieves the Submodel from the Asset Administration Shell
</summary>
- <param name="submodelId">The Submodel's unique id</param>
+ <param name="submodelIdShort">The Submodel's short id</param>
<returns></returns>
<response code="200">Submodel retrieved successfully</response>
<response code="404">No Submodel Service Provider found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.DeleteSubmodelById(System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.DeleteSubmodelByIdShort(System.String)">
<summary>
Deletes a specific Submodel from the Asset Administration Shell
</summary>
- <param name="submodelId">The Submodel's idShort</param>
+ <param name="submodelIdShort">The Submodel's short id</param>
<returns></returns>
<response code="204">Submodel deleted successfully</response>
<response code="400">Bad Request</response>
@@ -109,9 +98,17 @@
<response code="200">Returns a list of found Submodels</response>
<response code="404">No Submodel Service Providers found</response>
</member>
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetSubmodelElements">
+ <summary>
+ Retrieves all Submodel-Elements from the Submodel
+ </summary>
+ <returns></returns>
+ <response code="200">Returns a list of found Submodel-Elements</response>
+ <response code="404">Submodel not found / No Submodel-Elements found</response>
+ </member>
<member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetProperties">
<summary>
- Retrieves all Properties from the current Submodel
+ Retrieves all Properties from the Submodel
</summary>
<returns></returns>
<response code="200">Returns a list of found Properties</response>
@@ -119,7 +116,7 @@
</member>
<member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetOperations">
<summary>
- Retrieves all Operations from the current Submodel
+ Retrieves all Operations from the Submodel
</summary>
<returns></returns>
<response code="200">Success</response>
@@ -127,99 +124,127 @@
</member>
<member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetEvents">
<summary>
- Retrieves all Events from the current Submodel
+ Retrieves all Events from the Submodel
</summary>
<returns></returns>
<response code="200">Success</response>
<response code="404">Submodel not found / No Events found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedPostDataElement(BaSyx.Models.Core.AssetAdministrationShell.Generics.SubmodelElementTypes.IProperty)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedPutSubmodelElement(BaSyx.Models.Core.AssetAdministrationShell.Generics.ISubmodelElement)">
<summary>
- Adds a new Property to the Asset Administration Shell's Submodel
+ Creates or updates a Submodel-Element to the Asset Administration Shell's Submodel
</summary>
- <param name="property">The Property's description object</param>
+ <param name="submodelElement">The serialized Submodel Element object</param>
<returns></returns>
- <response code="201">DataElement created successfully</response>
+ <response code="201">Submodel-Element created successfully</response>
<response code="400">Bad Request</response>
<response code="404">Submodel not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetDataElement(System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetSubmodelElementByIdShort(System.String)">
<summary>
- Retrieves a specific Property from the Asset Administrations's Submodel
+ Retrieves a specific Submodel-Element from the Asset Administrations's Submodel
</summary>
- <param name="propertyId">The Property's short id</param>
+ <param name="submodelElementIdShort">The Submodel-Element's short id</param>
<returns></returns>
<response code="200">Returns the requested Property</response>
<response code="404">Submodel/Property not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetPropertyValue(System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedDeleteSubmodelElementByIdShort(System.String)">
+ <summary>
+ Deletes a specific Submodel-Element from the Asset Administration Shell's Submodel
+ </summary>
+ <param name="submodelElementIdShort">The Submodel-Element's short id</param>
+ <returns></returns>
+ <response code="204">Property deleted successfully</response>
+ <response code="404">Submodel not found</response>
+ </member>
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedPutProperty(BaSyx.Models.Core.AssetAdministrationShell.Generics.SubmodelElementTypes.IProperty)">
+ <summary>
+ Creates or updated a Property to the Asset Administration Shell's Submodel
+ </summary>
+ <param name="property">The Property's description object</param>
+ <returns></returns>
+ <response code="201">Property created successfully</response>
+ <response code="400">Bad Request</response>
+ <response code="404">Submodel not found</response>
+ </member>
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetPropertyByIdShort(System.String)">
+ <summary>
+ Retrieves a specific Property from the Asset Administrations's Submodel
+ </summary>
+ <param name="propertyIdShort">The Property's short id</param>
+ <returns></returns>
+ <response code="200">Returns the requested Property</response>
+ <response code="404">Submodel/Property not found</response>
+ </member>
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetPropertyValueByIdShort(System.String)">
<summary>
Retrieves the value of a specific Property from the Asset Administrations Shell's Submodel
</summary>
- <param name="propertyId">The Property's short id</param>
+ <param name="propertyIdShort">The Property's short id</param>
<returns></returns>
<response code="200">Returns the requested Property's value</response>
<response code="404">Submodel/Property not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedPutPropertyValue(System.String,BaSyx.Models.Core.Common.IValue)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedPutPropertyValueByIdShort(System.String,BaSyx.Models.Core.Common.IValue)">
<summary>
Updates the Asset Administration Shell's Submodel's Property
</summary>
- <param name="propertyId">The Property's short id</param>
+ <param name="propertyIdShort">The Property's short id</param>
<param name="value">The new value</param>
<returns></returns>
<response code="200">Property's value changed successfully</response>
<response code="404">Submodel/Property not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedDelProperty(System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedDeletePropertyByIdShort(System.String)">
<summary>
Deletes a specific Property from the Asset Administration Shell's Submodel
</summary>
- <param name="propertyId">The Property's short id</param>
+ <param name="propertyIdShort">The Property's short id</param>
<returns></returns>
<response code="204">Property deleted successfully</response>
<response code="404">Submodel not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedPostOperation(BaSyx.Models.Core.AssetAdministrationShell.Generics.SubmodelElementTypes.IOperation)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedPutOperation(BaSyx.Models.Core.AssetAdministrationShell.Generics.SubmodelElementTypes.IOperation)">
<summary>
- Adds a new operation to the Asset Administraiton Shell's Submodel
+ Adds a new operation to the Asset Administration Shell's Submodel
</summary>
- <param name="operation">The operation description object</param>
+ <param name="operation">The serialized Operation object</param>
<returns></returns>
<response code="201">Operation created successfully</response>
<response code="400">Bad Request</response>
<response code="404">Submodel not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetOperation(System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetOperationByIdShort(System.String)">
<summary>
Retrieves a specific Operation from the Asset Administration Shell's Submodel
</summary>
- <param name="operationId">The Operation's short id</param>
+ <param name="operationIdShort">The Operation's short id</param>
<returns></returns>
<response code="200">Success</response>
<response code="404">Submodel/Operation not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedDelOperation(System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedDeleteOperationByIdShort(System.String)">
<summary>
Deletes a specific Operation from the Asset Administration Shell's Submodel
</summary>
- <param name="operationId">The Operation's short id</param>
+ <param name="operationIdShort">The Operation's short id</param>
<returns></returns>
<response code="204">Operation deleted successfully</response>
<response code="404">Submodel not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedInvokeOperationRest(System.String,BaSyx.Models.Communication.InvocationRequest)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedInvokeOperationByIdShort(System.String,BaSyx.Models.Communication.InvocationRequest)">
<summary>
Synchronously invokes a specific operation from the Submodel
</summary>
- <param name="operationId">The operation's short id</param>
+ <param name="operationIdShort">The Operation's short id</param>
<param name="invocationRequest">The parameterized request object for the invocation</param>
<returns></returns>
<response code="200">Operation invoked successfully</response>
<response code="400">Bad Request</response>
<response code="404">Submodel / Method handler not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedPostEvent(BaSyx.Models.Core.AssetAdministrationShell.Generics.SubmodelElementTypes.IEvent)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedPutEvent(BaSyx.Models.Core.AssetAdministrationShell.Generics.SubmodelElementTypes.IEvent)">
<summary>
Adds a new event to the Asset Administration Shell's Submodel
</summary>
@@ -229,20 +254,20 @@
<response code="400">Bad Request</response>
<response code="404">Submodel not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetEvent(System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetEventByIdShort(System.String)">
<summary>
Retrieves a specific event from the Asset Administration Shell's Submodel
</summary>
- <param name="eventId">The Event's short id</param>
+ <param name="eventIdShort">The Event's short id</param>
<returns></returns>
<response code="200">Success</response>
<response code="404">Submodel/Event not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedDelEvent(System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedDeleteEventByIdShort(System.String)">
<summary>
Deletes a specific event from the Asset Administration Shell's Submodel
</summary>
- <param name="eventId">The Event's short id</param>
+ <param name="eventIdShort">The Event's short id</param>
<returns></returns>
<response code="204">Event deleted successfully</response>
<response code="404">Submodel not found</response>
@@ -252,7 +277,7 @@
The Submodel Repository Controller
</summary>
</member>
- <member name="M:BaSyx.API.Http.Controllers.SubmodelRepositoryServices.RetrieveAllSubmodels">
+ <member name="M:BaSyx.API.Http.Controllers.SubmodelRepositoryServices.GetAllSubmodels">
<summary>
Retrieves all Submodels from the repository service endpoint
</summary>
@@ -262,39 +287,28 @@
<response code="400">Bad Request</response>
<response code="502">Bad Gateway</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.SubmodelRepositoryServices.RetrieveSubmodelByIdShort(System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.SubmodelRepositoryServices.RetrieveSubmodelById(System.String)">
<summary>
- Retrieves a specific Submodel from the repository service endpint
+ Retrieves a specific Submodel from the repository service endpoint
</summary>
- <param name="submodelId">The Submodel's short id</param>
+ <param name="submodelId">The Submodel's unique id</param>
<returns></returns>
<response code="200">Returns the requested Submodel</response>
<response code="404">No Submodel found</response>
<response code="400">Bad Request</response>
<response code="502">Bad Gateway</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.SubmodelRepositoryServices.UpdateSubmodelByIdShort(System.String,BaSyx.Models.Core.AssetAdministrationShell.Generics.ISubmodel)">
+ <member name="M:BaSyx.API.Http.Controllers.SubmodelRepositoryServices.PutSubmodel(BaSyx.Models.Core.AssetAdministrationShell.Generics.ISubmodel)">
<summary>
- Updates a specific Submodel at the repository service endpint
- </summary>
- <param name="submodelId">The Submodel's unique id</param>
- <param name="submodel">The updated Submodel</param>
- <returns></returns>
- <response code="200">Submodel updated successfully</response>
- <response code="400">Bad Request</response>
- <response code="502">Bad Gateway</response>
- </member>
- <member name="M:BaSyx.API.Http.Controllers.SubmodelRepositoryServices.CreateNewSubmodel(BaSyx.Models.Core.AssetAdministrationShell.Generics.ISubmodel)">
- <summary>
- Creates a new Submodel at the repository service endpoint
+ Creates or updates a Submodel at the repository service endpoint
</summary>
<param name="submodel">The serialized Submodel object</param>
<returns></returns>
- <response code="201">Submodel created successfully</response>
+ <response code="201">Submodel created/updated successfully</response>
<response code="400">Bad Request</response>
<response code="502">Bad Gateway</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.SubmodelRepositoryServices.DeleteSubmodelByIdShort(System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.SubmodelRepositoryServices.DeleteSubmodelById(System.String)">
<summary>
Deletes a specific Submodel at the repository service endpoint
</summary>
@@ -313,13 +327,14 @@
<summary>
Retrieves a customizable table version of a Submodel
</summary>
+ <param name="columns">A comma-separated list of field names to structure the payload beeing returned</param>
<returns></returns>
<response code="200">Success</response>
- <response code="404">Submodel not found</response>
+ <response code="404">Submodel not found</response>
</member>
<member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetMinimizedSubmodel">
<summary>
- Retrieves the minimized version of a Submodel
+ Retrieves the minimized version of a Submodel, i.e. only the values of SubmodelElements are serialized and returned
</summary>
<returns></returns>
<response code="200">Success</response>
@@ -327,7 +342,7 @@
</member>
<member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetSubmodel">
<summary>
- Retrieves the Submodel
+ Retrieves the entire Submodel
</summary>
<returns></returns>
<response code="200">Success</response>
@@ -365,11 +380,11 @@
<response code="200">Success</response>
<response code="404">Submodel not found / No Events found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.PostSubmodelElement(BaSyx.Models.Core.AssetAdministrationShell.Generics.ISubmodelElement)">
+ <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.PutSubmodelElement(BaSyx.Models.Core.AssetAdministrationShell.Generics.ISubmodelElement)">
<summary>
Adds a new Submodel Element to the Submodel
</summary>
- <param name="submodelElement">The Submodel Element's description object</param>
+ <param name="submodelElement">The serialized Submodel Element object</param>
<returns></returns>
<response code="201">Submodel Element created successfully</response>
<response code="400">Bad Request</response>
@@ -379,7 +394,7 @@
<summary>
Retrieves a specific Submodel Element from the Submodel
</summary>
- <param name="submodelElementId">The Submodel Element's short id</param>
+ <param name="submodelElementIdShort">The Submodel Element's short id</param>
<returns></returns>
<response code="200">Returns the requested Submodel Element</response>
<response code="404">Submodel/Submodel Element not found</response>
@@ -388,157 +403,157 @@
<summary>
Deletes a specific Submodel Element from the Submodel
</summary>
- <param name="submodelElementId">The Submodel Element's short id</param>
+ <param name="submodelElementIdShort">The Submodel Element's short id</param>
<returns></returns>
<response code="204">Submodel Element deleted successfully</response>
<response code="404">Submodel/Submodel Element not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.PostProperty(BaSyx.Models.Core.AssetAdministrationShell.Generics.SubmodelElementTypes.IProperty)">
+ <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.PutProperty(BaSyx.Models.Core.AssetAdministrationShell.Generics.SubmodelElementTypes.IProperty)">
<summary>
Adds a new Property to the Asset Administration Shell's Submodel
</summary>
- <param name="property">The Property's description object</param>
+ <param name="property">The serialized Property object</param>
<returns></returns>
<response code="201">Property created successfully</response>
<response code="400">Bad Request</response>
<response code="404">Submodel not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetProperty(System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetPropertyByIdShort(System.String)">
<summary>
Retrieves a specific Property from the Asset Administrations's Submodel
</summary>
- <param name="propertyId">The Property's short id</param>
+ <param name="propertyIdShort">The Property's short id</param>
<returns></returns>
<response code="200">Returns the requested Property</response>
<response code="404">Submodel/Property not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetPropertyValue(System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetPropertyValueByIdShort(System.String)">
<summary>
Retrieves the value of a specific Property from the Asset Administrations Shell's Submodel
</summary>
- <param name="propertyId">The Property's short id</param>
+ <param name="propertyIdShort">The Property's short id</param>
<returns></returns>
<response code="200">Returns the requested Property's value</response>
<response code="404">Submodel/Property not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.PutPropertyValue(System.String,BaSyx.Models.Core.Common.IValue)">
+ <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.PutPropertyValueByIdShort(System.String,BaSyx.Models.Core.Common.IValue)">
<summary>
Updates the Asset Administration Shell's Submodel's Property
</summary>
- <param name="propertyId">The Property's short id</param>
+ <param name="propertyIdShort">The Property's short id</param>
<param name="value">The new value</param>
<returns></returns>
<response code="200">Property's value changed successfully</response>
<response code="404">Submodel/Property not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.DelProperty(System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.DeletePropertyByIdShort(System.String)">
<summary>
Deletes a specific Property from the Asset Administration Shell's Submodel
</summary>
- <param name="propertyId">The Property's short id</param>
+ <param name="propertyIdShort">The Property's short id</param>
<returns></returns>
<response code="204">Property deleted successfully</response>
<response code="404">Submodel not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.PostOperation(BaSyx.Models.Core.AssetAdministrationShell.Generics.SubmodelElementTypes.IOperation)">
+ <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.PutOperation(BaSyx.Models.Core.AssetAdministrationShell.Generics.SubmodelElementTypes.IOperation)">
<summary>
Adds a new operation to the Asset Administraiton Shell's Submodel
</summary>
- <param name="operation">The operation description object</param>
+ <param name="operation">The serialized Operation object</param>
<returns></returns>
<response code="201">Operation created successfully</response>
<response code="400">Bad Request</response>
<response code="404">Submodel not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetOperation(System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetOperationByIdShort(System.String)">
<summary>
Retrieves a specific Operation from the Asset Administration Shell's Submodel
</summary>
- <param name="operationId">The Operation's short id</param>
+ <param name="operationIdShort">The Operation's short id</param>
<returns></returns>
<response code="200">Success</response>
<response code="404">Submodel/Operation not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.DelOperation(System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.DeleteOperationByIdShort(System.String)">
<summary>
Deletes a specific Operation from the Asset Administration Shell's Submodel
</summary>
- <param name="operationId">The Operation's short id</param>
+ <param name="operationIdShort">The Operation's short id</param>
<returns></returns>
<response code="204">Operation deleted successfully</response>
<response code="404">Submodel not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.InvokeOperationRest(System.String,BaSyx.Models.Communication.InvocationRequest)">
+ <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.InvokeOperationByIdShort(System.String,BaSyx.Models.Communication.InvocationRequest)">
<summary>
Synchronously invokes a specific operation from the Submodel
</summary>
- <param name="operationId">The operation's short id</param>
+ <param name="operationIdShort">The Operation's short id</param>
<param name="invocationRequest">The parameterized request object for the invocation</param>
<returns></returns>
<response code="200">Operation invoked successfully</response>
<response code="400">Bad Request</response>
<response code="404">Submodel / Method handler not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.InvokeOperationRestAsync(System.String,BaSyx.Models.Communication.InvocationRequest)">
+ <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.InvokeOperationByIdShortAsync(System.String,BaSyx.Models.Communication.InvocationRequest)">
<summary>
Asynchronously invokes a specific operation from the Submodel
</summary>
- <param name="operationId">The operation's short id</param>
+ <param name="operationIdShort">The Operation's short id</param>
<param name="invocationRequest">The parameterized request object for the invocation</param>
<returns></returns>
<response code="200">Operation invoked successfully</response>
<response code="400">Bad Request</response>
<response code="404">Submodel / Method handler not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetInvocationResultRest(System.String,System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetInvocationResultByIdShort(System.String,System.String)">
<summary>
Retrieves the result of an asynchronously started operation
</summary>
- <param name="operationId">The operation's short id</param>
+ <param name="operationIdShort">The Operation's short id</param>
<param name="requestId">The request id</param>
<returns></returns>
<response code="200">Result found</response>
<response code="400">Bad Request</response>
<response code="404">Submodel / Operation / Request not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.PostEvent(BaSyx.Models.Core.AssetAdministrationShell.Generics.SubmodelElementTypes.IEvent)">
+ <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.PutEvent(BaSyx.Models.Core.AssetAdministrationShell.Generics.SubmodelElementTypes.IEvent)">
<summary>
Adds a new event to the Asset Administration Shell's Submodel
</summary>
- <param name="eventable">The Event description object</param>
+ <param name="eventable">The serialized Event object</param>
<returns></returns>
<response code="201">Event created successfully</response>
<response code="400">Bad Request</response>
<response code="404">Submodel not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetEvent(System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetEventByIdShort(System.String)">
<summary>
Retrieves a specific event from the Asset Administration Shell's Submodel
</summary>
- <param name="eventId">The Event's short id</param>
+ <param name="eventIdShort">The Event's short id</param>
<returns></returns>
<response code="200">Success</response>
<response code="404">Submodel/Event not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.DelEvent(System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.DeleteEventByIdShort(System.String)">
<summary>
Deletes a specific event from the Asset Administration Shell's Submodel
</summary>
- <param name="eventId">The Event's short id</param>
+ <param name="eventIdShort">The Event's short id</param>
<returns></returns>
<response code="204">Event deleted successfully</response>
<response code="404">Submodel not found</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.GetAssetAdministrationShells">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.GetAssetAdministrationShellDescriptors">
<summary>
Retrieves all registered Asset Administration Shells within a defined system (e.g. site, area, production line, station)
</summary>
<returns></returns>
- <response code="200">Returns a list of found Asset Administration Shells</response>
+ <response code="200">Returns a list of found Asset Administration Shell Descriptors</response>
<response code="400">Bad Request</response>
<response code="502">Bad Gateway</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.GetAssetAdministrationShell(System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.GetAssetAdministrationShellDescriptor(System.String)">
<summary>
Retrieves a specific Asset Administration Shell
</summary>
@@ -549,7 +564,7 @@
<response code="404">No Asset Administration Shell with passed id found</response>
<response code="502">Bad Gateway</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.PutAssetAdministrationShell(System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.RenewAssetAdministrationShellRegistration(System.String)">
<summary>
Renews a specific Asset Administration Shell's registration
</summary>
@@ -560,18 +575,18 @@
<response code="404">No Asset Administration Shell with passed id found</response>
<response code="502">Bad Gateway</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.PostAssetAdministrationShell(BaSyx.Models.Connectivity.Descriptors.IAssetAdministrationShellDescriptor)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.RegisterAssetAdministrationShell(BaSyx.Models.Connectivity.Descriptors.IAssetAdministrationShellDescriptor)">
<summary>
- Registers a new Asset Administration Shell
+ Registers a new Asset Administration Shell at the registry
</summary>
- <param name="aas">The Asset Administration Shell descriptor object</param>
+ <param name="aasDescriptor">The Asset Administration Shell descriptor object</param>
<returns></returns>
<response code="201">The Asset Administration Shell was created successfully</response>
<response code="400">The syntax of the passed Asset Administration Shell is not valid or malformed request</response>
<response code="422">The passed Asset Administration Shell conflicts with already registered Asset Administration Shells</response>
<response code="502">Bad Gateway</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.DeleteAssetAdministrationShell_(System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.DeleteAssetAdministrationShellRegistration(System.String)">
<summary>
Deletes a specific Asset Administration Shell
</summary>
@@ -582,12 +597,12 @@
<response code="404">No Asset Administration Shell with passed id found</response>
<response code="502">Bad Gateway</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.PostSubmodelToRegistry(System.String,BaSyx.Models.Connectivity.Descriptors.ISubmodelDescriptor)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.RegisterSubmodelAtAssetAdministrationShell(System.String,BaSyx.Models.Connectivity.Descriptors.ISubmodelDescriptor)">
<summary>
Adds a new Submodel to an existing resp. registered Asset Administration Shell
</summary>
<param name="aasId">The Asset Administration Shell's unique id</param>
- <param name="submodel">The Submodel descriptor object</param>
+ <param name="submodelDescriptor">The Submodel descriptor object</param>
<returns></returns>
<response code="201">The Submodel was created successfully</response>
<response code="400">The syntax of the passed Submodel is not valid or malformed request</response>
@@ -595,19 +610,19 @@
<response code="422">The passed Submodel conflicts with already registered Submodels</response>
<response code="502">Bad Gateway</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.GetSubmodelFromRegistry(System.String,System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.GetSubmodelDescriptorFromAssetAdministrationShell(System.String,System.String)">
<summary>
Retrieves a specific Submodel from a specific Asset Administration Shell
</summary>
<param name="aasId">The Asset Administration Shell's unique id</param>
- <param name="submodelIdShort">The Submodel's short id (idShort)</param>
+ <param name="submodelIdShort">The Submodel's short id</param>
<returns></returns>
<response code="200">Returns the requested Submodels</response>
<response code="400">Bad Request</response>
<response code="404">No Asset Administration Shell / Submodel with passed id found</response>
<response code="502">Bad Gateway</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.DeleteSubmodelFromRegistry(System.String,System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.DeleteSubmodelFromAssetAdministrationShell(System.String,System.String)">
<summary>
Deletes a specific Submodel from a specific Asset Administration Shell
</summary>
@@ -619,7 +634,7 @@
<response code="404">No Asset Administration Shell / Submodel with passed id found</response>
<response code="502">Bad Gateway</response>
</member>
- <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.GetSubmodelsFromRegistry(System.String)">
+ <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.GetAllSubmodelDescriptorsFromAssetAdministrationShell(System.String)">
<summary>
Retrieves all Submodels from a specific Asset Administration Shell
</summary>