chore(concept):[#322] add edc management api endpoints and abstract d…

…efinition
eclipse-tractusx · Jan 11, 2024 · adf5ef4 · adf5ef4
1 parent 0a21ff3
commit adf5ef4
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 2 deletions.
diff --git a/...ract-definiton-for-assets/#322-Provisioning-of-contract-definiton-for-assets.md b/...ract-definiton-for-assets/#322-Provisioning-of-contract-definiton-for-assets.md
@@ -20,6 +20,7 @@
 6. [Out of scope](#outofscope)
 7. [Concept](#concept)
 8. [Glossary](#glossary)
+9. [References](#references)
 
 
 # <ins>Overview</ins> <a name="overview"></a>
@@ -48,6 +49,14 @@ This specific id must therefore be stored and linked for the exchanged asset in
 
 # <ins>Concept</ins> <a name="concept"></a>
 
+## EDC Management API 
+Source: https://app.swaggerhub.com/apis/eclipse-tractusx-bot/tractusx-edc/0.5.3#/Contract%20Agreement/getNegotiationByAgreementId
+GET /v2/contractagreements/{id} Gets an contract agreement with the given ID
+GET /v2/contractagreements/{id}/negotiation Gets a contract negotiation with the given contract agreement ID
+
+## ContractAgreementId for AAS 
+
+
 
 ## ContractAgreementId for submodels 
 
@@ -58,6 +67,25 @@ Impact: High invasive changes to the code, api, JobResponse and documentation.
   "contractAggreements" : [
     "contractAggreement" : {
        "contractAgreementId": "<contractAgreementId>",
+       "submodels": [
+        {
+            "identification": "<identification>>",
+            "aspectType": "<aspectType>",
+            "payload": {
+              <... submodel payload ...>
+        }
+      ] 
+    }     
+
+  ]
+```
+
+### Example 
+
+```json 
+  "contractAggreements" : [
+    "contractAggreement" : {
+       "contractAgreementId": "YjA4NjdmMjgtYWMwMC00OTdiLTliMTItNGEzZDdkYjk4YmEw:cmVnaXN0cnktYXNzZXQ=:YWI2MTY5ZDctNzdiYi00YTQ1LTljZTYtZTUzZjhjM2MwYTFm",
        "submodels": [
         {
             "identification": "urn:uuid:f9b6f066-c4de-4bed-b531-2a1cad7bd173",
@@ -71,6 +99,9 @@ Impact: High invasive changes to the code, api, JobResponse and documentation.
   ]
 ```
 
+
+
+
 ### Option 2: Provide contractAgreementId for each submodel: 
 Impact: 
 - Redundant information in case multiple submodels were received for the same contractAgreementId. 
@@ -89,11 +120,16 @@ Impact:
   ]
 ```
 
+
 # <ins>Glossary</ins> <a name="glossary"></a>
 
 | Abbreviation           | Name                     |
 |------------------------|--------------------------|
 | edc:ContractAgreement  |                          |
 | edc:ContractNegotation |                          |
 | AAS                    | AssetAdministrationShell |   
- | contractAgreementId   |                          |
+ | contractAgreementId   |                          |
+
+# <ins>References</ins> <a name="references"></a>
+
+https://app.swaggerhub.com/apis/eclipse-tractusx-bot/tractusx-edc/0.5.3#/Contract%20Agreement/getAgreementById
diff --git a/docs/concept/TEMPLATE_Concept.md b/docs/concept/TEMPLATE_Concept.md
@@ -15,6 +15,7 @@
 6. [Out of scope](#outofscope)
 7. [Concept](#concept)
 8. [Glossary](#glossary)
+9. [References](#references)
 
 
 # <ins>Overview</ins> <a name="overview"></a>
@@ -37,4 +38,6 @@
 | Abbreviation | Name                        |
 |-------------|-----------------------------|
 |   |  |
-|   |  |
+|   |  |
+
+# <ins>References</ins> <a name="references"></a>