blob: 6199a8395845db65be5db3a584219c5282571712 [file] [log] [blame]
Constantin Ziesche857c7ab2020-02-25 11:24:51 +01001<?xml version="1.0"?>
2<doc>
3 <assembly>
4 <name>BaSyx.API.Http.Controllers</name>
5 </assembly>
6 <members>
Constantin Ziesche8b4a64d2020-06-25 11:52:09 +02007 <member name="T:BaSyx.API.Http.Controllers.AssetAdministrationShellRepositoryServices">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +01008 <summary>
Constantin Ziesche8b4a64d2020-06-25 11:52:09 +02009 The Asset Administration Shell Repository Controller
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010010 </summary>
11 </member>
Constantin Ziesche02817f12020-08-04 21:40:43 +020012 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRepositoryServices.GetAllAssetAdministrationShells">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010013 <summary>
Constantin Ziesche8b4a64d2020-06-25 11:52:09 +020014 Retrieves all Asset Administration Shells from the repository service endpoint
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010015 </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 Ziesche02817f12020-08-04 21:40:43 +020022 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRepositoryServices.GetAssetAdministrationShellById(System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010023 <summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +020024 Retrieves a specific Asset Administration Shell from the repository service endpoint
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010025 </summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +020026 <param name="aasId">The Asset Administration Shell's unique id</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010027 <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 Ziesche02817f12020-08-04 21:40:43 +020033 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRepositoryServices.PutAssetAdministrationShell(BaSyx.Models.Core.AssetAdministrationShell.Generics.IAssetAdministrationShell)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010034 <summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +020035 Creates or updates a Asset Administration Shell at the repository service endpoint
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010036 </summary>
Constantin Zieschefa612082020-04-03 09:54:56 +020037 <param name="aas">The serialized Asset Administration Shell object</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010038 <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 Ziesche02817f12020-08-04 21:40:43 +020043 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRepositoryServices.DeleteAssetAdministrationShellById(System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010044 <summary>
Constantin Ziesche8b4a64d2020-06-25 11:52:09 +020045 Deletes a specific Asset Administration Shell at the repository service endpoint
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010046 </summary>
Constantin Zieschefa612082020-04-03 09:54:56 +020047 <param name="aasId">The Asset Administration Shell's unique id</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010048 <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 Zieschee837f992020-08-19 12:04:32 +020058 <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 Ziesche02817f12020-08-04 21:40:43 +020064 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.GetAssetAdministrationShell">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010065 <summary>
Constantin Zieschee837f992020-08-19 12:04:32 +020066 Retrieves the Asset Administration Shell Descriptor
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010067 </summary>
68 <returns></returns>
Constantin Zieschee837f992020-08-19 12:04:32 +020069 <response code="200">Success</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010070 </member>
Constantin Ziescheb4a60112020-08-05 12:08:10 +020071 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.PutSubmodelToShell(BaSyx.Models.Core.AssetAdministrationShell.Generics.ISubmodel)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010072 <summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +020073 Creates or updates a Submodel to an existing Asset Administration Shell
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010074 </summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +020075 <param name="submodel">The serialized Submodel object</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010076 <returns></returns>
77 <response code="201">Submodel created successfully</response>
78 <response code="400">Bad Request</response>
79 </member>
Constantin Ziescheb4a60112020-08-05 12:08:10 +020080 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.GetSubmodelFromShellByIdShort(System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010081 <summary>
82 Retrieves the Submodel from the Asset Administration Shell
83 </summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +020084 <param name="submodelIdShort">The Submodel's short id</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010085 <returns></returns>
86 <response code="200">Submodel retrieved successfully</response>
87 <response code="404">No Submodel Service Provider found</response>
88 </member>
Constantin Ziescheb4a60112020-08-05 12:08:10 +020089 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.DeleteSubmodelFromShellByIdShort(System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010090 <summary>
91 Deletes a specific Submodel from the Asset Administration Shell
92 </summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +020093 <param name="submodelIdShort">The Submodel's short id</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010094 <returns></returns>
95 <response code="204">Submodel deleted successfully</response>
96 <response code="400">Bad Request</response>
97 </member>
Constantin Ziescheb4a60112020-08-05 12:08:10 +020098 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.GetSubmodelsFromShell">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010099 <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 Ziesche02817f12020-08-04 21:40:43 +0200106 <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 Zieschefa612082020-04-03 09:54:56 +0200114 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetProperties">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100115 <summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200116 Retrieves all Properties from the Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100117 </summary>
118 <returns></returns>
Constantin Zieschefa612082020-04-03 09:54:56 +0200119 <response code="200">Returns a list of found Properties</response>
120 <response code="404">Submodel not found / No Properties found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100121 </member>
122 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetOperations">
123 <summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200124 Retrieves all Operations from the Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100125 </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 Ziesche02817f12020-08-04 21:40:43 +0200132 Retrieves all Events from the Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100133 </summary>
134 <returns></returns>
135 <response code="200">Success</response>
136 <response code="404">Submodel not found / No Events found</response>
137 </member>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200138 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedPutSubmodelElement(BaSyx.Models.Core.AssetAdministrationShell.Generics.ISubmodelElement)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100139 <summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200140 Creates or updates a Submodel-Element to the Asset Administration Shell's Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100141 </summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200142 <param name="submodelElement">The serialized Submodel Element object</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100143 <returns></returns>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200144 <response code="201">Submodel-Element created successfully</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100145 <response code="400">Bad Request</response>
146 <response code="404">Submodel not found</response>
147 </member>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200148 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetSubmodelElementByIdShort(System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100149 <summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200150 Retrieves a specific Submodel-Element from the Asset Administrations's Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100151 </summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200152 <param name="submodelElementIdShort">The Submodel-Element's short id</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100153 <returns></returns>
Constantin Zieschee837f992020-08-19 12:04:32 +0200154 <response code="200">Returns the requested Submodel-Element</response>
155 <response code="404">Submodel / Submodel-Element not found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100156 </member>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200157 <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 Ziesche7b6d4792020-08-18 17:15:11 +0200163 <response code="204">Submodel-Element deleted successfully</response>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200164 <response code="404">Submodel not found</response>
165 </member>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200166 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetPropertyByIdShort(System.String)">
167 <summary>
Constantin Zieschee837f992020-08-19 12:04:32 +0200168 Retrieves a specific Property from the Asset Administration Shell's Submodel
Constantin Ziesche02817f12020-08-04 21:40:43 +0200169 </summary>
170 <param name="propertyIdShort">The Property's short id</param>
171 <returns></returns>
172 <response code="200">Returns the requested Property</response>
Constantin Zieschee837f992020-08-19 12:04:32 +0200173 <response code="404">Submodel / Property not found</response>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200174 </member>
175 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetPropertyValueByIdShort(System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100176 <summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200177 Retrieves the value of a specific Property from the Asset Administrations Shell's Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100178 </summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200179 <param name="propertyIdShort">The Property's short id</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100180 <returns></returns>
Constantin Zieschefa612082020-04-03 09:54:56 +0200181 <response code="200">Returns the requested Property's value</response>
Constantin Zieschee837f992020-08-19 12:04:32 +0200182 <response code="404">Submodel / Property not found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100183 </member>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200184 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedPutPropertyValueByIdShort(System.String,BaSyx.Models.Core.Common.IValue)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100185 <summary>
Constantin Zieschee837f992020-08-19 12:04:32 +0200186 Updates the Asset Administration Shell's Submodel's Property's value
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100187 </summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200188 <param name="propertyIdShort">The Property's short id</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100189 <param name="value">The new value</param>
190 <returns></returns>
Constantin Zieschefa612082020-04-03 09:54:56 +0200191 <response code="200">Property's value changed successfully</response>
192 <response code="404">Submodel/Property not found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100193 </member>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200194 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetOperationByIdShort(System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100195 <summary>
196 Retrieves a specific Operation from the Asset Administration Shell's Submodel
197 </summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200198 <param name="operationIdShort">The Operation's short id</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100199 <returns></returns>
200 <response code="200">Success</response>
Constantin Zieschee837f992020-08-19 12:04:32 +0200201 <response code="404">Submodel / Operation not found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100202 </member>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200203 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedInvokeOperationByIdShort(System.String,BaSyx.Models.Communication.InvocationRequest)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100204 <summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200205 Synchronously invokes a specific operation from the Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100206 </summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200207 <param name="operationIdShort">The Operation's short id</param>
Constantin Zieschefa612082020-04-03 09:54:56 +0200208 <param name="invocationRequest">The parameterized request object for the invocation</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100209 <returns></returns>
210 <response code="200">Operation invoked successfully</response>
211 <response code="400">Bad Request</response>
Constantin Zieschefa612082020-04-03 09:54:56 +0200212 <response code="404">Submodel / Method handler not found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100213 </member>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200214 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetEventByIdShort(System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100215 <summary>
216 Retrieves a specific event from the Asset Administration Shell's Submodel
217 </summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200218 <param name="eventIdShort">The Event's short id</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100219 <returns></returns>
220 <response code="200">Success</response>
221 <response code="404">Submodel/Event not found</response>
222 </member>
Constantin Ziesche8b4a64d2020-06-25 11:52:09 +0200223 <member name="T:BaSyx.API.Http.Controllers.SubmodelRepositoryServices">
224 <summary>
225 The Submodel Repository Controller
226 </summary>
227 </member>
Constantin Ziescheb4a60112020-08-05 12:08:10 +0200228 <member name="M:BaSyx.API.Http.Controllers.SubmodelRepositoryServices.GetAllSubmodelsFromRepo">
Constantin Ziesche8b4a64d2020-06-25 11:52:09 +0200229 <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 Ziescheb4a60112020-08-05 12:08:10 +0200238 <member name="M:BaSyx.API.Http.Controllers.SubmodelRepositoryServices.RetrieveSubmodelFromRepoById(System.String)">
Constantin Ziesche8b4a64d2020-06-25 11:52:09 +0200239 <summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200240 Retrieves a specific Submodel from the repository service endpoint
Constantin Ziesche8b4a64d2020-06-25 11:52:09 +0200241 </summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200242 <param name="submodelId">The Submodel's unique id</param>
Constantin Ziesche8b4a64d2020-06-25 11:52:09 +0200243 <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 Ziescheb4a60112020-08-05 12:08:10 +0200249 <member name="M:BaSyx.API.Http.Controllers.SubmodelRepositoryServices.PutSubmodelToRepo(BaSyx.Models.Core.AssetAdministrationShell.Generics.ISubmodel)">
Constantin Ziesche8b4a64d2020-06-25 11:52:09 +0200250 <summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200251 Creates or updates a Submodel at the repository service endpoint
Constantin Ziesche8b4a64d2020-06-25 11:52:09 +0200252 </summary>
253 <param name="submodel">The serialized Submodel object</param>
254 <returns></returns>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200255 <response code="201">Submodel created/updated successfully</response>
Constantin Ziesche8b4a64d2020-06-25 11:52:09 +0200256 <response code="400">Bad Request</response>
257 <response code="502">Bad Gateway</response>
258 </member>
Constantin Ziescheb4a60112020-08-05 12:08:10 +0200259 <member name="M:BaSyx.API.Http.Controllers.SubmodelRepositoryServices.DeleteSubmodelFromRepoById(System.String)">
Constantin Ziesche8b4a64d2020-06-25 11:52:09 +0200260 <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 Ziesche857c7ab2020-02-25 11:24:51 +0100269 <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 Zieschee837f992020-08-19 12:04:32 +0200274 <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 Ziesche857c7ab2020-02-25 11:24:51 +0100280 <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 Ziesche02817f12020-08-04 21:40:43 +0200284 <param name="columns">A comma-separated list of field names to structure the payload beeing returned</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100285 <returns></returns>
286 <response code="200">Success</response>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200287 <response code="404">Submodel not found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100288 </member>
289 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetMinimizedSubmodel">
290 <summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200291 Retrieves the minimized version of a Submodel, i.e. only the values of SubmodelElements are serialized and returned
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100292 </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 Ziesche02817f12020-08-04 21:40:43 +0200299 Retrieves the entire Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100300 </summary>
301 <returns></returns>
302 <response code="200">Success</response>
303 <response code="404">Submodel not found</response>
304 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +0200305 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetSubmodelElements">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100306 <summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200307 Retrieves all SubmodelElements from the current Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100308 </summary>
309 <returns></returns>
Constantin Zieschefa612082020-04-03 09:54:56 +0200310 <response code="200">Returns a list of found SubmodelElements</response>
Constantin Zieschee837f992020-08-19 12:04:32 +0200311 <response code="404">Submodel not found</response>
Constantin Zieschefa612082020-04-03 09:54:56 +0200312 </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 Zieschee837f992020-08-19 12:04:32 +0200319 <response code="404">Submodel not found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100320 </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 Zieschee837f992020-08-19 12:04:32 +0200327 <response code="404">Submodel not found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100328 </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 Zieschee837f992020-08-19 12:04:32 +0200335 <response code="404">Submodel not found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100336 </member>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200337 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.PutSubmodelElement(BaSyx.Models.Core.AssetAdministrationShell.Generics.ISubmodelElement)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100338 <summary>
Constantin Zieschee837f992020-08-19 12:04:32 +0200339 Adds a new Submodel-Element to the Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100340 </summary>
Constantin Zieschee837f992020-08-19 12:04:32 +0200341 <param name="submodelElement">The Submodel-Element object</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100342 <returns></returns>
Constantin Zieschefa612082020-04-03 09:54:56 +0200343 <response code="201">Submodel Element created successfully</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100344 <response code="400">Bad Request</response>
345 <response code="404">Submodel not found</response>
346 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +0200347 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetSubmodelElementByIdShort(System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100348 <summary>
Constantin Zieschee837f992020-08-19 12:04:32 +0200349 Retrieves a specific Submodel-Element from the Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100350 </summary>
Constantin Zieschee837f992020-08-19 12:04:32 +0200351 <param name="submodelElementIdShort">The Submodel-Element's short id</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100352 <returns></returns>
Constantin Zieschee837f992020-08-19 12:04:32 +0200353 <response code="200">Returns the requested Submodel-Element</response>
354 <response code="404">Submodel / Submodel Element not found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100355 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +0200356 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.DeleteSubmodelElementByIdShort(System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100357 <summary>
Constantin Zieschee837f992020-08-19 12:04:32 +0200358 Deletes a specific Submodel-Element from the Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100359 </summary>
Constantin Zieschee837f992020-08-19 12:04:32 +0200360 <param name="submodelElementIdShort">The Submodel-Element's short id</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100361 <returns></returns>
Constantin Zieschee837f992020-08-19 12:04:32 +0200362 <response code="204">Submodel-Element deleted successfully</response>
363 <response code="404">Submodel / Submodel-Element not found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100364 </member>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200365 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetPropertyByIdShort(System.String)">
Constantin Zieschefa612082020-04-03 09:54:56 +0200366 <summary>
367 Retrieves a specific Property from the Asset Administrations's Submodel
368 </summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200369 <param name="propertyIdShort">The Property's short id</param>
Constantin Zieschefa612082020-04-03 09:54:56 +0200370 <returns></returns>
371 <response code="200">Returns the requested Property</response>
Constantin Zieschee837f992020-08-19 12:04:32 +0200372 <response code="404">Submodel / Property not found</response>
Constantin Zieschefa612082020-04-03 09:54:56 +0200373 </member>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200374 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetPropertyValueByIdShort(System.String)">
Constantin Zieschefa612082020-04-03 09:54:56 +0200375 <summary>
376 Retrieves the value of a specific Property from the Asset Administrations Shell's Submodel
377 </summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200378 <param name="propertyIdShort">The Property's short id</param>
Constantin Zieschefa612082020-04-03 09:54:56 +0200379 <returns></returns>
380 <response code="200">Returns the requested Property's value</response>
Constantin Zieschee837f992020-08-19 12:04:32 +0200381 <response code="404">Submodel / Property not found</response>
Constantin Zieschefa612082020-04-03 09:54:56 +0200382 </member>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200383 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.PutPropertyValueByIdShort(System.String,BaSyx.Models.Core.Common.IValue)">
Constantin Zieschefa612082020-04-03 09:54:56 +0200384 <summary>
385 Updates the Asset Administration Shell's Submodel's Property
386 </summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200387 <param name="propertyIdShort">The Property's short id</param>
Constantin Zieschefa612082020-04-03 09:54:56 +0200388 <param name="value">The new value</param>
389 <returns></returns>
390 <response code="200">Property's value changed successfully</response>
Constantin Zieschee837f992020-08-19 12:04:32 +0200391 <response code="404">Submodel / Property not found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100392 </member>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200393 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetOperationByIdShort(System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100394 <summary>
395 Retrieves a specific Operation from the Asset Administration Shell's Submodel
396 </summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200397 <param name="operationIdShort">The Operation's short id</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100398 <returns></returns>
399 <response code="200">Success</response>
Constantin Zieschee837f992020-08-19 12:04:32 +0200400 <response code="404">Submodel / Operation not found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100401 </member>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200402 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.InvokeOperationByIdShort(System.String,BaSyx.Models.Communication.InvocationRequest)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100403 <summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200404 Synchronously invokes a specific operation from the Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100405 </summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200406 <param name="operationIdShort">The Operation's short id</param>
Constantin Zieschefa612082020-04-03 09:54:56 +0200407 <param name="invocationRequest">The parameterized request object for the invocation</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100408 <returns></returns>
409 <response code="200">Operation invoked successfully</response>
410 <response code="400">Bad Request</response>
Constantin Zieschee837f992020-08-19 12:04:32 +0200411 <response code="404">Submodel / Operation not found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100412 </member>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200413 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.InvokeOperationByIdShortAsync(System.String,BaSyx.Models.Communication.InvocationRequest)">
Constantin Zieschefa612082020-04-03 09:54:56 +0200414 <summary>
415 Asynchronously invokes a specific operation from the Submodel
416 </summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200417 <param name="operationIdShort">The Operation's short id</param>
Constantin Zieschefa612082020-04-03 09:54:56 +0200418 <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 Ziesche02817f12020-08-04 21:40:43 +0200424 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetInvocationResultByIdShort(System.String,System.String)">
Constantin Zieschefa612082020-04-03 09:54:56 +0200425 <summary>
426 Retrieves the result of an asynchronously started operation
427 </summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200428 <param name="operationIdShort">The Operation's short id</param>
Constantin Zieschefa612082020-04-03 09:54:56 +0200429 <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 Ziesche02817f12020-08-04 21:40:43 +0200435 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetEventByIdShort(System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100436 <summary>
437 Retrieves a specific event from the Asset Administration Shell's Submodel
438 </summary>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200439 <param name="eventIdShort">The Event's short id</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100440 <returns></returns>
441 <response code="200">Success</response>
Constantin Zieschee837f992020-08-19 12:04:32 +0200442 <response code="404">Submodel / Event not found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100443 </member>
Constantin Ziesche7b6d4792020-08-18 17:15:11 +0200444 <member name="T:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100445 <summary>
Constantin Ziesche7b6d4792020-08-18 17:15:11 +0200446 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 Ziesche857c7ab2020-02-25 11:24:51 +0100458 </summary>
459 <returns></returns>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200460 <response code="200">Returns a list of found Asset Administration Shell Descriptors</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100461 </member>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200462 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.GetAssetAdministrationShellDescriptor(System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100463 <summary>
Constantin Ziesche7b6d4792020-08-18 17:15:11 +0200464 Retrieves a specific Asset Administration Shell registration
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100465 </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 Ziesche857c7ab2020-02-25 11:24:51 +0100471 </member>
Constantin Ziesche7b6d4792020-08-18 17:15:11 +0200472 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.RegisterAssetAdministrationShell(System.String,BaSyx.Models.Connectivity.Descriptors.IAssetAdministrationShellDescriptor)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100473 <summary>
Constantin Ziesche7b6d4792020-08-18 17:15:11 +0200474 Creates a new or updates an existing Asset Administration Shell registration at the Registry
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100475 </summary>
476 <param name="aasId">The Asset Administration Shell's unique id</param>
Constantin Ziesche7b6d4792020-08-18 17:15:11 +0200477 <param name="aasDescriptor">The Asset Administration Shell Descriptor</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100478 <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 Ziesche7b6d4792020-08-18 17:15:11 +0200481 <response code="404">No Asset Administration Shell with passed id found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100482 </member>
Constantin Ziesche7b6d4792020-08-18 17:15:11 +0200483 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.UnregisterAssetAdministrationShell(System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100484 <summary>
Constantin Ziesche7b6d4792020-08-18 17:15:11 +0200485 Deletes the Asset Administration Shell registration from the Registry
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100486 </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 Ziesche857c7ab2020-02-25 11:24:51 +0100492 </member>
Constantin Ziesche7b6d4792020-08-18 17:15:11 +0200493 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.RegisterSubmodelAtAssetAdministrationShell(System.String,System.String,BaSyx.Models.Connectivity.Descriptors.ISubmodelDescriptor)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100494 <summary>
Constantin Ziesche7b6d4792020-08-18 17:15:11 +0200495 Creates a new or updates an existing Submodel registration at a specific Asset Administration Shell registered at the Registry
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100496 </summary>
497 <param name="aasId">The Asset Administration Shell's unique id</param>
Constantin Ziesche7b6d4792020-08-18 17:15:11 +0200498 <param name="submodelId">The Submodel's unique id</param>
499 <param name="submodelDescriptor">The Submodel Descriptor</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100500 <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 Ziesche857c7ab2020-02-25 11:24:51 +0100504 </member>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200505 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.GetSubmodelDescriptorFromAssetAdministrationShell(System.String,System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100506 <summary>
Constantin Ziesche7b6d4792020-08-18 17:15:11 +0200507 Retrieves the Submodel registration from a specific Asset Administration Shell registered at the Registry
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100508 </summary>
509 <param name="aasId">The Asset Administration Shell's unique id</param>
Constantin Ziesche7b6d4792020-08-18 17:15:11 +0200510 <param name="submodelId">The Submodel's unique id</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100511 <returns></returns>
Constantin Ziesche7b6d4792020-08-18 17:15:11 +0200512 <response code="200">Returns the requested Submodels Descriptor</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100513 <response code="400">Bad Request</response>
514 <response code="404">No Asset Administration Shell / Submodel with passed id found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100515 </member>
Constantin Ziesche7b6d4792020-08-18 17:15:11 +0200516 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.DeleteSubmodelDescriptorFromAssetAdministrationShell(System.String,System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100517 <summary>
Constantin Ziesche7b6d4792020-08-18 17:15:11 +0200518 Unregisters the Submodel from a specific Asset Administration Shell registered at the Registry
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100519 </summary>
520 <param name="aasId">The Asset Administration Shell's unique id</param>
Constantin Ziesche7b6d4792020-08-18 17:15:11 +0200521 <param name="submodelId">The Submodel's unique id</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100522 <returns></returns>
Constantin Ziesche7b6d4792020-08-18 17:15:11 +0200523 <response code="200">The Submodel Descriptor was successfully unregistered</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100524 <response code="400">Bad Request</response>
525 <response code="404">No Asset Administration Shell / Submodel with passed id found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100526 </member>
Constantin Ziesche02817f12020-08-04 21:40:43 +0200527 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.GetAllSubmodelDescriptorsFromAssetAdministrationShell(System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100528 <summary>
Constantin Ziesche7b6d4792020-08-18 17:15:11 +0200529 Retrieves all Submodel registrations from a specific Asset Administration Shell registered at the Registry
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100530 </summary>
531 <param name="aasId">The Asset Administration Shell's unique id</param>
532 <returns></returns>
Constantin Ziesche7b6d4792020-08-18 17:15:11 +0200533 <response code="200">Returns a list of found Submodels Descriptors</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100534 <response code="400">Bad Request</response>
535 <response code="404">No Asset Administration Shell with passed id found</response>
Constantin Ziesche7b6d4792020-08-18 17:15:11 +0200536 </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 Ziesche857c7ab2020-02-25 11:24:51 +0100566 </member>
Constantin Zieschee837f992020-08-19 12:04:32 +0200567 <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 Ziesche857c7ab2020-02-25 11:24:51 +0100618 </members>
619</doc>