+
+
+
+ The requirements for a request for update from another Catena-X Partner of a specific entity.
+If within the payload, no specific object type is defined (Payload empty), than an update of all objects within the sender reciever relation is requested).
+
+
+
+
+
+ Overview
+
+
+
+
+
+
+
+ 
+
+
+
+
+
+
+
+
+
+
+Properties
+
+
+
+
+
+
+Material demands the supplier requests an update for.
+If within the array, no specific ID (array empty), than an update of all IDs is requested).
+
+ Material Demand List
+
+
+
+
+
+ Name
+ materialDemand
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Set
+
+
+ Has no order
+
+
+
+ Duplicates not allowed
+
+
+
+ Optional
+
+ Yes
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ materialDemand
+
+
+
+
+
+
+Capacity groups the customer requests an update for.
+If within the array, no specific ID (array empty), than an update of all IDs is requested).
+
+ Week Based Capacity Group List
+
+
+
+
+
+ Name
+ weekBasedCapacityGroup
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Set
+
+
+ Has no order
+
+
+
+ Duplicates not allowed
+
+
+
+ Optional
+
+ Yes
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ weekBasedCapacityGroup
+
+
+
+
+ Entities
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/io.catenax.id_based_request_for_update/2.0.0/gen/IdBasedRequestForUpdate.json b/io.catenax.id_based_request_for_update/2.0.0/gen/IdBasedRequestForUpdate.json
new file mode 100644
index 00000000..e3703bda
--- /dev/null
+++ b/io.catenax.id_based_request_for_update/2.0.0/gen/IdBasedRequestForUpdate.json
@@ -0,0 +1,10 @@
+{
+ "materialDemand" : [ {
+ "materialDemandId" : "0157ba42-d2a8-4e28-8565-7b07830c3456",
+ "changedAt" : "2023-03-10T12:27:11.320Z"
+ } ],
+ "weekBasedCapacityGroup" : [ {
+ "capacityGroupId" : "0157ba42-d2a8-4e28-8565-7b07830c1110",
+ "changedAt" : "2023-03-10T12:27:11.320Z"
+ } ]
+}
\ No newline at end of file
diff --git a/io.catenax.id_based_request_for_update/2.0.0/gen/IdBasedRequestForUpdate.yml b/io.catenax.id_based_request_for_update/2.0.0/gen/IdBasedRequestForUpdate.yml
new file mode 100644
index 00000000..bf26f991
--- /dev/null
+++ b/io.catenax.id_based_request_for_update/2.0.0/gen/IdBasedRequestForUpdate.yml
@@ -0,0 +1,200 @@
+---
+openapi: 3.0.3
+info:
+ title: ID Based Request For Update
+ version: v2
+servers:
+- url: catenax.io/api/v2
+ variables:
+ api-version:
+ default: v2
+paths:
+ /{tenant-id}/id-based-request-for-update:
+ get:
+ tags:
+ - IdBasedRequestForUpdate
+ operationId: getIdBasedRequestForUpdate
+ parameters:
+ - name: tenant-id
+ in: path
+ description: The ID of the tenant owning the requested Twin.
+ required: true
+ schema:
+ type: string
+ format: uuid
+ - name: start
+ in: query
+ description: Starting index which is starting by 0
+ required: false
+ schema:
+ type: number
+ - name: count
+ in: query
+ description: Number of items to return per call.
+ required: false
+ schema:
+ type: number
+ - name: totalItemCount
+ in: query
+ description: Flag that indicates that the total counts should be returned.
+ required: false
+ schema:
+ type: boolean
+ responses:
+ "200":
+ $ref: '#/components/responses/IdBasedRequestForUpdate'
+ "401":
+ $ref: '#/components/responses/ClientError'
+ "402":
+ $ref: '#/components/responses/Unauthorized'
+ "403":
+ $ref: '#/components/responses/Forbidden'
+ "404":
+ $ref: '#/components/responses/NotFoundError'
+components:
+ schemas:
+ ErrorResponse:
+ type: object
+ required:
+ - error
+ properties:
+ error:
+ $ref: '#/components/schemas/Error'
+ Error:
+ type: object
+ required:
+ - details
+ properties:
+ message:
+ type: string
+ minLength: 1
+ path:
+ type: string
+ minLength: 1
+ details:
+ type: object
+ minLength: 1
+ additionalProperties:
+ type: object
+ code:
+ type: string
+ nullable: true
+ PagingSchema:
+ type: object
+ properties:
+ items:
+ type: array
+ items:
+ $ref: '#/components/schemas/IdBasedRequestForUpdate'
+ totalItems:
+ type: number
+ totalPages:
+ type: number
+ pageSize:
+ type: number
+ currentPage:
+ type: number
+ urn_samm_io.catenax.shared.uuid_1.0.0_UuidV4Trait:
+ type: string
+ description: "The provided regular expression ensures that the UUID is composed\
+ \ of five groups of characters separated by hyphens, in the form 8-4-4-4-12\
+ \ for a total of 36 characters (32 hexadecimal characters and 4 hyphens),\
+ \ optionally prefixed by \"urn:uuid:\" to make it an IRI."
+ pattern: "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)"
+ urn_samm_io.catenax.id_based_request_for_update_2.0.0_Timestamp:
+ type: string
+ pattern: "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\\
+ .[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?"
+ description: Describes a Property which contains the date and time with an optional
+ timezone.
+ urn_samm_io.catenax.id_based_request_for_update_2.0.0_MaterialDemandEntity:
+ description: Encapsulates the information that is necessary for an update request.
+ type: object
+ properties:
+ materialDemandId:
+ 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.
+ $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_1.0.0_UuidV4Trait'
+ changedAt:
+ 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."
+ $ref: '#/components/schemas/urn_samm_io.catenax.id_based_request_for_update_2.0.0_Timestamp'
+ required:
+ - materialDemandId
+ urn_samm_io.catenax.id_based_request_for_update_2.0.0_MaterialDemandCharacteristic:
+ description: A list of material demand UUIDs without duplicates an update is
+ requested for.
+ type: array
+ items:
+ $ref: '#/components/schemas/urn_samm_io.catenax.id_based_request_for_update_2.0.0_MaterialDemandEntity'
+ uniqueItems: true
+ urn_samm_io.catenax.id_based_request_for_update_2.0.0_WeekBasedCapacityGroupEntity:
+ description: Encapsulates the information that is necessary for an update request.
+ type: object
+ properties:
+ capacityGroupId:
+ 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.
+ $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_1.0.0_UuidV4Trait'
+ changedAt:
+ 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."
+ $ref: '#/components/schemas/urn_samm_io.catenax.id_based_request_for_update_2.0.0_Timestamp'
+ required:
+ - capacityGroupId
+ urn_samm_io.catenax.id_based_request_for_update_2.0.0_WeekBasedCapacityGroupCharacteristic:
+ description: A list of capacity group UUIDs without duplicates an update is
+ requested for.
+ type: array
+ items:
+ $ref: '#/components/schemas/urn_samm_io.catenax.id_based_request_for_update_2.0.0_WeekBasedCapacityGroupEntity'
+ uniqueItems: true
+ IdBasedRequestForUpdate:
+ description: |-
+ The requirements for a request for update from another Catena-X Partner of a specific entity.
+ If within the payload, no specific object type is defined (Payload empty), than an update of all objects within the sender reciever relation is requested).
+ type: object
+ properties:
+ materialDemand:
+ description: |-
+ Material demands the supplier requests an update for.
+ If within the array, no specific ID (array empty), than an update of all IDs is requested).
+ $ref: '#/components/schemas/urn_samm_io.catenax.id_based_request_for_update_2.0.0_MaterialDemandCharacteristic'
+ weekBasedCapacityGroup:
+ description: |-
+ Capacity groups the customer requests an update for.
+ If within the array, no specific ID (array empty), than an update of all IDs is requested).
+ $ref: '#/components/schemas/urn_samm_io.catenax.id_based_request_for_update_2.0.0_WeekBasedCapacityGroupCharacteristic'
+ responses:
+ Unauthorized:
+ description: The requesting user or client is not authenticated.
+ Forbidden:
+ description: The requesting user or client is not authorized to access resources
+ for the given tenant.
+ NotFoundError:
+ description: The requested Twin has not been found.
+ ClientError:
+ description: Payload or user input is invalid. See error details in the payload
+ for more.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ IdBasedRequestForUpdate:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PagingSchema'
+ description: The request was successful.
+ requestBodies:
+ IdBasedRequestForUpdate:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/IdBasedRequestForUpdate'
+
+ Material Demand Entity
+
+ Encapsulates the information that is necessary for an update request.
+
+
+
+
+Properties
+
+
+
+
+
+
+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.
+
+ Material Demand ID
+
+
+
+
+
+ Name
+ materialDemandId
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Trait
+
+
+
+ Reference
+
+
+
+ -
+
- https://tools.ietf.org/html/rfc4122 +
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ 0157ba42-d2a8-4e28-8565-7b07830c3456
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+ Payload key
+ materialDemandId
+
+
+Constraints
+
+
+-
+
-
++ +++ UUID v4 Regular Expression ++ +++ +Description+The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by "urn:uuid:" to make it an IRI.+++ +Reference+++++
-
+
- https://datatracker.ietf.org/doc/html/rfc4122 +
++ + + +Regular expression+(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)+
+
+
+
+
+
+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.
+
+ Changed At
+
+
+
+
+
+ Name
+ changedAt
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime
+
+
+
+
+
+ Example
+ 2023-03-10T12:27:11.320Z
+
+
+
+ Optional
+
+ Yes
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ changedAt
+
+
+
+
+
+ Week Based Capacity Group Entity
+
+ Encapsulates the information that is necessary for an update request.
+
+
+
+
+Properties
+
+
+
+
+
+
+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.
+
+ Capacity Group ID
+
+
+
+
+
+ Name
+ capacityGroupId
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Trait
+
+
+
+ Reference
+
+
+
+ -
+
- https://tools.ietf.org/html/rfc4122 +
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ 0157ba42-d2a8-4e28-8565-7b07830c1110
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+ Payload key
+ capacityGroupId
+
+
+Constraints
+
+
+-
+
-
++ +++ UUID v4 Regular Expression ++ +++ +Description+The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by "urn:uuid:" to make it an IRI.+++ +Reference+++++
-
+
- https://datatracker.ietf.org/doc/html/rfc4122 +
++ + + +Regular expression+(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)+
+
+
+
+
+
+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.
+
+ Changed At
+
+
+
+
+
+ Name
+ changedAt
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime
+
+
+
+
+
+ Example
+ 2023-03-10T12:27:11.320Z
+
+
+
+ Optional
+
+ Yes
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ changedAt
+
+ Third party licenses
+
+
+
+