Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 1 | <?xml version="1.0"?> |
| 2 | <doc> |
| 3 | <assembly> |
| 4 | <name>BaSyx.API.Http.Controllers</name> |
| 5 | </assembly> |
| 6 | <members> |
Constantin Ziesche | 8b4a64d | 2020-06-25 11:52:09 +0200 | [diff] [blame] | 7 | <member name="T:BaSyx.API.Http.Controllers.AssetAdministrationShellRepositoryServices"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 8 | <summary> |
Constantin Ziesche | 8b4a64d | 2020-06-25 11:52:09 +0200 | [diff] [blame] | 9 | The Asset Administration Shell Repository Controller |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 10 | </summary> |
| 11 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 12 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRepositoryServices.GetAllAssetAdministrationShells"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 13 | <summary> |
Constantin Ziesche | 8b4a64d | 2020-06-25 11:52:09 +0200 | [diff] [blame] | 14 | Retrieves all Asset Administration Shells from the repository service endpoint |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 15 | </summary> |
| 16 | <returns></returns> |
| 17 | <response code="200">Returns a list of found Asset Administration Shells</response> |
| 18 | <response code="404">No Asset Administration Shells found</response> |
| 19 | <response code="400">Bad Request</response> |
| 20 | <response code="502">Bad Gateway</response> |
| 21 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 22 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRepositoryServices.GetAssetAdministrationShellById(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 23 | <summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 24 | Retrieves a specific Asset Administration Shell from the repository service endpoint |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 25 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 26 | <param name="aasId">The Asset Administration Shell's unique id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 27 | <returns></returns> |
| 28 | <response code="200">Returns the requested Asset Administration Shell</response> |
| 29 | <response code="404">No Asset Administration Shell found</response> |
| 30 | <response code="400">Bad Request</response> |
| 31 | <response code="502">Bad Gateway</response> |
| 32 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 33 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRepositoryServices.PutAssetAdministrationShell(BaSyx.Models.Core.AssetAdministrationShell.Generics.IAssetAdministrationShell)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 34 | <summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 35 | Creates or updates a Asset Administration Shell at the repository service endpoint |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 36 | </summary> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 37 | <param name="aas">The serialized Asset Administration Shell object</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 38 | <returns></returns> |
| 39 | <response code="201">Asset Administration Shell created successfully</response> |
| 40 | <response code="400">Bad Request</response> |
| 41 | <response code="502">Bad Gateway</response> |
| 42 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 43 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRepositoryServices.DeleteAssetAdministrationShellById(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 44 | <summary> |
Constantin Ziesche | 8b4a64d | 2020-06-25 11:52:09 +0200 | [diff] [blame] | 45 | Deletes a specific Asset Administration Shell at the repository service endpoint |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 46 | </summary> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 47 | <param name="aasId">The Asset Administration Shell's unique id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 48 | <returns></returns> |
| 49 | <response code="200">Asset Administration Shell deleted successfully</response> |
| 50 | <response code="400">Bad Request</response> |
| 51 | <response code="502">Bad Gateway</response> |
| 52 | </member> |
| 53 | <member name="T:BaSyx.API.Http.Controllers.AssetAdministrationShellServices"> |
| 54 | <summary> |
| 55 | All Asset Administration Shell Services provided by the component |
| 56 | </summary> |
| 57 | </member> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 58 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.#ctor(BaSyx.API.Components.IAssetAdministrationShellServiceProvider)"> |
| 59 | <summary> |
| 60 | Constructor for the Asset Administration Shell Services Controller |
| 61 | </summary> |
| 62 | <param name="assetAdministrationShellServiceProvider">The Asset Administration Shell Service Provider implementation provided by the dependency injection</param> |
| 63 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 64 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.GetAssetAdministrationShell"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 65 | <summary> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 66 | Retrieves the Asset Administration Shell Descriptor |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 67 | </summary> |
| 68 | <returns></returns> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 69 | <response code="200">Success</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 70 | </member> |
Constantin Ziesche | b4a6011 | 2020-08-05 12:08:10 +0200 | [diff] [blame] | 71 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.PutSubmodelToShell(BaSyx.Models.Core.AssetAdministrationShell.Generics.ISubmodel)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 72 | <summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 73 | Creates or updates a Submodel to an existing Asset Administration Shell |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 74 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 75 | <param name="submodel">The serialized Submodel object</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 76 | <returns></returns> |
| 77 | <response code="201">Submodel created successfully</response> |
| 78 | <response code="400">Bad Request</response> |
| 79 | </member> |
Constantin Ziesche | b4a6011 | 2020-08-05 12:08:10 +0200 | [diff] [blame] | 80 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.GetSubmodelFromShellByIdShort(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 81 | <summary> |
| 82 | Retrieves the Submodel from the Asset Administration Shell |
| 83 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 84 | <param name="submodelIdShort">The Submodel's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 85 | <returns></returns> |
| 86 | <response code="200">Submodel retrieved successfully</response> |
| 87 | <response code="404">No Submodel Service Provider found</response> |
| 88 | </member> |
Constantin Ziesche | b4a6011 | 2020-08-05 12:08:10 +0200 | [diff] [blame] | 89 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.DeleteSubmodelFromShellByIdShort(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 90 | <summary> |
| 91 | Deletes a specific Submodel from the Asset Administration Shell |
| 92 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 93 | <param name="submodelIdShort">The Submodel's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 94 | <returns></returns> |
| 95 | <response code="204">Submodel deleted successfully</response> |
| 96 | <response code="400">Bad Request</response> |
| 97 | </member> |
Constantin Ziesche | b4a6011 | 2020-08-05 12:08:10 +0200 | [diff] [blame] | 98 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.GetSubmodelsFromShell"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 99 | <summary> |
| 100 | Retrieves all Submodels from the Asset Administration Shell |
| 101 | </summary> |
| 102 | <returns></returns> |
| 103 | <response code="200">Returns a list of found Submodels</response> |
| 104 | <response code="404">No Submodel Service Providers found</response> |
| 105 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 106 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetSubmodelElements"> |
| 107 | <summary> |
| 108 | Retrieves all Submodel-Elements from the Submodel |
| 109 | </summary> |
| 110 | <returns></returns> |
| 111 | <response code="200">Returns a list of found Submodel-Elements</response> |
| 112 | <response code="404">Submodel not found / No Submodel-Elements found</response> |
| 113 | </member> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 114 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetProperties"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 115 | <summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 116 | Retrieves all Properties from the Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 117 | </summary> |
| 118 | <returns></returns> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 119 | <response code="200">Returns a list of found Properties</response> |
| 120 | <response code="404">Submodel not found / No Properties found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 121 | </member> |
| 122 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetOperations"> |
| 123 | <summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 124 | Retrieves all Operations from the Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 125 | </summary> |
| 126 | <returns></returns> |
| 127 | <response code="200">Success</response> |
| 128 | <response code="404">Submodel not found / No Operations found</response> |
| 129 | </member> |
| 130 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetEvents"> |
| 131 | <summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 132 | Retrieves all Events from the Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 133 | </summary> |
| 134 | <returns></returns> |
| 135 | <response code="200">Success</response> |
| 136 | <response code="404">Submodel not found / No Events found</response> |
| 137 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 138 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedPutSubmodelElement(BaSyx.Models.Core.AssetAdministrationShell.Generics.ISubmodelElement)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 139 | <summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 140 | Creates or updates a Submodel-Element to the Asset Administration Shell's Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 141 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 142 | <param name="submodelElement">The serialized Submodel Element object</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 143 | <returns></returns> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 144 | <response code="201">Submodel-Element created successfully</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 145 | <response code="400">Bad Request</response> |
| 146 | <response code="404">Submodel not found</response> |
| 147 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 148 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetSubmodelElementByIdShort(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 149 | <summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 150 | Retrieves a specific Submodel-Element from the Asset Administrations's Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 151 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 152 | <param name="submodelElementIdShort">The Submodel-Element's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 153 | <returns></returns> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 154 | <response code="200">Returns the requested Submodel-Element</response> |
| 155 | <response code="404">Submodel / Submodel-Element not found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 156 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 157 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedDeleteSubmodelElementByIdShort(System.String)"> |
| 158 | <summary> |
| 159 | Deletes a specific Submodel-Element from the Asset Administration Shell's Submodel |
| 160 | </summary> |
| 161 | <param name="submodelElementIdShort">The Submodel-Element's short id</param> |
| 162 | <returns></returns> |
Constantin Ziesche | 7b6d479 | 2020-08-18 17:15:11 +0200 | [diff] [blame] | 163 | <response code="204">Submodel-Element deleted successfully</response> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 164 | <response code="404">Submodel not found</response> |
| 165 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 166 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetPropertyByIdShort(System.String)"> |
| 167 | <summary> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 168 | Retrieves a specific Property from the Asset Administration Shell's Submodel |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 169 | </summary> |
| 170 | <param name="propertyIdShort">The Property's short id</param> |
| 171 | <returns></returns> |
| 172 | <response code="200">Returns the requested Property</response> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 173 | <response code="404">Submodel / Property not found</response> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 174 | </member> |
| 175 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetPropertyValueByIdShort(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 176 | <summary> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 177 | Retrieves the value of a specific Property from the Asset Administrations Shell's Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 178 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 179 | <param name="propertyIdShort">The Property's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 180 | <returns></returns> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 181 | <response code="200">Returns the requested Property's value</response> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 182 | <response code="404">Submodel / Property not found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 183 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 184 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedPutPropertyValueByIdShort(System.String,BaSyx.Models.Core.Common.IValue)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 185 | <summary> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 186 | Updates the Asset Administration Shell's Submodel's Property's value |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 187 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 188 | <param name="propertyIdShort">The Property's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 189 | <param name="value">The new value</param> |
| 190 | <returns></returns> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 191 | <response code="200">Property's value changed successfully</response> |
| 192 | <response code="404">Submodel/Property not found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 193 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 194 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetOperationByIdShort(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 195 | <summary> |
| 196 | Retrieves a specific Operation from the Asset Administration Shell's Submodel |
| 197 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 198 | <param name="operationIdShort">The Operation's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 199 | <returns></returns> |
| 200 | <response code="200">Success</response> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 201 | <response code="404">Submodel / Operation not found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 202 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 203 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedInvokeOperationByIdShort(System.String,BaSyx.Models.Communication.InvocationRequest)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 204 | <summary> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 205 | Synchronously invokes a specific operation from the Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 206 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 207 | <param name="operationIdShort">The Operation's short id</param> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 208 | <param name="invocationRequest">The parameterized request object for the invocation</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 209 | <returns></returns> |
| 210 | <response code="200">Operation invoked successfully</response> |
| 211 | <response code="400">Bad Request</response> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 212 | <response code="404">Submodel / Method handler not found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 213 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 214 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetEventByIdShort(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 215 | <summary> |
| 216 | Retrieves a specific event from the Asset Administration Shell's Submodel |
| 217 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 218 | <param name="eventIdShort">The Event's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 219 | <returns></returns> |
| 220 | <response code="200">Success</response> |
| 221 | <response code="404">Submodel/Event not found</response> |
| 222 | </member> |
Constantin Ziesche | 8b4a64d | 2020-06-25 11:52:09 +0200 | [diff] [blame] | 223 | <member name="T:BaSyx.API.Http.Controllers.SubmodelRepositoryServices"> |
| 224 | <summary> |
| 225 | The Submodel Repository Controller |
| 226 | </summary> |
| 227 | </member> |
Constantin Ziesche | b4a6011 | 2020-08-05 12:08:10 +0200 | [diff] [blame] | 228 | <member name="M:BaSyx.API.Http.Controllers.SubmodelRepositoryServices.GetAllSubmodelsFromRepo"> |
Constantin Ziesche | 8b4a64d | 2020-06-25 11:52:09 +0200 | [diff] [blame] | 229 | <summary> |
| 230 | Retrieves all Submodels from the repository service endpoint |
| 231 | </summary> |
| 232 | <returns></returns> |
| 233 | <response code="200">Returns a list of found Submodels</response> |
| 234 | <response code="404">No Submodels found</response> |
| 235 | <response code="400">Bad Request</response> |
| 236 | <response code="502">Bad Gateway</response> |
| 237 | </member> |
Constantin Ziesche | b4a6011 | 2020-08-05 12:08:10 +0200 | [diff] [blame] | 238 | <member name="M:BaSyx.API.Http.Controllers.SubmodelRepositoryServices.RetrieveSubmodelFromRepoById(System.String)"> |
Constantin Ziesche | 8b4a64d | 2020-06-25 11:52:09 +0200 | [diff] [blame] | 239 | <summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 240 | Retrieves a specific Submodel from the repository service endpoint |
Constantin Ziesche | 8b4a64d | 2020-06-25 11:52:09 +0200 | [diff] [blame] | 241 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 242 | <param name="submodelId">The Submodel's unique id</param> |
Constantin Ziesche | 8b4a64d | 2020-06-25 11:52:09 +0200 | [diff] [blame] | 243 | <returns></returns> |
| 244 | <response code="200">Returns the requested Submodel</response> |
| 245 | <response code="404">No Submodel found</response> |
| 246 | <response code="400">Bad Request</response> |
| 247 | <response code="502">Bad Gateway</response> |
| 248 | </member> |
Constantin Ziesche | b4a6011 | 2020-08-05 12:08:10 +0200 | [diff] [blame] | 249 | <member name="M:BaSyx.API.Http.Controllers.SubmodelRepositoryServices.PutSubmodelToRepo(BaSyx.Models.Core.AssetAdministrationShell.Generics.ISubmodel)"> |
Constantin Ziesche | 8b4a64d | 2020-06-25 11:52:09 +0200 | [diff] [blame] | 250 | <summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 251 | Creates or updates a Submodel at the repository service endpoint |
Constantin Ziesche | 8b4a64d | 2020-06-25 11:52:09 +0200 | [diff] [blame] | 252 | </summary> |
| 253 | <param name="submodel">The serialized Submodel object</param> |
| 254 | <returns></returns> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 255 | <response code="201">Submodel created/updated successfully</response> |
Constantin Ziesche | 8b4a64d | 2020-06-25 11:52:09 +0200 | [diff] [blame] | 256 | <response code="400">Bad Request</response> |
| 257 | <response code="502">Bad Gateway</response> |
| 258 | </member> |
Constantin Ziesche | b4a6011 | 2020-08-05 12:08:10 +0200 | [diff] [blame] | 259 | <member name="M:BaSyx.API.Http.Controllers.SubmodelRepositoryServices.DeleteSubmodelFromRepoById(System.String)"> |
Constantin Ziesche | 8b4a64d | 2020-06-25 11:52:09 +0200 | [diff] [blame] | 260 | <summary> |
| 261 | Deletes a specific Submodel at the repository service endpoint |
| 262 | </summary> |
| 263 | <param name="submodelId">The Submodel's unique id</param> |
| 264 | <returns></returns> |
| 265 | <response code="200">Submodel deleted successfully</response> |
| 266 | <response code="400">Bad Request</response> |
| 267 | <response code="502">Bad Gateway</response> |
| 268 | </member> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 269 | <member name="T:BaSyx.API.Http.Controllers.SubmodelServices"> |
| 270 | <summary> |
| 271 | All Asset Administration Shell Services provided by the component |
| 272 | </summary> |
| 273 | </member> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 274 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.#ctor(BaSyx.API.Components.ISubmodelServiceProvider)"> |
| 275 | <summary> |
| 276 | Constructor for the Submodel Services Controller |
| 277 | </summary> |
| 278 | <param name="submodelServiceProvider">The Submodel Service Provider implementation provided by the dependency injection</param> |
| 279 | </member> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 280 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetSubmodelAsTable(System.String)"> |
| 281 | <summary> |
| 282 | Retrieves a customizable table version of a Submodel |
| 283 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 284 | <param name="columns">A comma-separated list of field names to structure the payload beeing returned</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 285 | <returns></returns> |
| 286 | <response code="200">Success</response> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 287 | <response code="404">Submodel not found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 288 | </member> |
| 289 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetMinimizedSubmodel"> |
| 290 | <summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 291 | Retrieves the minimized version of a Submodel, i.e. only the values of SubmodelElements are serialized and returned |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 292 | </summary> |
| 293 | <returns></returns> |
| 294 | <response code="200">Success</response> |
| 295 | <response code="404">Submodel not found</response> |
| 296 | </member> |
| 297 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetSubmodel"> |
| 298 | <summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 299 | Retrieves the entire Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 300 | </summary> |
| 301 | <returns></returns> |
| 302 | <response code="200">Success</response> |
| 303 | <response code="404">Submodel not found</response> |
| 304 | </member> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 305 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetSubmodelElements"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 306 | <summary> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 307 | Retrieves all SubmodelElements from the current Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 308 | </summary> |
| 309 | <returns></returns> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 310 | <response code="200">Returns a list of found SubmodelElements</response> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 311 | <response code="404">Submodel not found</response> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 312 | </member> |
| 313 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetProperties"> |
| 314 | <summary> |
| 315 | Retrieves all Properties from the current Submodel |
| 316 | </summary> |
| 317 | <returns></returns> |
| 318 | <response code="200">Returns a list of found Properties</response> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 319 | <response code="404">Submodel not found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 320 | </member> |
| 321 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetOperations"> |
| 322 | <summary> |
| 323 | Retrieves all Operations from the current Submodel |
| 324 | </summary> |
| 325 | <returns></returns> |
| 326 | <response code="200">Success</response> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 327 | <response code="404">Submodel not found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 328 | </member> |
| 329 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetEvents"> |
| 330 | <summary> |
| 331 | Retrieves all Events from the current Submodel |
| 332 | </summary> |
| 333 | <returns></returns> |
| 334 | <response code="200">Success</response> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 335 | <response code="404">Submodel not found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 336 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 337 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.PutSubmodelElement(BaSyx.Models.Core.AssetAdministrationShell.Generics.ISubmodelElement)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 338 | <summary> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 339 | Adds a new Submodel-Element to the Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 340 | </summary> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 341 | <param name="submodelElement">The Submodel-Element object</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 342 | <returns></returns> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 343 | <response code="201">Submodel Element created successfully</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 344 | <response code="400">Bad Request</response> |
| 345 | <response code="404">Submodel not found</response> |
| 346 | </member> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 347 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetSubmodelElementByIdShort(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 348 | <summary> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 349 | Retrieves a specific Submodel-Element from the Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 350 | </summary> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 351 | <param name="submodelElementIdShort">The Submodel-Element's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 352 | <returns></returns> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 353 | <response code="200">Returns the requested Submodel-Element</response> |
| 354 | <response code="404">Submodel / Submodel Element not found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 355 | </member> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 356 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.DeleteSubmodelElementByIdShort(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 357 | <summary> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 358 | Deletes a specific Submodel-Element from the Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 359 | </summary> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 360 | <param name="submodelElementIdShort">The Submodel-Element's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 361 | <returns></returns> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 362 | <response code="204">Submodel-Element deleted successfully</response> |
| 363 | <response code="404">Submodel / Submodel-Element not found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 364 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 365 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetPropertyByIdShort(System.String)"> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 366 | <summary> |
| 367 | Retrieves a specific Property from the Asset Administrations's Submodel |
| 368 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 369 | <param name="propertyIdShort">The Property's short id</param> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 370 | <returns></returns> |
| 371 | <response code="200">Returns the requested Property</response> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 372 | <response code="404">Submodel / Property not found</response> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 373 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 374 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetPropertyValueByIdShort(System.String)"> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 375 | <summary> |
| 376 | Retrieves the value of a specific Property from the Asset Administrations Shell's Submodel |
| 377 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 378 | <param name="propertyIdShort">The Property's short id</param> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 379 | <returns></returns> |
| 380 | <response code="200">Returns the requested Property's value</response> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 381 | <response code="404">Submodel / Property not found</response> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 382 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 383 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.PutPropertyValueByIdShort(System.String,BaSyx.Models.Core.Common.IValue)"> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 384 | <summary> |
| 385 | Updates the Asset Administration Shell's Submodel's Property |
| 386 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 387 | <param name="propertyIdShort">The Property's short id</param> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 388 | <param name="value">The new value</param> |
| 389 | <returns></returns> |
| 390 | <response code="200">Property's value changed successfully</response> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 391 | <response code="404">Submodel / Property not found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 392 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 393 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetOperationByIdShort(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 394 | <summary> |
| 395 | Retrieves a specific Operation from the Asset Administration Shell's Submodel |
| 396 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 397 | <param name="operationIdShort">The Operation's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 398 | <returns></returns> |
| 399 | <response code="200">Success</response> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 400 | <response code="404">Submodel / Operation not found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 401 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 402 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.InvokeOperationByIdShort(System.String,BaSyx.Models.Communication.InvocationRequest)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 403 | <summary> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 404 | Synchronously invokes a specific operation from the Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 405 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 406 | <param name="operationIdShort">The Operation's short id</param> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 407 | <param name="invocationRequest">The parameterized request object for the invocation</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 408 | <returns></returns> |
| 409 | <response code="200">Operation invoked successfully</response> |
| 410 | <response code="400">Bad Request</response> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 411 | <response code="404">Submodel / Operation not found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 412 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 413 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.InvokeOperationByIdShortAsync(System.String,BaSyx.Models.Communication.InvocationRequest)"> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 414 | <summary> |
| 415 | Asynchronously invokes a specific operation from the Submodel |
| 416 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 417 | <param name="operationIdShort">The Operation's short id</param> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 418 | <param name="invocationRequest">The parameterized request object for the invocation</param> |
| 419 | <returns></returns> |
| 420 | <response code="200">Operation invoked successfully</response> |
| 421 | <response code="400">Bad Request</response> |
| 422 | <response code="404">Submodel / Method handler not found</response> |
| 423 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 424 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetInvocationResultByIdShort(System.String,System.String)"> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 425 | <summary> |
| 426 | Retrieves the result of an asynchronously started operation |
| 427 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 428 | <param name="operationIdShort">The Operation's short id</param> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 429 | <param name="requestId">The request id</param> |
| 430 | <returns></returns> |
| 431 | <response code="200">Result found</response> |
| 432 | <response code="400">Bad Request</response> |
| 433 | <response code="404">Submodel / Operation / Request not found</response> |
| 434 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 435 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetEventByIdShort(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 436 | <summary> |
| 437 | Retrieves a specific event from the Asset Administration Shell's Submodel |
| 438 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 439 | <param name="eventIdShort">The Event's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 440 | <returns></returns> |
| 441 | <response code="200">Success</response> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 442 | <response code="404">Submodel / Event not found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 443 | </member> |
Constantin Ziesche | 7b6d479 | 2020-08-18 17:15:11 +0200 | [diff] [blame] | 444 | <member name="T:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 445 | <summary> |
Constantin Ziesche | 7b6d479 | 2020-08-18 17:15:11 +0200 | [diff] [blame] | 446 | The Http-Controller implementation of the IAssetAdministrationShellRegistry interface |
| 447 | </summary> |
| 448 | </member> |
| 449 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.#ctor(BaSyx.API.Components.IAssetAdministrationShellRegistry)"> |
| 450 | <summary> |
| 451 | The Constructor for the AssetAdministrationShellRegistry-Controller |
| 452 | </summary> |
| 453 | <param name="aasRegistry">The backend implementation for the IAssetAdministrationShellRegistry interface. Usually provided by the Depedency Injection mechanism.</param> |
| 454 | </member> |
| 455 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.GetAllAssetAdministrationShellDescriptors"> |
| 456 | <summary> |
| 457 | Retrieves all registered Asset Administration Shells within system (e.g. Station, Line, Plant, Area, etc.) defined by the Registry |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 458 | </summary> |
| 459 | <returns></returns> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 460 | <response code="200">Returns a list of found Asset Administration Shell Descriptors</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 461 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 462 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.GetAssetAdministrationShellDescriptor(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 463 | <summary> |
Constantin Ziesche | 7b6d479 | 2020-08-18 17:15:11 +0200 | [diff] [blame] | 464 | Retrieves a specific Asset Administration Shell registration |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 465 | </summary> |
| 466 | <param name="aasId">The Asset Administration Shell's unique id</param> |
| 467 | <returns></returns> |
| 468 | <response code="200">Returns the requested Asset Administration Shell</response> |
| 469 | <response code="400">Bad Request</response> |
| 470 | <response code="404">No Asset Administration Shell with passed id found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 471 | </member> |
Constantin Ziesche | 7b6d479 | 2020-08-18 17:15:11 +0200 | [diff] [blame] | 472 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.RegisterAssetAdministrationShell(System.String,BaSyx.Models.Connectivity.Descriptors.IAssetAdministrationShellDescriptor)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 473 | <summary> |
Constantin Ziesche | 7b6d479 | 2020-08-18 17:15:11 +0200 | [diff] [blame] | 474 | Creates a new or updates an existing Asset Administration Shell registration at the Registry |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 475 | </summary> |
| 476 | <param name="aasId">The Asset Administration Shell's unique id</param> |
Constantin Ziesche | 7b6d479 | 2020-08-18 17:15:11 +0200 | [diff] [blame] | 477 | <param name="aasDescriptor">The Asset Administration Shell Descriptor</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 478 | <returns></returns> |
| 479 | <response code="200">The Asset Administration Shell's registration was successfully renewed</response> |
| 480 | <response code="400">The syntax of the passed Asset Administration Shell is not valid or malformed request</response> |
Constantin Ziesche | 7b6d479 | 2020-08-18 17:15:11 +0200 | [diff] [blame] | 481 | <response code="404">No Asset Administration Shell with passed id found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 482 | </member> |
Constantin Ziesche | 7b6d479 | 2020-08-18 17:15:11 +0200 | [diff] [blame] | 483 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.UnregisterAssetAdministrationShell(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 484 | <summary> |
Constantin Ziesche | 7b6d479 | 2020-08-18 17:15:11 +0200 | [diff] [blame] | 485 | Deletes the Asset Administration Shell registration from the Registry |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 486 | </summary> |
| 487 | <param name="aasId">The Asset Administration Shell's unique id</param> |
| 488 | <returns></returns> |
| 489 | <response code="200">The Asset Administration Shell was deleted successfully</response> |
| 490 | <response code="400">Bad Request</response> |
| 491 | <response code="404">No Asset Administration Shell with passed id found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 492 | </member> |
Constantin Ziesche | 7b6d479 | 2020-08-18 17:15:11 +0200 | [diff] [blame] | 493 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.RegisterSubmodelAtAssetAdministrationShell(System.String,System.String,BaSyx.Models.Connectivity.Descriptors.ISubmodelDescriptor)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 494 | <summary> |
Constantin Ziesche | 7b6d479 | 2020-08-18 17:15:11 +0200 | [diff] [blame] | 495 | Creates a new or updates an existing Submodel registration at a specific Asset Administration Shell registered at the Registry |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 496 | </summary> |
| 497 | <param name="aasId">The Asset Administration Shell's unique id</param> |
Constantin Ziesche | 7b6d479 | 2020-08-18 17:15:11 +0200 | [diff] [blame] | 498 | <param name="submodelId">The Submodel's unique id</param> |
| 499 | <param name="submodelDescriptor">The Submodel Descriptor</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 500 | <returns></returns> |
| 501 | <response code="201">The Submodel was created successfully</response> |
| 502 | <response code="400">The syntax of the passed Submodel is not valid or malformed request</response> |
| 503 | <response code="404">No Asset Administration Shell with passed id found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 504 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 505 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.GetSubmodelDescriptorFromAssetAdministrationShell(System.String,System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 506 | <summary> |
Constantin Ziesche | 7b6d479 | 2020-08-18 17:15:11 +0200 | [diff] [blame] | 507 | Retrieves the Submodel registration from a specific Asset Administration Shell registered at the Registry |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 508 | </summary> |
| 509 | <param name="aasId">The Asset Administration Shell's unique id</param> |
Constantin Ziesche | 7b6d479 | 2020-08-18 17:15:11 +0200 | [diff] [blame] | 510 | <param name="submodelId">The Submodel's unique id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 511 | <returns></returns> |
Constantin Ziesche | 7b6d479 | 2020-08-18 17:15:11 +0200 | [diff] [blame] | 512 | <response code="200">Returns the requested Submodels Descriptor</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 513 | <response code="400">Bad Request</response> |
| 514 | <response code="404">No Asset Administration Shell / Submodel with passed id found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 515 | </member> |
Constantin Ziesche | 7b6d479 | 2020-08-18 17:15:11 +0200 | [diff] [blame] | 516 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.DeleteSubmodelDescriptorFromAssetAdministrationShell(System.String,System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 517 | <summary> |
Constantin Ziesche | 7b6d479 | 2020-08-18 17:15:11 +0200 | [diff] [blame] | 518 | Unregisters the Submodel from a specific Asset Administration Shell registered at the Registry |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 519 | </summary> |
| 520 | <param name="aasId">The Asset Administration Shell's unique id</param> |
Constantin Ziesche | 7b6d479 | 2020-08-18 17:15:11 +0200 | [diff] [blame] | 521 | <param name="submodelId">The Submodel's unique id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 522 | <returns></returns> |
Constantin Ziesche | 7b6d479 | 2020-08-18 17:15:11 +0200 | [diff] [blame] | 523 | <response code="200">The Submodel Descriptor was successfully unregistered</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 524 | <response code="400">Bad Request</response> |
| 525 | <response code="404">No Asset Administration Shell / Submodel with passed id found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 526 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame] | 527 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.GetAllSubmodelDescriptorsFromAssetAdministrationShell(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 528 | <summary> |
Constantin Ziesche | 7b6d479 | 2020-08-18 17:15:11 +0200 | [diff] [blame] | 529 | Retrieves all Submodel registrations from a specific Asset Administration Shell registered at the Registry |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 530 | </summary> |
| 531 | <param name="aasId">The Asset Administration Shell's unique id</param> |
| 532 | <returns></returns> |
Constantin Ziesche | 7b6d479 | 2020-08-18 17:15:11 +0200 | [diff] [blame] | 533 | <response code="200">Returns a list of found Submodels Descriptors</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 534 | <response code="400">Bad Request</response> |
| 535 | <response code="404">No Asset Administration Shell with passed id found</response> |
Constantin Ziesche | 7b6d479 | 2020-08-18 17:15:11 +0200 | [diff] [blame] | 536 | </member> |
| 537 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.RetrieveAssetAdministrationShellRegistration(System.String)"> |
| 538 | <inheritdoc/> |
| 539 | </member> |
| 540 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.RetrieveSubmodelRegistration(System.String,System.String)"> |
| 541 | <inheritdoc/> |
| 542 | </member> |
| 543 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.DeleteSubmodelRegistration(System.String,System.String)"> |
| 544 | <inheritdoc/> |
| 545 | </member> |
| 546 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.CreateOrUpdateAssetAdministrationShellRegistration(System.String,BaSyx.Models.Connectivity.Descriptors.IAssetAdministrationShellDescriptor)"> |
| 547 | <inheritdoc/> |
| 548 | </member> |
| 549 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.RetrieveAllAssetAdministrationShellRegistrations(System.Predicate{BaSyx.Models.Connectivity.Descriptors.IAssetAdministrationShellDescriptor})"> |
| 550 | <inheritdoc/> |
| 551 | </member> |
| 552 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.CreateOrUpdateSubmodelRegistration(System.String,System.String,BaSyx.Models.Connectivity.Descriptors.ISubmodelDescriptor)"> |
| 553 | <inheritdoc/> |
| 554 | </member> |
| 555 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.RetrieveAllSubmodelRegistrations(System.String,System.Predicate{BaSyx.Models.Connectivity.Descriptors.ISubmodelDescriptor})"> |
| 556 | <inheritdoc/> |
| 557 | </member> |
| 558 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.DeleteAssetAdministrationShellRegistration(System.String)"> |
| 559 | <inheritdoc/> |
| 560 | </member> |
| 561 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.RetrieveAllAssetAdministrationShellRegistrations"> |
| 562 | <inheritdoc/> |
| 563 | </member> |
| 564 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.RetrieveAllSubmodelRegistrations(System.String)"> |
| 565 | <inheritdoc/> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 566 | </member> |
Constantin Ziesche | e837f99 | 2020-08-19 12:04:32 +0200 | [diff] [blame^] | 567 | <member name="T:BaSyx.API.Http.Controllers.ResultHandling"> |
| 568 | <summary> |
| 569 | Helper class for handling Action Results for HTTP-Requests |
| 570 | </summary> |
| 571 | </member> |
| 572 | <member name="M:BaSyx.API.Http.Controllers.ResultHandling.NullResult(System.String)"> |
| 573 | <summary> |
| 574 | Returns a Result-Object in an ObjectResult with status code 400 and a message which element is null or empty |
| 575 | </summary> |
| 576 | <param name="elementName">The name of the element which is null or empty</param> |
| 577 | <returns></returns> |
| 578 | </member> |
| 579 | <member name="M:BaSyx.API.Http.Controllers.ResultHandling.CreateActionResult(BaSyx.Utils.ResultHandling.IResult,BaSyx.API.Http.Controllers.CrudOperation,System.String)"> |
| 580 | <summary> |
| 581 | Returns a Result-Object wrapped in an ObjectResult according to the CRUD-operation |
| 582 | </summary> |
| 583 | <param name="result">The orignary Result object</param> |
| 584 | <param name="crud">The CRUD-operation taken</param> |
| 585 | <param name="route">Optional route for Create-Operations</param> |
| 586 | <returns></returns> |
| 587 | </member> |
| 588 | <member name="T:BaSyx.API.Http.Controllers.CrudOperation"> |
| 589 | <summary> |
| 590 | Enumeration of the different CRUD-Operations |
| 591 | </summary> |
| 592 | </member> |
| 593 | <member name="F:BaSyx.API.Http.Controllers.CrudOperation.Create"> |
| 594 | <summary> |
| 595 | Create |
| 596 | </summary> |
| 597 | </member> |
| 598 | <member name="F:BaSyx.API.Http.Controllers.CrudOperation.Retrieve"> |
| 599 | <summary> |
| 600 | Retrieve |
| 601 | </summary> |
| 602 | </member> |
| 603 | <member name="F:BaSyx.API.Http.Controllers.CrudOperation.Update"> |
| 604 | <summary> |
| 605 | Update |
| 606 | </summary> |
| 607 | </member> |
| 608 | <member name="F:BaSyx.API.Http.Controllers.CrudOperation.Delete"> |
| 609 | <summary> |
| 610 | Delete |
| 611 | </summary> |
| 612 | </member> |
| 613 | <member name="F:BaSyx.API.Http.Controllers.CrudOperation.Invoke"> |
| 614 | <summary> |
| 615 | Invoke |
| 616 | </summary> |
| 617 | </member> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 618 | </members> |
| 619 | </doc> |