blob: bb52cf94243ccb370358ff08c027ea6a23e48dae [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>
7 <member name="T:BaSyx.API.Http.Controllers.AssetAdministrationShellAggregatorServices">
8 <summary>
Constantin Zieschefa612082020-04-03 09:54:56 +02009 The Asset Administration Shell Aggregator Controller
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010010 </summary>
11 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +020012 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellAggregatorServices.RetrieveAllAssetAdministrationShells">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010013 <summary>
Constantin Zieschefa612082020-04-03 09:54:56 +020014 Retrieves all Asset Administration Shells from the aggregator 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 Zieschefa612082020-04-03 09:54:56 +020022 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellAggregatorServices.RetrieveAssetAdministrationShellByIdShort(System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010023 <summary>
Constantin Zieschefa612082020-04-03 09:54:56 +020024 Retrieves a specific Asset Administration Shell from the aggregator service endpint
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010025 </summary>
Constantin Zieschefa612082020-04-03 09:54:56 +020026 <param name="aasId">The Asset Administration Shell's short 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 Zieschefa612082020-04-03 09:54:56 +020033 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellAggregatorServices.UpdateAssetAdministrationShellByIdShort(System.String,BaSyx.Models.Core.AssetAdministrationShell.Generics.IAssetAdministrationShell)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010034 <summary>
Constantin Zieschefa612082020-04-03 09:54:56 +020035 Updates a specific Asset Administration Shell at the aggregator service endpint
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010036 </summary>
Constantin Zieschefa612082020-04-03 09:54:56 +020037 <param name="aasId">The Asset Administration Shell's unique id</param>
38 <param name="aas">The updated Asset Administration Shell</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010039 <returns></returns>
40 <response code="200">Asset Administration Shell updated successfully</response>
41 <response code="400">Bad Request</response>
42 <response code="502">Bad Gateway</response>
43 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +020044 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellAggregatorServices.CreateNewAssetAdministrationShell(BaSyx.Models.Core.AssetAdministrationShell.Generics.IAssetAdministrationShell)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010045 <summary>
Constantin Zieschefa612082020-04-03 09:54:56 +020046 Creates a new Asset Administration Shell at the aggregator service endpoint
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010047 </summary>
Constantin Zieschefa612082020-04-03 09:54:56 +020048 <param name="aas">The serialized Asset Administration Shell object</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010049 <returns></returns>
50 <response code="201">Asset Administration Shell created successfully</response>
51 <response code="400">Bad Request</response>
52 <response code="502">Bad Gateway</response>
53 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +020054 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellAggregatorServices.DeleteAssetAdministrationShellByIdShort(System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010055 <summary>
Constantin Zieschefa612082020-04-03 09:54:56 +020056 Deletes a specific Asset Administration Shell at the aggregator service endpoint
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010057 </summary>
Constantin Zieschefa612082020-04-03 09:54:56 +020058 <param name="aasId">The Asset Administration Shell's unique id</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +010059 <returns></returns>
60 <response code="200">Asset Administration Shell deleted successfully</response>
61 <response code="400">Bad Request</response>
62 <response code="502">Bad Gateway</response>
63 </member>
64 <member name="T:BaSyx.API.Http.Controllers.AssetAdministrationShellServices">
65 <summary>
66 All Asset Administration Shell Services provided by the component
67 </summary>
68 </member>
69 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.GetAAS">
70 <summary>
71 Retrieves the Asset Administration Shell
72 </summary>
73 <returns></returns>
74 <response code="200">Success</response>
75 <response code="502">Bad Gateway - Asset Administration Shell not available</response>
76 </member>
77 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.PostSubmodel(BaSyx.Models.Core.AssetAdministrationShell.Generics.ISubmodel)">
78 <summary>
79 Adds a new Submodel to an existing Asset Administration Shell
80 </summary>
81 <param name="submodel">The Submodel's description object</param>
82 <returns></returns>
83 <response code="201">Submodel created successfully</response>
84 <response code="400">Bad Request</response>
85 </member>
86 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.GetSubmodelById(System.String)">
87 <summary>
88 Retrieves the Submodel from the Asset Administration Shell
89 </summary>
90 <param name="submodelId">The Submodel's unique id</param>
91 <returns></returns>
92 <response code="200">Submodel retrieved successfully</response>
93 <response code="404">No Submodel Service Provider found</response>
94 </member>
95 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.DeleteSubmodelById(System.String)">
96 <summary>
97 Deletes a specific Submodel from the Asset Administration Shell
98 </summary>
99 <param name="submodelId">The Submodel's idShort</param>
100 <returns></returns>
101 <response code="204">Submodel deleted successfully</response>
102 <response code="400">Bad Request</response>
103 </member>
104 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.GetSubmodels">
105 <summary>
106 Retrieves all Submodels from the Asset Administration Shell
107 </summary>
108 <returns></returns>
109 <response code="200">Returns a list of found Submodels</response>
110 <response code="404">No Submodel Service Providers found</response>
111 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +0200112 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetProperties">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100113 <summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200114 Retrieves all Properties from the current Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100115 </summary>
116 <returns></returns>
Constantin Zieschefa612082020-04-03 09:54:56 +0200117 <response code="200">Returns a list of found Properties</response>
118 <response code="404">Submodel not found / No Properties found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100119 </member>
120 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetOperations">
121 <summary>
122 Retrieves all Operations from the current Submodel
123 </summary>
124 <returns></returns>
125 <response code="200">Success</response>
126 <response code="404">Submodel not found / No Operations found</response>
127 </member>
128 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetEvents">
129 <summary>
130 Retrieves all Events from the current Submodel
131 </summary>
132 <returns></returns>
133 <response code="200">Success</response>
134 <response code="404">Submodel not found / No Events found</response>
135 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +0200136 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedPostDataElement(BaSyx.Models.Core.AssetAdministrationShell.Generics.SubmodelElementTypes.IProperty)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100137 <summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200138 Adds a new Property to the Asset Administration Shell's Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100139 </summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200140 <param name="property">The Property's description object</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100141 <returns></returns>
142 <response code="201">DataElement created successfully</response>
143 <response code="400">Bad Request</response>
144 <response code="404">Submodel not found</response>
145 </member>
146 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetDataElement(System.String)">
147 <summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200148 Retrieves a specific Property from the Asset Administrations's Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100149 </summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200150 <param name="propertyId">The Property's short id</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100151 <returns></returns>
Constantin Zieschefa612082020-04-03 09:54:56 +0200152 <response code="200">Returns the requested Property</response>
153 <response code="404">Submodel/Property not found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100154 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +0200155 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetPropertyValue(System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100156 <summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200157 Retrieves the value of a specific Property from the Asset Administrations Shell's Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100158 </summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200159 <param name="propertyId">The Property's short id</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100160 <returns></returns>
Constantin Zieschefa612082020-04-03 09:54:56 +0200161 <response code="200">Returns the requested Property's value</response>
162 <response code="404">Submodel/Property not found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100163 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +0200164 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedPutPropertyValue(System.String,BaSyx.Models.Core.Common.IValue)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100165 <summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200166 Updates the Asset Administration Shell's Submodel's Property
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100167 </summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200168 <param name="propertyId">The Property's short id</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100169 <param name="value">The new value</param>
170 <returns></returns>
Constantin Zieschefa612082020-04-03 09:54:56 +0200171 <response code="200">Property's value changed successfully</response>
172 <response code="404">Submodel/Property not found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100173 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +0200174 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedDelProperty(System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100175 <summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200176 Deletes a specific Property from the Asset Administration Shell's Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100177 </summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200178 <param name="propertyId">The Property's short id</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100179 <returns></returns>
Constantin Zieschefa612082020-04-03 09:54:56 +0200180 <response code="204">Property deleted successfully</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100181 <response code="404">Submodel not found</response>
182 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +0200183 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedPostOperation(BaSyx.Models.Core.AssetAdministrationShell.Generics.SubmodelElementTypes.IOperation)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100184 <summary>
185 Adds a new operation to the Asset Administraiton Shell's Submodel
186 </summary>
187 <param name="operation">The operation description object</param>
188 <returns></returns>
189 <response code="201">Operation created successfully</response>
190 <response code="400">Bad Request</response>
191 <response code="404">Submodel not found</response>
192 </member>
193 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetOperation(System.String)">
194 <summary>
195 Retrieves a specific Operation from the Asset Administration Shell's Submodel
196 </summary>
197 <param name="operationId">The Operation's short id</param>
198 <returns></returns>
199 <response code="200">Success</response>
200 <response code="404">Submodel/Operation not found</response>
201 </member>
202 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedDelOperation(System.String)">
203 <summary>
204 Deletes a specific Operation from the Asset Administration Shell's Submodel
205 </summary>
206 <param name="operationId">The Operation's short id</param>
207 <returns></returns>
208 <response code="204">Operation deleted successfully</response>
209 <response code="404">Submodel not found</response>
210 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +0200211 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedInvokeOperationRest(System.String,BaSyx.Models.Communication.InvocationRequest)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100212 <summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200213 Synchronously invokes a specific operation from the Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100214 </summary>
215 <param name="operationId">The operation's short id</param>
Constantin Zieschefa612082020-04-03 09:54:56 +0200216 <param name="invocationRequest">The parameterized request object for the invocation</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100217 <returns></returns>
218 <response code="200">Operation invoked successfully</response>
219 <response code="400">Bad Request</response>
Constantin Zieschefa612082020-04-03 09:54:56 +0200220 <response code="404">Submodel / Method handler not found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100221 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +0200222 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedPostEvent(BaSyx.Models.Core.AssetAdministrationShell.Generics.SubmodelElementTypes.IEvent)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100223 <summary>
224 Adds a new event to the Asset Administration Shell's Submodel
225 </summary>
226 <param name="eventable">The Event description object</param>
227 <returns></returns>
228 <response code="201">Event created successfully</response>
229 <response code="400">Bad Request</response>
230 <response code="404">Submodel not found</response>
231 </member>
232 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedGetEvent(System.String)">
233 <summary>
234 Retrieves a specific event from the Asset Administration Shell's Submodel
235 </summary>
236 <param name="eventId">The Event's short id</param>
237 <returns></returns>
238 <response code="200">Success</response>
239 <response code="404">Submodel/Event not found</response>
240 </member>
241 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellServices.RoutedDelEvent(System.String)">
242 <summary>
243 Deletes a specific event from the Asset Administration Shell's Submodel
244 </summary>
245 <param name="eventId">The Event's short id</param>
246 <returns></returns>
247 <response code="204">Event deleted successfully</response>
248 <response code="404">Submodel not found</response>
249 </member>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100250 <member name="T:BaSyx.API.Http.Controllers.SubmodelServices">
251 <summary>
252 All Asset Administration Shell Services provided by the component
253 </summary>
254 </member>
255 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetSubmodelAsTable(System.String)">
256 <summary>
257 Retrieves a customizable table version of a Submodel
258 </summary>
259 <returns></returns>
260 <response code="200">Success</response>
261 <response code="404">Submodel not found</response>
262 </member>
263 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetMinimizedSubmodel">
264 <summary>
265 Retrieves the minimized version of a Submodel
266 </summary>
267 <returns></returns>
268 <response code="200">Success</response>
269 <response code="404">Submodel not found</response>
270 </member>
271 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetSubmodel">
272 <summary>
273 Retrieves the Submodel
274 </summary>
275 <returns></returns>
276 <response code="200">Success</response>
277 <response code="404">Submodel not found</response>
278 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +0200279 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetSubmodelElements">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100280 <summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200281 Retrieves all SubmodelElements from the current Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100282 </summary>
283 <returns></returns>
Constantin Zieschefa612082020-04-03 09:54:56 +0200284 <response code="200">Returns a list of found SubmodelElements</response>
285 <response code="404">Submodel not found / No SubmodelElements found</response>
286 </member>
287 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetProperties">
288 <summary>
289 Retrieves all Properties from the current Submodel
290 </summary>
291 <returns></returns>
292 <response code="200">Returns a list of found Properties</response>
293 <response code="404">Submodel not found / No Properties found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100294 </member>
295 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetOperations">
296 <summary>
297 Retrieves all Operations from the current Submodel
298 </summary>
299 <returns></returns>
300 <response code="200">Success</response>
301 <response code="404">Submodel not found / No Operations found</response>
302 </member>
303 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetEvents">
304 <summary>
305 Retrieves all Events from the current Submodel
306 </summary>
307 <returns></returns>
308 <response code="200">Success</response>
309 <response code="404">Submodel not found / No Events found</response>
310 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +0200311 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.PostSubmodelElement(BaSyx.Models.Core.AssetAdministrationShell.Generics.ISubmodelElement)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100312 <summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200313 Adds a new Submodel Element to the Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100314 </summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200315 <param name="submodelElement">The Submodel Element's description object</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100316 <returns></returns>
Constantin Zieschefa612082020-04-03 09:54:56 +0200317 <response code="201">Submodel Element created successfully</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100318 <response code="400">Bad Request</response>
319 <response code="404">Submodel not found</response>
320 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +0200321 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetSubmodelElementByIdShort(System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100322 <summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200323 Retrieves a specific Submodel Element from the Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100324 </summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200325 <param name="submodelElementId">The Submodel Element's short id</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100326 <returns></returns>
Constantin Zieschefa612082020-04-03 09:54:56 +0200327 <response code="200">Returns the requested Submodel Element</response>
328 <response code="404">Submodel/Submodel Element not found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100329 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +0200330 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.DeleteSubmodelElementByIdShort(System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100331 <summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200332 Deletes a specific Submodel Element from the Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100333 </summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200334 <param name="submodelElementId">The Submodel Element's short id</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100335 <returns></returns>
Constantin Zieschefa612082020-04-03 09:54:56 +0200336 <response code="204">Submodel Element deleted successfully</response>
337 <response code="404">Submodel/Submodel Element not found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100338 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +0200339 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.PostProperty(BaSyx.Models.Core.AssetAdministrationShell.Generics.SubmodelElementTypes.IProperty)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100340 <summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200341 Adds a new Property to the Asset Administration Shell's Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100342 </summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200343 <param name="property">The Property's description object</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100344 <returns></returns>
Constantin Zieschefa612082020-04-03 09:54:56 +0200345 <response code="201">Property created successfully</response>
346 <response code="400">Bad Request</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100347 <response code="404">Submodel not found</response>
348 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +0200349 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetProperty(System.String)">
350 <summary>
351 Retrieves a specific Property from the Asset Administrations's Submodel
352 </summary>
353 <param name="propertyId">The Property's short id</param>
354 <returns></returns>
355 <response code="200">Returns the requested Property</response>
356 <response code="404">Submodel/Property not found</response>
357 </member>
358 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetPropertyValue(System.String)">
359 <summary>
360 Retrieves the value of a specific Property from the Asset Administrations Shell's Submodel
361 </summary>
362 <param name="propertyId">The Property's short id</param>
363 <returns></returns>
364 <response code="200">Returns the requested Property's value</response>
365 <response code="404">Submodel/Property not found</response>
366 </member>
367 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.PutPropertyValue(System.String,BaSyx.Models.Core.Common.IValue)">
368 <summary>
369 Updates the Asset Administration Shell's Submodel's Property
370 </summary>
371 <param name="propertyId">The Property's short id</param>
372 <param name="value">The new value</param>
373 <returns></returns>
374 <response code="200">Property's value changed successfully</response>
375 <response code="404">Submodel/Property not found</response>
376 </member>
377 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.DelProperty(System.String)">
378 <summary>
379 Deletes a specific Property from the Asset Administration Shell's Submodel
380 </summary>
381 <param name="propertyId">The Property's short id</param>
382 <returns></returns>
383 <response code="204">Property deleted successfully</response>
384 <response code="404">Submodel not found</response>
385 </member>
386 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.PostOperation(BaSyx.Models.Core.AssetAdministrationShell.Generics.SubmodelElementTypes.IOperation)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100387 <summary>
388 Adds a new operation to the Asset Administraiton Shell's Submodel
389 </summary>
390 <param name="operation">The operation description object</param>
391 <returns></returns>
392 <response code="201">Operation created successfully</response>
393 <response code="400">Bad Request</response>
394 <response code="404">Submodel not found</response>
395 </member>
396 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetOperation(System.String)">
397 <summary>
398 Retrieves a specific Operation from the Asset Administration Shell's Submodel
399 </summary>
400 <param name="operationId">The Operation's short id</param>
401 <returns></returns>
402 <response code="200">Success</response>
403 <response code="404">Submodel/Operation not found</response>
404 </member>
405 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.DelOperation(System.String)">
406 <summary>
407 Deletes a specific Operation from the Asset Administration Shell's Submodel
408 </summary>
409 <param name="operationId">The Operation's short id</param>
410 <returns></returns>
411 <response code="204">Operation deleted successfully</response>
412 <response code="404">Submodel not found</response>
413 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +0200414 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.InvokeOperationRest(System.String,BaSyx.Models.Communication.InvocationRequest)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100415 <summary>
Constantin Zieschefa612082020-04-03 09:54:56 +0200416 Synchronously invokes a specific operation from the Submodel
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100417 </summary>
418 <param name="operationId">The operation's short id</param>
Constantin Zieschefa612082020-04-03 09:54:56 +0200419 <param name="invocationRequest">The parameterized request object for the invocation</param>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100420 <returns></returns>
421 <response code="200">Operation invoked successfully</response>
422 <response code="400">Bad Request</response>
Constantin Zieschefa612082020-04-03 09:54:56 +0200423 <response code="404">Submodel / Method handler not found</response>
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100424 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +0200425 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.InvokeOperationRestAsync(System.String,BaSyx.Models.Communication.InvocationRequest)">
426 <summary>
427 Asynchronously invokes a specific operation from the Submodel
428 </summary>
429 <param name="operationId">The operation's short id</param>
430 <param name="invocationRequest">The parameterized request object for the invocation</param>
431 <returns></returns>
432 <response code="200">Operation invoked successfully</response>
433 <response code="400">Bad Request</response>
434 <response code="404">Submodel / Method handler not found</response>
435 </member>
436 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetInvocationResultRest(System.String,System.String)">
437 <summary>
438 Retrieves the result of an asynchronously started operation
439 </summary>
440 <param name="operationId">The operation's short id</param>
441 <param name="requestId">The request id</param>
442 <returns></returns>
443 <response code="200">Result found</response>
444 <response code="400">Bad Request</response>
445 <response code="404">Submodel / Operation / Request not found</response>
446 </member>
447 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.PostEvent(BaSyx.Models.Core.AssetAdministrationShell.Generics.SubmodelElementTypes.IEvent)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100448 <summary>
449 Adds a new event to the Asset Administration Shell's Submodel
450 </summary>
451 <param name="eventable">The Event description object</param>
452 <returns></returns>
453 <response code="201">Event created successfully</response>
454 <response code="400">Bad Request</response>
455 <response code="404">Submodel not found</response>
456 </member>
457 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.GetEvent(System.String)">
458 <summary>
459 Retrieves a specific event from the Asset Administration Shell's Submodel
460 </summary>
461 <param name="eventId">The Event's short id</param>
462 <returns></returns>
463 <response code="200">Success</response>
464 <response code="404">Submodel/Event not found</response>
465 </member>
466 <member name="M:BaSyx.API.Http.Controllers.SubmodelServices.DelEvent(System.String)">
467 <summary>
468 Deletes a specific event from the Asset Administration Shell's Submodel
469 </summary>
470 <param name="eventId">The Event's short id</param>
471 <returns></returns>
472 <response code="204">Event deleted successfully</response>
473 <response code="404">Submodel not found</response>
474 </member>
475 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.GetAssetAdministrationShells">
476 <summary>
477 Retrieves all registered Asset Administration Shells within a defined system (e.g. site, area, production line, station)
478 </summary>
479 <returns></returns>
480 <response code="200">Returns a list of found Asset Administration Shells</response>
481 <response code="400">Bad Request</response>
482 <response code="502">Bad Gateway</response>
483 </member>
484 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.GetAssetAdministrationShell(System.String)">
485 <summary>
486 Retrieves a specific Asset Administration Shell
487 </summary>
488 <param name="aasId">The Asset Administration Shell's unique id</param>
489 <returns></returns>
490 <response code="200">Returns the requested Asset Administration Shell</response>
491 <response code="400">Bad Request</response>
492 <response code="404">No Asset Administration Shell with passed id found</response>
493 <response code="502">Bad Gateway</response>
494 </member>
495 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.PutAssetAdministrationShell(System.String)">
496 <summary>
497 Renews a specific Asset Administration Shell's registration
498 </summary>
499 <param name="aasId">The Asset Administration Shell's unique id</param>
500 <returns></returns>
501 <response code="200">The Asset Administration Shell's registration was successfully renewed</response>
502 <response code="400">The syntax of the passed Asset Administration Shell is not valid or malformed request</response>
503 <response code="404">No Asset Administration Shell with passed id found</response>
504 <response code="502">Bad Gateway</response>
505 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +0200506 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.PostAssetAdministrationShell(BaSyx.Models.Connectivity.Descriptors.IAssetAdministrationShellDescriptor)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100507 <summary>
508 Registers a new Asset Administration Shell
509 </summary>
510 <param name="aas">The Asset Administration Shell descriptor object</param>
511 <returns></returns>
512 <response code="201">The Asset Administration Shell was created successfully</response>
513 <response code="400">The syntax of the passed Asset Administration Shell is not valid or malformed request</response>
514 <response code="422">The passed Asset Administration Shell conflicts with already registered Asset Administration Shells</response>
515 <response code="502">Bad Gateway</response>
516 </member>
517 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.DeleteAssetAdministrationShell_(System.String)">
518 <summary>
519 Deletes a specific Asset Administration Shell
520 </summary>
521 <param name="aasId">The Asset Administration Shell's unique id</param>
522 <returns></returns>
523 <response code="200">The Asset Administration Shell was deleted successfully</response>
524 <response code="400">Bad Request</response>
525 <response code="404">No Asset Administration Shell with passed id found</response>
526 <response code="502">Bad Gateway</response>
527 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +0200528 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.PostSubmodelToRegistry(System.String,BaSyx.Models.Connectivity.Descriptors.ISubmodelDescriptor)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100529 <summary>
530 Adds a new Submodel to an existing resp. registered Asset Administration Shell
531 </summary>
532 <param name="aasId">The Asset Administration Shell's unique id</param>
533 <param name="submodel">The Submodel descriptor object</param>
534 <returns></returns>
535 <response code="201">The Submodel was created successfully</response>
536 <response code="400">The syntax of the passed Submodel is not valid or malformed request</response>
537 <response code="404">No Asset Administration Shell with passed id found</response>
538 <response code="422">The passed Submodel conflicts with already registered Submodels</response>
539 <response code="502">Bad Gateway</response>
540 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +0200541 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.GetSubmodelFromRegistry(System.String,System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100542 <summary>
543 Retrieves a specific Submodel from a specific Asset Administration Shell
544 </summary>
545 <param name="aasId">The Asset Administration Shell's unique id</param>
546 <param name="submodelIdShort">The Submodel's short id (idShort)</param>
547 <returns></returns>
548 <response code="200">Returns the requested Submodels</response>
549 <response code="400">Bad Request</response>
550 <response code="404">No Asset Administration Shell / Submodel with passed id found</response>
551 <response code="502">Bad Gateway</response>
552 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +0200553 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.DeleteSubmodelFromRegistry(System.String,System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100554 <summary>
555 Deletes a specific Submodel from a specific Asset Administration Shell
556 </summary>
557 <param name="aasId">The Asset Administration Shell's unique id</param>
558 <param name="submodelIdShort">The Submodel's short id (idShort)</param>
559 <returns></returns>
560 <response code="200">The Submodel was deleted successfully</response>
561 <response code="400">Bad Request</response>
562 <response code="404">No Asset Administration Shell / Submodel with passed id found</response>
563 <response code="502">Bad Gateway</response>
564 </member>
Constantin Zieschefa612082020-04-03 09:54:56 +0200565 <member name="M:BaSyx.API.Http.Controllers.AssetAdministrationShellRegistry.GetSubmodelsFromRegistry(System.String)">
Constantin Ziesche857c7ab2020-02-25 11:24:51 +0100566 <summary>
567 Retrieves all Submodels from a specific Asset Administration Shell
568 </summary>
569 <param name="aasId">The Asset Administration Shell's unique id</param>
570 <returns></returns>
571 <response code="200">Returns a list of found Submodels</response>
572 <response code="400">Bad Request</response>
573 <response code="404">No Asset Administration Shell with passed id found</response>
574 <response code="502">Bad Gateway</response>
575 </member>
576 </members>
577</doc>