| <?xml version="1.0"?> |
| <doc> |
| <assembly> |
| <name>BaSyx.API.Http.Controllers</name> |
| </assembly> |
| <members> |
| <member name="T:BaSyx.API.Http.Controllers.AssetAdministrationShellRepositoryServices"> |
| <summary> |
| The Asset Administration Shell Repository Controller |
| </summary> |
| </member> |
| <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRepositoryServices.RetrieveAllAssetAdministrationShells"> |
| <summary> |
| Retrieves all Asset Administration Shells from the repository service endpoint |
| </summary> |
| <returns></returns> |
| <response code="200">Returns a list of found Asset Administration Shells</response> |
| <response code="404">No Asset Administration Shells found</response> |
| <response code="400">Bad Request</response> |
| <response code="502">Bad Gateway</response> |
| </member> |
| <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRepositoryServices.RetrieveAssetAdministrationShellByIdShort(System.String)"> |
| <summary> |
| Retrieves a specific Asset Administration Shell from the repository service endpint |
| </summary> |
| <param name="aasId">The Asset Administration Shell's short 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)"> |
| <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 |
| </summary> |
| <param name="aas">The serialized Asset Administration Shell object</param> |
| <returns></returns> |
| <response code="201">Asset Administration Shell created successfully</response> |
| <response code="400">Bad Request</response> |
| <response code="502">Bad Gateway</response> |
| </member> |
| <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRepositoryServices.DeleteAssetAdministrationShellByIdShort(System.String)"> |
| <summary> |
| Deletes a specific Asset Administration Shell at the repository service endpoint |
| </summary> |
| <param name="aasId">The Asset Administration Shell's unique id</param> |
| <returns></returns> |
| <response code="200">Asset Administration Shell deleted successfully</response> |
| <response code="400">Bad Request</response> |
| <response code="502">Bad Gateway</response> |
| </member> |
| <member name="T:BaSyx.API.Http.Controllers.AssetAdministrationShellServices"> |
| <summary> |
| All Asset Administration Shell Services provided by the component |
| </summary> |
| </member> |
| <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.GetAAS"> |
| <summary> |
| Retrieves the Asset Administration Shell |
| </summary> |
| <returns></returns> |
| <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)"> |
| <summary> |
| Adds a new Submodel to an existing Asset Administration Shell |
| </summary> |
| <param name="submodel">The Submodel's description 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)"> |
| <summary> |
| Retrieves the Submodel from the Asset Administration Shell |
| </summary> |
| <param name="submodelId">The Submodel's unique 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)"> |
| <summary> |
| Deletes a specific Submodel from the Asset Administration Shell |
| </summary> |
| <param name="submodelId">The Submodel's idShort</param> |
| <returns></returns> |
| <response code="204">Submodel deleted successfully</response> |
| <response code="400">Bad Request</response> |
| </member> |
| <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.GetSubmodels"> |
| <summary> |
| Retrieves all Submodels from the Asset Administration Shell |
| </summary> |
| <returns></returns> |
| <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.RoutedGetProperties"> |
| <summary> |
| Retrieves all Properties from the current Submodel |
| </summary> |
| <returns></returns> |
| <response code="200">Returns a list of found Properties</response> |
| <response code="404">Submodel not found / No Properties found</response> |
| </member> |
| <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetOperations"> |
| <summary> |
| Retrieves all Operations from the current Submodel |
| </summary> |
| <returns></returns> |
| <response code="200">Success</response> |
| <response code="404">Submodel not found / No Operations found</response> |
| </member> |
| <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetEvents"> |
| <summary> |
| Retrieves all Events from the current 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)"> |
| <summary> |
| Adds a new Property to the Asset Administration Shell's Submodel |
| </summary> |
| <param name="property">The Property's description object</param> |
| <returns></returns> |
| <response code="201">DataElement 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)"> |
| <summary> |
| Retrieves a specific Property from the Asset Administrations's Submodel |
| </summary> |
| <param name="propertyId">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.RoutedGetPropertyValue(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> |
| <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)"> |
| <summary> |
| Updates the Asset Administration Shell's Submodel's Property |
| </summary> |
| <param name="propertyId">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)"> |
| <summary> |
| Deletes a specific Property from the Asset Administration Shell's Submodel |
| </summary> |
| <param name="propertyId">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)"> |
| <summary> |
| Adds a new operation to the Asset Administraiton Shell's Submodel |
| </summary> |
| <param name="operation">The operation description 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)"> |
| <summary> |
| Retrieves a specific Operation from the Asset Administration Shell's Submodel |
| </summary> |
| <param name="operationId">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)"> |
| <summary> |
| Deletes a specific Operation from the Asset Administration Shell's Submodel |
| </summary> |
| <param name="operationId">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)"> |
| <summary> |
| Synchronously invokes a specific operation from the Submodel |
| </summary> |
| <param name="operationId">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)"> |
| <summary> |
| Adds a new event to the Asset Administration Shell's Submodel |
| </summary> |
| <param name="eventable">The Event description 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.AssetAdministrationShellServices.RoutedGetEvent(System.String)"> |
| <summary> |
| Retrieves a specific event from the Asset Administration Shell's Submodel |
| </summary> |
| <param name="eventId">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)"> |
| <summary> |
| Deletes a specific event from the Asset Administration Shell's Submodel |
| </summary> |
| <param name="eventId">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="T:BaSyx.API.Http.Controllers.SubmodelRepositoryServices"> |
| <summary> |
| The Submodel Repository Controller |
| </summary> |
| </member> |
| <member name="M:BaSyx.API.Http.Controllers.SubmodelRepositoryServices.RetrieveAllSubmodels"> |
| <summary> |
| Retrieves all Submodels from the repository service endpoint |
| </summary> |
| <returns></returns> |
| <response code="200">Returns a list of found Submodels</response> |
| <response code="404">No Submodels found</response> |
| <response code="400">Bad Request</response> |
| <response code="502">Bad Gateway</response> |
| </member> |
| <member name="M:BaSyx.API.Http.Controllers.SubmodelRepositoryServices.RetrieveSubmodelByIdShort(System.String)"> |
| <summary> |
| Retrieves a specific Submodel from the repository service endpint |
| </summary> |
| <param name="submodelId">The Submodel's short 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)"> |
| <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 |
| </summary> |
| <param name="submodel">The serialized Submodel object</param> |
| <returns></returns> |
| <response code="201">Submodel created 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)"> |
| <summary> |
| Deletes a specific Submodel at the repository service endpoint |
| </summary> |
| <param name="submodelId">The Submodel's unique id</param> |
| <returns></returns> |
| <response code="200">Submodel deleted successfully</response> |
| <response code="400">Bad Request</response> |
| <response code="502">Bad Gateway</response> |
| </member> |
| <member name="T:BaSyx.API.Http.Controllers.SubmodelServices"> |
| <summary> |
| All Asset Administration Shell Services provided by the component |
| </summary> |
| </member> |
| <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetSubmodelAsTable(System.String)"> |
| <summary> |
| Retrieves a customizable table version of a Submodel |
| </summary> |
| <returns></returns> |
| <response code="200">Success</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 |
| </summary> |
| <returns></returns> |
| <response code="200">Success</response> |
| <response code="404">Submodel not found</response> |
| </member> |
| <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetSubmodel"> |
| <summary> |
| Retrieves the Submodel |
| </summary> |
| <returns></returns> |
| <response code="200">Success</response> |
| <response code="404">Submodel not found</response> |
| </member> |
| <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetSubmodelElements"> |
| <summary> |
| Retrieves all SubmodelElements from the current Submodel |
| </summary> |
| <returns></returns> |
| <response code="200">Returns a list of found SubmodelElements</response> |
| <response code="404">Submodel not found / No SubmodelElements found</response> |
| </member> |
| <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetProperties"> |
| <summary> |
| Retrieves all Properties from the current Submodel |
| </summary> |
| <returns></returns> |
| <response code="200">Returns a list of found Properties</response> |
| <response code="404">Submodel not found / No Properties found</response> |
| </member> |
| <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetOperations"> |
| <summary> |
| Retrieves all Operations from the current Submodel |
| </summary> |
| <returns></returns> |
| <response code="200">Success</response> |
| <response code="404">Submodel not found / No Operations found</response> |
| </member> |
| <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetEvents"> |
| <summary> |
| Retrieves all Events from the current 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.SubmodelServices.PostSubmodelElement(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> |
| <returns></returns> |
| <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.SubmodelServices.GetSubmodelElementByIdShort(System.String)"> |
| <summary> |
| Retrieves a specific Submodel Element from the Submodel |
| </summary> |
| <param name="submodelElementId">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> |
| </member> |
| <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.DeleteSubmodelElementByIdShort(System.String)"> |
| <summary> |
| Deletes a specific Submodel Element from the Submodel |
| </summary> |
| <param name="submodelElementId">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)"> |
| <summary> |
| Adds a new 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.SubmodelServices.GetProperty(System.String)"> |
| <summary> |
| Retrieves a specific Property from the Asset Administrations's Submodel |
| </summary> |
| <param name="propertyId">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)"> |
| <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> |
| <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)"> |
| <summary> |
| Updates the Asset Administration Shell's Submodel's Property |
| </summary> |
| <param name="propertyId">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)"> |
| <summary> |
| Deletes a specific Property from the Asset Administration Shell's Submodel |
| </summary> |
| <param name="propertyId">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)"> |
| <summary> |
| Adds a new operation to the Asset Administraiton Shell's Submodel |
| </summary> |
| <param name="operation">The operation description 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)"> |
| <summary> |
| Retrieves a specific Operation from the Asset Administration Shell's Submodel |
| </summary> |
| <param name="operationId">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)"> |
| <summary> |
| Deletes a specific Operation from the Asset Administration Shell's Submodel |
| </summary> |
| <param name="operationId">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)"> |
| <summary> |
| Synchronously invokes a specific operation from the Submodel |
| </summary> |
| <param name="operationId">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)"> |
| <summary> |
| Asynchronously invokes a specific operation from the Submodel |
| </summary> |
| <param name="operationId">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)"> |
| <summary> |
| Retrieves the result of an asynchronously started operation |
| </summary> |
| <param name="operationId">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)"> |
| <summary> |
| Adds a new event to the Asset Administration Shell's Submodel |
| </summary> |
| <param name="eventable">The Event description 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)"> |
| <summary> |
| Retrieves a specific event from the Asset Administration Shell's Submodel |
| </summary> |
| <param name="eventId">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)"> |
| <summary> |
| Deletes a specific event from the Asset Administration Shell's Submodel |
| </summary> |
| <param name="eventId">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"> |
| <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="400">Bad Request</response> |
| <response code="502">Bad Gateway</response> |
| </member> |
| <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.GetAssetAdministrationShell(System.String)"> |
| <summary> |
| Retrieves a specific Asset Administration Shell |
| </summary> |
| <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="400">Bad Request</response> |
| <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)"> |
| <summary> |
| Renews a specific Asset Administration Shell's registration |
| </summary> |
| <param name="aasId">The Asset Administration Shell's unique id</param> |
| <returns></returns> |
| <response code="200">The Asset Administration Shell's registration was successfully renewed</response> |
| <response code="400">The syntax of the passed Asset Administration Shell is not valid or malformed request</response> |
| <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)"> |
| <summary> |
| Registers a new Asset Administration Shell |
| </summary> |
| <param name="aas">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)"> |
| <summary> |
| Deletes a specific Asset Administration Shell |
| </summary> |
| <param name="aasId">The Asset Administration Shell's unique id</param> |
| <returns></returns> |
| <response code="200">The Asset Administration Shell was deleted successfully</response> |
| <response code="400">Bad Request</response> |
| <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)"> |
| <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> |
| <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> |
| <response code="404">No Asset Administration Shell with passed id found</response> |
| <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)"> |
| <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> |
| <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)"> |
| <summary> |
| Deletes 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> |
| <returns></returns> |
| <response code="200">The Submodel was deleted successfully</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.GetSubmodelsFromRegistry(System.String)"> |
| <summary> |
| Retrieves all Submodels from a specific Asset Administration Shell |
| </summary> |
| <param name="aasId">The Asset Administration Shell's unique id</param> |
| <returns></returns> |
| <response code="200">Returns a list of found Submodels</response> |
| <response code="400">Bad Request</response> |
| <response code="404">No Asset Administration Shell with passed id found</response> |
| <response code="502">Bad Gateway</response> |
| </member> |
| </members> |
| </doc> |