+
+
+
+
+
+
+ Overview
+
+
+
+
+
+
+
+ 
+
+
+
+
+
+
+Properties
+
+
+
+
+
+
+This property provides a reference to an EDC asset that will contain a zip file organized according to the specification CX-0092 and the model defined in io.catenax.quality_task_attachment:1.0.0. The zip file will contain additional data describing the early warning case.
+
+ Additional Quality Data Link
+
+
+
+
+
+ Name
+ earlyWarningAttachmentLink
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ subprotocolBody: catalogEndpoint=https://test.com/catalog;dataset=79afc338-f7ea-4255-a17d-ba6faf40d2b5
+
+
+
+ Optional
+
+ Yes
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ earlyWarningAttachmentLink
+
+
+
+
+
+
+Some text describing the detected anomaly in the data
+
+ Information
+
+
+
+
+
+ Name
+ information
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ There is an unusual number of DTCs occuring in the population described by the property qualityAppFiilter
+
+
+
+ Optional
+
+ Yes
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ information
+
+
+
+
+
+
+List of unique identifiers to explicitly specify parts or vehicles exhibiting the issue described in the property "Information"
+
+ List Of Affected Items
+
+
+
+
+
+ Name
+ listOfAffectedItems
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ List
+
+
+ Has a certain order
+
+
+ Duplicates allowed
+
+
+
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ listOfAffectedItems
+
+
+
+
+
+
+
+
+
+A unique ID for the EW notification
+
+ Notification Id
+
+
+
+
+
+ Name
+ notificationId
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Trait
+
+
+
+ Reference
+
+
+
+ -
+
- https://tools.ietf.org/html/rfc4122 +
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ c2801472-5f87-41a7-9a25-b0939c4e0dff
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+ Payload key
+ notificationId
+
+
+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}$)+
+
+
+
+
+
+A set of Population Filters
+
+ Population Filter List
+
+
+
+
+
+ Name
+ poulationFilterList
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ List
+
+
+ Has a certain order
+
+
+
+ Duplicates allowed
+
+
+
+ Optional
+
+ Yes
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ poulationFilterList
+
+
+
+
+
+
+An ID to reference an existing early warning project and its data
+
+ Related Quality Task ID
+
+
+
+
+
+ Name
+ relatedQualityTaskID
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ BPN-811_2022_000001
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ relatedQualityTaskID
+
+
+
+
+
+
+A flag indicating the severity of the quality issue
+
+ Severity
+
+
+
+
+
+ Name
+ severity
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Enumeration
+
+
+ Values
+
+
+
+
+ -
+
- MINOR +
- MAJOR +
- CRITICAL +
- LIFE-THREATENING +
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ MINOR
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ severity
+
+
+
+
+
+
+A status information about the current status of the quality process triggered by this notification.
+
+ Status
+
+
+
+
+
+ Name
+ status
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Enumeration
+
+
+ Values
+
+
+
+
+ -
+
- ACKNOWLEDGED +
- ACCEPTED +
- DECLINED +
- CLOSED +
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ ACCEPTED
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ status
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/io.catenax.early_warning_notification/1.0.0/gen/EarlyWarningNotification.json b/io.catenax.early_warning_notification/1.0.0/gen/EarlyWarningNotification.json
new file mode 100644
index 00000000..edf1f46f
--- /dev/null
+++ b/io.catenax.early_warning_notification/1.0.0/gen/EarlyWarningNotification.json
@@ -0,0 +1,18 @@
+{
+ "severity" : "MINOR",
+ "earlyWarningAttachmentLink" : "subprotocolBody: catalogEndpoint=https://test.com/catalog;dataset=79afc338-f7ea-4255-a17d-ba6faf40d2b5",
+ "relatedQualityTaskID" : "BPN-811_2022_000001",
+ "notificationId" : "c2801472-5f87-41a7-9a25-b0939c4e0dff",
+ "information" : "There is an unusual number of DTCs occuring in the population described by the property qualityAppFiilter",
+ "poulationFilterList" : [ {
+ "aspectModel" : "urn:bamm:io.catenax.manufactured_parts_quality_information:1.0.0",
+ "rangeTo" : "2019-07-30T23:59:59",
+ "rangeFrom" : "2019-02-01T00:00:00",
+ "aspectProperty" : "production.productionDate",
+ "valueList" : [ "eOMtThyhVNLWUZNRcBaQKxI" ]
+ } ],
+ "listOfAffectedItems" : [ {
+ "catenaXId" : "urn:uuid:ed85f17e-29dd-473c-9cb8-d7ad1dc44d2f"
+ } ],
+ "status" : "ACKNOWLEDGED"
+}
\ No newline at end of file
diff --git a/io.catenax.early_warning_notification/1.0.0/gen/EarlyWarningNotification.yml b/io.catenax.early_warning_notification/1.0.0/gen/EarlyWarningNotification.yml
new file mode 100644
index 00000000..41eceb7e
--- /dev/null
+++ b/io.catenax.early_warning_notification/1.0.0/gen/EarlyWarningNotification.yml
@@ -0,0 +1,241 @@
+---
+openapi: 3.0.3
+info:
+ title: Early Warning Notification
+ version: v1
+servers:
+- url: catenax.io/api/v1
+ variables:
+ api-version:
+ default: v1
+paths:
+ /{tenant-id}/early-warning-notification:
+ get:
+ tags:
+ - EarlyWarningNotification
+ operationId: getEarlyWarningNotification
+ 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/EarlyWarningNotification'
+ "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/EarlyWarningNotification'
+ totalItems:
+ type: number
+ totalPages:
+ type: number
+ pageSize:
+ type: number
+ currentPage:
+ type: number
+ urn_samm_io.catenax.shared.uuid_2.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_org.eclipse.esmf.samm_characteristic_2.1.0_Text:
+ type: string
+ description: "Describes a Property which contains plain text. This is intended\
+ \ exclusively for human readable strings, not for identifiers, measurement\
+ \ values, etc."
+ urn_samm_io.catenax.early_warning_notification_1.0.0_Status:
+ type: string
+ description: A status infomration d´selected from a predefined set of possible
+ states.
+ enum:
+ - ACKNOWLEDGED
+ - ACCEPTED
+ - DECLINED
+ - CLOSED
+ urn_samm_io.catenax.early_warning_notification_1.0.0_Severity:
+ type: string
+ description: Describes the severity of a quality issue.
+ enum:
+ - MINOR
+ - MAJOR
+ - CRITICAL
+ - LIFE-THREATENING
+ urn_samm_io.catenax.early_warning_notification_1.0.0_Items:
+ description: A unique identifier
+ type: object
+ properties:
+ catenaXId:
+ description: A unique identifier for a part or a vehicle. The identifier
+ relates to a Catena-X digital twin
+ $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait'
+ urn_samm_io.catenax.early_warning_notification_1.0.0_AffectedItemsCharacteristic:
+ description: Characteristic for the UIDs defining the affected items
+ type: array
+ items:
+ $ref: '#/components/schemas/urn_samm_io.catenax.early_warning_notification_1.0.0_Items'
+ urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_ResourcePath:
+ type: string
+ format: uri
+ description: The path of a resource.
+ urn_samm_io.catenax.early_warning_notification_1.0.0_ValuesCharacteristic:
+ description: Characteristic for the values in the value list
+ type: array
+ items:
+ type: string
+ urn_samm_io.catenax.early_warning_notification_1.0.0_PopulationFilter:
+ description: Population filter for the early warning data
+ type: object
+ properties:
+ aspectProperty:
+ description: A property from the aspect model referenced by "aspectModel"
+ $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text'
+ aspectModel:
+ description: A reference to an aspect model standardized by Catena-X for
+ the quality use case
+ $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_ResourcePath'
+ rangeFrom:
+ description: 'Start value of a value range for an aspect property '
+ $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text'
+ rangeTo:
+ description: 'End value of a value range for an aspect property '
+ $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text'
+ valueList:
+ description: A list of values for the aspect property
+ $ref: '#/components/schemas/urn_samm_io.catenax.early_warning_notification_1.0.0_ValuesCharacteristic'
+ required:
+ - aspectProperty
+ - aspectModel
+ urn_samm_io.catenax.early_warning_notification_1.0.0_PopulationFilterListCharacteristic:
+ description: Characteristic for a List of Population Filters
+ type: array
+ items:
+ $ref: '#/components/schemas/urn_samm_io.catenax.early_warning_notification_1.0.0_PopulationFilter'
+ EarlyWarningNotification:
+ type: object
+ properties:
+ notificationId:
+ description: 'A unique ID for the EW notification '
+ $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait'
+ relatedQualityTaskID:
+ description: An ID to reference an existing early warning project and its
+ data
+ $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text'
+ information:
+ description: Some text describing the detected anomaly in the data
+ $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text'
+ status:
+ description: A status information about the current status of the quality
+ process triggered by this notification.
+ $ref: '#/components/schemas/urn_samm_io.catenax.early_warning_notification_1.0.0_Status'
+ severity:
+ description: A flag indicating the severity of the quality issue
+ $ref: '#/components/schemas/urn_samm_io.catenax.early_warning_notification_1.0.0_Severity'
+ listOfAffectedItems:
+ description: List of unique identifiers to explicitly specify parts or vehicles
+ exhibiting the issue described in the property "Information"
+ $ref: '#/components/schemas/urn_samm_io.catenax.early_warning_notification_1.0.0_AffectedItemsCharacteristic'
+ poulationFilterList:
+ description: A set of Population Filters
+ $ref: '#/components/schemas/urn_samm_io.catenax.early_warning_notification_1.0.0_PopulationFilterListCharacteristic'
+ earlyWarningAttachmentLink:
+ description: This property provides a reference to an EDC asset that will
+ contain a zip file organized according to the specification CX-0092 and
+ the model defined in io.catenax.quality_task_attachment:1.0.0. The zip
+ file will contain additional data describing the early warning case.
+ $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text'
+ required:
+ - notificationId
+ - relatedQualityTaskID
+ - status
+ - severity
+ - listOfAffectedItems
+ 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'
+ EarlyWarningNotification:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PagingSchema'
+ description: The request was successful.
+ requestBodies:
+ EarlyWarningNotification:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/EarlyWarningNotification'
+
+
+ Entities
+
+
+
+
+
+ Items
+
+ A unique identifier
+
+
+
+
+Properties
+
+
+
+
+
+
+A unique identifier for a part or a vehicle. The identifier relates to a Catena-X digital twin
+
+ Catena-X ID
+
+
+
+
+
+ Name
+ catenaXId
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Trait
+
+
+
+ Reference
+
+
+
+ -
+
- https://tools.ietf.org/html/rfc4122 +
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ urn:uuid:ed85f17e-29dd-473c-9cb8-d7ad1dc44d2f
+
+
+
+ Optional
+
+ Yes
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+ Payload key
+ catenaXId
+
+
+ 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}$)+
+
+
+
+ Population Filter
+
+ Population filter for the early warning data
+
+
+
+
+Properties
+
+
+
+
+
+
+A property from the aspect model referenced by "aspectModel"
+
+ Aspect Property
+
+
+
+
+
+ Name
+ aspectProperty
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ production.productionDate
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ aspectProperty
+
+
+
+
+
+
+A reference to an aspect model standardized by Catena-X for the quality use case
+
+ Aspect Model
+
+
+
+
+
+ Name
+ aspectModel
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#anyURI
+
+
+
+
+
+ Example
+ urn:bamm:io.catenax.manufactured_parts_quality_information:1.0.0
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ aspectModel
+
+
+
+
+
+
+Start value of a value range for an aspect property
+
+ Value Range From
+
+
+
+
+
+ Name
+ rangeFrom
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ 2019-02-01T00:00:00
+
+
+
+ Optional
+
+ Yes
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ rangeFrom
+
+
+
+
+
+
+End value of a value range for an aspect property
+
+ Value Range To
+
+
+
+
+
+ Name
+ rangeTo
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ 2019-07-30T23:59:59
+
+
+
+ Optional
+
+ Yes
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ rangeTo
+
+
+
+
+
+
+A list of values for the aspect property
+
+ List of Values
+
+
+
+
+
+ Name
+ valueList
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ List
+
+
+ Has a certain order
+
+
+ Duplicates allowed
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Optional
+
+ Yes
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ valueList
+
+ Third party licenses
+
+
+
+