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 | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 58 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.GetAssetAdministrationShell"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 59 | <summary> |
| 60 | Retrieves the Asset Administration Shell |
| 61 | </summary> |
| 62 | <returns></returns> |
| 63 | <response code="200">Success</response> |
| 64 | <response code="502">Bad Gateway - Asset Administration Shell not available</response> |
| 65 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 66 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.PutSubmodel(BaSyx.Models.Core.AssetAdministrationShell.Generics.ISubmodel)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 67 | <summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 68 | Creates or updates a Submodel to an existing Asset Administration Shell |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 69 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 70 | <param name="submodel">The serialized Submodel object</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 71 | <returns></returns> |
| 72 | <response code="201">Submodel created successfully</response> |
| 73 | <response code="400">Bad Request</response> |
| 74 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 75 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.GetSubmodelByIdShort(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 76 | <summary> |
| 77 | Retrieves the Submodel from the Asset Administration Shell |
| 78 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 79 | <param name="submodelIdShort">The Submodel's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 80 | <returns></returns> |
| 81 | <response code="200">Submodel retrieved successfully</response> |
| 82 | <response code="404">No Submodel Service Provider found</response> |
| 83 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 84 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.DeleteSubmodelByIdShort(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 85 | <summary> |
| 86 | Deletes a specific Submodel from the Asset Administration Shell |
| 87 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 88 | <param name="submodelIdShort">The Submodel's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 89 | <returns></returns> |
| 90 | <response code="204">Submodel deleted successfully</response> |
| 91 | <response code="400">Bad Request</response> |
| 92 | </member> |
| 93 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.GetSubmodels"> |
| 94 | <summary> |
| 95 | Retrieves all Submodels from the Asset Administration Shell |
| 96 | </summary> |
| 97 | <returns></returns> |
| 98 | <response code="200">Returns a list of found Submodels</response> |
| 99 | <response code="404">No Submodel Service Providers found</response> |
| 100 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 101 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetSubmodelElements"> |
| 102 | <summary> |
| 103 | Retrieves all Submodel-Elements from the Submodel |
| 104 | </summary> |
| 105 | <returns></returns> |
| 106 | <response code="200">Returns a list of found Submodel-Elements</response> |
| 107 | <response code="404">Submodel not found / No Submodel-Elements found</response> |
| 108 | </member> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 109 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetProperties"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 110 | <summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 111 | Retrieves all Properties from the Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 112 | </summary> |
| 113 | <returns></returns> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 114 | <response code="200">Returns a list of found Properties</response> |
| 115 | <response code="404">Submodel not found / No Properties found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 116 | </member> |
| 117 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetOperations"> |
| 118 | <summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 119 | Retrieves all Operations from the Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 120 | </summary> |
| 121 | <returns></returns> |
| 122 | <response code="200">Success</response> |
| 123 | <response code="404">Submodel not found / No Operations found</response> |
| 124 | </member> |
| 125 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetEvents"> |
| 126 | <summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 127 | Retrieves all Events from the Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 128 | </summary> |
| 129 | <returns></returns> |
| 130 | <response code="200">Success</response> |
| 131 | <response code="404">Submodel not found / No Events found</response> |
| 132 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 133 | <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] | 134 | <summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 135 | 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] | 136 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 137 | <param name="submodelElement">The serialized Submodel Element object</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 138 | <returns></returns> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 139 | <response code="201">Submodel-Element created successfully</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 140 | <response code="400">Bad Request</response> |
| 141 | <response code="404">Submodel not found</response> |
| 142 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 143 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetSubmodelElementByIdShort(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 144 | <summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 145 | Retrieves a specific Submodel-Element from the Asset Administrations's Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 146 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 147 | <param name="submodelElementIdShort">The Submodel-Element's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 148 | <returns></returns> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 149 | <response code="200">Returns the requested Property</response> |
| 150 | <response code="404">Submodel/Property not found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 151 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 152 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedDeleteSubmodelElementByIdShort(System.String)"> |
| 153 | <summary> |
| 154 | Deletes a specific Submodel-Element from the Asset Administration Shell's Submodel |
| 155 | </summary> |
| 156 | <param name="submodelElementIdShort">The Submodel-Element's short id</param> |
| 157 | <returns></returns> |
| 158 | <response code="204">Property deleted successfully</response> |
| 159 | <response code="404">Submodel not found</response> |
| 160 | </member> |
| 161 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedPutProperty(BaSyx.Models.Core.AssetAdministrationShell.Generics.SubmodelElementTypes.IProperty)"> |
| 162 | <summary> |
| 163 | Creates or updated a Property to the Asset Administration Shell's Submodel |
| 164 | </summary> |
| 165 | <param name="property">The Property's description object</param> |
| 166 | <returns></returns> |
| 167 | <response code="201">Property created successfully</response> |
| 168 | <response code="400">Bad Request</response> |
| 169 | <response code="404">Submodel not found</response> |
| 170 | </member> |
| 171 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetPropertyByIdShort(System.String)"> |
| 172 | <summary> |
| 173 | Retrieves a specific Property from the Asset Administrations's Submodel |
| 174 | </summary> |
| 175 | <param name="propertyIdShort">The Property's short id</param> |
| 176 | <returns></returns> |
| 177 | <response code="200">Returns the requested Property</response> |
| 178 | <response code="404">Submodel/Property not found</response> |
| 179 | </member> |
| 180 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetPropertyValueByIdShort(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 181 | <summary> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 182 | 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] | 183 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 184 | <param name="propertyIdShort">The Property's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 185 | <returns></returns> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 186 | <response code="200">Returns the requested Property's value</response> |
| 187 | <response code="404">Submodel/Property not found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 188 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 189 | <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] | 190 | <summary> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 191 | Updates the Asset Administration Shell's Submodel's Property |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 192 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 193 | <param name="propertyIdShort">The Property's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 194 | <param name="value">The new value</param> |
| 195 | <returns></returns> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 196 | <response code="200">Property's value changed successfully</response> |
| 197 | <response code="404">Submodel/Property not found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 198 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 199 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedDeletePropertyByIdShort(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 200 | <summary> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 201 | Deletes a specific Property from the Asset Administration Shell's Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 202 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 203 | <param name="propertyIdShort">The Property's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 204 | <returns></returns> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 205 | <response code="204">Property deleted successfully</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 206 | <response code="404">Submodel not found</response> |
| 207 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 208 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedPutOperation(BaSyx.Models.Core.AssetAdministrationShell.Generics.SubmodelElementTypes.IOperation)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 209 | <summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 210 | Adds a new operation to the Asset Administration Shell's Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 211 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 212 | <param name="operation">The serialized Operation object</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 213 | <returns></returns> |
| 214 | <response code="201">Operation created successfully</response> |
| 215 | <response code="400">Bad Request</response> |
| 216 | <response code="404">Submodel not found</response> |
| 217 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 218 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetOperationByIdShort(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 219 | <summary> |
| 220 | Retrieves a specific Operation from the Asset Administration Shell's Submodel |
| 221 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 222 | <param name="operationIdShort">The Operation's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 223 | <returns></returns> |
| 224 | <response code="200">Success</response> |
| 225 | <response code="404">Submodel/Operation not found</response> |
| 226 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 227 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedDeleteOperationByIdShort(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 228 | <summary> |
| 229 | Deletes a specific Operation from the Asset Administration Shell's Submodel |
| 230 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 231 | <param name="operationIdShort">The Operation's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 232 | <returns></returns> |
| 233 | <response code="204">Operation deleted successfully</response> |
| 234 | <response code="404">Submodel not found</response> |
| 235 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 236 | <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] | 237 | <summary> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 238 | Synchronously invokes a specific operation from the Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 239 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 240 | <param name="operationIdShort">The Operation's short id</param> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 241 | <param name="invocationRequest">The parameterized request object for the invocation</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 242 | <returns></returns> |
| 243 | <response code="200">Operation invoked successfully</response> |
| 244 | <response code="400">Bad Request</response> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 245 | <response code="404">Submodel / Method handler not found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 246 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 247 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedPutEvent(BaSyx.Models.Core.AssetAdministrationShell.Generics.SubmodelElementTypes.IEvent)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 248 | <summary> |
| 249 | Adds a new event to the Asset Administration Shell's Submodel |
| 250 | </summary> |
| 251 | <param name="eventable">The Event description object</param> |
| 252 | <returns></returns> |
| 253 | <response code="201">Event created successfully</response> |
| 254 | <response code="400">Bad Request</response> |
| 255 | <response code="404">Submodel not found</response> |
| 256 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 257 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetEventByIdShort(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 258 | <summary> |
| 259 | Retrieves a specific event from the Asset Administration Shell's Submodel |
| 260 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 261 | <param name="eventIdShort">The Event's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 262 | <returns></returns> |
| 263 | <response code="200">Success</response> |
| 264 | <response code="404">Submodel/Event not found</response> |
| 265 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 266 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedDeleteEventByIdShort(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 267 | <summary> |
| 268 | Deletes a specific event from the Asset Administration Shell's Submodel |
| 269 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 270 | <param name="eventIdShort">The Event's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 271 | <returns></returns> |
| 272 | <response code="204">Event deleted successfully</response> |
| 273 | <response code="404">Submodel not found</response> |
| 274 | </member> |
Constantin Ziesche | 8b4a64d | 2020-06-25 11:52:09 +0200 | [diff] [blame] | 275 | <member name="T:BaSyx.API.Http.Controllers.SubmodelRepositoryServices"> |
| 276 | <summary> |
| 277 | The Submodel Repository Controller |
| 278 | </summary> |
| 279 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 280 | <member name="M:BaSyx.API.Http.Controllers.SubmodelRepositoryServices.GetAllSubmodels"> |
Constantin Ziesche | 8b4a64d | 2020-06-25 11:52:09 +0200 | [diff] [blame] | 281 | <summary> |
| 282 | Retrieves all Submodels from the repository service endpoint |
| 283 | </summary> |
| 284 | <returns></returns> |
| 285 | <response code="200">Returns a list of found Submodels</response> |
| 286 | <response code="404">No Submodels found</response> |
| 287 | <response code="400">Bad Request</response> |
| 288 | <response code="502">Bad Gateway</response> |
| 289 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 290 | <member name="M:BaSyx.API.Http.Controllers.SubmodelRepositoryServices.RetrieveSubmodelById(System.String)"> |
Constantin Ziesche | 8b4a64d | 2020-06-25 11:52:09 +0200 | [diff] [blame] | 291 | <summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 292 | Retrieves a specific Submodel from the repository service endpoint |
Constantin Ziesche | 8b4a64d | 2020-06-25 11:52:09 +0200 | [diff] [blame] | 293 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 294 | <param name="submodelId">The Submodel's unique id</param> |
Constantin Ziesche | 8b4a64d | 2020-06-25 11:52:09 +0200 | [diff] [blame] | 295 | <returns></returns> |
| 296 | <response code="200">Returns the requested Submodel</response> |
| 297 | <response code="404">No Submodel found</response> |
| 298 | <response code="400">Bad Request</response> |
| 299 | <response code="502">Bad Gateway</response> |
| 300 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 301 | <member name="M:BaSyx.API.Http.Controllers.SubmodelRepositoryServices.PutSubmodel(BaSyx.Models.Core.AssetAdministrationShell.Generics.ISubmodel)"> |
Constantin Ziesche | 8b4a64d | 2020-06-25 11:52:09 +0200 | [diff] [blame] | 302 | <summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 303 | Creates or updates a Submodel at the repository service endpoint |
Constantin Ziesche | 8b4a64d | 2020-06-25 11:52:09 +0200 | [diff] [blame] | 304 | </summary> |
| 305 | <param name="submodel">The serialized Submodel object</param> |
| 306 | <returns></returns> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 307 | <response code="201">Submodel created/updated successfully</response> |
Constantin Ziesche | 8b4a64d | 2020-06-25 11:52:09 +0200 | [diff] [blame] | 308 | <response code="400">Bad Request</response> |
| 309 | <response code="502">Bad Gateway</response> |
| 310 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 311 | <member name="M:BaSyx.API.Http.Controllers.SubmodelRepositoryServices.DeleteSubmodelById(System.String)"> |
Constantin Ziesche | 8b4a64d | 2020-06-25 11:52:09 +0200 | [diff] [blame] | 312 | <summary> |
| 313 | Deletes a specific Submodel at the repository service endpoint |
| 314 | </summary> |
| 315 | <param name="submodelId">The Submodel's unique id</param> |
| 316 | <returns></returns> |
| 317 | <response code="200">Submodel deleted successfully</response> |
| 318 | <response code="400">Bad Request</response> |
| 319 | <response code="502">Bad Gateway</response> |
| 320 | </member> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 321 | <member name="T:BaSyx.API.Http.Controllers.SubmodelServices"> |
| 322 | <summary> |
| 323 | All Asset Administration Shell Services provided by the component |
| 324 | </summary> |
| 325 | </member> |
| 326 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetSubmodelAsTable(System.String)"> |
| 327 | <summary> |
| 328 | Retrieves a customizable table version of a Submodel |
| 329 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 330 | <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] | 331 | <returns></returns> |
| 332 | <response code="200">Success</response> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 333 | <response code="404">Submodel not found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 334 | </member> |
| 335 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetMinimizedSubmodel"> |
| 336 | <summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 337 | 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] | 338 | </summary> |
| 339 | <returns></returns> |
| 340 | <response code="200">Success</response> |
| 341 | <response code="404">Submodel not found</response> |
| 342 | </member> |
| 343 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetSubmodel"> |
| 344 | <summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 345 | Retrieves the entire Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 346 | </summary> |
| 347 | <returns></returns> |
| 348 | <response code="200">Success</response> |
| 349 | <response code="404">Submodel not found</response> |
| 350 | </member> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 351 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetSubmodelElements"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 352 | <summary> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 353 | Retrieves all SubmodelElements from the current Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 354 | </summary> |
| 355 | <returns></returns> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 356 | <response code="200">Returns a list of found SubmodelElements</response> |
| 357 | <response code="404">Submodel not found / No SubmodelElements found</response> |
| 358 | </member> |
| 359 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetProperties"> |
| 360 | <summary> |
| 361 | Retrieves all Properties from the current Submodel |
| 362 | </summary> |
| 363 | <returns></returns> |
| 364 | <response code="200">Returns a list of found Properties</response> |
| 365 | <response code="404">Submodel not found / No Properties found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 366 | </member> |
| 367 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetOperations"> |
| 368 | <summary> |
| 369 | Retrieves all Operations from the current Submodel |
| 370 | </summary> |
| 371 | <returns></returns> |
| 372 | <response code="200">Success</response> |
| 373 | <response code="404">Submodel not found / No Operations found</response> |
| 374 | </member> |
| 375 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetEvents"> |
| 376 | <summary> |
| 377 | Retrieves all Events from the current Submodel |
| 378 | </summary> |
| 379 | <returns></returns> |
| 380 | <response code="200">Success</response> |
| 381 | <response code="404">Submodel not found / No Events found</response> |
| 382 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 383 | <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] | 384 | <summary> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 385 | Adds a new Submodel Element to the Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 386 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 387 | <param name="submodelElement">The serialized Submodel Element object</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 388 | <returns></returns> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 389 | <response code="201">Submodel Element created successfully</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 390 | <response code="400">Bad Request</response> |
| 391 | <response code="404">Submodel not found</response> |
| 392 | </member> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 393 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetSubmodelElementByIdShort(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 394 | <summary> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 395 | Retrieves a specific Submodel Element from the Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 396 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 397 | <param name="submodelElementIdShort">The Submodel Element's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 398 | <returns></returns> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 399 | <response code="200">Returns the requested Submodel Element</response> |
| 400 | <response code="404">Submodel/Submodel Element not found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 401 | </member> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 402 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.DeleteSubmodelElementByIdShort(System.String)"> |
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 | Deletes a specific Submodel Element 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="submodelElementIdShort">The Submodel Element's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 407 | <returns></returns> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 408 | <response code="204">Submodel Element deleted successfully</response> |
| 409 | <response code="404">Submodel/Submodel Element not found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 410 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 411 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.PutProperty(BaSyx.Models.Core.AssetAdministrationShell.Generics.SubmodelElementTypes.IProperty)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 412 | <summary> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 413 | Adds a new Property to the Asset Administration Shell's Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 414 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 415 | <param name="property">The serialized Property object</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 416 | <returns></returns> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 417 | <response code="201">Property created successfully</response> |
| 418 | <response code="400">Bad Request</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 419 | <response code="404">Submodel not found</response> |
| 420 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 421 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetPropertyByIdShort(System.String)"> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 422 | <summary> |
| 423 | Retrieves a specific Property from the Asset Administrations's Submodel |
| 424 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 425 | <param name="propertyIdShort">The Property's short id</param> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 426 | <returns></returns> |
| 427 | <response code="200">Returns the requested Property</response> |
| 428 | <response code="404">Submodel/Property not found</response> |
| 429 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 430 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetPropertyValueByIdShort(System.String)"> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 431 | <summary> |
| 432 | Retrieves the value of a specific Property from the Asset Administrations Shell's Submodel |
| 433 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 434 | <param name="propertyIdShort">The Property's short id</param> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 435 | <returns></returns> |
| 436 | <response code="200">Returns the requested Property's value</response> |
| 437 | <response code="404">Submodel/Property not found</response> |
| 438 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 439 | <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] | 440 | <summary> |
| 441 | Updates the Asset Administration Shell's Submodel's Property |
| 442 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 443 | <param name="propertyIdShort">The Property's short id</param> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 444 | <param name="value">The new value</param> |
| 445 | <returns></returns> |
| 446 | <response code="200">Property's value changed successfully</response> |
| 447 | <response code="404">Submodel/Property not found</response> |
| 448 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 449 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.DeletePropertyByIdShort(System.String)"> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 450 | <summary> |
| 451 | Deletes a specific Property from the Asset Administration Shell's Submodel |
| 452 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 453 | <param name="propertyIdShort">The Property's short id</param> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 454 | <returns></returns> |
| 455 | <response code="204">Property deleted successfully</response> |
| 456 | <response code="404">Submodel not found</response> |
| 457 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 458 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.PutOperation(BaSyx.Models.Core.AssetAdministrationShell.Generics.SubmodelElementTypes.IOperation)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 459 | <summary> |
| 460 | Adds a new operation to the Asset Administraiton Shell's Submodel |
| 461 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 462 | <param name="operation">The serialized Operation object</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 463 | <returns></returns> |
| 464 | <response code="201">Operation created successfully</response> |
| 465 | <response code="400">Bad Request</response> |
| 466 | <response code="404">Submodel not found</response> |
| 467 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 468 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetOperationByIdShort(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 469 | <summary> |
| 470 | Retrieves a specific Operation from the Asset Administration Shell's Submodel |
| 471 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 472 | <param name="operationIdShort">The Operation's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 473 | <returns></returns> |
| 474 | <response code="200">Success</response> |
| 475 | <response code="404">Submodel/Operation not found</response> |
| 476 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 477 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.DeleteOperationByIdShort(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 478 | <summary> |
| 479 | Deletes a specific Operation from the Asset Administration Shell's Submodel |
| 480 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 481 | <param name="operationIdShort">The Operation's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 482 | <returns></returns> |
| 483 | <response code="204">Operation deleted successfully</response> |
| 484 | <response code="404">Submodel not found</response> |
| 485 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 486 | <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] | 487 | <summary> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 488 | Synchronously invokes a specific operation from the Submodel |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 489 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 490 | <param name="operationIdShort">The Operation's short id</param> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 491 | <param name="invocationRequest">The parameterized request object for the invocation</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 492 | <returns></returns> |
| 493 | <response code="200">Operation invoked successfully</response> |
| 494 | <response code="400">Bad Request</response> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 495 | <response code="404">Submodel / Method handler not found</response> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 496 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 497 | <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] | 498 | <summary> |
| 499 | Asynchronously invokes a specific operation from the Submodel |
| 500 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 501 | <param name="operationIdShort">The Operation's short id</param> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 502 | <param name="invocationRequest">The parameterized request object for the invocation</param> |
| 503 | <returns></returns> |
| 504 | <response code="200">Operation invoked successfully</response> |
| 505 | <response code="400">Bad Request</response> |
| 506 | <response code="404">Submodel / Method handler not found</response> |
| 507 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 508 | <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] | 509 | <summary> |
| 510 | Retrieves the result of an asynchronously started operation |
| 511 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 512 | <param name="operationIdShort">The Operation's short id</param> |
Constantin Ziesche | fa61208 | 2020-04-03 09:54:56 +0200 | [diff] [blame] | 513 | <param name="requestId">The request id</param> |
| 514 | <returns></returns> |
| 515 | <response code="200">Result found</response> |
| 516 | <response code="400">Bad Request</response> |
| 517 | <response code="404">Submodel / Operation / Request not found</response> |
| 518 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 519 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.PutEvent(BaSyx.Models.Core.AssetAdministrationShell.Generics.SubmodelElementTypes.IEvent)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 520 | <summary> |
| 521 | Adds a new event to the Asset Administration Shell's Submodel |
| 522 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 523 | <param name="eventable">The serialized Event object</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 524 | <returns></returns> |
| 525 | <response code="201">Event created successfully</response> |
| 526 | <response code="400">Bad Request</response> |
| 527 | <response code="404">Submodel not found</response> |
| 528 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 529 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetEventByIdShort(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 530 | <summary> |
| 531 | Retrieves a specific event from the Asset Administration Shell's Submodel |
| 532 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 533 | <param name="eventIdShort">The Event's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 534 | <returns></returns> |
| 535 | <response code="200">Success</response> |
| 536 | <response code="404">Submodel/Event not found</response> |
| 537 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 538 | <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.DeleteEventByIdShort(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 539 | <summary> |
| 540 | Deletes a specific event from the Asset Administration Shell's Submodel |
| 541 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 542 | <param name="eventIdShort">The Event's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 543 | <returns></returns> |
| 544 | <response code="204">Event deleted successfully</response> |
| 545 | <response code="404">Submodel not found</response> |
| 546 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 547 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.GetAssetAdministrationShellDescriptors"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 548 | <summary> |
| 549 | Retrieves all registered Asset Administration Shells within a defined system (e.g. site, area, production line, station) |
| 550 | </summary> |
| 551 | <returns></returns> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 552 | <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] | 553 | <response code="400">Bad Request</response> |
| 554 | <response code="502">Bad Gateway</response> |
| 555 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 556 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.GetAssetAdministrationShellDescriptor(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 557 | <summary> |
| 558 | Retrieves a specific Asset Administration Shell |
| 559 | </summary> |
| 560 | <param name="aasId">The Asset Administration Shell's unique id</param> |
| 561 | <returns></returns> |
| 562 | <response code="200">Returns the requested Asset Administration Shell</response> |
| 563 | <response code="400">Bad Request</response> |
| 564 | <response code="404">No Asset Administration Shell with passed id found</response> |
| 565 | <response code="502">Bad Gateway</response> |
| 566 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 567 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.RenewAssetAdministrationShellRegistration(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 568 | <summary> |
| 569 | Renews a specific Asset Administration Shell's registration |
| 570 | </summary> |
| 571 | <param name="aasId">The Asset Administration Shell's unique id</param> |
| 572 | <returns></returns> |
| 573 | <response code="200">The Asset Administration Shell's registration was successfully renewed</response> |
| 574 | <response code="400">The syntax of the passed Asset Administration Shell is not valid or malformed request</response> |
| 575 | <response code="404">No Asset Administration Shell with passed id found</response> |
| 576 | <response code="502">Bad Gateway</response> |
| 577 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 578 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.RegisterAssetAdministrationShell(BaSyx.Models.Connectivity.Descriptors.IAssetAdministrationShellDescriptor)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 579 | <summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 580 | Registers a new Asset Administration Shell at the registry |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 581 | </summary> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 582 | <param name="aasDescriptor">The Asset Administration Shell descriptor object</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 583 | <returns></returns> |
| 584 | <response code="201">The Asset Administration Shell was created successfully</response> |
| 585 | <response code="400">The syntax of the passed Asset Administration Shell is not valid or malformed request</response> |
| 586 | <response code="422">The passed Asset Administration Shell conflicts with already registered Asset Administration Shells</response> |
| 587 | <response code="502">Bad Gateway</response> |
| 588 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 589 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.DeleteAssetAdministrationShellRegistration(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 590 | <summary> |
| 591 | Deletes a specific Asset Administration Shell |
| 592 | </summary> |
| 593 | <param name="aasId">The Asset Administration Shell's unique id</param> |
| 594 | <returns></returns> |
| 595 | <response code="200">The Asset Administration Shell was deleted successfully</response> |
| 596 | <response code="400">Bad Request</response> |
| 597 | <response code="404">No Asset Administration Shell with passed id found</response> |
| 598 | <response code="502">Bad Gateway</response> |
| 599 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 600 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.RegisterSubmodelAtAssetAdministrationShell(System.String,BaSyx.Models.Connectivity.Descriptors.ISubmodelDescriptor)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 601 | <summary> |
| 602 | Adds a new Submodel to an existing resp. registered Asset Administration Shell |
| 603 | </summary> |
| 604 | <param name="aasId">The Asset Administration Shell's unique id</param> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 605 | <param name="submodelDescriptor">The Submodel descriptor object</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 606 | <returns></returns> |
| 607 | <response code="201">The Submodel was created successfully</response> |
| 608 | <response code="400">The syntax of the passed Submodel is not valid or malformed request</response> |
| 609 | <response code="404">No Asset Administration Shell with passed id found</response> |
| 610 | <response code="422">The passed Submodel conflicts with already registered Submodels</response> |
| 611 | <response code="502">Bad Gateway</response> |
| 612 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 613 | <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] | 614 | <summary> |
| 615 | Retrieves a specific Submodel from a specific Asset Administration Shell |
| 616 | </summary> |
| 617 | <param name="aasId">The Asset Administration Shell's unique id</param> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 618 | <param name="submodelIdShort">The Submodel's short id</param> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 619 | <returns></returns> |
| 620 | <response code="200">Returns the requested Submodels</response> |
| 621 | <response code="400">Bad Request</response> |
| 622 | <response code="404">No Asset Administration Shell / Submodel with passed id found</response> |
| 623 | <response code="502">Bad Gateway</response> |
| 624 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 625 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.DeleteSubmodelFromAssetAdministrationShell(System.String,System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 626 | <summary> |
| 627 | Deletes a specific Submodel from a specific Asset Administration Shell |
| 628 | </summary> |
| 629 | <param name="aasId">The Asset Administration Shell's unique id</param> |
| 630 | <param name="submodelIdShort">The Submodel's short id (idShort)</param> |
| 631 | <returns></returns> |
| 632 | <response code="200">The Submodel was deleted successfully</response> |
| 633 | <response code="400">Bad Request</response> |
| 634 | <response code="404">No Asset Administration Shell / Submodel with passed id found</response> |
| 635 | <response code="502">Bad Gateway</response> |
| 636 | </member> |
Constantin Ziesche | 02817f1 | 2020-08-04 21:40:43 +0200 | [diff] [blame^] | 637 | <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.GetAllSubmodelDescriptorsFromAssetAdministrationShell(System.String)"> |
Constantin Ziesche | 857c7ab | 2020-02-25 11:24:51 +0100 | [diff] [blame] | 638 | <summary> |
| 639 | Retrieves all Submodels from a specific Asset Administration Shell |
| 640 | </summary> |
| 641 | <param name="aasId">The Asset Administration Shell's unique id</param> |
| 642 | <returns></returns> |
| 643 | <response code="200">Returns a list of found Submodels</response> |
| 644 | <response code="400">Bad Request</response> |
| 645 | <response code="404">No Asset Administration Shell with passed id found</response> |
| 646 | <response code="502">Bad Gateway</response> |
| 647 | </member> |
| 648 | </members> |
| 649 | </doc> |