Merge pull request #679 from nhaenis/model_update_id_based_request_fo…

…r_update_2405

[Model Update]: IdBasedRequestForUpdate

io.catenax.id_based_request_for_update/3.0.0/IdBasedRequestForUpdate.ttl

@@ -0,0 +1,94 @@
+#######################################################################
+# Copyright (c) 2023-2024 BASF SE
+# Copyright (c) 2023-2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
+# Copyright (c) 2023-2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IML)
+# Copyright (c) 2023-2024 Henkel AG & Co. KGaA
+# Copyright (c) 2023-2024 Mercedes Benz AG
+# Copyright (c) 2023-2024 SAP SE
+# Copyright (c) 2023-2024 Siemens AG
+# Copyright (c) 2023-2024 SupplyOn AG
+# Copyright (c) 2023-2024 Volkswagen AG
+# Copyright (c) 2023-2024 ZF Friedrichshafen AG
+# Copyright (c) 2023-2024 Contributors to the Eclipse Foundation
+#
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
+#
+# This work is made available under the terms of the
+# Creative Commons Attribution 4.0 International (CC-BY-4.0) license,
+# which is available at
+# https://creativecommons.org/licenses/by/4.0/legalcode.
+#
+# SPDX-License-Identifier: CC-BY-4.0
+#######################################################################
+
+@prefix samm: <urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#> .
+@prefix samm-c: <urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#> .
+@prefix samm-e: <urn:samm:org.eclipse.esmf.samm:entity:2.1.0#> .
+@prefix unit: <urn:samm:org.eclipse.esmf.samm:unit:2.1.0#> .
+@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
+@prefix : <urn:samm:io.catenax.id_based_request_for_update:3.0.0#> .
+@prefix ext-uuid: <urn:samm:io.catenax.shared.uuid:2.0.0#> .
+
+:IdBasedRequestForUpdate a samm:Aspect ;
+   samm:preferredName "ID Based Request For Update"@en ;
+   samm:description "The requirements for a request for update from another Catena-X Partner of a specific entity.\nIf within the payload, no specific object type is defined (Payload empty), than an update of all objects within the sender receiver relation is requested)."@en ;
+   samm:properties ( [ samm:property :weekBasedMaterialDemand; samm:optional true ] [ samm:property :weekBasedCapacityGroup; samm:optional true ] ) ;
+   samm:operations ( ) ;
+   samm:events ( ) .
+
+:weekBasedMaterialDemand a samm:Property ;
+   samm:preferredName "Week Based Material Demand List"@en ;
+   samm:description "Material demands the supplier requests an update for.\nIf within the array, no specific ID (array empty), than an update of all IDs is requested)."@en ;
+   samm:characteristic :WeekBasedMaterialDemandCharacteristic .
+
+:weekBasedCapacityGroup a samm:Property ;
+   samm:preferredName "Week Based Capacity Group List"@en ;
+   samm:description "Capacity groups the customer requests an update for.\nIf within the array, no specific ID (array empty), than an update of all IDs is requested)."@en ;
+   samm:characteristic :WeekBasedCapacityGroupCharacteristic .
+
+:WeekBasedMaterialDemandCharacteristic a samm-c:Set ;
+   samm:preferredName "Week Based Material Demand Characteristic"@en ;
+   samm:description "A list of material demand UUIDs without duplicates an update is requested for."@en ;
+   samm:dataType :WeekBasedMaterialDemandEntity .
+
+:WeekBasedCapacityGroupCharacteristic a samm-c:Set ;
+   samm:preferredName "Week Based Capacity Group Characteristic"@en ;
+   samm:description "A list of capacity group UUIDs without duplicates an update is requested for."@en ;
+   samm:dataType :WeekBasedCapacityGroupEntity .
+
+:WeekBasedMaterialDemandEntity a samm:Entity ;
+   samm:preferredName "Week Based Material Demand Entity"@en ;
+   samm:description "Encapsulates the information that is necessary for an update request."@en ;
+   samm:properties ( :materialDemandId [ samm:property :changedAt; samm:optional true ] ) .
+
+:WeekBasedCapacityGroupEntity a samm:Entity ;
+   samm:preferredName "Week Based Capacity Group Entity"@en ;
+   samm:description "Encapsulates the information that is necessary for an update request."@en ;
+   samm:properties ( :capacityGroupId [ samm:property :changedAt; samm:optional true ] ) .
+
+:materialDemandId a samm:Property ;
+   samm:preferredName "Material Demand ID"@en ;
+   samm:description "The Material Demand ID uniquely identifies the material demand the supplier requests an update for within the business relationship between the customer and its supplier."@en ;
+   samm:characteristic ext-uuid:UuidV4Trait ;
+   samm:exampleValue "0157ba42-d2a8-4e28-8565-7b07830c3456" .
+
+:changedAt a samm:Property ;
+   samm:preferredName "Changed At"@en ;
+   samm:description "Point in time of the last update known to the requesting business partner. If the requested entity has been changed more recently, the requested party should resend the data. If the changedAt property is not given, the latest entity should be send without precondition."@en ;
+   samm:characteristic :Timestamp ;
+   samm:exampleValue "2023-03-10T12:27:11.320Z"^^xsd:dateTime .
+
+:capacityGroupId a samm:Property ;
+   samm:preferredName "Capacity Group ID"@en ;
+   samm:description "The Capacity Group ID uniquely identifies the capacity group the supplier requests an update for within the business relationship between the supplier and its customer."@en ;
+   samm:characteristic ext-uuid:UuidV4Trait ;
+   samm:exampleValue "0157ba42-d2a8-4e28-8565-7b07830c1110" .
+
+:Timestamp a samm:Characteristic ;
+   samm:preferredName "Timestamp"@en ;
+   samm:description "Describes a Property which contains the date and time with an optional timezone."@en ;
+   samm:dataType xsd:dateTime .
+

io.catenax.id_based_request_for_update/3.0.0/metadata.json

@@ -0,0 +1 @@
+{ "status" : "release"} 

io.catenax.id_based_request_for_update/RELEASE_NOTES.md

@@ -1,23 +1,48 @@
 # Changelog
+
 All notable changes to this model will be documented in this file.
 
+## [3.0.0] - 2024-03-11
+
+### Added
+
+n/a
+
+### Changed
+
+- migrated from SAMM version `2.0.0` to `2.1.0`
+- renamed property `materialDemand` to `weekBasedMaterialDemand`
+- updated external references of `urn:samm:io.catenax.shared.uuid` to version `2.0.0`
+
+### Removed
+
+n/a
+
 ## [2.0.0] - 2023-11-13
+
 ### Added
+
 n/a
 
 ### Changed
+
 - renamed property `weekBasedMaterialDemand` to `materialDemand`
 - use [`io.catenax.shared.uuid`](https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.shared.uuid/1.0.0/Uuid.ttl) trait for UUIDs
 
 ### Removed
+
 n/a
 
 ## [1.0.0] - 2023-05-08
+
 ### Added
+
 - initial version of this model
 
 ### Changed
+
 n/a
 
 ### Removed
-n/a
+
+n/a