3 title: TS 28.532 Streaming data reporting service
5 description: OAS 3.0.1 specification for the Streaming data reporting service (Streaming MnS)
7 - url: '{protocol}://{root}/StreamingDataReportingMnS/{version}'
10 description: Protocol used
17 description: Indicates the host name and optional port, and an optional sequence of path segments that together represent a prefix path.
20 description: Indicates the current version of the specification
25 summary: Inform consumer about reporting streams to be carried by the new connection and receive a new connection id.
26 description: Exchange of meta-data (producer informs consumer about its own identity and the nature of the data to be reported via streaming) phase of the connection establishement by streaming data reporting producer to the streaming data reporting consumer (i.e. streaming target).
32 $ref: '#/components/schemas/connectionRequest-Type'
35 description: Success case (201 Created).
38 description: Location of the created connection resource.
40 $ref: '#/components/schemas/connectionId-Type'
42 description: Error case.
46 $ref: '#/components/schemas/failedConnectionResponse-Type'
48 summary: Obtain information about connections.
49 description: Enables the streaming data reporting service producer to obtain information about one or more streaming connections.
51 - name: connectionIdList
53 description: The list of connectionId for which the connection information is to be returned.
58 $ref: '#/components/schemas/connectionId-Type'
61 description: Success case (200 OK). The resources identified in the request for retrieval are returned in the response message body. In case the fields query parameter is used, the selected resources are returned.
67 $ref: '#/components/schemas/connectionInfo-Type'
69 description: Partial success case (202 Partially retrieved). Subset of the resources identified in the request for retrieval are returned in the response message body.
75 $ref: '#/components/schemas/connectionInfo-Type'
77 description: Error case.
81 $ref: '#/components/schemas/errorResponse-Type'
82 '/connections/{connectionId}':
84 summary: Obtain information about a connection.
85 description: Enables the streaming data reporting service producer to obtain information about one streaming connection.
89 description: Indicate the ID (URI) of the connection for which the information is being retrieved
92 $ref: '#/components/schemas/connectionId-Type'
96 $ref: '#/components/schemas/websocketHeaderConnection-Type'
97 - name: Sec-WebSocket-Extensions
100 $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Extensions-Type'
101 - name: Sec-WebSocket-Key
104 $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Key-Type'
105 - name: Sec-WebSocket-Protocol
108 $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Protocol-Type'
109 - name: Sec-WebSocket-Version
112 $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Version-Type'
115 description: Success case (101 Switching Protocols). The connection has been successfully switched to WebSocket. The response message body is absent.
119 $ref: '#/components/schemas/websocketHeaderUpgrade-Type'
122 $ref: '#/components/schemas/websocketHeaderConnection-Type'
123 Sec-WebSocket-Accept:
125 $ref: '#/components/schemas/websocketHeader-Sec-WebSocket-Accept-Type'
127 description: Success case (200 OK). The resource identified in the request for retrieval returned in the response message body.
131 $ref: '#/components/schemas/connectionInfo-Type'
133 description: Error case.
137 $ref: '#/components/schemas/errorResponse-Type'
138 '/connections/{connectionId}/streams':
140 summary: Inform consumer about new reporting streams on an existing connection.
141 description: Allows the producer to add one or more reporting streams to an already established streaming connection.
145 description: Indicate the ID (URI) of the connection for which the reporting stream information is being added.
148 $ref: '#/components/schemas/connectionId-Type'
156 $ref: '#/components/schemas/streamInfo-Type'
159 description: Success case (201 Posted).
165 $ref: '#/components/schemas/streamInfo-Type'
167 description: Partial success case (202 Posted).
173 $ref: '#/components/schemas/streamInfo-Type'
175 description: Error case.
179 $ref: '#/components/schemas/errorResponse-Type'
181 summary: Remove reporting streams from an existing connection
182 description: Allows the producer to remove one or more reporting streams from an already established streaming connection.
186 description: Indicate the ID (URI) of the connection for which the reporting stream information is being removed.
189 $ref: '#/components/schemas/connectionId-Type'
192 description: The list of streamId for the stream(s) to be deleted.
197 $ref: '#/components/schemas/streamId-Type'
200 description: Success case (204 No Content). The stream information resource has been deleted. The response message body is absent.
202 description: Error case.
206 $ref: '#/components/schemas/errorResponse-Type'
208 summary: Obtain information about streams.
209 description: Enables the streaming data reporting service producer to obtain information about one or more reporting streams.
213 description: Indicate the ID (URI) of the connection for which the information is being retrieved
216 $ref: '#/components/schemas/connectionId-Type'
219 description: The list of streamId for which the stream information is to be retrieved.
224 $ref: '#/components/schemas/streamId-Type'
227 description: Success case (200 OK).
233 $ref: '#/components/schemas/streamInfoWithReporters-Type'
235 description: Partial success case (202 Partially retrieved).
241 $ref: '#/components/schemas/streamInfoWithReporters-Type'
243 description: Error case.
247 $ref: '#/components/schemas/errorResponse-Type'
248 '/connections/{connectionId}/streams/{streamId}':
250 summary: Obtain information about stream
251 description: Enables the streaming data reporting service producer to obtain information about a reporting stream.
255 description: Indicate the ID (URI) of the connection for which the information is being retrieved
258 $ref: '#/components/schemas/connectionId-Type'
261 description: Indicate the ID of the reporting stream for which the information is being retrieved
264 $ref: '#/components/schemas/streamId-Type'
267 description: Success case (200 OK).
271 $ref: '#/components/schemas/streamInfoWithReporters-Type'
273 description: Error case.
277 $ref: '#/components/schemas/errorResponse-Type'
281 description: Information specific to analytics reporting.
287 $ref: '#/components/schemas/uri-Type'
292 $ref: '#/components/schemas/connectionId-Type'
294 $ref: '#/components/schemas/producerId-Type'
298 $ref: '#/components/schemas/streamId-Type'
299 connectionRequest-Type:
303 $ref: '#/components/schemas/producerId-Type'
307 $ref: '#/components/schemas/streamInfo-Type'
316 failedConnectionResponse-Type:
325 $ref: '#/components/schemas/streamId-Type'
329 description: DN of the measured object instance (see 3GPP TS 28.550)
331 - $ref: '#/components/schemas/systemDN-Type'
333 description: an ordered list of measurement type or KPI whose measurement values or KPI result values are to be reported by the Performance Data Stream Units (see Annex C of TS 28.550) via this stream
337 performanceInfo-Type:
338 description: Information specific to performance data reporting
342 $ref: '#/components/schemas/measObjDn-Type'
344 $ref: '#/components/schemas/measTypes-Type'
346 $ref: '#/components/schemas/systemDN-Type'
353 description: DN of the streaming data reporting MnS producer.
355 - $ref: '#/components/schemas/systemDN-Type'
356 serializationFormat-Type:
362 description: globally unique stream identifier
364 example: '26F452550021'
366 description: Reporting stream meta-data.
370 $ref: '#/components/schemas/streamType-Type'
372 $ref: '#/components/schemas/serializationFormat-Type'
375 - $ref: '#/components/schemas/streamId-Type'
376 - $ref: '#/components/schemas/traceReference-Type'
379 - $ref: '#/components/schemas/traceInfo-Type'
380 - $ref: '#/components/schemas/performanceInfo-Type'
381 - $ref: '#/components/schemas/analyticsInfo-Type'
382 - $ref: '#/components/schemas/vsDataContainer-Type'
385 - serializationFormat
387 streamInfoWithReporters-Type:
388 description: Reporting stream meta-data with added information about reporters.
392 $ref: '#/components/schemas/streamInfo-Type'
396 $ref: '#/components/schemas/producerId-Type'
398 description: See 3GPP TS 32.300 for details
400 example: 'SubNetwork=ABCNetwork,SubNetwork=MUC01,GNBDUFunction=XYZ0100'
409 description: Information specific to trace data reporting
411 - $ref: 'genericNrm.yaml#/components/schemas/TraceJob-Attr'
413 description: Trace Reference (see clause 5.6 of 3GPP TS 32.422) as stream identifier for streaming trace data reporting
415 example: '4358070034D7'
417 description: Resource URI
419 vsDataContainer-Type:
420 description: container for vendor specific data (see 3GPP TS 28.622)
429 websocketHeaderConnection-Type:
430 description: Header value for the upgrade request and response.
434 websocketHeaderUpgrade-Type:
435 description: Header value for the upgrade to WebSocket request and response.
439 websocketHeader-Sec-WebSocket-Accept-Type:
440 description: Header value for secure WebSocket response. Carries hash.
442 websocketHeader-Sec-WebSocket-Extensions-Type:
443 description: Header value for secure WebSocket request. Carries protocol extensions.
445 websocketHeader-Sec-WebSocket-Key-Type:
446 description: Header value for secure WebSocket request. Provides information to the server which is needed in order to confirm that the client is entitled to request an upgrade to WebSocket.
448 websocketHeader-Sec-WebSocket-Protocol-Type:
449 description: Header value for secure WebSocket request. Carries a comma-separated list of subprotocol names, in the order of preference.
451 websocketHeader-Sec-WebSocket-Version-Type:
452 description: Header value for secure WebSocket request and response. Carries the WebSocket protocol version to be used.