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 V16.4.0; Generic management services
11 url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/
13 - url: 'http://{URI-DN-prefix}/{root}/ProvMnS/v1640/{LDN-first-part}'
16 description: See subclause 4.4 of TS 32.158
19 description: See subclause 4.4 of TS 32.158
20 default: 3GPPManagement
22 description: See subclause 4.4 of TS 32.158
31 $ref: '#/components/schemas/className-PathType'
36 $ref: '#/components/schemas/id-PathType'
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/resourcePut-RequestType'
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/resourceUpdate-ResponseType'
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/resourceCreation-ResponseType'
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: '#/components/schemas/error-ResponseType'
88 '{request.body#/notificationRecipientAddress}':
95 $ref: '#/components/schemas/notifyMOICreation-NotifType'
99 Success case ("204 No Content").
100 The notification is successfully delivered. The response
103 description: Error case.
107 $ref: '#/components/schemas/error-ResponseType'
109 '{request.body#/notificationRecipientAddress}':
116 $ref: '#/components/schemas/notifyMOIDeletion-NotifType'
120 Success case ("204 No Content").
121 The notification is successfully delivered. The response
124 description: Error case.
128 $ref: '#/components/schemas/error-ResponseType'
129 notifyMOIAttributeValueChange:
130 '{request.body#/notificationRecipientAddress}':
137 $ref: '#/components/schemas/notifyMOIAttributeValueChange-NotifType'
141 Success case ("204 No Content").
142 The notification is successfully delivered. The response
145 description: Error case.
149 $ref: '#/components/schemas/error-ResponseType'
151 '{request.body#/notificationRecipientAddress}':
158 $ref: '#/components/schemas/notifyMOIChanges-NotifType'
162 Success case ("204 No Content").
163 The notification is successfully delivered. The response
166 description: Error case.
170 $ref: '#/components/schemas/error-ResponseType'
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-QueryType'
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: '#/components/schemas/filter-QueryType'
203 This parameter specifies the attributes of the scoped resources that
207 $ref: '#/components/schemas/attributes-QueryType'
213 This parameter specifies the attribute field of the scoped resources
217 $ref: '#/components/schemas/fields-QueryType'
223 Success case ("200 OK").
224 The resources identified in the request for retrieval are returned
225 in the response message body. In case the attributes or fields query
226 parameters are used, only the selected attributes or sub-attributes are
227 returned. The response message body is constructed according to the
228 hierarchical response construction method (TS 32.158 [15]).
232 $ref: '#/components/schemas/resourceRetrieval-ResponseType'
234 description: Error case.
238 $ref: '#/components/schemas/error-ResponseType'
240 summary: Patches one or multiple resources
242 With HTTP PATCH resources are created, updated or deleted. The resources
243 to be modified are identified with the target URI (base resource) and
244 the patch document included in the request message body.
247 The request body describes changes to be made to the target resources.
248 The following patch media types are available
249 - "application/merge-patch+json" (RFC 7396)
250 - "application/3gpp-merge-patch+json" (TS 32.158)
251 - "application/json-patch+json" (RFC 6902)
252 - "application/3gpp-json-patch+json" (TS 32.158)
255 application/merge-patch+json:
257 $ref: '#/components/schemas/jsonMergePatch-RequestType'
258 application/3gpp-merge-patch+json:
260 $ref: '#/components/schemas/3gppJsonMergePatch-RequestType'
261 application/json-patch+json:
263 $ref: '#/components/schemas/jsonPatch-RequestType'
264 application/3gpp-json-patch+json:
266 $ref: '#/components/schemas/3gppJsonPatch-RequestType'
270 Success case ("200 OK").
271 This status code is returned when the updated the resource representations
272 shall be returned for some reason.
273 The resource representations are returned in the response message body. The
274 response message body is constructed according to the hierarchical response
275 construction method (TS 32.158 [15])
279 $ref: '#/components/schemas/resourceUpdate-ResponseType'
282 Success case ("204 No Content").
283 This status code is returned when there is no need to return the updated
284 resource representations.
285 The response message body is empty.
287 description: Error case.
291 $ref: '#/components/schemas/error-ResponseType'
293 summary: Deletes one or multiple resources
295 With HTTP DELETE resources are deleted. The resources to be deleted are
296 identified with the target URI.
301 This parameter extends the set of targeted resources beyond the base
302 resource identified with the path component of the URI. No scoping
303 mechanism is specified in the present document.
306 $ref: '#/components/schemas/scope-QueryType'
310 This parameter reduces the targeted set of resources by applying a
311 filter to the scoped set of resource representations. Only resources
312 representations for which the filter construct evaluates to "true"
313 are returned. No filter language is specified in the present
317 $ref: '#/components/schemas/filter-QueryType'
321 Success case ("200 OK").
322 This status code shall be returned, when query parameters are present in
323 the request and one or multiple resources are deleted.
324 The URIs of the deleted resources are returned in the response message body.
327 Success case ("204 No Content").
328 This status code shall be returned, when no query parameters are present in
329 the request and only one resource is deleted.
330 The message body is empty.
334 $ref: '#/components/schemas/resourceDeletion-ResponseType'
336 description: Error case.
340 $ref: '#/components/schemas/error-ResponseType'
351 correlatedNotification-Type:
355 $ref: '#/components/schemas/uri-Type'
359 $ref: '#/components/schemas/notificationId-Type'
361 $ref: '#/components/schemas/long-Type'
362 notificationType-Type:
367 - notifyMOIAttributeValueChange
372 sourceIndicator-Type:
383 $ref: '#/components/schemas/uri-Type'
385 $ref: '#/components/schemas/notificationId-Type'
387 $ref: '#/components/schemas/notificationType-Type'
389 $ref: '#/components/schemas/dateTime-Type'
391 $ref: '#/components/schemas/systemDN-Type'
411 attributes-QueryType:
425 $ref: '#/components/schemas/scopeType-Type'
427 $ref: '#/components/schemas/scopeLevel-Type'
429 resourcePut-RequestType:
430 $ref: '#/components/schemas/resourceRepresentation-Type'
431 jsonMergePatch-RequestType:
432 $ref: '#/components/schemas/resourceRepresentation-Type'
433 3gppJsonMergePatch-RequestType:
434 $ref: '#/components/schemas/resourceRepresentation-Type'
435 jsonPatch-RequestType:
439 3gppJsonPatch-RequestType:
452 resourceRetrieval-ResponseType:
453 $ref: '#/components/schemas/resourceRepresentation-Type'
454 resourceCreation-ResponseType:
455 $ref: '#/components/schemas/resourceRepresentation-Type'
456 resourceUpdate-ResponseType:
457 $ref: '#/components/schemas/resourceRepresentation-Type'
458 resourceDeletion-ResponseType:
461 $ref: '#/components/schemas/uri-Type'
463 resourceRepresentation-Type:
471 additionalProperties:
476 - $ref: 'genericNrm.yaml#/components/schemas/resources-genericNrm'
477 - $ref: 'nrNrm.yaml#/components/schemas/resources-nrNrm'
478 - $ref: '5gcNrm.yaml#/components/schemas/resources-5gcNrm'
479 - $ref: 'sliceNrm.yaml#/components/schemas/resources-sliceNrm'
485 $ref: '#/components/schemas/notificationId-Type'
486 correlatedNotifications:
489 $ref: '#/components/schemas/correlatedNotification-Type'
491 $ref: '#/components/schemas/additionalText-Type'
493 $ref: '#/components/schemas/sourceIndicator-Type'
495 $ref: '#/components/schemas/uri-Type'
505 additionalProperties:
513 notifyMOICreation-NotifType:
515 - $ref: '#/components/schemas/header-Type'
518 correlatedNotifications:
521 $ref: '#/components/schemas/correlatedNotification-Type'
523 $ref: '#/components/schemas/additionalText-Type'
525 $ref: '#/components/schemas/sourceIndicator-Type'
528 additionalProperties:
530 notifyMOIDeletion-NotifType:
532 - $ref: '#/components/schemas/header-Type'
535 correlatedNotifications:
538 $ref: '#/components/schemas/correlatedNotification-Type'
540 $ref: '#/components/schemas/additionalText-Type'
542 $ref: '#/components/schemas/sourceIndicator-Type'
545 additionalProperties: true
546 notifyMOIAttributeValueChange-NotifType:
548 - $ref: '#/components/schemas/header-Type'
551 correlatedNotifications:
554 $ref: '#/components/schemas/correlatedNotification-Type'
556 $ref: '#/components/schemas/additionalText-Type'
558 $ref: '#/components/schemas/sourceIndicator-Type'
559 attributeValueChange:
561 additionalProperties:
568 - attributeValueChange
569 notifyMOIChanges-NotifType:
571 - $ref: '#/components/schemas/header-Type'
577 $ref: '#/components/schemas/mOIChange-Type'