3 title: Provisioning MnS
6 OAS 3.0.1 definition of the Provisioning MnS
7 © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
10 description: 3GPP TS 28.532; Generic management services
11 url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/
13 - url: '{MnSRoot}/ProvMnS/{MnSVersion}/{URI-LDN-first-part}'
16 description: See clause 4.4.2 of TS 32.158
17 default: http://example.com/3GPPManagement
19 description: Version number of the OpenAPI definition
22 description: See clause 4.4.2 of TS 32.158
38 summary: Replaces a complete single resource or creates it if it does not exist
40 With HTTP PUT a complete resource is replaced or created if it does not
41 exist. The target resource is identified by the target URI.
47 $ref: '#/components/schemas/Resource'
51 Success case ("200 OK").
52 This status code shall be returned when the resource is replaced, and
53 when the replaced resource representation is not identical to the resource
54 representation in the request.
55 This status code may be retourned when the resource is updated and when the
56 updated resource representation is identical to the resource representation
58 The representation of the updated resource is returned in the response
63 $ref: '#/components/schemas/Resource'
66 Success case ("201 Created").
67 This status code shall be returned when the resource is created.
68 The representation of the created resource is returned in the response
73 $ref: '#/components/schemas/Resource'
76 Success case ("204 No Content").
77 This status code may be returned only when the replaced resource
78 representation is identical to the representation in the request.
79 The response has no message body.
81 description: Error case.
85 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
88 '{request.body#/notificationRecipientAddress}':
95 $ref: '#/components/schemas/NotifyMoiCreation'
99 Success case ("204 No Content").
100 The notification is successfully delivered. The response
103 description: Error case.
107 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
109 '{request.body#/notificationRecipientAddress}':
116 $ref: '#/components/schemas/NotifyMoiDeletion'
120 Success case ("204 No Content").
121 The notification is successfully delivered. The response
124 description: Error case.
128 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
129 notifyMOIAttributeValueChanges:
130 '{request.body#/notificationRecipientAddress}':
137 $ref: '#/components/schemas/NotifyMoiAttributeValueChanges'
141 Success case ("204 No Content").
142 The notification is successfully delivered. The response
145 description: Error case.
149 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
151 '{request.body#/notificationRecipientAddress}':
158 $ref: '#/components/schemas/NotifyMoiChanges'
162 Success case ("204 No Content").
163 The notification is successfully delivered. The response
166 description: Error case.
170 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
172 summary: Reads one or multiple resources
174 With HTTP GET resources are read. The resources to be retrieved are
175 identified with the target URI. The attributes and fields parameter
176 of the query components allow to select the resource properties to be returned.
181 This parameter extends the set of targeted resources beyond the base
182 resource identified with the path component of the URI. No scoping
183 mechanism is specified in the present document.
186 $ref: '#/components/schemas/Scope'
192 This parameter reduces the targeted set of resources by applying a
193 filter to the scoped set of resource representations. Only resource
194 representations for which the filter construct evaluates to "true"
195 are targeted. No filter language is specified in the present
199 $ref: 'comDefs.yaml#/components/schemas/Filter'
203 This parameter specifies the attributes of the scoped resources that
215 This parameter specifies the attribute field of the scoped resources
227 Success case ("200 OK").
228 The resources identified in the request for retrieval are returned
229 in the response message body. In case the attributes or fields query
230 parameters are used, only the selected attributes or sub-attributes are
231 returned. The response message body is constructed according to the
232 hierarchical response construction method (TS 32.158 [15]).
236 $ref: '#/components/schemas/Resource'
238 description: Error case.
242 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
244 summary: Patches one or multiple resources
246 With HTTP PATCH resources are created, updated or deleted. The resources
247 to be modified are identified with the target URI (base resource) and
248 the patch document included in the request message body.
251 The request body describes changes to be made to the target resources.
252 The following patch media types are available
253 - "application/merge-patch+json" (RFC 7396)
254 - "application/3gpp-merge-patch+json" (TS 32.158)
255 - "application/json-patch+json" (RFC 6902)
256 - "application/3gpp-json-patch+json" (TS 32.158)
259 application/merge-patch+json:
261 $ref: '#/components/schemas/Resource'
262 application/3gpp-merge-patch+json:
264 $ref: '#/components/schemas/Resource'
265 application/json-patch+json:
270 application/3gpp-json-patch+json:
278 Success case ("200 OK").
279 This status code is returned when the updated the resource representations
280 shall be returned for some reason.
281 The resource representations are returned in the response message body. The
282 response message body is constructed according to the hierarchical response
283 construction method (TS 32.158 [15])
287 $ref: '#/components/schemas/Resource'
290 Success case ("204 No Content").
291 This status code is returned when there is no need to return the updated
292 resource representations.
293 The response message body is empty.
295 description: Error case.
299 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
301 summary: Deletes one or multiple resources
303 With HTTP DELETE resources are deleted. The resources to be deleted are
304 identified with the target URI.
309 This parameter extends the set of targeted resources beyond the base
310 resource identified with the path component of the URI. No scoping
311 mechanism is specified in the present document.
314 $ref: '#/components/schemas/Scope'
320 This parameter reduces the targeted set of resources by applying a
321 filter to the scoped set of resource representations. Only resources
322 representations for which the filter construct evaluates to "true"
323 are returned. No filter language is specified in the present
327 $ref: 'comDefs.yaml#/components/schemas/Filter'
331 Success case ("200 OK").
332 This status code shall be returned, when query parameters are present in
333 the request and one or multiple resources are deleted.
334 The URIs of the deleted resources are returned in the response message body.
337 Success case ("204 No Content").
338 This status code shall be returned, when no query parameters are present in
339 the request and only one resource is deleted.
340 The message body is empty.
346 $ref: 'comDefs.yaml#/components/schemas/Uri'
348 description: Error case.
352 $ref: 'comDefs.yaml#/components/schemas/ErrorResponse'
355 CorrelatedNotification:
359 $ref: 'comDefs.yaml#/components/schemas/Dn'
363 $ref: 'comDefs.yaml#/components/schemas/NotificationId'
372 - notifyMOIAttributeValueChanges
378 - MANAGEMENT_OPERATION
398 $ref: '#/components/schemas/ScopeType'
411 additionalProperties:
416 - $ref: 'genericNrm.yaml#/components/schemas/resources-genericNrm'
417 - $ref: 'nrNrm.yaml#/components/schemas/resources-nrNrm'
418 - $ref: '5gcNrm.yaml#/components/schemas/resources-5gcNrm'
419 - $ref: 'sliceNrm.yaml#/components/schemas/resources-sliceNrm'
425 $ref: 'comDefs.yaml#/components/schemas/NotificationId'
426 correlatedNotifications:
429 $ref: '#/components/schemas/CorrelatedNotification'
433 $ref: '#/components/schemas/SourceIndicator'
435 $ref: 'comDefs.yaml#/components/schemas/Uri'
437 $ref: '#/components/schemas/Operation'
440 - $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
441 - $ref: 'comDefs.yaml#/components/schemas/AttributeValueChangeSet'
445 - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
448 correlatedNotifications:
451 $ref: '#/components/schemas/CorrelatedNotification'
455 $ref: '#/components/schemas/SourceIndicator'
457 $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
460 - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
463 correlatedNotifications:
466 $ref: '#/components/schemas/CorrelatedNotification'
470 $ref: '#/components/schemas/SourceIndicator'
472 $ref: 'comDefs.yaml#/components/schemas/AttributeNameValuePairSet'
473 NotifyMoiAttributeValueChanges:
475 - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
478 correlatedNotifications:
481 $ref: '#/components/schemas/CorrelatedNotification'
485 $ref: '#/components/schemas/SourceIndicator'
486 attributeListValueChanges:
487 $ref: 'comDefs.yaml#/components/schemas/AttributeValueChangeSet'
489 - attributeListValueChanges
492 - $ref: 'comDefs.yaml#/components/schemas/NotificationHeader'
498 $ref: '#/components/schemas/MoiChange'