Adding auto-generated artifacts for new models

io.catenax.shopfloor_information.provide_production_forecast/1.0.0/gen/ProvideProductionForecast-schema.json

@@ -0,0 +1,190 @@
+{
+  "$schema" : "http://json-schema.org/draft-04/schema",
+  "description" : "Answer to a customer with all information about the requested items",
+  "type" : "object",
+  "components" : {
+    "schemas" : {
+      "urn_samm_io.catenax.shared.message_header_1.0.0_UuidCharacteristic" : {
+        "type" : "string",
+        "description" : "Structured Value for defining a property which requires an UUID"
+      },
+      "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.shopfloor_information_types_1.0.0_TimeUnitEnum" : {
+        "type" : "string",
+        "pattern" : "[a-zA-Z]*:[a-zA-Z]+",
+        "description" : "Enumerates all time units",
+        "enum" : [ "unit:secondUnitOfTime", "unit:minuteUnitOfTime", "unit:hour", "unit:day", "unit:week", "unit:month", "unit:year" ]
+      },
+      "urn_samm_io.catenax.shared.shopfloor_information_types_1.0.0_IntegerValueCharacteristic" : {
+        "type" : "number",
+        "description" : "The value of the specified timeUnit as an integer value"
+      },
+      "urn_samm_io.catenax.shared.shopfloor_information_types_1.0.0_TimeValueCharacteristic" : {
+        "description" : "Link to the  TimeUnit Data Type",
+        "type" : "object",
+        "properties" : {
+          "timeUnit" : {
+            "description" : "Specifies the unit in which the time is represented",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.shopfloor_information_types_1.0.0_TimeUnitEnum"
+          },
+          "value" : {
+            "description" : "The amount of timeUnits considered",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.shopfloor_information_types_1.0.0_IntegerValueCharacteristic"
+          }
+        },
+        "required" : [ "timeUnit", "value" ]
+      },
+      "urn_samm_io.catenax.shopfloor_information.provide_production_forecast_1.0.0_ProductionStatusEnum" : {
+        "type" : "string",
+        "description" : "Enumeration with all possible states of an order within MP",
+        "enum" : [ "itemReceived", "itemPlanned", "itemInProduction", "itemCompleted", "statusUndefined" ]
+      },
+      "urn_samm_io.catenax.shopfloor_information.provide_production_forecast_1.0.0_ReasonsForDelayEnum" : {
+        "type" : "string",
+        "description" : "Enum that specifies reasons for a delay of an order",
+        "enum" : [ "supplyProblems", "otherCircumstances", "internalProblems", "noInformationAvailable" ]
+      },
+      "urn_samm_io.catenax.shopfloor_information.provide_production_forecast_1.0.0_ReturnCodeEnum" : {
+        "type" : "string",
+        "description" : "Enumeration with all Return Codes",
+        "enum" : [ "ok", "lowerAccuracyOfPrecision", "noForecastAvailable" ]
+      },
+      "urn_samm_io.catenax.shopfloor_information.provide_production_forecast_1.0.0_ForecastItem" : {
+        "description" : "ForecastItem entry for the requested order",
+        "type" : "object",
+        "properties" : {
+          "positionId" : {
+            "description" : "Identifier of a position of an order",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.message_header_1.0.0_UuidCharacteristic"
+          },
+          "productionForecast" : {
+            "description" : "Date of completion",
+            "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp"
+          },
+          "precisionOfForecast" : {
+            "description" : "Accuracy of the prediction",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.shopfloor_information_types_1.0.0_TimeValueCharacteristic"
+          },
+          "productionStatus" : {
+            "description" : "Status of the order/position within MP",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.provide_production_forecast_1.0.0_ProductionStatusEnum"
+          },
+          "reasonsForDelay" : {
+            "description" : "Optional field to provide information to the customer why a delivery date is not met",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.provide_production_forecast_1.0.0_ReasonsForDelayEnum"
+          },
+          "returnCode" : {
+            "description" : "Return code that indicates whether a single item of an order matches the customers desired request",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.provide_production_forecast_1.0.0_ReturnCodeEnum"
+          },
+          "forecastDate" : {
+            "description" : "Date/time of the forecast calculation",
+            "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp"
+          }
+        },
+        "required" : [ "positionId", "productionForecast", "precisionOfForecast", "productionStatus", "returnCode", "forecastDate" ]
+      },
+      "urn_samm_io.catenax.shopfloor_information.provide_production_forecast_1.0.0_ForecastItemList" : {
+        "description" : "List with the forecast items",
+        "type" : "array",
+        "items" : {
+          "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.provide_production_forecast_1.0.0_ForecastItem"
+        }
+      },
+      "urn_samm_io.catenax.shared.shopfloor_information_types_1.0.0_CommunicationModeEnum" : {
+        "type" : "string",
+        "description" : "Enumerates all possible communication modes",
+        "enum" : [ "synchronous", "cyclic", "notification" ]
+      },
+      "urn_samm_io.catenax.shared.message_header_1.0.0_BpnCharacteristic" : {
+        "type" : "string",
+        "description" : "Characteristic for defining BPN values"
+      },
+      "urn_samm_io.catenax.shopfloor_information.provide_production_forecast_1.0.0_ProductionForecastCharacteristic" : {
+        "description" : "All Data that is related to a production forecast",
+        "type" : "object",
+        "properties" : {
+          "listOfForecastItems" : {
+            "description" : "List of ForecastItems matching the items to an order",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.provide_production_forecast_1.0.0_ForecastItemList"
+          },
+          "iterationNumber" : {
+            "description" : "Only set in CommunicationMode == \"notification/cyclic\" to be able to check the order of the notifications. \n\nNot required for communication mode = \"synchronous\"",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.shopfloor_information_types_1.0.0_IntegerValueCharacteristic"
+          },
+          "communicationMode" : {
+            "description" : "Specification of the communication mode",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.shopfloor_information_types_1.0.0_CommunicationModeEnum"
+          },
+          "versionDataModel" : {
+            "description" : "Specifies the used version of the data model",
+            "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.message_header_1.0.0_BpnCharacteristic"
+          }
+        },
+        "required" : [ "listOfForecastItems", "communicationMode", "versionDataModel" ]
+      },
+      "urn_samm_io.catenax.shared.message_header_1.0.0_ContextCharacteristic" : {
+        "type" : "string",
+        "description" : "Defining a string value for the context"
+      },
+      "urn_samm_io.catenax.shared.message_header_1.0.0_VersionCharacteristic" : {
+        "type" : "string",
+        "description" : "Characteristic defining the value of version."
+      },
+      "urn_samm_io.catenax.shared.message_header_1.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.message_header_1.0.0_UuidCharacteristic"
+          },
+          "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_1.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.message_header_1.0.0_BpnCharacteristic"
+          },
+          "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.message_header_1.0.0_BpnCharacteristic"
+          },
+          "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.message_header_1.0.0_UuidCharacteristic"
+          },
+          "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_1.0.0_VersionCharacteristic"
+          }
+        },
+        "required" : [ "messageId", "context", "sentDateTime", "senderBpn", "receiverBpn", "version" ]
+      }
+    }
+  },
+  "properties" : {
+    "productionForecastResponse" : {
+      "description" : "The concrete information about a production forecast",
+      "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.provide_production_forecast_1.0.0_ProductionForecastCharacteristic"
+    },
+    "header" : {
+      "description" : "Contains standardized attributes for message processing common across several use cases.",
+      "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.message_header_1.0.0_HeaderCharacteristic"
+    }
+  },
+  "required" : [ "productionForecastResponse", "header" ]
+}

io.catenax.shopfloor_information.provide_production_forecast/1.0.0/gen/ProvideProductionForecast.json

@@ -0,0 +1,29 @@
+{
+  "productionForecastResponse" : {
+    "listOfForecastItems" : [ {
+      "returnCode" : "ok",
+      "precisionOfForecast" : {
+        "value" : 12,
+        "timeUnit" : "unit:secondUnitOfTime"
+      },
+      "reasonsForDelay" : "supplyProblems",
+      "positionId" : "00000000-0000-0000-C000-000000000046",
+      "productionStatus" : "itemReceived",
+      "productionForecast" : "2023-06-19T21:24:00+07:00",
+      "forecastDate" : "2023-06-19T21:24:00+07:00"
+    } ],
+    "versionDataModel" : "urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0",
+    "communicationMode" : "synchronous",
+    "iterationNumber" : 6
+  },
+  "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" : "urn:samm:io.catenax.message_header:1.0.0"
+  }
+}