1 # ============LICENSE_START=======================================================
2 # Copyright (C) 2022-2023 Nordix Foundation
3 # ================================================================================
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
16 # SPDX-License-Identifier: Apache-2.0
17 # ============LICENSE_END=========================================================
20 title: Api Documentation
21 description: Api Documentation
22 termsOfService: urn:tos
26 url: http://www.apache.org/licenses/LICENSE-2.0
29 - url: https://{server}
32 default: onap/policy/clamp/acm/v2
33 description: This value is assigned by the service provider
35 - name: Participant Monitoring
36 description: Pariticipant Monitoring Controller, for monitoring of and requesting information from participants
37 - name: Automation Composition Definition
38 description: Automation Composition Definition Controller, for definition and management of Automation Composition Types
39 - name: Automation Composition Instance
40 description: Automation Composition Instance Controller, for definition and management of Automation Composition Instances
46 - Participant Monitoring
47 summary: Query Particicpants
48 description: Query the participants that are registered on the ACM runtime
49 operationId: queryParticipants
54 description: Automation composition definition name. Regular expressions are supported for filtering. If
55 this parameter is not specified, all automation composition definitions are returned.
61 description: Automation composition definition version. Regular expressions are supported for filtering. If this
62 parameter is not specified, all automation composition definitions that match the "name" filter are are returned.
65 - name: X-onap-RequestId
67 description: RequestID for http transaction
73 description: OK, serialised array of instances of
74 [ParticipantInformation](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/ParticipantInformation.java)
75 that contains information on participants with their information and status. Each participant entry contains
76 a list of AC Element types on the participant. Each AC Element type entry contains a list of AC Element
77 instances on the Participant.
80 $ref: '#/components/headers/X-LatestVersion'
82 $ref: '#/components/headers/X-PatchVersion'
84 $ref: '#/components/headers/X-MinorVersion'
86 $ref: '#/components/headers/X-onap-RequestId'
92 $ref: '#/components/schemas/ParticipantInformation'
94 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getMultiParticipantResponse.json'
99 $ref: '#/components/schemas/ParticipantInformation'
101 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getMultiParticipantResponse.yaml'
103 description: Authentication Error, returns an instance of
104 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
107 $ref: '#/components/headers/X-LatestVersion'
109 $ref: '#/components/headers/X-PatchVersion'
111 $ref: '#/components/headers/X-MinorVersion'
113 $ref: '#/components/headers/X-onap-RequestId'
117 $ref: '#/components/schemas/SimpleResponse'
122 last-mod-release: London
125 - Participant Monitoring
126 summary: Order an immendiate Participant Report from all participants
127 description: Requests all participants to immediately generate a heartbeat report with their information and status
128 and the information and status of all their AC Element Types and Instances. The results are published on subsequent
129 GET REST requests on the "participants" endpoint.
130 operationId: orderAllParticipantsReport
132 - name: X-onap-RequestId
134 description: RequestID for http transaction
140 description: Accepted, the request has been accepted and forwarded to participants
143 $ref: '#/components/headers/X-LatestVersion'
145 $ref: '#/components/headers/X-PatchVersion'
147 $ref: '#/components/headers/X-MinorVersion'
149 $ref: '#/components/headers/X-onap-RequestId'
151 description: Bad Request, returns an instance of
152 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
155 $ref: '#/components/headers/X-LatestVersion'
157 $ref: '#/components/headers/X-PatchVersion'
159 $ref: '#/components/headers/X-MinorVersion'
161 $ref: '#/components/headers/X-onap-RequestId'
165 $ref: '#/components/schemas/SimpleResponse'
167 description: Authentication Error, returns an instance of
168 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
171 $ref: '#/components/headers/X-LatestVersion'
173 $ref: '#/components/headers/X-PatchVersion'
175 $ref: '#/components/headers/X-MinorVersion'
177 $ref: '#/components/headers/X-onap-RequestId'
181 $ref: '#/components/schemas/SimpleResponse'
186 last-mod-release: London
187 x-codegen-request-body-name: body
188 /participants/{participantId}:
191 - Participant Monitoring
192 summary: Get details of the requested participant
194 description: Get details of the requested commissioned participant, returning all pariticipant details
195 operationId: getParticipant
197 - name : participantId
199 description: The UUID of the participant to get
204 - name: X-onap-RequestId
206 description: RequestID for http transaction
212 description: Serialised instance of
213 [ParticipantInformation](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/ParticipantInformation.java)
214 that information on the participant with its information and status. The participant entry contains
215 a list of AC Element types on the participant. Each AC Element type entry contains a list of AC Element
216 instances on the Participant.
219 $ref: '#/components/headers/X-LatestVersion'
221 $ref: '#/components/headers/X-PatchVersion'
223 $ref: '#/components/headers/X-MinorVersion'
225 $ref: '#/components/headers/X-onap-RequestId'
229 $ref: '#/components/schemas/ParticipantInformation'
231 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getSingleParticipantResponse.json'
234 $ref: '#/components/schemas/ToscaServiceTemplate'
236 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getParticipantResponse.yaml'
238 description: Authentication Error, returns an instance of
239 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
242 $ref: '#/components/headers/X-LatestVersion'
244 $ref: '#/components/headers/X-PatchVersion'
246 $ref: '#/components/headers/X-MinorVersion'
248 $ref: '#/components/headers/X-onap-RequestId'
252 $ref: '#/components/schemas/SimpleResponse'
254 description: Specified participant not found, returns an instance of
255 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
258 $ref: '#/components/headers/X-LatestVersion'
260 $ref: '#/components/headers/X-PatchVersion'
262 $ref: '#/components/headers/X-MinorVersion'
264 $ref: '#/components/headers/X-onap-RequestId'
268 $ref: '#/components/schemas/SimpleResponse'
273 last-mod-release: London
276 - Participant Monitoring
277 summary: Order an immendiate Participant Report from a participant
278 description: Requests the participants to immediately generate a heartbeat report with its information and status
279 and the information and status of all its AC Element Types and Instances. The results are published on subsequent
280 GET REST requests on the "participants" endpoint.
281 operationId: orderParticipantReport
283 - name : participantId
285 description: The UUID of the participant to get
290 - name: X-onap-RequestId
292 description: RequestID for http transaction
298 description: Accepted, the request has been accepted and forwarded to participants
301 $ref: '#/components/headers/X-LatestVersion'
303 $ref: '#/components/headers/X-PatchVersion'
305 $ref: '#/components/headers/X-MinorVersion'
307 $ref: '#/components/headers/X-onap-RequestId'
309 description: Bad Request, returns an instance of
310 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
313 $ref: '#/components/headers/X-LatestVersion'
315 $ref: '#/components/headers/X-PatchVersion'
317 $ref: '#/components/headers/X-MinorVersion'
319 $ref: '#/components/headers/X-onap-RequestId'
323 $ref: '#/components/schemas/SimpleResponse'
325 description: Authentication Error, returns an instance of
326 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
329 $ref: '#/components/headers/X-LatestVersion'
331 $ref: '#/components/headers/X-PatchVersion'
333 $ref: '#/components/headers/X-MinorVersion'
335 $ref: '#/components/headers/X-onap-RequestId'
339 $ref: '#/components/schemas/SimpleResponse'
341 description: Specified participant not found, returns an instance of
342 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
345 $ref: '#/components/headers/X-LatestVersion'
347 $ref: '#/components/headers/X-PatchVersion'
349 $ref: '#/components/headers/X-MinorVersion'
351 $ref: '#/components/headers/X-onap-RequestId'
355 $ref: '#/components/schemas/SimpleResponse'
360 last-mod-release: London
361 x-codegen-request-body-name: body
365 - Automation Composition Definition
366 summary: Query the commissioned automation composition definitions
368 description: Query the commissioned automation composition
369 definitions, returning the automation composition details
370 operationId: queryCompositionDefinitions
375 description: Automation composition definition name. Regular expressions are supported for filtering. If
376 this parameter is not specified, all automation composition definitions are returned.
382 description: Automation composition definition version. Regular expressions are supported for filtering. If this
383 parameter is not specified, all automation composition definitions that match the "name" filter are are returned.
386 - name: X-onap-RequestId
388 description: RequestID for http transaction
394 description: Serialised instance of
395 [ToscaServiceTemplates](https://github.com/onap/policy-models/blob/master/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaServiceTemplates.java)
396 that contains the automation composition definitions that match the requested filters.
399 $ref: '#/components/headers/X-LatestVersion'
401 $ref: '#/components/headers/X-PatchVersion'
403 $ref: '#/components/headers/X-MinorVersion'
405 $ref: '#/components/headers/X-onap-RequestId'
409 $ref: '#/components/schemas/ToscaServiceTemplates'
411 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getAllCompositionDefinitions.json'
414 $ref: '#/components/schemas/ToscaServiceTemplates'
416 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getAllCompositionDefinitions.yaml'
418 description: Authentication Error, returns an instance of
419 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
422 $ref: '#/components/headers/X-LatestVersion'
424 $ref: '#/components/headers/X-PatchVersion'
426 $ref: '#/components/headers/X-MinorVersion'
428 $ref: '#/components/headers/X-onap-RequestId'
432 $ref: '#/components/schemas/SimpleResponse'
437 last-mod-release: London
440 - Automation Composition Definition
441 summary: Commissions automation composition definitions
442 description: Commissions automation composition definitions, returning the UUIDs of
443 automation composition definitions commissioned by this request.
444 operationId: createCompositionDefinitions
446 - name: X-onap-RequestId
448 description: RequestID for http transaction
453 description: Serialised instance of
454 [ToscaServiceTemplate](https://github.com/onap/policy-models/blob/master/models-tosca/src/main/java/org/onap/policy/models/tosca/authorative/concepts/ToscaServiceTemplate.java)
455 containing the automation composition definitions to be commissioned.
459 $ref: '#/components/schemas/ToscaServiceTemplate'
461 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionDefinitions.json'
464 $ref: '#/components/schemas/ToscaServiceTemplate'
466 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionDefinitions.yaml'
470 description: Serialised instance of
471 [CommissioningResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/commissioning/CommissioningResponse.java)
472 containing the UUIDs of automation composition definitions created by this request
475 $ref: '#/components/headers/X-LatestVersion'
477 $ref: '#/components/headers/X-PatchVersion'
479 $ref: '#/components/headers/X-MinorVersion'
481 $ref: '#/components/headers/X-onap-RequestId'
485 $ref: '#/components/schemas/CommissioningResponse'
487 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCommissionCompositionDefinitionsResponse.json'
490 $ref: '#/components/schemas/CommissioningResponse'
492 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCommissionCompositionDefinitionsResponse.yaml'
494 description: Authentication Error, returns an instance of
495 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
498 $ref: '#/components/headers/X-LatestVersion'
500 $ref: '#/components/headers/X-PatchVersion'
502 $ref: '#/components/headers/X-MinorVersion'
504 $ref: '#/components/headers/X-onap-RequestId'
508 $ref: '#/components/schemas/SimpleResponse'
510 description: Bad Request, returns an instance of
511 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
514 $ref: '#/components/headers/X-LatestVersion'
516 $ref: '#/components/headers/X-PatchVersion'
518 $ref: '#/components/headers/X-MinorVersion'
520 $ref: '#/components/headers/X-onap-RequestId'
524 $ref: '#/components/schemas/SimpleResponse'
529 last-mod-release: London
530 x-codegen-request-body-name: body
531 /compositions/{compositionId}:
534 - Automation Composition Definition
535 summary: Get details of the requested commissioned automation composition
537 description: Get details of the requested commissioned automation composition
538 definitions, returning all automation composition details
539 operationId: getCompositionDefinition
541 - name : compositionId
543 description: The UUID of the automation composition definition to get
548 - name: X-onap-RequestId
550 description: RequestID for http transaction
557 Serialised instance of
558 [AutomationCompositionDefinition](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/AutomationCompositionDefinition.java)
559 containing the requested automation composition definition.
562 $ref: '#/components/headers/X-LatestVersion'
564 $ref: '#/components/headers/X-PatchVersion'
566 $ref: '#/components/headers/X-MinorVersion'
568 $ref: '#/components/headers/X-onap-RequestId'
572 $ref: '#/components/schemas/AutomationCompositionDefinition'
574 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getSingleCompositionDefinition.json'
577 $ref: '#/components/schemas/AutomationCompositionDefinition'
579 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getSingleCompositionDefinition.yaml'
581 description: Authentication Error, returns an instance of
582 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
585 $ref: '#/components/headers/X-LatestVersion'
587 $ref: '#/components/headers/X-PatchVersion'
589 $ref: '#/components/headers/X-MinorVersion'
591 $ref: '#/components/headers/X-onap-RequestId'
595 $ref: '#/components/schemas/SimpleResponse'
597 description: Specified automation composition definition not found, returns an instance of
598 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
601 $ref: '#/components/headers/X-LatestVersion'
603 $ref: '#/components/headers/X-PatchVersion'
605 $ref: '#/components/headers/X-MinorVersion'
607 $ref: '#/components/headers/X-onap-RequestId'
611 $ref: '#/components/schemas/SimpleResponse'
616 last-mod-release: London
619 - Automation Composition Definition
620 summary: Primes or deprimes an automation composition definition
621 description: Primes or deprimes an automation composition definition by sending the AC Element Types to participants and
622 getting participants to take responsibility for AC Element Types in this AC Type.
623 operationId: compositionDefinitionPriming
625 - name : compositionId
627 description: The UUID of the automation composition definition to update
632 - name: X-onap-RequestId
634 description: RequestID for http transaction
639 description: Serialised instance of
640 [AcTypeStateUpdate](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/commissioning/AcTypeStateUpdate.java)
641 which specifies the requested state change on the automation concept instance
645 $ref: '#/components/schemas/AcTypeStateUpdate'
647 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putAcTypeStateUpdate.json'
650 $ref: '#/components/schemas/AcTypeStateUpdate'
652 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putAcTypeStateUpdate.yaml'
655 description: Accepted, the request has been accepted and forwarded to participants
658 $ref: '#/components/headers/X-LatestVersion'
660 $ref: '#/components/headers/X-PatchVersion'
662 $ref: '#/components/headers/X-MinorVersion'
664 $ref: '#/components/headers/X-onap-RequestId'
666 description: Bad Request, returns an instance of
667 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
670 $ref: '#/components/headers/X-LatestVersion'
672 $ref: '#/components/headers/X-PatchVersion'
674 $ref: '#/components/headers/X-MinorVersion'
676 $ref: '#/components/headers/X-onap-RequestId'
680 $ref: '#/components/schemas/SimpleResponse'
682 description: Authentication Error, returns an instance of
683 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
686 $ref: '#/components/headers/X-LatestVersion'
688 $ref: '#/components/headers/X-PatchVersion'
690 $ref: '#/components/headers/X-MinorVersion'
692 $ref: '#/components/headers/X-onap-RequestId'
696 $ref: '#/components/schemas/SimpleResponse'
698 description: Specified automation composition definition not found, returns an instance of
699 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
702 $ref: '#/components/headers/X-LatestVersion'
704 $ref: '#/components/headers/X-PatchVersion'
706 $ref: '#/components/headers/X-MinorVersion'
708 $ref: '#/components/headers/X-onap-RequestId'
712 $ref: '#/components/schemas/SimpleResponse'
717 last-mod-release: London
718 x-codegen-request-body-name: body
721 - Automation Composition Definition
722 summary: Delete a commissioned automation composition definition
723 description: Deletes a commissioned automation composition definition,returning the UUID of the automation composition definition deleted by this request
724 operationId: deleteCompositionDefinition
726 - name : compositionId
728 description: The UUID of the automation composition definition to delete
733 - name: X-onap-RequestId
735 description: RequestID for http transaction
741 description: Serialised instance of
742 [CommissioningResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/commissioning/CommissioningResponse.java)
743 containing the UUID of the automation composition deleted by this request
746 $ref: '#/components/headers/X-LatestVersion'
748 $ref: '#/components/headers/X-PatchVersion'
750 $ref: '#/components/headers/X-MinorVersion'
752 $ref: '#/components/headers/X-onap-RequestId'
756 $ref: '#/components/schemas/CommissioningResponse'
758 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionDefinitionResponse.json'
761 $ref: '#/components/schemas/CommissioningResponse'
763 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionDefinitionResponse.yaml'
765 description: Authentication Error, returns an instance of
766 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
769 $ref: '#/components/headers/X-LatestVersion'
771 $ref: '#/components/headers/X-PatchVersion'
773 $ref: '#/components/headers/X-MinorVersion'
775 $ref: '#/components/headers/X-onap-RequestId'
779 $ref: '#/components/schemas/SimpleResponse'
781 description: Specified automation composition definition not found, returns an instance of
782 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
785 $ref: '#/components/headers/X-LatestVersion'
787 $ref: '#/components/headers/X-PatchVersion'
789 $ref: '#/components/headers/X-MinorVersion'
791 $ref: '#/components/headers/X-onap-RequestId'
795 $ref: '#/components/schemas/SimpleResponse'
797 description: Bad Request, returns an instance of
798 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
801 $ref: '#/components/headers/X-LatestVersion'
803 $ref: '#/components/headers/X-PatchVersion'
805 $ref: '#/components/headers/X-MinorVersion'
807 $ref: '#/components/headers/X-onap-RequestId'
811 $ref: '#/components/schemas/SimpleResponse'
816 last-mod-release: London
817 /compositions/{compositionId}/instances:
820 - Automation Composition Instance
821 summary: Query details of the requested automation composition instances
822 description: Query details of the requested automation composition instances for the given automation composition definition ID, returning
823 details of all its automation composition instances
824 operationId: queryCompositionInstances
826 - name : compositionId
828 description: The UUID of the automation composition definition for which to return instances
835 description: Automation composition instance name. Regular expressions are supported for filtering. If
836 this parameter is not specified, all automation composition instances for the specified definition are returned.
841 description: Automation composition instance version. Regular expressions are supported for filtering. If this
842 parameter is not specified, all automation composition instances for the specified definition that match the "name" filter are are returned.
845 - name: X-onap-RequestId
847 description: RequestID for http transaction
853 description: Serialised instance of
854 [AutomationCompositions](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/AutomationCompositions.java)
855 containing a list of automation composition instances found
858 $ref: '#/components/headers/X-LatestVersion'
860 $ref: '#/components/headers/X-PatchVersion'
862 $ref: '#/components/headers/X-MinorVersion'
864 $ref: '#/components/headers/X-onap-RequestId'
868 $ref: '#/components/schemas/AutomationCompositions'
870 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getCompositionInstancesResponse.json'
873 $ref: '#/components/schemas/AutomationCompositions'
875 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getCompositionInstancesResponse.yaml'
877 description: Authentication Error, returns an instance of
878 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
881 $ref: '#/components/headers/X-LatestVersion'
883 $ref: '#/components/headers/X-PatchVersion'
885 $ref: '#/components/headers/X-MinorVersion'
887 $ref: '#/components/headers/X-onap-RequestId'
891 $ref: '#/components/schemas/SimpleResponse'
893 description: The specified automation composition definition was not found, returns an instance of
894 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
897 $ref: '#/components/headers/X-LatestVersion'
899 $ref: '#/components/headers/X-PatchVersion'
901 $ref: '#/components/headers/X-MinorVersion'
903 $ref: '#/components/headers/X-onap-RequestId'
907 $ref: '#/components/schemas/SimpleResponse'
912 last-mod-release: London
915 - Automation Composition Instance
916 summary: Create automation composition instance
917 description: Creates automation composition instance that use the sepcified automation composition definition. The ID of the created
918 automation composition instance is returned.
919 operationId: createCompositionInstance
921 - name : compositionId
923 description: The UUID of the automation composition definition on which to create instance
928 - name: X-onap-RequestId
930 description: RequestID for http transaction
935 description: Serialised instance of
936 [AutomationComposition](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/AutomationComposition.java)
937 containing a automation composition instance to create
941 $ref: '#/components/schemas/AutomationComposition'
943 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstance.json'
946 $ref: '#/components/schemas/AutomationComposition'
948 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstance.yaml'
952 description: Serialised instance of
953 [InstantiationResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/instantiation/InstantiationResponse.java)
954 containing the UUID of the created automation composition instance
957 $ref: '#/components/headers/X-LatestVersion'
959 $ref: '#/components/headers/X-PatchVersion'
961 $ref: '#/components/headers/X-MinorVersion'
963 $ref: '#/components/headers/X-onap-RequestId'
967 $ref: '#/components/schemas/InstantiationResponse'
969 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstancesResponse.json'
972 $ref: '#/components/schemas/InstantiationResponse'
974 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/postCompositionInstancesResponse.yaml'
976 description: Authentication Error, returns an instance of
977 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
980 $ref: '#/components/headers/X-LatestVersion'
982 $ref: '#/components/headers/X-PatchVersion'
984 $ref: '#/components/headers/X-MinorVersion'
986 $ref: '#/components/headers/X-onap-RequestId'
990 $ref: '#/components/schemas/SimpleResponse'
992 description: The specified automation composition definition was not found, returns an instance of
993 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
996 $ref: '#/components/headers/X-LatestVersion'
998 $ref: '#/components/headers/X-PatchVersion'
1000 $ref: '#/components/headers/X-MinorVersion'
1002 $ref: '#/components/headers/X-onap-RequestId'
1006 $ref: '#/components/schemas/SimpleResponse'
1008 description: Bad Request, returns an instance of
1009 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
1012 $ref: '#/components/headers/X-LatestVersion'
1014 $ref: '#/components/headers/X-PatchVersion'
1016 $ref: '#/components/headers/X-MinorVersion'
1018 $ref: '#/components/headers/X-onap-RequestId'
1022 $ref: '#/components/schemas/SimpleResponse'
1027 last-mod-release: London
1028 x-codegen-request-body-name: body
1029 /compositions/{compositionId}/instances/{instanceId}:
1032 - Automation Composition Instance
1033 summary: Get automation composition instance details.
1034 description: Get details of the requested automation composition instance.
1035 operationId: getCompositionInstance
1037 - name : compositionId
1039 description: The UUID of the automation composition definition on which to get an instance
1046 description: The UUID of the automation composition instance to get
1051 - name: X-onap-RequestId
1053 description: RequestID for http transaction
1059 description: Serialised instance of
1060 [AutomationComposition](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/AutomationComposition.java)
1061 containing the automation composition instance
1064 $ref: '#/components/headers/X-LatestVersion'
1066 $ref: '#/components/headers/X-PatchVersion'
1068 $ref: '#/components/headers/X-MinorVersion'
1070 $ref: '#/components/headers/X-onap-RequestId'
1074 $ref: '#/components/schemas/AutomationComposition'
1076 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getCompositionInstanceResponse.json'
1079 $ref: '#/components/schemas/AutomationComposition'
1081 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getCompositionInstanceResponse.yaml'
1083 description: Authentication Error, returns an instance of
1084 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
1087 $ref: '#/components/headers/X-LatestVersion'
1089 $ref: '#/components/headers/X-PatchVersion'
1091 $ref: '#/components/headers/X-MinorVersion'
1093 $ref: '#/components/headers/X-onap-RequestId'
1097 $ref: '#/components/schemas/SimpleResponse'
1099 description: The automation composition instance was not found, returns an instance of
1100 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
1103 $ref: '#/components/headers/X-LatestVersion'
1105 $ref: '#/components/headers/X-PatchVersion'
1107 $ref: '#/components/headers/X-MinorVersion'
1109 $ref: '#/components/headers/X-onap-RequestId'
1113 $ref: '#/components/schemas/SimpleResponse'
1118 last-mod-release: London
1121 - Automation Composition Instance
1122 summary: Manage deployment and locking of an automation composition instance
1123 description: This request manages deployment and locking of an automation composition instance. This endpoint can
1124 order deployment and undeployment of an AC Instance to participants and order unlocking and locking of AC instances
1126 operationId: compositionInstanceState
1128 - name : compositionId
1130 description: The UUID of the automation composition definition on which to update an instance
1137 description: The UUID of the automation composition instance to update
1142 - name: X-onap-RequestId
1144 description: RequestID for http transaction
1149 description: Serialised instance of
1150 [AcInstanceStateUpdate](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/instantiation/AcInstanceStateUpdate.java)
1151 which specifies the requested state change on the automation concept instance
1155 $ref: '#/components/schemas/AcInstanceStateUpdate'
1157 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putAcInstanceStateUpdate.json'
1160 $ref: '#/components/schemas/AcInstanceStateUpdate'
1162 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/putAcInstanceStateUpdate.yaml'
1166 description: Accepted, the request has been accepted and forwarded to participants
1169 $ref: '#/components/headers/X-LatestVersion'
1171 $ref: '#/components/headers/X-PatchVersion'
1173 $ref: '#/components/headers/X-MinorVersion'
1175 $ref: '#/components/headers/X-onap-RequestId'
1177 description: Bad Request, returns an instance of
1178 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
1181 $ref: '#/components/headers/X-LatestVersion'
1183 $ref: '#/components/headers/X-PatchVersion'
1185 $ref: '#/components/headers/X-MinorVersion'
1187 $ref: '#/components/headers/X-onap-RequestId'
1191 $ref: '#/components/schemas/SimpleResponse'
1193 description: Authentication Error, returns an instance of
1194 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
1197 $ref: '#/components/headers/X-LatestVersion'
1199 $ref: '#/components/headers/X-PatchVersion'
1201 $ref: '#/components/headers/X-MinorVersion'
1203 $ref: '#/components/headers/X-onap-RequestId'
1207 $ref: '#/components/schemas/SimpleResponse'
1209 description: The specified automation composition instance was not found, returns an instance of
1210 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
1213 $ref: '#/components/headers/X-LatestVersion'
1215 $ref: '#/components/headers/X-PatchVersion'
1217 $ref: '#/components/headers/X-MinorVersion'
1219 $ref: '#/components/headers/X-onap-RequestId'
1223 $ref: '#/components/schemas/SimpleResponse'
1228 last-mod-release: London
1229 x-codegen-request-body-name: body
1232 - Automation Composition Instance
1233 summary: Delete an automation composition instance
1234 description: Deletes a automation composition instance, returning the UUID of the deleted automation composition instance
1235 operationId: deleteCompositionInstance
1237 - name : compositionId
1239 description: The UUID of the automation composition definition on which to delete an instance
1246 description: The UUID of the automation composition instance to delete
1251 - name: X-onap-RequestId
1253 description: RequestID for http transaction
1259 description: Serialised instance of
1260 [InstantiationResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/instantiation/InstantiationResponse.java)
1261 containing the UUID of the deleted automation composition instance
1264 $ref: '#/components/headers/X-LatestVersion'
1266 $ref: '#/components/headers/X-PatchVersion'
1268 $ref: '#/components/headers/X-MinorVersion'
1270 $ref: '#/components/headers/X-onap-RequestId'
1274 $ref: '#/components/schemas/InstantiationResponse'
1276 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionInstanceResponse.json'
1279 $ref: '#/components/schemas/InstantiationResponse'
1281 externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/deleteCompositionInstanceResponse.yaml'
1283 description: Authentication Error, returns an instance of
1284 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
1287 $ref: '#/components/headers/X-LatestVersion'
1289 $ref: '#/components/headers/X-PatchVersion'
1291 $ref: '#/components/headers/X-MinorVersion'
1293 $ref: '#/components/headers/X-onap-RequestId'
1297 $ref: '#/components/schemas/SimpleResponse'
1299 description: The specified automation composition instance was not found, returns an instance of
1300 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
1303 $ref: '#/components/headers/X-LatestVersion'
1305 $ref: '#/components/headers/X-PatchVersion'
1307 $ref: '#/components/headers/X-MinorVersion'
1309 $ref: '#/components/headers/X-onap-RequestId'
1313 $ref: '#/components/schemas/SimpleResponse'
1315 description: Bad Request, returns an instance of
1316 [SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
1319 $ref: '#/components/headers/X-LatestVersion'
1321 $ref: '#/components/headers/X-PatchVersion'
1323 $ref: '#/components/headers/X-MinorVersion'
1325 $ref: '#/components/headers/X-onap-RequestId'
1329 $ref: '#/components/schemas/SimpleResponse'
1334 last-mod-release: London
1342 ParticipantInformation:
1343 title: ParticipantInformation
1345 ToscaServiceTemplates:
1346 title: ToscaServiceTemplates
1348 ToscaServiceTemplate:
1349 title: ToscaServiceTemplate
1351 AutomationCompositionDefinition:
1352 title: AutomationCompositionDefinition
1354 AutomationComposition:
1355 title: AutomationComposition
1357 AutomationCompositions:
1358 title: AutomationCompositions
1361 title: SimpleResponse
1363 CommissioningResponse:
1364 title: CommissioningResponse
1367 title: AcTypeStateUpdate
1369 AcInstanceStateUpdate:
1370 title: AcInstanceStateUpdate
1372 InstantiationResponse:
1373 title: InstantiationResponse