From adf5ef49c78e6e7d3eeb267eb41f5745618f918d Mon Sep 17 00:00:00 2001 From: mk Date: Thu, 11 Jan 2024 16:56:25 +0100 Subject: [PATCH] chore(concept):[#322] add edc management api endpoints and abstract definition --- ...ioning-of-contract-definiton-for-assets.md | 38 ++++++++++++++++++- docs/concept/TEMPLATE_Concept.md | 5 ++- 2 files changed, 41 insertions(+), 2 deletions(-) diff --git a/docs/concept/#322-Provisioning-of-contract-definiton-for-assets/#322-Provisioning-of-contract-definiton-for-assets.md b/docs/concept/#322-Provisioning-of-contract-definiton-for-assets/#322-Provisioning-of-contract-definiton-for-assets.md index 3ee668cc07..c3c4093e4b 100644 --- a/docs/concept/#322-Provisioning-of-contract-definiton-for-assets/#322-Provisioning-of-contract-definiton-for-assets.md +++ b/docs/concept/#322-Provisioning-of-contract-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) # Overview @@ -48,6 +49,14 @@ This specific id must therefore be stored and linked for the exchanged asset in # Concept +## 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": "", + "submodels": [ + { + "identification": ">", + "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,6 +120,7 @@ Impact: ] ``` + # Glossary | Abbreviation | Name | @@ -96,4 +128,8 @@ Impact: | edc:ContractAgreement | | | edc:ContractNegotation | | | AAS | AssetAdministrationShell | - | contractAgreementId | | \ No newline at end of file + | contractAgreementId | | + +# References + +https://app.swaggerhub.com/apis/eclipse-tractusx-bot/tractusx-edc/0.5.3#/Contract%20Agreement/getAgreementById \ No newline at end of file diff --git a/docs/concept/TEMPLATE_Concept.md b/docs/concept/TEMPLATE_Concept.md index 34f70ca2ec..aa1765852c 100644 --- 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) # Overview @@ -37,4 +38,6 @@ | Abbreviation | Name | |-------------|-----------------------------| | | | -| | | \ No newline at end of file +| | | + +# References \ No newline at end of file