Add documentation for AC instance update support
[policy/parent.git] / docs / clamp / acm / api-protocol / system-level-dialogues.rst
index 4ffcbe6..e3ee09a 100644 (file)
@@ -114,9 +114,18 @@ Note that this dialogue creates the Automation Composition Instance in the ACM d
 
 3.2 Delete an Automation Composition Instance
 ---------------------------------------------
+The user requests the AC Instance to be deleted using a REST endpoint. The ACM Runtime orders the AC Instance to be deleted.
 
 .. image:: ../images/system-dialogues/DeleteAcInstance.png
 
+Each participant deletes its AC Element Instances from the AC Instance
+
+.. image:: ../images/system-dialogues/DeleteInstanceElements.png
+
+The ACM Runtime receives and stores the responses, when all instances element are deleted, it delete the instance.
+
+.. image:: ../images/system-dialogues/DeleteResponseStored.png
+
 3.3 Deploy Automation Composition Instance
 ------------------------------------------
 The user requests the AC Instance to be deployed using a REST endpoint. The ACM Runtime orders the AC Instance to be deployed to Participants.
@@ -131,7 +140,21 @@ The ACM Runtime receives and stores the responses.
 
 .. image:: ../images/system-dialogues/DeployResponseStored.png
 
-3.4 Undeploy Automation Composition Instance
+3.4 Update Automation Composition Instance
+------------------------------------------
+The user requests the AC Instance to be updated using a REST endpoint. The ACM Runtime orders the AC Instance to be updated.
+
+.. image:: ../images/system-dialogues/UpdateAcInstance.png
+
+Each participant updates its AC Element from the AC Instance
+
+.. image:: ../images/system-dialogues/UpdateAcElements.png
+
+The ACM Runtime receives and stores the responses.
+
+.. image:: ../images/system-dialogues/UpdateAcElementsResponse.png
+
+3.5 Undeploy Automation Composition Instance
 --------------------------------------------
 The user requests the AC Instance to be undeployed using a REST endpoint. The ACM Runtime orders the AC Instance to be undeployed.
 
@@ -145,12 +168,12 @@ The ACM Runtime receives and stores the responses.
 
 .. image:: ../images/system-dialogues/UndeployResponseStored.png
 
-3.5 Read Automation Composition Instances
+3.6 Read Automation Composition Instances
 -----------------------------------------
 
 .. image:: ../images/system-dialogues/ReadAcInstances.png
 
-3.6 Unlock Automation Composition Instance
+3.7 Unlock Automation Composition Instance
 ------------------------------------------
 The user requests the AC Instance to be unlocked using a REST endpoint. The ACM Runtime orders the AC Instance to be unlocked on Participants.
 
@@ -164,7 +187,7 @@ The ACM Runtime receives and stores the responses.
 
 .. image:: ../images/system-dialogues/UnlockResponseStored.png
 
-3.7 Lock Automation Composition Instance
+3.8 Lock Automation Composition Instance
 ----------------------------------------
 The user requests the AC Instance to be locked using a REST endpoint. The ACM Runtime orders the AC Instance to be locked on Participants.
 
@@ -178,13 +201,13 @@ The ACM Runtime receives and stores the responses.
 
 .. image:: ../images/system-dialogues/LockResponseStored.png
 
-3.8 Update Operational State on Automation Composition Instance
+3.9 Update Operational State on Automation Composition Instance
 ---------------------------------------------------------------
 
 .. image:: ../images/system-dialogues/UpdateOperationalState.png
 
-3.9 Update Usage State on Automation Composition Instance
----------------------------------------------------------
+3.10 Update Usage State on Automation Composition Instance
+----------------------------------------------------------
 
 .. image:: ../images/system-dialogues/UpdateUsageState.png