4 "description": "Api Documentation",
6 "title": "Api Documentation",
7 "termsOfService": "urn:tos",
11 "url": "http://www.apache.org/licenses/LICENSE-2.0"
15 "/onap/policy/clamp/acm/v2/instantiation": {
18 "Clamp Automation Composition Instantiation API"
20 "summary": "Query details of the requested automation compositions",
21 "description": "Queries details of the requested automation compositions, returning all composition details",
22 "operationId": "queryUsingGET_1",
31 "description": "Automation composition definition name",
38 "description": "Automation composition definition version",
43 "name": "X-ONAP-RequestID",
45 "description": "RequestID for http transaction",
55 "$ref": "#/definitions/AutomationCompositionsRes",
56 "originalRef": "AutomationCompositionsRes"
60 "description": "Authentication Error",
78 "description": "Authorization Error",
96 "description": "Not Found"
99 "description": "Internal Server Error",
110 "X-ONAP-RequestID": {
122 "x-interface info": {
123 "api-version": "1.0.0",
124 "last-mod-release": "Istanbul"
129 "Clamp Automation Composition Instantiation API"
131 "summary": "Commissions automation composition definitions",
132 "description": "Commissions automation composition definitions, returning the automation composition IDs",
133 "operationId": "createUsingPOST_1",
145 "name": "automationCompositions",
146 "description": "Entity Body of automation composition",
149 "$ref": "#/definitions/AutomationCompositionsReq",
150 "originalRef": "AutomationCompositionsReq"
154 "name": "X-ONAP-RequestID",
156 "description": "RequestID for http transaction",
166 "$ref": "#/definitions/InstantiationResponse",
167 "originalRef": "InstantiationResponse"
171 "description": "Created"
174 "description": "Authentication Error",
185 "X-ONAP-RequestID": {
192 "description": "Authorization Error",
203 "X-ONAP-RequestID": {
210 "description": "Not Found"
213 "description": "Internal Server Error",
224 "X-ONAP-RequestID": {
236 "x-interface info": {
237 "api-version": "1.0.0",
238 "last-mod-release": "Istanbul"
243 "Clamp Automation Composition Instantiation API"
245 "summary": "Updates automation composition definitions",
246 "description": "Updates automation composition definitions, returning the updated composition definition IDs",
247 "operationId": "updateUsingPUT",
259 "name": "automationCompositions",
260 "description": "Entity Body of Automation Composition",
263 "$ref": "#/definitions/AutomationCompositionsReq",
264 "originalRef": "AutomationCompositionsReq"
268 "name": "X-ONAP-RequestID",
270 "description": "RequestID for http transaction",
280 "$ref": "#/definitions/InstantiationResponse",
281 "originalRef": "InstantiationResponse"
285 "description": "Created"
288 "description": "Authentication Error",
299 "X-ONAP-RequestID": {
306 "description": "Authorization Error",
317 "X-ONAP-RequestID": {
324 "description": "Not Found"
327 "description": "Internal Server Error",
338 "X-ONAP-RequestID": {
350 "x-interface info": {
351 "api-version": "1.0.0",
352 "last-mod-release": "Istanbul"
357 "Clamp Automation Composition Instantiation API"
359 "summary": "Delete a automation composition",
360 "description": "Deletes a automation composition, returning optional error details",
361 "operationId": "deleteUsingDELETE_1",
370 "description": "Automation composition definition name",
377 "description": "Automation composition definition version",
382 "name": "X-ONAP-RequestID",
384 "description": "RequestID for http transaction",
394 "$ref": "#/definitions/InstantiationResponse",
395 "originalRef": "InstantiationResponse"
399 "description": "No Content"
402 "description": "Authentication Error",
413 "X-ONAP-RequestID": {
420 "description": "Authorization Error",
431 "X-ONAP-RequestID": {
438 "description": "Internal Server Error",
449 "X-ONAP-RequestID": {
461 "x-interface info": {
462 "api-version": "1.0.0",
463 "last-mod-release": "Istanbul"
467 "/onap/policy/clamp/acm/v2/instantiation/command": {
470 "Clamp Automation Composition Instantiation API"
472 "summary": "Issue a command to the requested automation compositions",
473 "description": "Issues a command to an automation composition, ordering a state change on the composition",
474 "operationId": "issueAutomationCompositionCommandUsingPUT",
487 "description": "Entity Body of automation composition command",
490 "$ref": "#/definitions/InstantiationCommand",
491 "originalRef": "InstantiationCommand"
495 "name": "X-ONAP-RequestID",
497 "description": "RequestID for http transaction",
507 "$ref": "#/definitions/InstantiationResponse",
508 "originalRef": "InstantiationResponse"
512 "description": "Created"
515 "description": "Authentication Error",
526 "X-ONAP-RequestID": {
533 "description": "Authorization Error",
544 "X-ONAP-RequestID": {
551 "description": "Not Found"
554 "description": "Internal Server Error",
565 "X-ONAP-RequestID": {
577 "x-interface info": {
578 "api-version": "1.0.0",
579 "last-mod-release": "Istanbul"
583 "/onap/policy/clamp/acm/v2/instantiationState":{
586 "Clamp Automation Composition Instantiation API"
588 "summary":"Query details of the requested automation compositions",
589 "description":"Queries details of requested automation compositions, returning all automation composition details",
590 "operationId":"getInstantiationOrderStateUsingGET",
599 "description":"Automation composition name",
606 "description":"Automation composition version",
611 "name":"X-ONAP-RequestID",
613 "description":"RequestID for http transaction",
623 "$ref":"#/definitions/AutomationCompositionOrderStateResponse",
624 "originalRef":"AutomationCompositionOrderStateResponse"
628 "description":"Authentication Error",
646 "description":"Authorization Error",
664 "description":"Not Found"
667 "description":"Internal Server Error",
689 "$ref":"#/definitions/AutomationCompositionOrderStateResponse",
690 "originalRef":"AutomationCompositionOrderStateResponse"
694 "description":"Authentication Error",
712 "description":"Authorization Error",
730 "description":"Not Found"
733 "description":"Internal Server Error",
759 "api-version":"1.0.0",
760 "last-mod-release":"Istanbul"
764 "/onap/policy/clamp/acm/v2/instanceProperties":{
767 "Clamp Automation Composition Instantiation API"
769 "summary":"Saves instance properties",
770 "description":"Saves instance properties, returning the saved instances properties and it's version",
771 "operationId":"createInstancePropertiesUsingPOST",
784 "description":"Body of instance properties",
787 "$ref":"#/definitions/ToscaServiceTemplateReq",
788 "originalRef":"ToscaServiceTemplateReq"
792 "name":"X-ONAP-RequestID",
794 "description":"RequestID for http transaction",
804 "$ref":"#/definitions/InstancePropertiesResponse",
805 "originalRef":"InstancePropertiesResponse"
809 "description":"Created"
812 "description":"Authentication Error",
830 "description":"Authorization Error",
848 "description":"Not Found"
851 "description":"Internal Server Error",
873 "$ref":"#/definitions/InstancePropertiesResponse",
874 "originalRef":"InstancePropertiesResponse"
878 "description":"Created"
881 "description":"Authentication Error",
899 "description":"Authorization Error",
917 "description":"Not Found"
920 "description":"Internal Server Error",
946 "api-version":"1.0.0",
947 "last-mod-release":"Istanbul"
952 "Clamp Automation Composition Instantiation API"
954 "summary":"Updates instance properties",
955 "description":"Updates instance properties, returning the saved instances properties and it's version",
956 "operationId":"updatesInstancePropertiesUsingPUT",
969 "description":"Body of instance properties",
972 "$ref":"#/definitions/ToscaServiceTemplateReq",
973 "originalRef":"ToscaServiceTemplateReq"
979 "description":"Automation composition definition name",
986 "description":"Automation composition definition version",
991 "name":"X-ONAP-RequestID",
993 "description":"RequestID for http transaction",
1003 "$ref":"#/definitions/InstancePropertiesResponse",
1004 "originalRef":"InstancePropertiesResponse"
1008 "description":"Created"
1011 "description":"Authentication Error",
1022 "X-ONAP-RequestID":{
1029 "description":"Authorization Error",
1040 "X-ONAP-RequestID":{
1047 "description":"Not Found"
1050 "description":"Internal Server Error",
1061 "X-ONAP-RequestID":{
1072 "$ref":"#/definitions/InstancePropertiesResponse",
1073 "originalRef":"InstancePropertiesResponse"
1077 "description":"Created"
1080 "description":"Authentication Error",
1091 "X-ONAP-RequestID":{
1098 "description":"Authorization Error",
1109 "X-ONAP-RequestID":{
1116 "description":"Not Found"
1119 "description":"Internal Server Error",
1130 "X-ONAP-RequestID":{
1144 "x-interface info":{
1145 "api-version":"1.0.0",
1146 "last-mod-release":"Istanbul"
1151 "Clamp Automation Composition Instantiation API"
1153 "summary":"Delete a automation composition and instance properties",
1154 "description":"Deletes a automation composition and instance properties, returning optional error details",
1155 "operationId":"deleteInstancePropertiesUsingDELETE",
1164 "description":"Automation composition definition name",
1171 "description":"Automation composition definition version",
1176 "name":"X-ONAP-RequestID",
1178 "description":"RequestID for http transaction",
1188 "$ref":"#/definitions/InstantiationResponse",
1189 "originalRef":"InstantiationResponse"
1193 "description":"No Content"
1196 "description":"Authentication Error",
1207 "X-ONAP-RequestID":{
1214 "description":"Authorization Error",
1225 "X-ONAP-RequestID":{
1232 "description":"Internal Server Error",
1243 "X-ONAP-RequestID":{
1254 "$ref":"#/definitions/InstantiationResponse",
1255 "originalRef":"InstantiationResponse"
1259 "description":"No Content"
1262 "description":"Authentication Error",
1273 "X-ONAP-RequestID":{
1280 "description":"Authorization Error",
1291 "X-ONAP-RequestID":{
1298 "description":"Internal Server Error",
1309 "X-ONAP-RequestID":{
1323 "x-interface info":{
1324 "api-version":"1.0.0",
1325 "last-mod-release":"Istanbul"
1329 "/onap/policy/clamp/acm/v2/automationCompositionPriming":{
1332 "Clamp Automation Composition Instantiation API"
1334 "summary":"Query priming details of the requested automation compositions",
1335 "description":"Queries priming details of requested automation compositions, returning primed/deprimed compositions",
1336 "operationId":"getAutomationCompositionPrimingUsingGET",
1345 "description":"Automation composition definition name",
1352 "description":"Automation composition definition version",
1357 "name":"X-ONAP-RequestID",
1359 "description":"RequestID for http transaction",
1369 "$ref":"#/definitions/AutomationCompositionPrimedResponse",
1370 "originalRef":"AutomationCompositionPrimedResponse"
1374 "description":"Authentication Error",
1385 "X-ONAP-RequestID":{
1392 "description":"Authorization Error",
1403 "X-ONAP-RequestID":{
1410 "description":"Not Found"
1413 "description":"Internal Server Error",
1424 "X-ONAP-RequestID":{
1435 "$ref":"#/definitions/AutomationCompositionPrimedResponse",
1436 "originalRef":"AutomationCompositionPrimedResponse"
1440 "description":"Authentication Error",
1451 "X-ONAP-RequestID":{
1458 "description":"Authorization Error",
1469 "X-ONAP-RequestID":{
1476 "description":"Not Found"
1479 "description":"Internal Server Error",
1490 "X-ONAP-RequestID":{
1504 "x-interface info":{
1505 "api-version":"1.0.0",
1506 "last-mod-release":"Istanbul"