Adding auto-generated artifacts for new models

io.catenax.shopfloor_information.provide_production_tracking/1.0.0/gen/ProvideProductionTracking-schema.json

@@ -0,0 +1,181 @@
+{
+  "$schema" : "http://json-schema.org/draft-04/schema",
+  "description" : "Aspect for the production tracking response",
+  "type" : "object",
+  "components" : {
+    "schemas" : {
+      "urn_samm_io.catenax.shopfloor_information.provide_production_tracking_1.0.0_StringCharacteristic" : {
+        "type" : "string",
+        "description" : "Characteristic to express strings"
+      },
+      "urn_samm_io.catenax.shopfloor_information.provide_production_tracking_1.0.0_ProcessParameterQualityEnumeration" : {
+        "type" : "string",
+        "description" : "Enumeration that provides a set of characteristic of a process parameter",
+        "enum" : [ "ok", "inexact", "noValue" ]
+      },
+      "urn_samm_io.catenax.shopfloor_information.provide_production_tracking_1.0.0_ProcessParameter" : {
+        "description" : "Data Type to provide process parameter with values from process step",
+        "type" : "object",
+        "properties" : {
+          "processParameterName" : {
+            "description" : "Name of a process parameter",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.provide_production_tracking_1.0.0_StringCharacteristic"
+          },
+          "semanticId" : {
+            "description" : "Reference to a global defined semantic that characterizes the process parameter. For eaxample an E-Class reference",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.provide_production_tracking_1.0.0_StringCharacteristic"
+          },
+          "processParameterValue" : {
+            "description" : "The concrete value of a process parameter. Becomes mandatory in case that the processParameterQuality property is not set to NoValue",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.provide_production_tracking_1.0.0_StringCharacteristic"
+          },
+          "processParameterQuality" : {
+            "description" : "Enumeration to provide additional information about the significance of the parameter.",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.provide_production_tracking_1.0.0_ProcessParameterQualityEnumeration"
+          }
+        },
+        "required" : [ "processParameterName", "semanticId", "processParameterQuality" ]
+      },
+      "urn_samm_io.catenax.shopfloor_information.provide_production_tracking_1.0.0_ProcessParameterValueCharacteristic" : {
+        "description" : "Lists all requested process parameter",
+        "type" : "array",
+        "items" : {
+          "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.provide_production_tracking_1.0.0_ProcessParameter"
+        }
+      },
+      "urn_samm_io.catenax.shopfloor_information.provide_production_tracking_1.0.0_ProcessStepIdentifier" : {
+        "description" : "Data type to express process steps with corresponding paramater",
+        "type" : "object",
+        "properties" : {
+          "processStepId" : {
+            "description" : "Id of a concrete process step",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.provide_production_tracking_1.0.0_StringCharacteristic"
+          },
+          "processParameterValueList" : {
+            "description" : "A set of process parameter for the corresponsing process step, that corresponds to the requested parameters",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.provide_production_tracking_1.0.0_ProcessParameterValueCharacteristic"
+          }
+        },
+        "required" : [ "processStepId", "processParameterValueList" ]
+      },
+      "urn_samm_io.catenax.shopfloor_information.provide_production_tracking_1.0.0_ProcessStepIdentifierListCharacteristic" : {
+        "description" : "Characteristic that describes each element of the requested process steps ",
+        "type" : "array",
+        "items" : {
+          "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.provide_production_tracking_1.0.0_ProcessStepIdentifier"
+        }
+      },
+      "urn_samm_io.catenax.shared.message_header_2.0.0_SemanticVersioningTrait" : {
+        "type" : "string",
+        "description" : "Constraint for defining a SemVer version.",
+        "pattern" : "^(0|[1-9][0-9]*).(0|[1-9][0-9]*).(0|[1-9][0-9]*)(-(0|[1-9A-Za-z-][0-9A-Za-z-]*)(.[0-9A-Za-z-]+)*)?([0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?$"
+      },
+      "urn_samm_io.catenax.shopfloor_information.provide_production_tracking_1.0.0_IdentifierTypeCharacteristic" : {
+        "type" : "string",
+        "description" : "Enumeration that defines values for the identifier type",
+        "enum" : [ "partInstanceId", "batchId", "bomId" ]
+      },
+      "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_io.catenax.shopfloor_information.provide_production_tracking_1.0.0_ResponseCharacteristic" : {
+        "description" : "Characteristic describing the response of the production tracking data model",
+        "type" : "object",
+        "properties" : {
+          "processStepIdentifierList" : {
+            "description" : "List that contains a set of process steps, where each process step provides a list with the values of the requeste parameters",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.provide_production_tracking_1.0.0_ProcessStepIdentifierListCharacteristic"
+          },
+          "version" : {
+            "description" : "The unique identifier of the aspect model defining the structure and the semantics of the message's header. The version number should reflect the versioning schema of aspect models in Catena-X.",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.message_header_2.0.0_SemanticVersioningTrait"
+          },
+          "identifierType" : {
+            "description" : "Distinghuished between a bill of material, a part instanceId or a batchId to identify a product",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.provide_production_tracking_1.0.0_IdentifierTypeCharacteristic"
+          },
+          "identifierNumber" : {
+            "description" : "Identifier number of a product",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.provide_production_tracking_1.0.0_StringCharacteristic"
+          },
+          "catenaXId" : {
+            "description" : "The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace.",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait"
+          }
+        },
+        "required" : [ "processStepIdentifierList", "version", "identifierType", "identifierNumber" ]
+      },
+      "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.shared.message_header_2.0.0_ContextCharacteristic" : {
+        "type" : "string",
+        "description" : "Defining a string value for the context"
+      },
+      "urn_samm_org.eclipse.esmf.samm_characteristic_2.1.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.shared.business_partner_number_1.0.0_BpnlTrait" : {
+        "type" : "string",
+        "description" : "The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two uppercase letters.",
+        "pattern" : "^BPNL[0-9]{8}[a-zA-Z0-9]{4}$"
+      },
+      "urn_samm_io.catenax.shared.message_header_2.0.0_HeaderCharacteristic" : {
+        "description" : "Characteristic describing the common shared aspect Message Header",
+        "type" : "object",
+        "properties" : {
+          "messageId" : {
+            "description" : "Unique ID identifying the message. The purpose of the ID is to uniquely identify a single message, therefore it MUST not be reused.",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_1.0.0_UuidV4Trait"
+          },
+          "context" : {
+            "description" : "Information about the context the message should be considered in.\nThe value MUST consist of two parts: an identifier of the context (e.g. business domain, etc.) followed by a version number.\nBoth the identifier and the version number MUST correspond to the content of the message.\nIf the content of a message is described by an aspect model available in the Catena-X Semantic Hub, then the unique identifier of this semantic model (e.g. urn:samm:io.catenax.<ASPECT-MODEL-NAME>:1.x.x) MUST be used as a value of the context field. This is considered the default case.\nIn all other cases the value of the context field MUST follow the pattern <domain>-<subdomain>-<object>:<[major] version> (e.g. TRACE-QM-Alert:1.x.x).\nVersioning only refers to major versions in both default and fallback cases.\nNote: The version of the message's header is specified in the version field.",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.message_header_2.0.0_ContextCharacteristic"
+          },
+          "sentDateTime" : {
+            "description" : "Time zone aware timestamp holding the date and the time the message was sent by the sending party. The value MUST be formatted according to the ISO 8601 standard",
+            "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp"
+          },
+          "senderBpn" : {
+            "description" : "The Business Partner Number of the sending party. The value MUST be a valid BPN. BPNA and BPNS are not allowed. Applicable constraints are defined in the corresponding standard",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_1.0.0_BpnlTrait"
+          },
+          "receiverBpn" : {
+            "description" : "The Business Partner Number of the receiving party. The value MUST be a valid BPN. BPNA and BPNS are not allowed. Applicable constraints are defined in the corresponding standard.",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_1.0.0_BpnlTrait"
+          },
+          "expectedResponseBy" : {
+            "description" : "Time zone aware timestamp holding the date and time by which the sending party expects a certain type of response from the receiving party. The meaning and interpretation of the fields's value are context-bound and MUST therefore be defined by any business domain or platform capability making use of it. The value MUST be formatted according to the ISO 8601 standard",
+            "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp"
+          },
+          "relatedMessageId" : {
+            "description" : "Unique ID identifying a message somehow related to the current one",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_1.0.0_UuidV4Trait"
+          },
+          "version" : {
+            "description" : "The unique identifier of the aspect model defining the structure and the semantics of the message's header. The version number should reflect the versioning schema of aspect models in Catena-X.",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.message_header_2.0.0_SemanticVersioningTrait"
+          }
+        },
+        "required" : [ "messageId", "context", "sentDateTime", "senderBpn", "receiverBpn", "version" ]
+      }
+    }
+  },
+  "properties" : {
+    "response" : {
+      "description" : "Response data for the production tracking request",
+      "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.provide_production_tracking_1.0.0_ResponseCharacteristic"
+    },
+    "header" : {
+      "description" : "Contains standardized attributes for message processing common across several use cases.",
+      "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.message_header_2.0.0_HeaderCharacteristic"
+    }
+  },
+  "required" : [ "response", "header" ]
+}

io.catenax.shopfloor_information.provide_production_tracking/1.0.0/gen/ProvideProductionTracking.json

@@ -0,0 +1,27 @@
+{
+  "header" : {
+    "senderBpn" : "BPNL7588787849VQ",
+    "relatedMessageId" : "d9452f24-3bf3-4134-b3eb-68858f1b2362",
+    "expectedResponseBy" : "2023-06-19T21:24:00+07:00",
+    "context" : "urn:samm:io.catenax.<ASPECT-MODEL-NAME>:1.x.x",
+    "messageId" : "3b4edc05-e214-47a1-b0c2-1d831cdd9ba9",
+    "receiverBpn" : "BPNL6666787765VQ",
+    "sentDateTime" : "2023-06-19T21:24:00+07:00",
+    "version" : "2.0.0"
+  },
+  "response" : {
+    "identifierNumber" : "Deckerl-2345",
+    "catenaXId" : "urn:uuid:580d3adf-1981-44a0-a214-13d6ceed9379",
+    "identifierType" : "partInstanceId",
+    "version" : "2.0.0",
+    "processStepIdentifierList" : [ {
+      "processStepId" : "step_id_12345",
+      "processParameterValueList" : [ {
+        "processParameterName" : "Drehmoment_max",
+        "semanticId" : "EClass123",
+        "processParameterQuality" : "ok",
+        "processParameterValue" : "10"
+      } ]
+    } ]
+  }
+}