summaryrefslogtreecommitdiffstats
path: root/docs/clamp/acm/api-protocol
diff options
context:
space:
mode:
authorrameshiyer27 <ramesh.murugan.iyer@est.tech>2023-06-08 16:54:55 +0100
committerrameshiyer27 <ramesh.murugan.iyer@est.tech>2023-06-12 10:17:15 +0100
commit580de3ad1abeac9001d5f5190e12dd687fa7d0fc (patch)
tree94a56bc56721ccf3ddae8146efe87e8ed77255de /docs/clamp/acm/api-protocol
parentd3ea2362501e3b51a709f8e2671f97ec5aad1349 (diff)
Add documentation for AC instance update support
Issue-ID: POLICY-4698 Signed-off-by: zrrmmua <ramesh.murugan.iyer@est.tech> Change-Id: I80396650e0f12636ea39de924777bc0ef78dc920
Diffstat (limited to 'docs/clamp/acm/api-protocol')
-rw-r--r--docs/clamp/acm/api-protocol/system-level-dialogues.rst28
1 files changed, 21 insertions, 7 deletions
diff --git a/docs/clamp/acm/api-protocol/system-level-dialogues.rst b/docs/clamp/acm/api-protocol/system-level-dialogues.rst
index c5105313..e3ee09ab 100644
--- a/docs/clamp/acm/api-protocol/system-level-dialogues.rst
+++ b/docs/clamp/acm/api-protocol/system-level-dialogues.rst
@@ -140,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.
@@ -154,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.
@@ -173,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.
@@ -187,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