4 - description: OSM NB API
5 url: https://osm.etsi.org/nbapi/v1.0.0
9 This is Open Source MANO Northbound API featuring ETSI NFV SOL005.
10 For more information on OSM, you can visit [http://osm.etsi.org](http://osm.etsi.org).
11 You can send us your comments and questions to OSM_TECH@list.etsi.org
12 or join the [OpenSourceMANO Slack Workplace](https://join.slack.com/t/opensourcemano/shared_invite/enQtMzQ3MzYzNTQ0NDIyLWVkNTE4ZjZjNWI0ZTQyN2VhOTI1MjViMzU1NWYwMWM3ODI4NTQyY2VlODA2ZjczMWIyYTFkZWNiZmFkM2M2ZDk)
14 title: OSM NB API featuring ETSI NFV SOL005
16 email: OSM_TECH@list.etsi.org
19 url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
22 - name: 'VNF packages'
23 description: Management operations of VNF descriptors and packages
25 description: Management operations of NS descriptors and packages
26 - name: 'NS instances'
27 description: Management operations of NS instances
28 - name: 'NetSlice templates'
29 description: Management operations of NetSlice Templates
30 - name: 'NetSlice instances'
31 description: Management operations of NetSlice Instances
33 # description: Management operations of NSPMs
35 # description: Management operations of PDUs
37 # description: Management operations of Administration items
45 '/nsd/v1/ns_descriptors':
49 summary: Query information about multiple NS descriptor resources
50 description: Query information about multiple NS descriptor resources
58 $ref: '#/components/schemas/ArrayOfNsdInfo'
61 $ref: '#/components/schemas/ArrayOfNsdInfo'
63 $ref: '#/components/responses/BadRequest'
65 $ref: '#/components/responses/Unauthorized'
67 $ref: '#/components/responses/Forbidden'
69 $ref: '#/components/responses/NotFound'
71 $ref: '#/components/responses/MethodNotAllowed'
73 $ref: '#/components/responses/NotAcceptable'
75 $ref: '#/components/responses/Conflict'
77 $ref: '#/components/responses/UnprocessableEntity'
79 $ref: '#/components/responses/InternalServerError'
81 $ref: '#/components/responses/ServiceUnavailable'
83 $ref: '#/components/responses/UnexpectedError'
85 $ref: '#/components/responses/UnexpectedError'
89 summary: Create a new NS descriptor resource
90 description: Create a new NS descriptor resource
93 $ref: '#/components/requestBodies/CreateNsdInfoRequest'
105 $ref: '#/components/schemas/ObjectId'
108 $ref: '#/components/schemas/ObjectId'
110 $ref: '#/components/responses/BadRequest'
112 $ref: '#/components/responses/Unauthorized'
114 $ref: '#/components/responses/Forbidden'
116 $ref: '#/components/responses/NotFound'
118 $ref: '#/components/responses/MethodNotAllowed'
120 $ref: '#/components/responses/NotAcceptable'
122 $ref: '#/components/responses/Conflict'
124 $ref: '#/components/responses/UnprocessableEntity'
126 $ref: '#/components/responses/InternalServerError'
128 $ref: '#/components/responses/ServiceUnavailable'
130 $ref: '#/components/responses/UnexpectedError'
132 $ref: '#/components/responses/UnexpectedError'
133 '/nsd/v1/ns_descriptors/{nsdInfoId}':
138 description: NSD Info ID
144 summary: Read information about an individual NS descriptor resource
145 description: Read information about an individual NS descriptor resource
153 $ref: '#/components/schemas/NsdInfo'
156 $ref: '#/components/schemas/NsdInfo'
158 $ref: '#/components/responses/BadRequest'
160 $ref: '#/components/responses/Unauthorized'
162 $ref: '#/components/responses/Forbidden'
164 $ref: '#/components/responses/NotFound'
166 $ref: '#/components/responses/MethodNotAllowed'
168 $ref: '#/components/responses/NotAcceptable'
170 $ref: '#/components/responses/Conflict'
172 $ref: '#/components/responses/UnprocessableEntity'
174 $ref: '#/components/responses/InternalServerError'
176 $ref: '#/components/responses/ServiceUnavailable'
178 $ref: '#/components/responses/UnexpectedError'
180 $ref: '#/components/responses/UnexpectedError'
184 summary: Delete an individual NS descriptor resource
185 description: Delete an individual NS descriptor resource
186 operationId: deleteNSD
189 description: No Content
191 $ref: '#/components/responses/BadRequest'
193 $ref: '#/components/responses/Unauthorized'
195 $ref: '#/components/responses/Forbidden'
197 $ref: '#/components/responses/NotFound'
199 $ref: '#/components/responses/MethodNotAllowed'
201 $ref: '#/components/responses/NotAcceptable'
203 $ref: '#/components/responses/Conflict'
205 $ref: '#/components/responses/UnprocessableEntity'
207 $ref: '#/components/responses/InternalServerError'
209 $ref: '#/components/responses/ServiceUnavailable'
211 $ref: '#/components/responses/UnexpectedError'
213 $ref: '#/components/responses/UnexpectedError'
217 summary: Modify the data of an individual NS descriptor resource
218 description: Modify the data of an individual NS descriptor resource
219 operationId: updateNSD
221 $ref: '#/components/requestBodies/NsdInfoModifications'
224 description: No Content
226 $ref: '#/components/responses/BadRequest'
228 $ref: '#/components/responses/Unauthorized'
230 $ref: '#/components/responses/Forbidden'
232 $ref: '#/components/responses/NotFound'
234 $ref: '#/components/responses/MethodNotAllowed'
236 $ref: '#/components/responses/NotAcceptable'
238 $ref: '#/components/responses/Conflict'
240 $ref: '#/components/responses/UnprocessableEntity'
242 $ref: '#/components/responses/InternalServerError'
244 $ref: '#/components/responses/ServiceUnavailable'
246 $ref: '#/components/responses/UnexpectedError'
248 $ref: '#/components/responses/UnexpectedError'
249 '/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content':
254 description: NSD Info ID
260 summary: Fetch the content of a NSD
261 description: Fetch the content of a NSD
262 operationId: getNSDcontent
269 $ref: '#/components/schemas/NsPackage'
271 description: Partial Content
279 $ref: '#/components/schemas/NsPackage'
281 $ref: '#/components/responses/BadRequest'
283 $ref: '#/components/responses/Unauthorized'
285 $ref: '#/components/responses/Forbidden'
287 $ref: '#/components/responses/NotFound'
289 $ref: '#/components/responses/MethodNotAllowed'
291 $ref: '#/components/responses/NotAcceptable'
293 $ref: '#/components/responses/Conflict'
295 $ref: '#/components/responses/UnprocessableEntity'
297 $ref: '#/components/responses/InternalServerError'
299 $ref: '#/components/responses/ServiceUnavailable'
301 $ref: '#/components/responses/UnexpectedError'
303 $ref: '#/components/responses/UnexpectedError'
307 summary: Upload the content of a NSD
308 description: Upload the content of a NSD
309 operationId: updateNSDcontent
311 $ref: '#/components/requestBodies/NsPackage'
314 description: Accepted
316 description: No Content
318 $ref: '#/components/responses/BadRequest'
320 $ref: '#/components/responses/Unauthorized'
322 $ref: '#/components/responses/Forbidden'
324 $ref: '#/components/responses/NotFound'
326 $ref: '#/components/responses/MethodNotAllowed'
328 $ref: '#/components/responses/NotAcceptable'
330 $ref: '#/components/responses/Conflict'
332 $ref: '#/components/responses/UnprocessableEntity'
334 $ref: '#/components/responses/InternalServerError'
336 $ref: '#/components/responses/ServiceUnavailable'
338 $ref: '#/components/responses/UnexpectedError'
340 $ref: '#/components/responses/UnexpectedError'
341 '/nsd/v1/ns_descriptors/{nsdInfoId}/artifacts/{artifactPath}':
346 description: NS Package ID
352 description: Artifact Path
358 summary: Fetch individual NS package artifact
359 description: Fetch individual NS package artifact
360 operationId: getNsPkgArtifact
365 application/octet-stream:
370 description: Partial Content
376 application/octet-stream:
381 $ref: '#/components/responses/BadRequest'
383 $ref: '#/components/responses/Unauthorized'
385 $ref: '#/components/responses/Forbidden'
387 $ref: '#/components/responses/NotFound'
389 $ref: '#/components/responses/MethodNotAllowed'
391 $ref: '#/components/responses/NotAcceptable'
393 $ref: '#/components/responses/Conflict'
395 $ref: '#/components/responses/UnprocessableEntity'
397 $ref: '#/components/responses/InternalServerError'
399 $ref: '#/components/responses/ServiceUnavailable'
401 $ref: '#/components/responses/UnexpectedError'
403 $ref: '#/components/responses/UnexpectedError'
404 '/nsd/v1/ns_descriptors/{nsdInfoId}/nsd':
409 description: NS Package ID
415 summary: Read NSD of an on-boarded NS package
416 description: Read NSD of an on-boarded NS package
417 operationId: getNsPkgNsd
424 $ref: '#/components/schemas/NsDescriptor'
426 $ref: '#/components/responses/BadRequest'
428 $ref: '#/components/responses/Unauthorized'
430 $ref: '#/components/responses/Forbidden'
432 $ref: '#/components/responses/NotFound'
434 $ref: '#/components/responses/MethodNotAllowed'
436 $ref: '#/components/responses/NotAcceptable'
438 $ref: '#/components/responses/Conflict'
440 $ref: '#/components/responses/UnprocessableEntity'
442 $ref: '#/components/responses/InternalServerError'
444 $ref: '#/components/responses/ServiceUnavailable'
446 $ref: '#/components/responses/UnexpectedError'
448 $ref: '#/components/responses/UnexpectedError'
449 '/nsd/v1/ns_descriptors_content':
453 summary: Upload a NS package by providing the content of the NS package
454 description: Upload a NS package by providing the content of the NS package
455 operationId: uploadNsPkgsContent
460 $ref: '#/components/schemas/NsPackage'
472 $ref: '#/components/schemas/ObjectId'
475 $ref: '#/components/schemas/ObjectId'
477 description: Accepted
479 description: No Content
481 $ref: '#/components/responses/BadRequest'
483 $ref: '#/components/responses/Unauthorized'
485 $ref: '#/components/responses/Forbidden'
487 $ref: '#/components/responses/NotFound'
489 $ref: '#/components/responses/MethodNotAllowed'
491 $ref: '#/components/responses/NotAcceptable'
493 $ref: '#/components/responses/Conflict'
495 $ref: '#/components/responses/UnprocessableEntity'
497 $ref: '#/components/responses/InternalServerError'
499 $ref: '#/components/responses/ServiceUnavailable'
501 $ref: '#/components/responses/UnexpectedError'
503 $ref: '#/components/responses/UnexpectedError'
507 summary: Query information about multiple NS package resources
508 description: Query information about multiple NS package resources
509 operationId: getNsPkgsContent
516 $ref: '#/components/schemas/ArrayOfNsdInfo'
519 $ref: '#/components/schemas/ArrayOfNsdInfo'
521 description: Partial Content
527 application/octet-stream:
532 $ref: '#/components/responses/BadRequest'
534 $ref: '#/components/responses/Unauthorized'
536 $ref: '#/components/responses/Forbidden'
538 $ref: '#/components/responses/NotFound'
540 $ref: '#/components/responses/MethodNotAllowed'
542 $ref: '#/components/responses/NotAcceptable'
544 $ref: '#/components/responses/Conflict'
546 $ref: '#/components/responses/UnprocessableEntity'
548 $ref: '#/components/responses/InternalServerError'
550 $ref: '#/components/responses/ServiceUnavailable'
552 $ref: '#/components/responses/UnexpectedError'
554 $ref: '#/components/responses/UnexpectedError'
555 '/nsd/v1/ns_descriptors_content/{nsdInfoId}':
560 description: NS Package ID
566 summary: Read information about an individual NS package resource
567 description: Read information about an individual NS package resource
568 operationId: getNsPkgsIdContent
575 $ref: '#/components/schemas/NsdInfo'
578 $ref: '#/components/schemas/NsdInfo'
580 $ref: '#/components/responses/BadRequest'
582 $ref: '#/components/responses/Unauthorized'
584 $ref: '#/components/responses/Forbidden'
586 $ref: '#/components/responses/NotFound'
588 $ref: '#/components/responses/MethodNotAllowed'
590 $ref: '#/components/responses/NotAcceptable'
592 $ref: '#/components/responses/Conflict'
594 $ref: '#/components/responses/UnprocessableEntity'
596 $ref: '#/components/responses/InternalServerError'
598 $ref: '#/components/responses/ServiceUnavailable'
600 $ref: '#/components/responses/UnexpectedError'
602 $ref: '#/components/responses/UnexpectedError'
606 summary: Modify an individual NS package resource
607 description: Modify an individual NS package resource
608 operationId: updateNsPkgsIdContent
610 $ref: '#/components/requestBodies/NsdInfoModifications'
613 description: No Content
615 $ref: '#/components/responses/BadRequest'
617 $ref: '#/components/responses/Unauthorized'
619 $ref: '#/components/responses/Forbidden'
621 $ref: '#/components/responses/NotFound'
623 $ref: '#/components/responses/MethodNotAllowed'
625 $ref: '#/components/responses/NotAcceptable'
627 $ref: '#/components/responses/Conflict'
629 $ref: '#/components/responses/UnprocessableEntity'
631 $ref: '#/components/responses/InternalServerError'
633 $ref: '#/components/responses/ServiceUnavailable'
635 $ref: '#/components/responses/UnexpectedError'
637 $ref: '#/components/responses/UnexpectedError'
641 summary: Delete an individual NS package resource
642 description: Delete an individual NS package resource
643 operationId: deleteNSPkgsIdContent
646 description: No Content
648 $ref: '#/components/responses/BadRequest'
650 $ref: '#/components/responses/Unauthorized'
652 $ref: '#/components/responses/Forbidden'
654 $ref: '#/components/responses/NotFound'
656 $ref: '#/components/responses/MethodNotAllowed'
658 $ref: '#/components/responses/NotAcceptable'
660 $ref: '#/components/responses/Conflict'
662 $ref: '#/components/responses/UnprocessableEntity'
664 $ref: '#/components/responses/InternalServerError'
666 $ref: '#/components/responses/ServiceUnavailable'
668 $ref: '#/components/responses/UnexpectedError'
670 $ref: '#/components/responses/UnexpectedError'
674 '/vnfpkgm/v1/vnf_packages':
678 summary: Query information about multiple VNF package resources
679 description: Query information about multiple VNF package resources
680 operationId: getVnfPkgs
687 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
690 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
692 $ref: '#/components/responses/BadRequest'
694 $ref: '#/components/responses/Unauthorized'
696 $ref: '#/components/responses/Forbidden'
698 $ref: '#/components/responses/NotFound'
700 $ref: '#/components/responses/MethodNotAllowed'
702 $ref: '#/components/responses/NotAcceptable'
704 $ref: '#/components/responses/Conflict'
706 $ref: '#/components/responses/UnprocessableEntity'
708 $ref: '#/components/responses/InternalServerError'
710 $ref: '#/components/responses/ServiceUnavailable'
712 $ref: '#/components/responses/UnexpectedError'
714 $ref: '#/components/responses/UnexpectedError'
718 summary: Create a new VNF package resource
719 description: Create a new VNF package resource
720 operationId: addVnfPkg
722 $ref: '#/components/requestBodies/CreateVnfPkgInfoRequest'
734 $ref: '#/components/schemas/ObjectId'
737 $ref: '#/components/schemas/ObjectId'
739 $ref: '#/components/responses/BadRequest'
741 $ref: '#/components/responses/Unauthorized'
743 $ref: '#/components/responses/Forbidden'
745 $ref: '#/components/responses/NotFound'
747 $ref: '#/components/responses/MethodNotAllowed'
749 $ref: '#/components/responses/NotAcceptable'
751 $ref: '#/components/responses/Conflict'
753 $ref: '#/components/responses/UnprocessableEntity'
755 $ref: '#/components/responses/InternalServerError'
757 $ref: '#/components/responses/ServiceUnavailable'
759 $ref: '#/components/responses/UnexpectedError'
761 $ref: '#/components/responses/UnexpectedError'
762 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}':
767 description: VNF Package ID
773 summary: Read information about an individual VNF package resource
774 description: Read information about an individual VNF package resource
775 operationId: getVnfPkg
782 $ref: '#/components/schemas/VnfPkgInfo'
785 $ref: '#/components/schemas/VnfPkgInfo'
787 $ref: '#/components/responses/BadRequest'
789 $ref: '#/components/responses/Unauthorized'
791 $ref: '#/components/responses/Forbidden'
793 $ref: '#/components/responses/NotFound'
795 $ref: '#/components/responses/MethodNotAllowed'
797 $ref: '#/components/responses/NotAcceptable'
799 $ref: '#/components/responses/Conflict'
801 $ref: '#/components/responses/UnprocessableEntity'
803 $ref: '#/components/responses/InternalServerError'
805 $ref: '#/components/responses/ServiceUnavailable'
807 $ref: '#/components/responses/UnexpectedError'
809 $ref: '#/components/responses/UnexpectedError'
813 summary: Delete an individual VNF package resource
814 description: Delete an individual VNF package resource
815 operationId: deleteVnfPkg
818 description: No Content
820 $ref: '#/components/responses/BadRequest'
822 $ref: '#/components/responses/Unauthorized'
824 $ref: '#/components/responses/Forbidden'
826 $ref: '#/components/responses/NotFound'
828 $ref: '#/components/responses/MethodNotAllowed'
830 $ref: '#/components/responses/NotAcceptable'
832 $ref: '#/components/responses/Conflict'
834 $ref: '#/components/responses/UnprocessableEntity'
836 $ref: '#/components/responses/InternalServerError'
838 $ref: '#/components/responses/ServiceUnavailable'
840 $ref: '#/components/responses/UnexpectedError'
842 $ref: '#/components/responses/UnexpectedError'
846 summary: Modify an individual VNF package resource
847 description: Modify an individual VNF package resource
848 operationId: updateVnfPkg
850 $ref: '#/components/requestBodies/VnfPkgInfoModifications'
853 description: No Content
855 $ref: '#/components/responses/BadRequest'
857 $ref: '#/components/responses/Unauthorized'
859 $ref: '#/components/responses/Forbidden'
861 $ref: '#/components/responses/NotFound'
863 $ref: '#/components/responses/MethodNotAllowed'
865 $ref: '#/components/responses/NotAcceptable'
867 $ref: '#/components/responses/Conflict'
869 $ref: '#/components/responses/UnprocessableEntity'
871 $ref: '#/components/responses/InternalServerError'
873 $ref: '#/components/responses/ServiceUnavailable'
875 $ref: '#/components/responses/UnexpectedError'
877 $ref: '#/components/responses/UnexpectedError'
878 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/vnfd':
883 description: VNF Package ID
889 summary: Read VNFD of an on-boarded VNF package
890 description: Read VNFD of an on-boarded VNF package
891 operationId: getVnfPkgVnfd
898 $ref: '#/components/schemas/VnfDescriptor'
900 $ref: '#/components/responses/BadRequest'
902 $ref: '#/components/responses/Unauthorized'
904 $ref: '#/components/responses/Forbidden'
906 $ref: '#/components/responses/NotFound'
908 $ref: '#/components/responses/MethodNotAllowed'
910 $ref: '#/components/responses/NotAcceptable'
912 $ref: '#/components/responses/Conflict'
914 $ref: '#/components/responses/UnprocessableEntity'
916 $ref: '#/components/responses/InternalServerError'
918 $ref: '#/components/responses/ServiceUnavailable'
920 $ref: '#/components/responses/UnexpectedError'
922 $ref: '#/components/responses/UnexpectedError'
923 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content':
928 description: VNF Package ID
934 summary: Fetch an on-boarded VNF package
935 description: Fetch an on-boarded VNF package
936 operationId: getVnfPkgContent
943 $ref: '#/components/schemas/VnfPackage'
945 description: Partial Content
953 $ref: '#/components/schemas/VnfPackage'
955 $ref: '#/components/responses/BadRequest'
957 $ref: '#/components/responses/Unauthorized'
959 $ref: '#/components/responses/Forbidden'
961 $ref: '#/components/responses/NotFound'
963 $ref: '#/components/responses/MethodNotAllowed'
965 $ref: '#/components/responses/NotAcceptable'
967 $ref: '#/components/responses/Conflict'
969 $ref: '#/components/responses/UnprocessableEntity'
971 $ref: '#/components/responses/InternalServerError'
973 $ref: '#/components/responses/ServiceUnavailable'
975 $ref: '#/components/responses/UnexpectedError'
977 $ref: '#/components/responses/UnexpectedError'
981 summary: Upload a VNF package by providing the content of the VNF package
982 description: Upload a VNF package by providing the content of the VNF package
983 operationId: uploadVnfPkgContent
988 $ref: '#/components/schemas/VnfPackage'
991 description: Accepted
993 description: No Content
995 $ref: '#/components/responses/BadRequest'
997 $ref: '#/components/responses/Unauthorized'
999 $ref: '#/components/responses/Forbidden'
1001 $ref: '#/components/responses/NotFound'
1003 $ref: '#/components/responses/MethodNotAllowed'
1005 $ref: '#/components/responses/NotAcceptable'
1007 $ref: '#/components/responses/Conflict'
1009 $ref: '#/components/responses/UnprocessableEntity'
1011 $ref: '#/components/responses/InternalServerError'
1013 $ref: '#/components/responses/ServiceUnavailable'
1015 $ref: '#/components/responses/UnexpectedError'
1017 $ref: '#/components/responses/UnexpectedError'
1018 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
1023 description: VNF Package ID
1026 - name: artifactPath
1029 description: Artifact Path
1035 summary: Fetch individual VNF package artifact
1036 description: Fetch individual VNF package artifact
1037 operationId: getVnfPkgArtifact
1042 application/octet-stream:
1047 description: Partial Content
1053 application/octet-stream:
1058 $ref: '#/components/responses/BadRequest'
1060 $ref: '#/components/responses/Unauthorized'
1062 $ref: '#/components/responses/Forbidden'
1064 $ref: '#/components/responses/NotFound'
1066 $ref: '#/components/responses/MethodNotAllowed'
1068 $ref: '#/components/responses/NotAcceptable'
1070 $ref: '#/components/responses/Conflict'
1072 $ref: '#/components/responses/UnprocessableEntity'
1074 $ref: '#/components/responses/InternalServerError'
1076 $ref: '#/components/responses/ServiceUnavailable'
1078 $ref: '#/components/responses/UnexpectedError'
1080 $ref: '#/components/responses/UnexpectedError'
1081 '/vnfpkgm/v1/vnf_packages_content':
1085 summary: Upload a VNF package by providing the content of the VNF package
1086 description: Upload a VNF package by providing the content of the VNF package
1087 operationId: uploadVnfPkgsContent
1092 $ref: '#/components/schemas/VnfPackage'
1095 description: Created
1104 $ref: '#/components/schemas/ObjectId'
1107 $ref: '#/components/schemas/ObjectId'
1109 description: Accepted
1111 description: No Content
1113 $ref: '#/components/responses/BadRequest'
1115 $ref: '#/components/responses/Unauthorized'
1117 $ref: '#/components/responses/Forbidden'
1119 $ref: '#/components/responses/NotFound'
1121 $ref: '#/components/responses/MethodNotAllowed'
1123 $ref: '#/components/responses/NotAcceptable'
1125 $ref: '#/components/responses/Conflict'
1127 $ref: '#/components/responses/UnprocessableEntity'
1129 $ref: '#/components/responses/InternalServerError'
1131 $ref: '#/components/responses/ServiceUnavailable'
1133 $ref: '#/components/responses/UnexpectedError'
1135 $ref: '#/components/responses/UnexpectedError'
1139 summary: Query information about multiple VNF package resources
1140 description: Query information about multiple VNF package resources
1141 operationId: getVnfPkgsContent
1148 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
1151 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
1153 description: Partial Content
1159 application/octet-stream:
1164 $ref: '#/components/responses/BadRequest'
1166 $ref: '#/components/responses/Unauthorized'
1168 $ref: '#/components/responses/Forbidden'
1170 $ref: '#/components/responses/NotFound'
1172 $ref: '#/components/responses/MethodNotAllowed'
1174 $ref: '#/components/responses/NotAcceptable'
1176 $ref: '#/components/responses/Conflict'
1178 $ref: '#/components/responses/UnprocessableEntity'
1180 $ref: '#/components/responses/InternalServerError'
1182 $ref: '#/components/responses/ServiceUnavailable'
1184 $ref: '#/components/responses/UnexpectedError'
1186 $ref: '#/components/responses/UnexpectedError'
1187 '/vnfpkgm/v1/vnf_packages_content/{packageContentId}':
1189 - name: packageContentId
1192 description: VNF Package Content ID
1198 summary: Read information about an individual VNF package resource
1199 description: Read information about an individual VNF package resource
1200 operationId: getVnfPkgsIdContent
1207 $ref: '#/components/schemas/VnfPkgInfo'
1210 $ref: '#/components/schemas/VnfPkgInfo'
1212 $ref: '#/components/responses/BadRequest'
1214 $ref: '#/components/responses/Unauthorized'
1216 $ref: '#/components/responses/Forbidden'
1218 $ref: '#/components/responses/NotFound'
1220 $ref: '#/components/responses/MethodNotAllowed'
1222 $ref: '#/components/responses/NotAcceptable'
1224 $ref: '#/components/responses/Conflict'
1226 $ref: '#/components/responses/UnprocessableEntity'
1228 $ref: '#/components/responses/InternalServerError'
1230 $ref: '#/components/responses/ServiceUnavailable'
1232 $ref: '#/components/responses/UnexpectedError'
1234 $ref: '#/components/responses/UnexpectedError'
1238 summary: Modify an individual VNF package resource
1239 description: Modify an individual VNF package resource
1240 operationId: updateVnfPkgsIdContent
1242 $ref: '#/components/requestBodies/VnfPkgInfoModifications'
1245 description: No Content
1247 $ref: '#/components/responses/BadRequest'
1249 $ref: '#/components/responses/Unauthorized'
1251 $ref: '#/components/responses/Forbidden'
1253 $ref: '#/components/responses/NotFound'
1255 $ref: '#/components/responses/MethodNotAllowed'
1257 $ref: '#/components/responses/NotAcceptable'
1259 $ref: '#/components/responses/Conflict'
1261 $ref: '#/components/responses/UnprocessableEntity'
1263 $ref: '#/components/responses/InternalServerError'
1265 $ref: '#/components/responses/ServiceUnavailable'
1267 $ref: '#/components/responses/UnexpectedError'
1269 $ref: '#/components/responses/UnexpectedError'
1273 summary: Delete an individual VNF package resource
1274 description: Delete an individual VNF package resource
1275 operationId: deleteVnfPkgsIdContent
1278 description: No Content
1280 $ref: '#/components/responses/BadRequest'
1282 $ref: '#/components/responses/Unauthorized'
1284 $ref: '#/components/responses/Forbidden'
1286 $ref: '#/components/responses/NotFound'
1288 $ref: '#/components/responses/MethodNotAllowed'
1290 $ref: '#/components/responses/NotAcceptable'
1292 $ref: '#/components/responses/Conflict'
1294 $ref: '#/components/responses/UnprocessableEntity'
1296 $ref: '#/components/responses/InternalServerError'
1298 $ref: '#/components/responses/ServiceUnavailable'
1300 $ref: '#/components/responses/UnexpectedError'
1302 $ref: '#/components/responses/UnexpectedError'
1305 # BEGIN NS Instances
1306 '/nslcm/v1/ns_instances':
1310 summary: Query information about multiple NS instances
1311 description: Query information about multiple NS isntances
1312 operationId: getNSinstances
1319 $ref: '#/components/schemas/ArrayOfNsInstance'
1322 $ref: '#/components/schemas/ArrayOfNsInstance'
1324 $ref: '#/components/responses/BadRequest'
1326 $ref: '#/components/responses/Unauthorized'
1328 $ref: '#/components/responses/Forbidden'
1330 $ref: '#/components/responses/NotFound'
1332 $ref: '#/components/responses/MethodNotAllowed'
1334 $ref: '#/components/responses/NotAcceptable'
1336 $ref: '#/components/responses/Conflict'
1338 $ref: '#/components/responses/UnprocessableEntity'
1340 $ref: '#/components/responses/InternalServerError'
1342 $ref: '#/components/responses/ServiceUnavailable'
1344 $ref: '#/components/responses/UnexpectedError'
1346 $ref: '#/components/responses/UnexpectedError'
1350 summary: Create a new NS instance resource
1351 description: Create a new NS instance resource
1352 operationId: addNSinstance
1354 $ref: '#/components/requestBodies/CreateNsRequest'
1357 description: Created
1366 $ref: '#/components/schemas/ObjectId'
1369 $ref: '#/components/schemas/ObjectId'
1371 $ref: '#/components/responses/BadRequest'
1373 $ref: '#/components/responses/Unauthorized'
1375 $ref: '#/components/responses/Forbidden'
1377 $ref: '#/components/responses/NotFound'
1379 $ref: '#/components/responses/MethodNotAllowed'
1381 $ref: '#/components/responses/NotAcceptable'
1383 $ref: '#/components/responses/Conflict'
1385 $ref: '#/components/responses/UnprocessableEntity'
1387 $ref: '#/components/responses/InternalServerError'
1389 $ref: '#/components/responses/ServiceUnavailable'
1391 $ref: '#/components/responses/UnexpectedError'
1393 $ref: '#/components/responses/UnexpectedError'
1394 '/nslcm/v1/ns_instances/{nsInstanceId}':
1396 - name: nsInstanceId
1399 description: NS Instance ID
1405 summary: Read an individual NS instance resource
1406 description: Read an individual NS instance resource
1407 operationId: getNSinstance
1414 $ref: '#/components/schemas/NsInstance'
1417 $ref: '#/components/schemas/NsInstance'
1419 $ref: '#/components/responses/BadRequest'
1421 $ref: '#/components/responses/Unauthorized'
1423 $ref: '#/components/responses/Forbidden'
1425 $ref: '#/components/responses/NotFound'
1427 $ref: '#/components/responses/MethodNotAllowed'
1429 $ref: '#/components/responses/NotAcceptable'
1431 $ref: '#/components/responses/Conflict'
1433 $ref: '#/components/responses/UnprocessableEntity'
1435 $ref: '#/components/responses/InternalServerError'
1437 $ref: '#/components/responses/ServiceUnavailable'
1439 $ref: '#/components/responses/UnexpectedError'
1441 $ref: '#/components/responses/UnexpectedError'
1445 summary: Delete an individual NS instance resource
1446 description: Delete an individual NS instance resource
1447 operationId: deleteNSinstance
1450 description: No Content
1452 $ref: '#/components/responses/BadRequest'
1454 $ref: '#/components/responses/Unauthorized'
1456 $ref: '#/components/responses/Forbidden'
1458 $ref: '#/components/responses/NotFound'
1460 $ref: '#/components/responses/MethodNotAllowed'
1462 $ref: '#/components/responses/NotAcceptable'
1464 $ref: '#/components/responses/Conflict'
1466 $ref: '#/components/responses/UnprocessableEntity'
1468 $ref: '#/components/responses/InternalServerError'
1470 $ref: '#/components/responses/ServiceUnavailable'
1472 $ref: '#/components/responses/UnexpectedError'
1474 $ref: '#/components/responses/UnexpectedError'
1475 '/nslcm/v1/ns_instances/{nsInstanceId}/instantiate':
1477 - name: nsInstanceId
1480 description: NS Instance ID
1486 summary: Instantiate a NS
1488 Instantiate a NS. The precondition is that the NS instance must have
1489 been created and must be in NOT_INSTANTIATED state. As a result of the
1490 success of this operation, the NFVO creates a "NS Lifecycle Operation
1491 Occurrence" resource for the request, and the NS instance state becomes
1493 operationId: instantiateNSinstance
1495 $ref: '#/components/requestBodies/InstantiateNsRequest'
1498 description: Accepted
1502 It must point to the new "NS Lifecycle Operation Occurrence"
1503 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1510 $ref: '#/components/schemas/ObjectId'
1513 $ref: '#/components/schemas/ObjectId'
1515 $ref: '#/components/responses/BadRequest'
1517 $ref: '#/components/responses/Unauthorized'
1519 $ref: '#/components/responses/Forbidden'
1521 $ref: '#/components/responses/NotFound'
1523 $ref: '#/components/responses/MethodNotAllowed'
1525 $ref: '#/components/responses/NotAcceptable'
1527 $ref: '#/components/responses/Conflict'
1529 $ref: '#/components/responses/UnprocessableEntity'
1531 $ref: '#/components/responses/InternalServerError'
1533 $ref: '#/components/responses/ServiceUnavailable'
1535 $ref: '#/components/responses/UnexpectedError'
1537 $ref: '#/components/responses/UnexpectedError'
1538 '/nslcm/v1/ns_instances/{nsInstanceId}/scale':
1540 - name: nsInstanceId
1543 description: NS Instance ID
1549 summary: Scale a NS instance
1551 Scale a NS instance. The precondition is that the NS instance must have
1552 been created and must be in INSTANTIATED state. As a result of the
1553 success of this operation, the NFVO creates a "NS Lifecycle Operation
1554 Occurrence" resource for the request, and the NS instance state remains
1556 operationId: scaleNSinstance
1558 $ref: '#/components/requestBodies/ScaleNsRequest'
1561 description: Accepted
1565 It must point to the new "NS Lifecycle Operation Occurrence"
1566 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1571 $ref: '#/components/responses/BadRequest'
1573 $ref: '#/components/responses/Unauthorized'
1575 $ref: '#/components/responses/Forbidden'
1577 $ref: '#/components/responses/NotFound'
1579 $ref: '#/components/responses/MethodNotAllowed'
1581 $ref: '#/components/responses/NotAcceptable'
1583 $ref: '#/components/responses/Conflict'
1585 $ref: '#/components/responses/UnprocessableEntity'
1587 $ref: '#/components/responses/InternalServerError'
1589 $ref: '#/components/responses/ServiceUnavailable'
1591 $ref: '#/components/responses/UnexpectedError'
1593 $ref: '#/components/responses/UnexpectedError'
1594 '/nslcm/v1/ns_instances/{nsInstanceId}/terminate':
1596 - name: nsInstanceId
1599 description: NS Instance ID
1605 summary: Terminate a NS instance
1607 Terminate a NS instance. The precondition is that the NS instance must have
1608 been created and must be in INSTANTIATED state. As a result of the
1609 success of this operation, the NFVO creates a "NS Lifecycle Operation
1610 Occurrence" resource for the request, and the NS instance state becomes
1612 operationId: terminateNSinstance
1614 # Request data is not required
1615 $ref: '#/components/requestBodies/TerminateNsRequest'
1618 description: Accepted
1622 It must point to the new "NS Lifecycle Operation Occurrence"
1623 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1630 $ref: '#/components/schemas/ObjectId'
1633 $ref: '#/components/schemas/ObjectId'
1635 $ref: '#/components/responses/BadRequest'
1637 $ref: '#/components/responses/Unauthorized'
1639 $ref: '#/components/responses/Forbidden'
1641 $ref: '#/components/responses/NotFound'
1643 $ref: '#/components/responses/MethodNotAllowed'
1645 $ref: '#/components/responses/NotAcceptable'
1647 $ref: '#/components/responses/Conflict'
1649 $ref: '#/components/responses/UnprocessableEntity'
1651 $ref: '#/components/responses/InternalServerError'
1653 $ref: '#/components/responses/ServiceUnavailable'
1655 $ref: '#/components/responses/UnexpectedError'
1657 $ref: '#/components/responses/UnexpectedError'
1658 '/nslcm/v1/ns_instances/{nsInstanceId}/action':
1660 - name: nsInstanceId
1663 description: NS Instance ID
1669 summary: Execute an action on a NS instance
1671 Execute an action on a NS instance.
1672 The NS instance must have been created and must be in INSTANTIATED state.
1673 operationId: actionOnNSinstance
1678 $ref: '#/components/schemas/NSinstanceActionRequest'
1681 $ref: '#/components/schemas/NSinstanceActionRequest'
1684 description: Accepted
1688 It must point to the new "NS Lifecycle Operation Occurrence"
1689 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1696 $ref: '#/components/schemas/ObjectId'
1699 $ref: '#/components/schemas/ObjectId'
1701 $ref: '#/components/responses/BadRequest'
1703 $ref: '#/components/responses/Unauthorized'
1705 $ref: '#/components/responses/Forbidden'
1707 $ref: '#/components/responses/NotFound'
1709 $ref: '#/components/responses/MethodNotAllowed'
1711 $ref: '#/components/responses/NotAcceptable'
1713 $ref: '#/components/responses/Conflict'
1715 $ref: '#/components/responses/UnprocessableEntity'
1717 $ref: '#/components/responses/InternalServerError'
1719 $ref: '#/components/responses/ServiceUnavailable'
1721 $ref: '#/components/responses/UnexpectedError'
1723 $ref: '#/components/responses/UnexpectedError'
1724 '/nslcm/v1/ns_instances_content':
1728 summary: Query information about multiple NS instances
1729 description: Query information about multiple NS isntances
1730 operationId: getNSinstancesContent
1737 $ref: '#/components/schemas/ArrayOfNsInstance'
1740 $ref: '#/components/schemas/ArrayOfNsInstance'
1742 $ref: '#/components/responses/BadRequest'
1744 $ref: '#/components/responses/Unauthorized'
1746 $ref: '#/components/responses/Forbidden'
1748 $ref: '#/components/responses/NotFound'
1750 $ref: '#/components/responses/MethodNotAllowed'
1752 $ref: '#/components/responses/NotAcceptable'
1754 $ref: '#/components/responses/Conflict'
1756 $ref: '#/components/responses/UnprocessableEntity'
1758 $ref: '#/components/responses/InternalServerError'
1760 $ref: '#/components/responses/ServiceUnavailable'
1762 $ref: '#/components/responses/UnexpectedError'
1764 $ref: '#/components/responses/UnexpectedError'
1768 summary: Create a new NS instance
1769 description: Create a new NS instance
1770 operationId: createNSinstanceContent
1772 $ref: '#/components/requestBodies/CreateNSinstanceContentRequest'
1775 description: Created
1784 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
1787 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
1789 $ref: '#/components/responses/BadRequest'
1791 $ref: '#/components/responses/Unauthorized'
1793 $ref: '#/components/responses/Forbidden'
1795 $ref: '#/components/responses/NotFound'
1797 $ref: '#/components/responses/MethodNotAllowed'
1799 $ref: '#/components/responses/NotAcceptable'
1801 $ref: '#/components/responses/Conflict'
1803 $ref: '#/components/responses/UnprocessableEntity'
1805 $ref: '#/components/responses/InternalServerError'
1807 $ref: '#/components/responses/ServiceUnavailable'
1809 $ref: '#/components/responses/UnexpectedError'
1811 $ref: '#/components/responses/UnexpectedError'
1812 '/nslcm/v1/ns_instances_content/{nsInstanceContentId}':
1814 - name: nsInstanceContentId
1817 description: NS Instance Content ID
1823 summary: Read an individual NS instance resource
1824 description: Read an individual NS instance resource
1825 operationId: getNSinstanceContent
1832 $ref: '#/components/schemas/NsInstance'
1835 $ref: '#/components/schemas/NsInstance'
1837 $ref: '#/components/responses/BadRequest'
1839 $ref: '#/components/responses/Unauthorized'
1841 $ref: '#/components/responses/Forbidden'
1843 $ref: '#/components/responses/NotFound'
1845 $ref: '#/components/responses/MethodNotAllowed'
1847 $ref: '#/components/responses/NotAcceptable'
1849 $ref: '#/components/responses/Conflict'
1851 $ref: '#/components/responses/UnprocessableEntity'
1853 $ref: '#/components/responses/InternalServerError'
1855 $ref: '#/components/responses/ServiceUnavailable'
1857 $ref: '#/components/responses/UnexpectedError'
1859 $ref: '#/components/responses/UnexpectedError'
1863 summary: Delete an individual NS instance resource
1864 description: Delete an individual NS instance resource
1865 operationId: deleteNSinstanceContent
1868 description: Accepted
1872 $ref: '#/components/schemas/ObjectId'
1875 $ref: '#/components/schemas/ObjectId'
1877 description: No Content
1879 $ref: '#/components/responses/BadRequest'
1881 $ref: '#/components/responses/Unauthorized'
1883 $ref: '#/components/responses/Forbidden'
1885 $ref: '#/components/responses/NotFound'
1887 $ref: '#/components/responses/MethodNotAllowed'
1889 $ref: '#/components/responses/NotAcceptable'
1891 $ref: '#/components/responses/Conflict'
1893 $ref: '#/components/responses/UnprocessableEntity'
1895 $ref: '#/components/responses/InternalServerError'
1897 $ref: '#/components/responses/ServiceUnavailable'
1899 $ref: '#/components/responses/UnexpectedError'
1901 $ref: '#/components/responses/UnexpectedError'
1902 '/nslcm/v1/ns_lcm_op_occs':
1906 summary: Query information about multiple NS LCM Operation Occurrences
1907 description: Query information about multiple NS LCM Operation Occurrences
1908 operationId: getNSLCMOpOccs
1915 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
1918 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
1920 $ref: '#/components/responses/BadRequest'
1922 $ref: '#/components/responses/Unauthorized'
1924 $ref: '#/components/responses/Forbidden'
1926 $ref: '#/components/responses/NotFound'
1928 $ref: '#/components/responses/MethodNotAllowed'
1930 $ref: '#/components/responses/NotAcceptable'
1932 $ref: '#/components/responses/Conflict'
1934 $ref: '#/components/responses/UnprocessableEntity'
1936 $ref: '#/components/responses/InternalServerError'
1938 $ref: '#/components/responses/ServiceUnavailable'
1940 $ref: '#/components/responses/UnexpectedError'
1942 $ref: '#/components/responses/UnexpectedError'
1943 '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}':
1945 - name: nsLcmOpOccId
1948 description: NS LCM Operation Occurrence ID
1954 summary: Query information about an individual NS LCM Operation Occurrence
1955 description: Query information about an individual NS LCM Operation Occurrence
1956 operationId: getNSLCMOpOcc
1963 $ref: '#/components/schemas/NsLcmOpOcc'
1966 $ref: '#/components/schemas/NsLcmOpOcc'
1968 $ref: '#/components/responses/BadRequest'
1970 $ref: '#/components/responses/Unauthorized'
1972 $ref: '#/components/responses/Forbidden'
1974 $ref: '#/components/responses/NotFound'
1976 $ref: '#/components/responses/MethodNotAllowed'
1978 $ref: '#/components/responses/NotAcceptable'
1980 $ref: '#/components/responses/Conflict'
1982 $ref: '#/components/responses/UnprocessableEntity'
1984 $ref: '#/components/responses/InternalServerError'
1986 $ref: '#/components/responses/ServiceUnavailable'
1988 $ref: '#/components/responses/UnexpectedError'
1990 $ref: '#/components/responses/UnexpectedError'
1991 '/nslcm/v1/vnf_instances':
1995 summary: Query information about multiple VNF Instances
1996 description: Query information about multiple VNF Instances
1997 operationId: getVnfInstances
2004 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2007 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2009 $ref: '#/components/responses/BadRequest'
2011 $ref: '#/components/responses/Unauthorized'
2013 $ref: '#/components/responses/Forbidden'
2015 $ref: '#/components/responses/NotFound'
2017 $ref: '#/components/responses/MethodNotAllowed'
2019 $ref: '#/components/responses/NotAcceptable'
2021 $ref: '#/components/responses/Conflict'
2023 $ref: '#/components/responses/UnprocessableEntity'
2025 $ref: '#/components/responses/InternalServerError'
2027 $ref: '#/components/responses/ServiceUnavailable'
2029 $ref: '#/components/responses/UnexpectedError'
2031 $ref: '#/components/responses/UnexpectedError'
2032 '/nslcm/v1/vnf_instances/{vnfInstanceId}':
2034 - name: vnfInstanceId
2037 description: VNF Instance ID
2043 summary: Query information about an individual VNF Instance
2044 description: Query information about an individual VNF Instance
2045 operationId: getVnfInstance
2052 $ref: '#/components/schemas/VnfInstanceInfo'
2055 $ref: '#/components/schemas/VnfInstanceInfo'
2057 $ref: '#/components/responses/BadRequest'
2059 $ref: '#/components/responses/Unauthorized'
2061 $ref: '#/components/responses/Forbidden'
2063 $ref: '#/components/responses/NotFound'
2065 $ref: '#/components/responses/MethodNotAllowed'
2067 $ref: '#/components/responses/NotAcceptable'
2069 $ref: '#/components/responses/Conflict'
2071 $ref: '#/components/responses/UnprocessableEntity'
2073 $ref: '#/components/responses/InternalServerError'
2075 $ref: '#/components/responses/ServiceUnavailable'
2077 $ref: '#/components/responses/UnexpectedError'
2079 $ref: '#/components/responses/UnexpectedError'
2082 # BEGIN NetSlice Templates
2083 '/nst/v1/netslice_templates':
2086 - "NetSlice templates"
2087 summary: Query information about multiple NetSlice template resources
2088 description: Query information about multiple NetSlice template resources
2089 operationId: getNSTs
2096 $ref: '#/components/schemas/ArrayOfNstInfo'
2099 $ref: '#/components/schemas/ArrayOfNstInfo'
2101 $ref: '#/components/responses/BadRequest'
2103 $ref: '#/components/responses/Unauthorized'
2105 $ref: '#/components/responses/Forbidden'
2107 $ref: '#/components/responses/NotFound'
2109 $ref: '#/components/responses/MethodNotAllowed'
2111 $ref: '#/components/responses/NotAcceptable'
2113 $ref: '#/components/responses/Conflict'
2115 $ref: '#/components/responses/UnprocessableEntity'
2117 $ref: '#/components/responses/InternalServerError'
2119 $ref: '#/components/responses/ServiceUnavailable'
2121 $ref: '#/components/responses/UnexpectedError'
2123 $ref: '#/components/responses/UnexpectedError'
2126 - "NetSlice templates"
2127 summary: Create a new NetSlice template resource
2128 description: Create a new NetSlice template resource
2131 $ref: '#/components/requestBodies/CreateNstInfoRequest'
2134 description: Created
2143 $ref: '#/components/schemas/ObjectId'
2146 $ref: '#/components/schemas/ObjectId'
2148 $ref: '#/components/responses/BadRequest'
2150 $ref: '#/components/responses/Unauthorized'
2152 $ref: '#/components/responses/Forbidden'
2154 $ref: '#/components/responses/NotFound'
2156 $ref: '#/components/responses/MethodNotAllowed'
2158 $ref: '#/components/responses/NotAcceptable'
2160 $ref: '#/components/responses/Conflict'
2162 $ref: '#/components/responses/UnprocessableEntity'
2164 $ref: '#/components/responses/InternalServerError'
2166 $ref: '#/components/responses/ServiceUnavailable'
2168 $ref: '#/components/responses/UnexpectedError'
2170 $ref: '#/components/responses/UnexpectedError'
2171 '/nst/v1/netslice_templates/{netsliceTemplateId}':
2173 - name: netsliceTemplateId
2176 description: NetSlice Template ID
2181 - "NetSlice templates"
2182 summary: Read information about an individual NetSlice template resource
2183 description: Read information about an individual NetSlice template resource
2191 $ref: '#/components/schemas/NstInfo'
2194 $ref: '#/components/schemas/NstInfo'
2196 $ref: '#/components/responses/BadRequest'
2198 $ref: '#/components/responses/Unauthorized'
2200 $ref: '#/components/responses/Forbidden'
2202 $ref: '#/components/responses/NotFound'
2204 $ref: '#/components/responses/MethodNotAllowed'
2206 $ref: '#/components/responses/NotAcceptable'
2208 $ref: '#/components/responses/Conflict'
2210 $ref: '#/components/responses/UnprocessableEntity'
2212 $ref: '#/components/responses/InternalServerError'
2214 $ref: '#/components/responses/ServiceUnavailable'
2216 $ref: '#/components/responses/UnexpectedError'
2218 $ref: '#/components/responses/UnexpectedError'
2221 - "NetSlice templates"
2222 summary: Delete an individual NetSlice template resource
2223 description: Delete an individual NetSlice template resource
2224 operationId: deleteNST
2227 description: No Content
2229 $ref: '#/components/responses/BadRequest'
2231 $ref: '#/components/responses/Unauthorized'
2233 $ref: '#/components/responses/Forbidden'
2235 $ref: '#/components/responses/NotFound'
2237 $ref: '#/components/responses/MethodNotAllowed'
2239 $ref: '#/components/responses/NotAcceptable'
2241 $ref: '#/components/responses/Conflict'
2243 $ref: '#/components/responses/UnprocessableEntity'
2245 $ref: '#/components/responses/InternalServerError'
2247 $ref: '#/components/responses/ServiceUnavailable'
2249 $ref: '#/components/responses/UnexpectedError'
2251 $ref: '#/components/responses/UnexpectedError'
2252 '/nst/v1/netslice_templates/{netsliceTemplateId}/artifacts/{artifactPath}':
2254 - name: netsliceTemplateId
2257 description: NetSlice Template ID
2260 - name: artifactPath
2263 description: Artifact Path
2268 - "NetSlice templates"
2269 summary: Fetch individual NetSlice Template artifact
2270 description: Fetch individual NetSlice Template artifact
2271 operationId: getNstArtifact
2276 application/octet-stream:
2281 description: Partial Content
2287 application/octet-stream:
2292 $ref: '#/components/responses/BadRequest'
2294 $ref: '#/components/responses/Unauthorized'
2296 $ref: '#/components/responses/Forbidden'
2298 $ref: '#/components/responses/NotFound'
2300 $ref: '#/components/responses/MethodNotAllowed'
2302 $ref: '#/components/responses/NotAcceptable'
2304 $ref: '#/components/responses/Conflict'
2306 $ref: '#/components/responses/UnprocessableEntity'
2308 $ref: '#/components/responses/InternalServerError'
2310 $ref: '#/components/responses/ServiceUnavailable'
2312 $ref: '#/components/responses/UnexpectedError'
2314 $ref: '#/components/responses/UnexpectedError'
2315 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst':
2317 - name: netsliceTemplateId
2320 description: NetSlice Template ID
2325 - "NetSlice templates"
2326 summary: Read NST of an on-boarded NetSlice Template
2327 description: Read NST of an on-boarded NetSlice Template
2328 operationId: getNstNst
2335 $ref: '#/components/schemas/NetSliceTemplate'
2337 $ref: '#/components/responses/BadRequest'
2339 $ref: '#/components/responses/Unauthorized'
2341 $ref: '#/components/responses/Forbidden'
2343 $ref: '#/components/responses/NotFound'
2345 $ref: '#/components/responses/MethodNotAllowed'
2347 $ref: '#/components/responses/NotAcceptable'
2349 $ref: '#/components/responses/Conflict'
2351 $ref: '#/components/responses/UnprocessableEntity'
2353 $ref: '#/components/responses/InternalServerError'
2355 $ref: '#/components/responses/ServiceUnavailable'
2357 $ref: '#/components/responses/UnexpectedError'
2359 $ref: '#/components/responses/UnexpectedError'
2360 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst_content':
2362 - name: netsliceTemplateId
2365 description: NetSlice Template ID
2370 - "NetSlice templates"
2371 summary: Fetch the content of a NST
2372 description: Fetch the content of a NST
2373 operationId: getNSTcontent
2380 $ref: '#/components/schemas/NetSlicePackage'
2382 description: Partial Content
2390 $ref: '#/components/schemas/NetSlicePackage'
2392 $ref: '#/components/responses/BadRequest'
2394 $ref: '#/components/responses/Unauthorized'
2396 $ref: '#/components/responses/Forbidden'
2398 $ref: '#/components/responses/NotFound'
2400 $ref: '#/components/responses/MethodNotAllowed'
2402 $ref: '#/components/responses/NotAcceptable'
2404 $ref: '#/components/responses/Conflict'
2406 $ref: '#/components/responses/UnprocessableEntity'
2408 $ref: '#/components/responses/InternalServerError'
2410 $ref: '#/components/responses/ServiceUnavailable'
2412 $ref: '#/components/responses/UnexpectedError'
2414 $ref: '#/components/responses/UnexpectedError'
2417 - "NetSlice templates"
2418 summary: Upload the content of a NST
2419 description: Upload the content of a NST
2420 operationId: updateNSTcontent
2422 $ref: '#/components/requestBodies/NetSlicePackage'
2425 description: Accepted
2427 description: No Content
2429 $ref: '#/components/responses/BadRequest'
2431 $ref: '#/components/responses/Unauthorized'
2433 $ref: '#/components/responses/Forbidden'
2435 $ref: '#/components/responses/NotFound'
2437 $ref: '#/components/responses/MethodNotAllowed'
2439 $ref: '#/components/responses/NotAcceptable'
2441 $ref: '#/components/responses/Conflict'
2443 $ref: '#/components/responses/UnprocessableEntity'
2445 $ref: '#/components/responses/InternalServerError'
2447 $ref: '#/components/responses/ServiceUnavailable'
2449 $ref: '#/components/responses/UnexpectedError'
2451 $ref: '#/components/responses/UnexpectedError'
2452 '/nst/v1/netslice_templates_content':
2455 - "NetSlice templates"
2456 summary: Upload a NetSlice package by providing the content of the NetSlice package
2457 description: Upload a NetSlice package by providing the content of the NetSlice package
2458 operationId: uploadNstContent
2463 $ref: '#/components/schemas/NetSlicePackage'
2466 description: Created
2475 $ref: '#/components/schemas/ObjectId'
2478 $ref: '#/components/schemas/ObjectId'
2480 description: Accepted
2482 description: No Content
2484 $ref: '#/components/responses/BadRequest'
2486 $ref: '#/components/responses/Unauthorized'
2488 $ref: '#/components/responses/Forbidden'
2490 $ref: '#/components/responses/NotFound'
2492 $ref: '#/components/responses/MethodNotAllowed'
2494 $ref: '#/components/responses/NotAcceptable'
2496 $ref: '#/components/responses/Conflict'
2498 $ref: '#/components/responses/UnprocessableEntity'
2500 $ref: '#/components/responses/InternalServerError'
2502 $ref: '#/components/responses/ServiceUnavailable'
2504 $ref: '#/components/responses/UnexpectedError'
2506 $ref: '#/components/responses/UnexpectedError'
2509 - "NetSlice templates"
2510 summary: Query information about multiple NetSlice Template resources
2511 description: Query information about multiple NetSlice Template resources
2512 operationId: getNstContent
2519 $ref: '#/components/schemas/ArrayOfNstInfo'
2522 $ref: '#/components/schemas/ArrayOfNstInfo'
2524 description: Partial Content
2530 application/octet-stream:
2535 $ref: '#/components/responses/BadRequest'
2537 $ref: '#/components/responses/Unauthorized'
2539 $ref: '#/components/responses/Forbidden'
2541 $ref: '#/components/responses/NotFound'
2543 $ref: '#/components/responses/MethodNotAllowed'
2545 $ref: '#/components/responses/NotAcceptable'
2547 $ref: '#/components/responses/Conflict'
2549 $ref: '#/components/responses/UnprocessableEntity'
2551 $ref: '#/components/responses/InternalServerError'
2553 $ref: '#/components/responses/ServiceUnavailable'
2555 $ref: '#/components/responses/UnexpectedError'
2557 $ref: '#/components/responses/UnexpectedError'
2558 '/nst/v1/netslice_templates_content/{netsliceTemplateContentId}':
2560 - name: netsliceTemplateContentId
2563 description: NetSlice Template ID
2568 - "NetSlice templates"
2569 summary: Read information about an individual NetSlice Template resource
2570 description: Read information about an individual NetSlice Template resource
2571 operationId: getNstIdContent
2578 $ref: '#/components/schemas/NstInfo'
2581 $ref: '#/components/schemas/NstInfo'
2583 $ref: '#/components/responses/BadRequest'
2585 $ref: '#/components/responses/Unauthorized'
2587 $ref: '#/components/responses/Forbidden'
2589 $ref: '#/components/responses/NotFound'
2591 $ref: '#/components/responses/MethodNotAllowed'
2593 $ref: '#/components/responses/NotAcceptable'
2595 $ref: '#/components/responses/Conflict'
2597 $ref: '#/components/responses/UnprocessableEntity'
2599 $ref: '#/components/responses/InternalServerError'
2601 $ref: '#/components/responses/ServiceUnavailable'
2603 $ref: '#/components/responses/UnexpectedError'
2605 $ref: '#/components/responses/UnexpectedError'
2608 - "NetSlice templates"
2609 summary: Modify an individual NetSlice Template resource
2610 description: Modify an individual NetSlice Template resource
2611 operationId: updateNstIdContent
2613 $ref: '#/components/requestBodies/NstInfoModifications'
2616 description: No Content
2618 $ref: '#/components/responses/BadRequest'
2620 $ref: '#/components/responses/Unauthorized'
2622 $ref: '#/components/responses/Forbidden'
2624 $ref: '#/components/responses/NotFound'
2626 $ref: '#/components/responses/MethodNotAllowed'
2628 $ref: '#/components/responses/NotAcceptable'
2630 $ref: '#/components/responses/Conflict'
2632 $ref: '#/components/responses/UnprocessableEntity'
2634 $ref: '#/components/responses/InternalServerError'
2636 $ref: '#/components/responses/ServiceUnavailable'
2638 $ref: '#/components/responses/UnexpectedError'
2640 $ref: '#/components/responses/UnexpectedError'
2643 - "NetSlice templates"
2644 summary: Delete an individual NetSlice Template resource
2645 description: Delete an individual NetSlice Template resource
2646 operationId: deleteNstIdContent
2649 description: No Content
2651 $ref: '#/components/responses/BadRequest'
2653 $ref: '#/components/responses/Unauthorized'
2655 $ref: '#/components/responses/Forbidden'
2657 $ref: '#/components/responses/NotFound'
2659 $ref: '#/components/responses/MethodNotAllowed'
2661 $ref: '#/components/responses/NotAcceptable'
2663 $ref: '#/components/responses/Conflict'
2665 $ref: '#/components/responses/UnprocessableEntity'
2667 $ref: '#/components/responses/InternalServerError'
2669 $ref: '#/components/responses/ServiceUnavailable'
2671 $ref: '#/components/responses/UnexpectedError'
2673 $ref: '#/components/responses/UnexpectedError'
2674 # END NetSlice Templates
2676 # BEGIN NetSlice Instances
2677 '/nsilcm/v1/netslice_instances':
2680 - "NetSlice instances"
2681 summary: Query information about multiple NetSlice instances
2682 description: Query information about multiple NetSlice isntances
2683 operationId: getNSIs
2690 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
2693 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
2695 $ref: '#/components/responses/BadRequest'
2697 $ref: '#/components/responses/Unauthorized'
2699 $ref: '#/components/responses/Forbidden'
2701 $ref: '#/components/responses/NotFound'
2703 $ref: '#/components/responses/MethodNotAllowed'
2705 $ref: '#/components/responses/NotAcceptable'
2707 $ref: '#/components/responses/Conflict'
2709 $ref: '#/components/responses/UnprocessableEntity'
2711 $ref: '#/components/responses/InternalServerError'
2713 $ref: '#/components/responses/ServiceUnavailable'
2715 $ref: '#/components/responses/UnexpectedError'
2717 $ref: '#/components/responses/UnexpectedError'
2720 - "NetSlice instances"
2721 summary: Create a new NetSlice instance resource
2722 description: Create a new NetSlice instance resource
2725 $ref: '#/components/requestBodies/CreateNsiRequest'
2728 description: Created
2737 $ref: '#/components/schemas/ObjectId'
2740 $ref: '#/components/schemas/ObjectId'
2742 $ref: '#/components/responses/BadRequest'
2744 $ref: '#/components/responses/Unauthorized'
2746 $ref: '#/components/responses/Forbidden'
2748 $ref: '#/components/responses/NotFound'
2750 $ref: '#/components/responses/MethodNotAllowed'
2752 $ref: '#/components/responses/NotAcceptable'
2754 $ref: '#/components/responses/Conflict'
2756 $ref: '#/components/responses/UnprocessableEntity'
2758 $ref: '#/components/responses/InternalServerError'
2760 $ref: '#/components/responses/ServiceUnavailable'
2762 $ref: '#/components/responses/UnexpectedError'
2764 $ref: '#/components/responses/UnexpectedError'
2765 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}':
2767 - name: netsliceInstanceId
2770 description: NetSlice Instance ID
2775 - "NetSlice instances"
2776 summary: Read an individual NetSlice instance resource
2777 description: Read an individual NetSlice instance resource
2785 $ref: '#/components/schemas/NetSliceInstance'
2788 $ref: '#/components/schemas/NetSliceInstance'
2790 $ref: '#/components/responses/BadRequest'
2792 $ref: '#/components/responses/Unauthorized'
2794 $ref: '#/components/responses/Forbidden'
2796 $ref: '#/components/responses/NotFound'
2798 $ref: '#/components/responses/MethodNotAllowed'
2800 $ref: '#/components/responses/NotAcceptable'
2802 $ref: '#/components/responses/Conflict'
2804 $ref: '#/components/responses/UnprocessableEntity'
2806 $ref: '#/components/responses/InternalServerError'
2808 $ref: '#/components/responses/ServiceUnavailable'
2810 $ref: '#/components/responses/UnexpectedError'
2812 $ref: '#/components/responses/UnexpectedError'
2815 - "NetSlice instances"
2816 summary: Delete an individual NetSlice instance resource
2817 description: Delete an individual NetSlice instance resource
2818 operationId: deleteNSI
2821 description: No Content
2823 $ref: '#/components/responses/BadRequest'
2825 $ref: '#/components/responses/Unauthorized'
2827 $ref: '#/components/responses/Forbidden'
2829 $ref: '#/components/responses/NotFound'
2831 $ref: '#/components/responses/MethodNotAllowed'
2833 $ref: '#/components/responses/NotAcceptable'
2835 $ref: '#/components/responses/Conflict'
2837 $ref: '#/components/responses/UnprocessableEntity'
2839 $ref: '#/components/responses/InternalServerError'
2841 $ref: '#/components/responses/ServiceUnavailable'
2843 $ref: '#/components/responses/UnexpectedError'
2845 $ref: '#/components/responses/UnexpectedError'
2846 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/instantiate':
2848 - name: netsliceInstanceId
2851 description: NetSlice Instance ID
2856 - "NetSlice instances"
2857 summary: Instantiate a NetSlice
2859 Instantiate a NetSlice. The precondition is that the NetSlice instance
2860 must have been created and must be in NOT_INSTANTIATED state. As a result
2861 of the success of this operation, the NFVO creates a "NetSlice Lifecycle
2862 Operation Occurrence" resource for the request, and the NS instance state
2863 becomes INSTANTIATED.
2864 operationId: instantiateNSI
2866 $ref: '#/components/requestBodies/InstantiateNsiRequest'
2869 description: Accepted
2873 It must point to the new "NetSlice Lifecycle Operation Occurrence"
2874 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
2881 $ref: '#/components/schemas/ObjectId'
2884 $ref: '#/components/schemas/ObjectId'
2886 $ref: '#/components/responses/BadRequest'
2888 $ref: '#/components/responses/Unauthorized'
2890 $ref: '#/components/responses/Forbidden'
2892 $ref: '#/components/responses/NotFound'
2894 $ref: '#/components/responses/MethodNotAllowed'
2896 $ref: '#/components/responses/NotAcceptable'
2898 $ref: '#/components/responses/Conflict'
2900 $ref: '#/components/responses/UnprocessableEntity'
2902 $ref: '#/components/responses/InternalServerError'
2904 $ref: '#/components/responses/ServiceUnavailable'
2906 $ref: '#/components/responses/UnexpectedError'
2908 $ref: '#/components/responses/UnexpectedError'
2909 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/terminate':
2911 - name: netsliceInstanceId
2914 description: NetSlice Instance ID
2919 - "NetSlice instances"
2920 summary: Terminate a NetSlice instance
2922 Terminate a NetSlice instance. The precondition is that the NetSlice instance
2923 must have been created and must be in INSTANTIATED state. As a result of the
2924 success of this operation, the NFVO creates a "NetSlice Lifecycle Operation
2925 Occurrence" resource for the request, and the NetSlice instance state becomes
2927 operationId: terminateNSI
2929 # Request data is not required
2930 $ref: '#/components/requestBodies/TerminateNsiRequest'
2933 description: Accepted
2937 It must point to the new "NetSlice Lifecycle Operation Occurrence"
2938 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
2945 $ref: '#/components/schemas/ObjectId'
2948 $ref: '#/components/schemas/ObjectId'
2950 $ref: '#/components/responses/BadRequest'
2952 $ref: '#/components/responses/Unauthorized'
2954 $ref: '#/components/responses/Forbidden'
2956 $ref: '#/components/responses/NotFound'
2958 $ref: '#/components/responses/MethodNotAllowed'
2960 $ref: '#/components/responses/NotAcceptable'
2962 $ref: '#/components/responses/Conflict'
2964 $ref: '#/components/responses/UnprocessableEntity'
2966 $ref: '#/components/responses/InternalServerError'
2968 $ref: '#/components/responses/ServiceUnavailable'
2970 $ref: '#/components/responses/UnexpectedError'
2972 $ref: '#/components/responses/UnexpectedError'
2973 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/action':
2975 - name: netsliceInstanceId
2978 description: NetSlice Instance ID
2983 - "NetSlice instances"
2984 summary: Execute an action on a NetSlice instance
2986 Execute an action on a NetSlice instance.
2987 The NetSlice instance must have been created and must be in INSTANTIATED state.
2988 operationId: actionOnNSI
2993 $ref: '#/components/schemas/NsiActionRequest'
2996 $ref: '#/components/schemas/NsiActionRequest'
2999 description: Accepted
3003 It must point to the new "NS Lifecycle Operation Occurrence"
3004 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
3011 $ref: '#/components/schemas/ObjectId'
3014 $ref: '#/components/schemas/ObjectId'
3016 $ref: '#/components/responses/BadRequest'
3018 $ref: '#/components/responses/Unauthorized'
3020 $ref: '#/components/responses/Forbidden'
3022 $ref: '#/components/responses/NotFound'
3024 $ref: '#/components/responses/MethodNotAllowed'
3026 $ref: '#/components/responses/NotAcceptable'
3028 $ref: '#/components/responses/Conflict'
3030 $ref: '#/components/responses/UnprocessableEntity'
3032 $ref: '#/components/responses/InternalServerError'
3034 $ref: '#/components/responses/ServiceUnavailable'
3036 $ref: '#/components/responses/UnexpectedError'
3038 $ref: '#/components/responses/UnexpectedError'
3039 '/nsilcm/v1/netslice_instances_content':
3042 - "NetSlice instances"
3043 summary: Query information about multiple NetSlice instances
3044 description: Query information about multiple NetSlice isntances
3045 operationId: getNSIsContent
3052 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3055 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3057 $ref: '#/components/responses/BadRequest'
3059 $ref: '#/components/responses/Unauthorized'
3061 $ref: '#/components/responses/Forbidden'
3063 $ref: '#/components/responses/NotFound'
3065 $ref: '#/components/responses/MethodNotAllowed'
3067 $ref: '#/components/responses/NotAcceptable'
3069 $ref: '#/components/responses/Conflict'
3071 $ref: '#/components/responses/UnprocessableEntity'
3073 $ref: '#/components/responses/InternalServerError'
3075 $ref: '#/components/responses/ServiceUnavailable'
3077 $ref: '#/components/responses/UnexpectedError'
3079 $ref: '#/components/responses/UnexpectedError'
3082 - "NetSlice instances"
3083 summary: Create a new NetSlice instance
3084 description: Create a new NetSlice instance
3085 operationId: createNSIContent
3087 $ref: '#/components/requestBodies/CreateNsiContentRequest'
3090 description: Created
3099 $ref: '#/components/schemas/CreateNsiContentResponse'
3102 $ref: '#/components/schemas/CreateNsiContentResponse'
3104 $ref: '#/components/responses/BadRequest'
3106 $ref: '#/components/responses/Unauthorized'
3108 $ref: '#/components/responses/Forbidden'
3110 $ref: '#/components/responses/NotFound'
3112 $ref: '#/components/responses/MethodNotAllowed'
3114 $ref: '#/components/responses/NotAcceptable'
3116 $ref: '#/components/responses/Conflict'
3118 $ref: '#/components/responses/UnprocessableEntity'
3120 $ref: '#/components/responses/InternalServerError'
3122 $ref: '#/components/responses/ServiceUnavailable'
3124 $ref: '#/components/responses/UnexpectedError'
3126 $ref: '#/components/responses/UnexpectedError'
3127 '/nsilcm/v1/netslice_instances_content/{netsliceInstanceContentId}':
3129 - name: netsliceInstanceContentId
3132 description: NetSlice Instance Content ID
3137 - "NetSlice instances"
3138 summary: Read an individual NetSlice instance resource
3139 description: Read an individual NetSlice instance resource
3140 operationId: getNSIContent
3147 $ref: '#/components/schemas/NetSliceInstance'
3150 $ref: '#/components/schemas/NetSliceInstance'
3152 $ref: '#/components/responses/BadRequest'
3154 $ref: '#/components/responses/Unauthorized'
3156 $ref: '#/components/responses/Forbidden'
3158 $ref: '#/components/responses/NotFound'
3160 $ref: '#/components/responses/MethodNotAllowed'
3162 $ref: '#/components/responses/NotAcceptable'
3164 $ref: '#/components/responses/Conflict'
3166 $ref: '#/components/responses/UnprocessableEntity'
3168 $ref: '#/components/responses/InternalServerError'
3170 $ref: '#/components/responses/ServiceUnavailable'
3172 $ref: '#/components/responses/UnexpectedError'
3174 $ref: '#/components/responses/UnexpectedError'
3177 - "NetSlice instances"
3178 summary: Delete an individual NS instance resource
3179 description: Delete an individual NS instance resource
3180 operationId: deleteNSIContent
3183 description: Accepted
3187 $ref: '#/components/schemas/ObjectId'
3190 $ref: '#/components/schemas/ObjectId'
3192 description: No Content
3194 $ref: '#/components/responses/BadRequest'
3196 $ref: '#/components/responses/Unauthorized'
3198 $ref: '#/components/responses/Forbidden'
3200 $ref: '#/components/responses/NotFound'
3202 $ref: '#/components/responses/MethodNotAllowed'
3204 $ref: '#/components/responses/NotAcceptable'
3206 $ref: '#/components/responses/Conflict'
3208 $ref: '#/components/responses/UnprocessableEntity'
3210 $ref: '#/components/responses/InternalServerError'
3212 $ref: '#/components/responses/ServiceUnavailable'
3214 $ref: '#/components/responses/UnexpectedError'
3216 $ref: '#/components/responses/UnexpectedError'
3217 '/nsilcm/v1/nsi_lcm_op_occs':
3220 - "NetSlice instances"
3221 summary: Query information about multiple NetSlice LCM Operation Occurrences
3222 description: Query information about multiple NetSlice LCM Operation Occurrences
3223 operationId: getNsiLcmOpOccs
3230 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
3233 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
3235 $ref: '#/components/responses/BadRequest'
3237 $ref: '#/components/responses/Unauthorized'
3239 $ref: '#/components/responses/Forbidden'
3241 $ref: '#/components/responses/NotFound'
3243 $ref: '#/components/responses/MethodNotAllowed'
3245 $ref: '#/components/responses/NotAcceptable'
3247 $ref: '#/components/responses/Conflict'
3249 $ref: '#/components/responses/UnprocessableEntity'
3251 $ref: '#/components/responses/InternalServerError'
3253 $ref: '#/components/responses/ServiceUnavailable'
3255 $ref: '#/components/responses/UnexpectedError'
3257 $ref: '#/components/responses/UnexpectedError'
3258 '/nsilcm/v1/nsi_lcm_op_occs/{nsiLcmOpOccId}':
3260 - name: nsiLcmOpOccId
3263 description: NetSlice LCM Operation Occurrence ID
3268 - "NetSlice instances"
3269 summary: Query information about an individual NetSlice LCM Operation Occurrence
3270 description: Query information about an individual NetSlice LCM Operation Occurrence
3271 operationId: getNsiLcmOpOcc
3278 $ref: '#/components/schemas/NsiLcmOpOcc'
3281 $ref: '#/components/schemas/NsiLcmOpOcc'
3283 $ref: '#/components/responses/BadRequest'
3285 $ref: '#/components/responses/Unauthorized'
3287 $ref: '#/components/responses/Forbidden'
3289 $ref: '#/components/responses/NotFound'
3291 $ref: '#/components/responses/MethodNotAllowed'
3293 $ref: '#/components/responses/NotAcceptable'
3295 $ref: '#/components/responses/Conflict'
3297 $ref: '#/components/responses/UnprocessableEntity'
3299 $ref: '#/components/responses/InternalServerError'
3301 $ref: '#/components/responses/ServiceUnavailable'
3303 $ref: '#/components/responses/UnexpectedError'
3305 $ref: '#/components/responses/UnexpectedError'
3306 # END NetSlice Instances
3309 # /nspm/v1/pm_jobs/{pmJobId}/reports/{reportId}
3313 # /pdu/v1/pdu_descriptors
3314 # /pdu/v1/pdu_descriptors/{pduDescriptorId}
3319 # /admin/v1/tokens/{tokenId}
3321 # /admin/v1/users/{userId}
3322 # /admin/v1/projects
3323 # /admin/v1/projects/{projectId}
3325 # /admin/v1/roles/{roleId}
3327 # /admin/v1/vims/{vimId}
3328 # /admin/v1/vim_accounts
3329 # /admin/v1/vim_accounts/{vimAccountId}
3330 # /admin/v1/wim_accounts
3331 # /admin/v1/wim_accounts/{wimAccountId}
3333 # /admin/v1/sdns/{sdnId}
3337 description: Find out more OSM
3338 url: 'http://osm.etsi.org/wikipub'
3343 description: Bad request. The server cannot process the request due to a client error.
3347 $ref: '#/components/schemas/ProblemDetails'
3349 description: Authorization information is missing or invalid.
3353 $ref: '#/components/schemas/ProblemDetails'
3355 description: Not enough permissions to do this operation.
3359 $ref: '#/components/schemas/ProblemDetails'
3361 description: The specified resource was not found.
3365 $ref: '#/components/schemas/ProblemDetails'
3367 description: This method is not supported for the requested resource.
3371 $ref: '#/components/schemas/ProblemDetails'
3373 description: The requested resource content cannot match the Accept headers sent in the request.
3377 $ref: '#/components/schemas/ProblemDetails'
3379 description: The operation cannot be executed currently, due to a conflict with the state of the resource.
3383 $ref: '#/components/schemas/ProblemDetails'
3384 UnprocessableEntity:
3385 description: The request was well-formed but was unable to be followed due to semantic errors.
3389 $ref: '#/components/schemas/ProblemDetails'
3390 InternalServerError:
3391 description: Internal server error.
3395 $ref: '#/components/schemas/ProblemDetails'
3397 description: Service temporarily unavailable.
3401 $ref: '#/components/schemas/ProblemDetails'
3403 description: Unexpected error.
3407 $ref: '#/components/schemas/ProblemDetails'
3409 description: VNF Descriptor (plaintext)
3413 $ref: '#/components/schemas/VnfDescriptor'
3415 description: VNF Package (compressed)
3419 $ref: '#/components/schemas/VnfPackage'
3421 description: NS Descriptor (plaintext)
3425 $ref: '#/components/schemas/NsDescriptor'
3427 description: NS Package (compressed)
3431 $ref: '#/components/schemas/NsPackage'
3433 description: NetSlice Template (plaintext)
3437 $ref: '#/components/schemas/NetSliceTemplate'
3439 description: NetSlice Package (compressed)
3443 $ref: '#/components/schemas/NetSlicePackage'
3454 # A free list of key:value pairs
3456 additionalProperties: true
3463 CreateNsdInfoRequest:
3464 # A free list of key:value pairs
3466 additionalProperties: true
3467 NsdInfoModifications:
3469 NS Descriptor Information
3470 Only generic fields (id, name, description) are described
3471 For a full specification of the NS Descriptor see:
3472 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
3476 description: NSD Identifier
3479 description: NSD Name
3482 description: NSD Description
3486 NS Descriptor Information
3487 Only generic fields (_id, id, name, description) are described
3488 For a full specification of the NS Descriptor see:
3489 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
3494 Identifier of the onboarded individual NS descriptor
3495 resource. This identifier is allocated by the NFVO.
3500 This identifier, which is allocated by the NSD
3501 designer, identifies the NSD in a globally unique
3502 way. It is copied from the NSD content and shall be
3503 present after the NSD content is on-boarded.
3507 Name of the onboarded NSD. This information is
3508 copied from the NSD content and shall be present
3509 after the NSD content is on-boarded.
3513 Description of the onboarded NSD.
3514 This information is copied from the NSD content.
3522 $ref: '#/components/schemas/NsdInfo'
3538 additionalProperties: true
3548 CreateVnfPkgInfoRequest:
3549 # A free list of key:value pairs
3551 additionalProperties: true
3552 VnfPkgInfoModifications:
3554 VNF Package Information
3555 Only generic fields (id, name, description) are described
3556 For a full specification of the VNF Descriptor see:
3557 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
3561 description: VNF Package Identifier
3564 description: VNF Package Name
3567 description: VNF Package description
3571 VNF Package Information
3572 Only generic fields (_id, id, name, description) are described
3573 For a full specification of the VNF Descriptor see:
3574 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
3579 Identifier of the VNF package. This identifier is allocated by the NFVO.
3583 description: VNF Package Identifier
3586 description: VNF Package Name
3589 description: VNF Package description
3597 $ref: '#/components/schemas/VnfPkgInfo'
3603 Identifier of the NSD that defines the NS instance to be created.
3608 Human-readable name of the NS instance to be created.
3612 Human-readable description of the NS instance to be created.
3616 Identifier of the VIM Account where the NS instance shall be created.
3625 NS Instance Information
3626 Only generic fields (_id, id, name, description) are described
3627 For a full specification of the NS Instance see:
3628 http://osm-download.etsi.org/ftp/osm-doc/nsr.html
3632 description: Identifier of the NS instance.
3636 description: Identifier of the NS instance.
3640 description: Human readable name of the NS instance.
3643 description: Human readable description of the NS instance.
3649 InstantiateNsRequest:
3654 Human-readable name of the NS instance to be created.
3658 Identifier of the NSD that defines the NS instance to be created.
3663 Identifier of the VIM Account where the NS instance shall be created.
3688 scaling-group-descriptor:
3692 additionalProperties: true
3693 additionalProperties: true
3694 additionalProperties: true
3700 Timestamp indicating the end time of the NS, i.e. the NS will be terminated
3701 automatically at this timestamp. Cardinality "0" indicates the NS termination
3702 takes place immediately.
3708 $ref: '#/components/schemas/NsInstance'
3709 NSinstanceActionRequest:
3715 $ref: '#/components/schemas/KeyValuePairs'
3730 additionalProperties: false
3731 CreateNSinstanceContentRequest:
3736 Identifier of the NSD that defines the NS instance to be created.
3741 Human-readable name of the NS instance to be created.
3745 Identifier of the VIM Account where the NS instance shall be created.
3752 CreateNSinstanceContentResponse:
3775 isAutomaticInvocation:
3817 $ref: '#/components/schemas/NsLcmOpOcc'
3820 VNF Instance Information
3821 Only generic fields (_id, id) are described
3822 For a full specification of the VNF Instance see:
3823 http://osm-download.etsi.org/ftp/osm-doc/vnfr.html
3832 ArrayOfVnfInstanceInfo:
3835 $ref: '#/components/schemas/VnfInstanceInfo'
3838 NetSlice Template Information
3839 Only generic fields (_id, id, name) are described
3840 For a full specification of the NetSlice Template see:
3841 http://osm-download.etsi.org/ftp/osm-doc/nst.html
3845 description: NetSlice Template Identifier
3849 description: Human readable NetSlice Template Identifier
3852 description: Human readable name of the NetSlice Template
3857 $ref: '#/components/schemas/NstInfo'
3858 CreateNstInfoRequest:
3859 # A free list of key:value pairs
3861 additionalProperties: true
3868 NstInfoModifications:
3870 NetSlice Template Information
3871 Only generic fields (id, name) are described
3872 For a full specification of the NetSlice Template see:
3873 http://osm-download.etsi.org/ftp/osm-doc/nst.html
3877 description: NST Identifier
3880 description: NST Name
3884 NetSlice Instance Information
3885 Only generic fields (_id, id, name, description) are described
3886 For a full specification of the NetSlice Instance see:
3887 http://osm-download.etsi.org/ftp/osm-doc/nsi.html
3891 description: Identifier of the NetSlice instance.
3895 description: Identifier of the NetSlice instance.
3899 description: Human readable name of the NetSlice instance.
3902 description: Human readable description of the NetSlice instance.
3908 ArrayOfNetSliceInstance:
3911 $ref: '#/components/schemas/NetSliceInstance'
3917 Identifier of the NST that defines the NetSlice instance to be created.
3922 Human-readable name of the NetSlice instance to be created.
3926 Human-readable description of the NetSlice instance to be created.
3930 Identifier of the VIM Account where the NetSlice instance shall be created.
3937 InstantiateNsiRequest:
3942 Human-readable name of the NetSlice instance to be created.
3946 Identifier of the NST that defines the NetSlice instance to be created.
3951 Identifier of the VIM Account where the NetSlice instance shall be created.
3958 TerminateNsiRequest:
3963 Timestamp indicating the end time of the NSI, i.e. the NSI will be terminated
3964 automatically at this timestamp. Cardinality "0" indicates the NSI termination
3965 takes place immediately.
3974 $ref: '#/components/schemas/KeyValuePairs'
3983 CreateNsiContentRequest:
3988 Identifier of the NST that defines the NetSlice instance to be created.
3993 Human-readable name of the NetSlice instance to be created.
3997 Identifier of the VIM Account where the NetSlice instance shall be created.
4004 CreateNsiContentResponse:
4027 isAutomaticInvocation:
4074 $ref: '#/components/schemas/NsiLcmOpOcc'
4078 CreateNsdInfoRequest:
4082 $ref: '#/components/schemas/CreateNsdInfoRequest'
4085 $ref: '#/components/schemas/CreateNsdInfoRequest'
4086 NsdInfoModifications:
4090 $ref: '#/components/schemas/NsdInfoModifications'
4093 $ref: '#/components/schemas/NsdInfoModifications'
4098 $ref: '#/components/schemas/NsDescriptor'
4103 $ref: '#/components/schemas/NsPackage'
4104 CreateVnfPkgInfoRequest:
4108 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
4111 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
4112 VnfPkgInfoModifications:
4116 $ref: '#/components/schemas/VnfPkgInfoModifications'
4119 $ref: '#/components/schemas/VnfPkgInfoModifications'
4124 $ref: '#/components/schemas/VnfPackage'
4129 $ref: '#/components/schemas/VnfDescriptor'
4134 $ref: '#/components/schemas/CreateNsRequest'
4137 $ref: '#/components/schemas/CreateNsRequest'
4138 InstantiateNsRequest:
4142 $ref: '#/components/schemas/InstantiateNsRequest'
4145 $ref: '#/components/schemas/InstantiateNsRequest'
4150 $ref: '#/components/schemas/ScaleNsRequest'
4153 $ref: '#/components/schemas/ScaleNsRequest'
4158 $ref: '#/components/schemas/TerminateNsRequest'
4161 $ref: '#/components/schemas/TerminateNsRequest'
4162 CreateNSinstanceContentRequest:
4166 $ref: '#/components/schemas/CreateNSinstanceContentRequest'
4169 $ref: '#/components/schemas/CreateNSinstanceContentRequest'
4170 CreateNstInfoRequest:
4174 $ref: '#/components/schemas/CreateNstInfoRequest'
4177 $ref: '#/components/schemas/CreateNstInfoRequest'
4182 $ref: '#/components/schemas/NetSliceTemplate'
4187 $ref: '#/components/schemas/NetSlicePackage'
4188 NstInfoModifications:
4192 $ref: '#/components/schemas/NstInfoModifications'
4195 $ref: '#/components/schemas/NstInfoModifications'
4200 $ref: '#/components/schemas/CreateNsiRequest'
4203 $ref: '#/components/schemas/CreateNsiRequest'
4204 InstantiateNsiRequest:
4208 $ref: '#/components/schemas/InstantiateNsiRequest'
4211 $ref: '#/components/schemas/InstantiateNsiRequest'
4212 TerminateNsiRequest:
4216 $ref: '#/components/schemas/TerminateNsiRequest'
4219 $ref: '#/components/schemas/TerminateNsiRequest'
4224 $ref: '#/components/schemas/NsiActionRequest'
4227 $ref: '#/components/schemas/NsiActionRequest'
4228 CreateNsiContentRequest:
4232 $ref: '#/components/schemas/CreateNsiContentRequest'
4235 $ref: '#/components/schemas/CreateNsiContentRequest'
4236 # END REQUEST BODIES