From d7ccab4d1c288f933f201a28d70297bd4411caa8 Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot Date: Wed, 31 Jan 2024 10:07:04 +0000 Subject: [PATCH] Adding auto-generated artifacts for new models --- .../gen/ProvideProductionForecast-aas.xml | 1926 ++++++++++++++++ .../gen/ProvideProductionForecast-schema.json | 190 ++ .../1.0.0/gen/ProvideProductionForecast.aasx | Bin 0 -> 7269 bytes .../1.0.0/gen/ProvideProductionForecast.html | 1721 ++++++++++++++ .../1.0.0/gen/ProvideProductionForecast.json | 29 + .../1.0.0/gen/ProvideProductionForecast.yml | 299 +++ .../gen/ProvideProductionForecast-aas.xml | 1926 ++++++++++++++++ .../gen/ProvideProductionForecast-schema.json | 193 ++ .../2.0.0/gen/ProvideProductionForecast.aasx | Bin 0 -> 7204 bytes .../2.0.0/gen/ProvideProductionForecast.html | 2014 +++++++++++++++++ .../2.0.0/gen/ProvideProductionForecast.json | 29 + .../2.0.0/gen/ProvideProductionForecast.yml | 309 +++ 12 files changed, 8636 insertions(+) create mode 100644 io.catenax.shopfloor_information.provide_production_forecast/1.0.0/gen/ProvideProductionForecast-aas.xml create mode 100644 io.catenax.shopfloor_information.provide_production_forecast/1.0.0/gen/ProvideProductionForecast-schema.json create mode 100644 io.catenax.shopfloor_information.provide_production_forecast/1.0.0/gen/ProvideProductionForecast.aasx create mode 100644 io.catenax.shopfloor_information.provide_production_forecast/1.0.0/gen/ProvideProductionForecast.html create mode 100644 io.catenax.shopfloor_information.provide_production_forecast/1.0.0/gen/ProvideProductionForecast.json create mode 100644 io.catenax.shopfloor_information.provide_production_forecast/1.0.0/gen/ProvideProductionForecast.yml create mode 100644 io.catenax.shopfloor_information.provide_production_forecast/2.0.0/gen/ProvideProductionForecast-aas.xml create mode 100644 io.catenax.shopfloor_information.provide_production_forecast/2.0.0/gen/ProvideProductionForecast-schema.json create mode 100644 io.catenax.shopfloor_information.provide_production_forecast/2.0.0/gen/ProvideProductionForecast.aasx create mode 100644 io.catenax.shopfloor_information.provide_production_forecast/2.0.0/gen/ProvideProductionForecast.html create mode 100644 io.catenax.shopfloor_information.provide_production_forecast/2.0.0/gen/ProvideProductionForecast.json create mode 100644 io.catenax.shopfloor_information.provide_production_forecast/2.0.0/gen/ProvideProductionForecast.yml diff --git a/io.catenax.shopfloor_information.provide_production_forecast/1.0.0/gen/ProvideProductionForecast-aas.xml b/io.catenax.shopfloor_information.provide_production_forecast/1.0.0/gen/ProvideProductionForecast-aas.xml new file mode 100644 index 00000000..5e991136 --- /dev/null +++ b/io.catenax.shopfloor_information.provide_production_forecast/1.0.0/gen/ProvideProductionForecast-aas.xml @@ -0,0 +1,1926 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#ProvideProductionForecast + + Type + + + + ModelReference + + + Submodel + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#ProvideProductionForecast/submodel + + + + + + + + + ProvideProductionForecast + + + en + Answer to a customer with all information about the requested items + + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#ProvideProductionForecast/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#ProvideProductionForecast + + + + + + ProductionForecastItem + + + en + Production Forecast Item + + + + + en + Datamodel of the concrete production forecast for one forecast item + + + + + listOfForecastItems + + + en + List Of Forecast Items + + + + + en + List of ForecastItems matching the items to an order + + + true + DataElement + + + ForecastItem + + + en + Forecast Item + + + + + en + ForecastItem entry for the requested order + + + + + positionId + + + en + Position Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#positionId + + + + xs:string + + + + productionForecast + + + en + Production Forecast + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#productionForecast + + + + xs:dateTime + + + + TimeValue + + + en + Time Value + + + + + en + Datatype to express a time value + + + + + timeUnit + + + en + Time Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#timeUnit + + + + xs:string + + + + value + + + en + Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#value + + + + xs:integer + + + + + + productionStatus + + + en + Production Status + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#productionStatus + + + + xs:string + + + + reasonsForDelay + + + en + Reasons For Delay + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#reasonsForDelay + + + + xs:string + + + + returnCode + + + en + Return Code + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#returnCode + + + + xs:string + + + + forecastDate + + + en + Forecast Date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#forecastDate + + + + xs:dateTime + + + + + + + + iterationNumber + + + en + Iteration Number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#iterationNumber + + + + xs:integer + + + + communicationMode + + + en + Communication Mode + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#communicationMode + + + + xs:string + + + + versionDataModel + + + en + Version Data Model + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#versionDataModel + + + + xs:string + + + + + + MessageHeader + + + en + Message Header + + + + + en + The Catena-X Message Header contains standardized attributes for message processing that are common across several use cases. It targets a minimal set of aspects that are needed for overall message handling, and not for the processing of the business related payload part. By standardizing the message header structure, we support a harmonized modelling approach and re-use of concepts. The message header originated from discussions on push notifications but has since then been abstracted for overall message handling – and does not only apply to notification anymore. + + + + + messageId + + + en + Message ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.message_header:1.0.0#messageId + + + + xs:string + + + + context + + + en + Context + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.message_header:1.0.0#context + + + + xs:string + + + + sentDateTime + + + en + Sent Date Time + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.message_header:1.0.0#sentDateTime + + + + xs:dateTime + + + + senderBpn + + + en + Sender BPN + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.message_header:1.0.0#senderBpn + + + + xs:string + + + + receiverBpn + + + en + Receiver BPN + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.message_header:1.0.0#receiverBpn + + + + xs:string + + + + expectedResponseBy + + + en + Expected Response By + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.message_header:1.0.0#expectedResponseBy + + + + xs:dateTime + + + + relatedMessageId + + + en + Related Message ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.message_header:1.0.0#relatedMessageId + + + + xs:string + + + + version + + + en + Version + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.message_header:1.0.0#version + + + + xs:string + + + + + + + + + + APPLICATION_CLASS + ProvideProductionForecast + + + en + Provide Production Forecast + + + + + en + Answer to a customer with all information about the requested items + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#ProvideProductionForecast + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Provide Production Forecast + + + + + en + ProvideProductionForecast + + + + + en + Answer to a customer with all information about the requested items + + + + + + + + + positionId + + + en + Position Id + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#positionId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Position Id + + + + + en + positionId + + + STRING + + + en + Identifier of a position of an order + + + + + + + + + productionForecast + + + en + Production Forecast + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#productionForecast + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Production Forecast + + + + + en + productionForecast + + + STRING + + + en + Date of completion + + + + + + + + + timeUnit + + + en + Time Unit + + + urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#timeUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Time Unit + + + + + en + timeUnit + + + STRING + + + en + Specifies the unit in which the time is represented + + + + + + unit:secondUnitOfTime + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#TimeUnitEnum:unit:secondUnitOfTime + + + + + + unit:minuteUnitOfTime + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#TimeUnitEnum:unit:minuteUnitOfTime + + + + + + unit:hour + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#TimeUnitEnum:unit:hour + + + + + + unit:day + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#TimeUnitEnum:unit:day + + + + + + unit:week + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#TimeUnitEnum:unit:week + + + + + + unit:month + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#TimeUnitEnum:unit:month + + + + + + unit:year + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#TimeUnitEnum:unit:year + + + + + + + + + + + + + value + + + en + Value + + + urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#value + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Value + + + + + en + value + + + INTEGER_MEASURE + + + en + The amount of timeUnits considered + + + + + + + + + precisionOfForecast + + + en + Precision Of Forecast + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#precisionOfForecast + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Precision Of Forecast + + + + + en + precisionOfForecast + + + STRING + + + en + Accuracy of the prediction + + + + + + + + + productionStatus + + + en + Production Status + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#productionStatus + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Production Status + + + + + en + productionStatus + + + STRING + + + en + Status of the order/position within MP + + + + + + itemReceived + + ModelReference + + + DataElement + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#ProductionStatusEnum:itemReceived + + + + + + itemPlanned + + ModelReference + + + DataElement + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#ProductionStatusEnum:itemPlanned + + + + + + itemInProduction + + ModelReference + + + DataElement + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#ProductionStatusEnum:itemInProduction + + + + + + itemCompleted + + ModelReference + + + DataElement + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#ProductionStatusEnum:itemCompleted + + + + + + statusUndefined + + ModelReference + + + DataElement + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#ProductionStatusEnum:statusUndefined + + + + + + + + + + + + + reasonsForDelay + + + en + Reasons For Delay + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#reasonsForDelay + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Reasons For Delay + + + + + en + reasonsForDelay + + + STRING + + + en + Optional field to provide information to the customer why a delivery date is not met + + + + + + supplyProblems + + ModelReference + + + DataElement + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#ReasonsForDelayEnum:supplyProblems + + + + + + otherCircumstances + + ModelReference + + + DataElement + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#ReasonsForDelayEnum:otherCircumstances + + + + + + internalProblems + + ModelReference + + + DataElement + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#ReasonsForDelayEnum:internalProblems + + + + + + noInformationAvailable + + ModelReference + + + DataElement + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#ReasonsForDelayEnum:noInformationAvailable + + + + + + + + + + + + + returnCode + + + en + Return Code + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#returnCode + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Return Code + + + + + en + returnCode + + + STRING + + + en + Return code that indicates whether a single item of an order matches the customers desired request + + + + + + ok + + ModelReference + + + DataElement + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#ReturnCodeEnum:ok + + + + + + lowerAccuracyOfPrecision + + ModelReference + + + DataElement + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#ReturnCodeEnum:lowerAccuracyOfPrecision + + + + + + noForecastAvailable + + ModelReference + + + DataElement + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#ReturnCodeEnum:noForecastAvailable + + + + + + + + + + + + + forecastDate + + + en + Forecast Date + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#forecastDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Forecast Date + + + + + en + forecastDate + + + STRING + + + en + Date/time of the forecast calculation + + + + + + + + + listOfForecastItems + + + en + List Of Forecast Items + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#listOfForecastItems + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + List Of Forecast Items + + + + + en + listOfForecastItems + + + STRING + + + en + List of ForecastItems matching the items to an order + + + + + + + + + iterationNumber + + + en + Iteration Number + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#iterationNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Iteration Number + + + + + en + iterationNumber + + + INTEGER_MEASURE + + + en + Only set in CommunicationMode == "notification/cyclic" to be able to check the order of the notifications. + +Not required for communication mode = "synchronous" + + + + + + + + + communicationMode + + + en + Communication Mode + + + urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#communicationMode + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Communication Mode + + + + + en + communicationMode + + + STRING + + + en + Specification of the communication mode + + + + + + synchronous + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#CommunicationModeEnum:synchronous + + + + + + cyclic + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#CommunicationModeEnum:cyclic + + + + + + notification + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#CommunicationModeEnum:notification + + + + + + + + + + + + + versionDataModel + + + en + Version Data Model + + + urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#versionDataModel + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Version Data Model + + + + + en + versionDataModel + + + STRING + + + en + Specifies the used version of the data model + + + + + + + + + productionForecastResponse + + + en + Production Forecast Response + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#productionForecastResponse + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Production Forecast Response + + + + + en + productionForecastResponse + + + STRING + + + en + The concrete information about a production forecast + + + + + + + + + messageId + + + en + Message ID + + + urn:samm:io.catenax.shared.message_header:1.0.0#messageId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Message ID + + + + + en + messageId + + + STRING + + + en + Unique ID identifying the message. The purpose of the ID is to uniquely identify a single message, therefore it MUST not be reused. + + + + + + + + + context + + + en + Context + + + urn:samm:io.catenax.shared.message_header:1.0.0#context + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Context + + + + + en + context + + + STRING + + + en + Information about the context the message should be considered in. +The value MUST consist of two parts: an identifier of the context (e.g. business domain, etc.) followed by a version number. +Both the identifier and the version number MUST correspond to the content of the message. +If 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. +In 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). +Versioning only refers to major versions in both default and fallback cases. +Note: The version of the message's header is specified in the version field. + + + + + + + + + sentDateTime + + + en + Sent Date Time + + + urn:samm:io.catenax.shared.message_header:1.0.0#sentDateTime + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Sent Date Time + + + + + en + sentDateTime + + + STRING + + + en + 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 + + + + + + + + + senderBpn + + + en + Sender BPN + + + urn:samm:io.catenax.shared.message_header:1.0.0#senderBpn + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Sender BPN + + + + + en + senderBpn + + + STRING + + + en + 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 + + + + + + + + + receiverBpn + + + en + Receiver BPN + + + urn:samm:io.catenax.shared.message_header:1.0.0#receiverBpn + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Receiver BPN + + + + + en + receiverBpn + + + STRING + + + en + 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. + + + + + + + + + expectedResponseBy + + + en + Expected Response By + + + urn:samm:io.catenax.shared.message_header:1.0.0#expectedResponseBy + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Expected Response By + + + + + en + expectedResponseBy + + + STRING + + + en + 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 + + + + + + + + + relatedMessageId + + + en + Related Message ID + + + urn:samm:io.catenax.shared.message_header:1.0.0#relatedMessageId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Related Message ID + + + + + en + relatedMessageId + + + STRING + + + en + Unique ID identifying a message somehow related to the current one + + + + + + + + + version + + + en + Version + + + urn:samm:io.catenax.shared.message_header:1.0.0#version + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Version + + + + + en + version + + + STRING + + + en + 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. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.shared.message_header:1.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + Contains standardized attributes for message processing common across several use cases. + + + + + + + + + diff --git a/io.catenax.shopfloor_information.provide_production_forecast/1.0.0/gen/ProvideProductionForecast-schema.json b/io.catenax.shopfloor_information.provide_production_forecast/1.0.0/gen/ProvideProductionForecast-schema.json new file mode 100644 index 00000000..239de962 --- /dev/null +++ b/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.: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 --:<[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" ] +} \ No newline at end of file diff --git a/io.catenax.shopfloor_information.provide_production_forecast/1.0.0/gen/ProvideProductionForecast.aasx b/io.catenax.shopfloor_information.provide_production_forecast/1.0.0/gen/ProvideProductionForecast.aasx new file mode 100644 index 0000000000000000000000000000000000000000..d0bff07088de8d21d64f534b3b0cc5b2e54e20df GIT binary patch literal 7269 zcmaKx1yCH_()Sm4S==RTfFQeA@Ssa@cX!v|1QvU60t5-}1b5dE++Bma2MMmp2luU8 z_j&Jk-`i7jYNqOR&&=<1Po3(&k}Luu0RR;h6)>SBtOfX+;XhyNiaR>Enmf1}s(Cq? zyXb>G?d_tJM{T;t+S1h07wMYgw77`r_lWgR%o~o6Z2bWjeC0NTMkhsip z^ZDs8y*{XDtoR6BL}GI-+6qvh21otMN*_~96g}mgk?Qv;xbGr;fqPls&x@F+Nb69D7Upv;2n^Xh4 zeQ(4#cg3XRvBC+llDOpfLK$eM*d_yu&ja*C!9w8VVKPaelV^V{ly2vJPZn9#oS9@^ z&RY)U2|U>LFj*bjafvB)??(9m&0qS7pvW*= ztD?-0q5{9HX)}iRmsP5xz*ea0Wia=xl=|I8(%N?&Tnuxr6mhhw?bXBuUY-@t&Ffy zFfln2f{F5%N7!I~iKBqPB2Vq~PPO+h@f3YbG6i{zz`*cGjM9+Pr9vN+PNeQYA>^qu zP{^>L{-9|wLtArCE(g5r4;g7{nd${ANe7c$B}(#(==`C!lAzsa=Hd!_lrMic*9Qm; zBSRbnzZ=_1VOuT@udXvn%4*HrY8cLj17vdij;?Xlo%5V#%4X~@0o*#PXf22 z+8p)N!X9~vJj+209ND|ll)uyb;9fAhr#IdVJ%2F$f5rR)>>rq)OBZ7LKh^wF#>e_c z4qHuezt*+od~TR%vlrg-5&T;K878!uRIeyW2N} z1~rs57jvO})vQa1$nT=nK#|m?5m}y3JC2Y5#Y`=bAeHa^+1C0NN|#t@tHJHdWehWGmuw+XbFq)9@W2&H?LI*;#n#E0L zD)K?j?%ZT;s5egs0%Bjg)KH1Ca;g|Mr7SqQpzyDC%v56K23#ansd@{+X%jt)z4tYG+-U&8c%q{vW%c840IWrQNzZX<5|T>Do(^-zuj8% zb8EM2`sS@oA=?{NN=UX#Ds&?}ThwXu7hD|?#=)?N+@0N~3l;353oQmd#hESgHh!6ct^O&yD(!dT>uAp*TKW`g`QN^XptSpHaf`F-}<<2n&swL+*p5Sj7nS?-)X^gMtu?v)Uxbp zAD~Y`_65Pw!MQ3rH9DnRsWyZ-y}8Zc&NLwdt0Fq|)^M;bbUaC@{6Sr~LLR9wfOW186m%H+VS_M?~U8F_6m0$-g~ZPuwm9601b z%BID3k@GmhU;0Zd70FfJ_$QyZM-Cwt<@dScqm1^E>p*db+S?ka#@=I^J1nYy{`R4! z(Nf_XV$r6rrjYnRjHKb=vNMQ{I9!y{C@wTP0C{bUA~>H+tRlp~QWd%z;Pp!oX`}(z4_N7?F zal7tipo1AFiJ^pCvnyJ!;LCD4eD|t-l~n+M^-ZNFWn|mOaBYIA2As>(?cuDWD=~SF z(qH$Bf~%Q(5FP8kFw8#Az<$_5>n09_5HG(Z7F@tve`Qy9wU5%Yj?%GBLg(_nMHlU` zYs==2F+lli=ai6~fGF6VhcVgr3UW}pvc4|%jk?X>o>R~@w@so%kShB+&h1n(x#RG& z46K2aQfIJA#hO#B4CIBRaC;TJ8l4sQ)0~K%7WFlI?oA!j$8xjPAR=O$hNgDqaV^wc zizvcJypI+zli0<9b&Lat_m!Zd!>WLf+; zTw;{AymXl=Ate8fAu3sSEx@-M4?3q_LchEyI+VL4AT3drVoTzlXp^C7GL2D1I{V}6 z63h89g>dF4@1a)*6^J-n3aa$A0j7KKlD+O8tTvv;BUBgcEvz9};!~@!vEO&;{1Cao z)|s2i&ikAml|GxArRKtCH-`w{7wceu+SaP8zlSMzivMDc0h4Oo_(Fpp>Qs0SC7EVx zl#Ow6#mYMuv(NfOX+!8+0YWv9Uw|X=A@l{QD&km?dKGfSRW8(RD?_4E1&?=_1d;kf zOba4aC;>(bDi2iX4g4rSk|p{lQSA-t?^qxb_L#CVyyqQ{`J&69PG0Kyg9r3k;|i`~ zn{VOu#qt`>CQ8wIT%A(tO=S%u2@t*r5|Q@i||r}+d?<0fPq z1q~WuIG26L;1ZkoBceq|N=J!)&UEMm$z%g;G%VV2Y_>*!ylG&wrG>C;E%W;AEE(zB z*M#573+=n75AF8>6y@CE>|dUGlh2u`yhnooD0dmkjR7&-ttB~W?kGsi)%#&f zg*R;G+hQMwCaIz2Yz_;N#l+}=D11#^&fkPnWUVkGKE)@aHP_M&O!*u0opG*kOPInd zNLHP8Jq;-IAZ>SbbQdY&!8sNgnTUk2hg)9`nCM}I3WOtgLXwx`C3-RCq!OBgKQ$}0 zFEcZ`oJV#QW@q6@{1I74LG#kH<1a4yVh^QYI3uoTk0fzGb07RP22=R;M_G_&??T4y zLf%M%?+x2}yhvnx*po;mDR9sZ*#hIOzZAmN7e;AEkuRtj0oXGsGPAGTgJx0G)49gr zP;rKl&IY_M#fn!zn{aT$AMgSurEvkSiD7T%rqayXL`2F>7^y_AX>@1!K&E|85MGBd z_f4Ypfj>{y6zz>#fW>Gv>J@0z(rBuT1Za$a#kJr4A9UdqXcpQ%npIwwZ)5p0odMw|` zIQI6a{qFDRR_i8lXWs(938h*l&V0k#u3On`uD!}_UadD8-+qFh2q$GvXf5IT7zB2F zeT<%vZ`z}>p(nc5rfUnJGv_AhkIE+7i6i%yCMF*d;h5q&a&em-fAyya<6T~SF$81M zt*f@+L=@$#cK-QT9u>2^NYStyT?+xJO7ooO+N**pcFH6UTAh$WfMX`;ZPw-kzshA_ zx)G^>EIbRE72b+8o{@XSb&lJ82ypdI(9F zivHx=VME_Fnku{8A2axW|Bj9;^K;!U5BH}etO{CpLJgqAvI>+W#$*xQkNB!L%UajkwO%Dv|y57ttt9y9ZT)}|wr$xjE^W7}N zbKy*#csYDPOnwLA<70P|s=|U)(P3*d4z09hl`h%%TMW^WcT&_kvBfe`s@`I_;_$OE+Q9XAgN1$d&l`uWw8C#}Knhte2 zN0;VdmGJwwmNU-9R|^TiHkDwilmrEpS`P`%i4VNBRCxZra$Y{H>Ic)Vp@E;{YBP?s zdCU@HTW{M}zX-y9(yTP( zos}G5yH45e&_xpnC%PDC_$LirS@HjLyLLy3CeU$NYHCi|1iLMf+meU8rkUI3wsX$t zNJ2k}TG9WS#%!Oy)HInw2dQ7eh{VSWgyfi|&FymAxae0W-CqqHy2iPGP<;}y>?!iM z^V^wxePR7Hi%m|w*QWTTE1Xb8xwL;Pos8s|t&nop4sWH`Sb=U&O;j-5cx;i^NRqF$ z%ad7vBm9368ul>N|#jpwjHFKh%NnbxFfEoHeu6T zPq#*4loFonNIGZMFTS=+u*w$L(AQR4Nc|Bo)?j6um)G2NLqY*>{oMt2twp0~tu7p_ zc*7t$lemCuzOU8XZqD8_8&IyTcQnm zjkJl^NnxZ-Vlb&~XfeV8gQX?gMA)j+j?hg$<1R@KvzO9HHXutwYW0Wgh7;LV&4D}U^0}=8gmONry=P8ZV)i6ep~#i(JoJ})P&P02O(dK^&0qN89e$7Z<-5b@0k!UWjZ}DLZ(q1~~ja73vWi zmCW}wVsqmRD9>1BO2oW6o1UWGN0WHhS#T%v*4h5Un*Csy4slw-Ahv5tj4?xdkNY&N zf%0?W;*1CTTX>j(LgLg%TOHfCtm2>ZUwIp=&z=g~>e|+qD=5jjeKa%Xmu{s{b_u45 zbZX`#0zG9@Q=b^BmOCBeKX0?{FE=X0$9x-?POqOA=+S}aLXxnz`_7><2JyNU);oS} zcVql2S(d}L66;rilSO)=gwFMl9m)ULZF&aB9s#xp&!Et<^h8^nuQ@MNem$K1HTSLBaIGV7;*d& zBoD>Q=O#HeY(uHHV=CmT9E=H^^ZgtWS;C=ffr-(f)oyer7QYWZ4@UM-%@LreS$7TX zQ3=Lt-&@43Sr(w6LJ`d2?3DT4?{HrwX8|HloSpx&`{h*=j*FcDMcJyo1yK#+6%(E18r zOyNPpFoy?O%XutQnk`CSRGyT>2Uck^4(AN#kV^+%Z6A3I7C|pmkn8l890Z^!;uJo8 zKq7X5Q08=jvg=IyP?;w@5Qao>={j&as8v&R36p6~qzQC}X3~uE1(#IVK57d8j;Wno zneFYKygJ^Q-OEd>Jt|e*CpScf_(?MhkL|`5iGa-GS?hw@`jHlB6EOd%>*y%(R-?)L z2oj0Yh$vaFF`U0bxMR#Hp4v-eift(L5y)eAk3v*eB!9X@^@}vqdy0?w12>VGxqkWw zeP7t~a?NWg)52eHIZI!U@@emCGG#oMxAbydpIbHZXVR8C1?e)V|I5O5GpbzyyN-&1 zI9CqZjDuXpsr3qSQ-4T?)MgtSPLg&nil~ZE;6S+D_1GvYjbi*OyMtdX`_+KgzeJKy zAp3&^E2!NlB~Y1+2DvXsA~ik>=R40Cy*+$fQTWP}x6X?XUh8Dpiytcn^C3R;(}ZPM zJz@+lK0B6$*$|9}+Sz6D(OHH`k+iht&@zGmr;I=gBow;F@p@|4i(gK2W6sozTid@5 zO)DM2jGL9-yrz4S_3mh#+7INJlOUU?uvM67?rKIlk(N2$wW@@BffTuLSSwB>xE8|b7Qmsp}$7q*P^ z>xco0W(IP)aZ##~f395^L4ovCGf^Ce(;Ws^e|E-8b4JXg;P38Y?bqVz4@>So3)x<+ z`t%@|vwHT4EQn>gN-ppDCz9M8u7g`8!MmI1=giEJQ;nwGw5u!L!f%6}_PmBy|FuQ0ZAo_~E=&3u>+APugex z@^_qrXJ8E|gAq&9HsA7XPF1KlR?St%lM$j}>5yFtG7G@e+i&TCC;Y_ZbZy;%$u)F( zN7ya2=lb$cFxmnKsM<)MUt%fF_$nHYK_S;Uz@~jgYM;9iGl7zAVXnl^k%S~8=C%5D z>p(HNC3^D^r5d69c0rntVM4~NHu)f9P9oR#2@IgGnlZNeWu(jpV~p?S8pd4Q>Pk|mY{vVJ^msdF~9E{8XDjDkBb ziy)Sesi^vfBc9WHw^JJHM6cUz2|>)SAOGOI^lV29+jE==0e~=Lxc}0|20r&}%^XdY zoE@E9o_n^=<}VFf`_Ia<-E0KGe`E%{)4o!Qi!IR(L6y0ka&L*^ZFTM9KSNu8dr$K- z7dfKsrN_7^R`Xp`-UIe@^JGU(fV@qE?~_<=h?o(m!nA2Le*h|0dJS3Q-b;e_Y%Ga?)^^It=05>Nx>I(ooR zA2Ft8n&Z|Z3;#Go{(VstMXjNM7#{zlr|$vU+Ub&O;0j}sDcUSpHIPoxqw&V&?(6LI zF`kop`h*@oE*wDwfa*Ot!<`1zMdWZdktXS=2Aa9_81^UUmR+xFz0ZbsXt!6~6)o^s z4h8L>_5~}Z0gI;WzE3sP?+%W;C|7WlwF+Td{T1kW15Kjo~y zOExcZ*8jHuAZ{ti{_g;Pmoi?Ioqrkk^W*-e^ZdKx-}Q<`<9{=wB_tyT4 zrtvSU{ipYTRyh7W(BJdzMG5$q^&$LcUEtp%{2lL0UjEBIlKzJ*Rgy(Qewl*&d;~rt J8YO$V`+tFcGe-ab literal 0 HcmV?d00001 diff --git a/io.catenax.shopfloor_information.provide_production_forecast/1.0.0/gen/ProvideProductionForecast.html b/io.catenax.shopfloor_information.provide_production_forecast/1.0.0/gen/ProvideProductionForecast.html new file mode 100644 index 00000000..93660f67 --- /dev/null +++ b/io.catenax.shopfloor_information.provide_production_forecast/1.0.0/gen/ProvideProductionForecast.html @@ -0,0 +1,1721 @@ + + + + + + + + + + + + + + Documentation Provide Production Forecast + + +
+
+
+
+

Aspect Model Provide Production Forecast

+
urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#ProvideProductionForecast
+
+
+
+
+
+
+
+ +
+ + +
+ Answer to a customer with all information about the requested items +
+ + +
+

Overview

+
+
+
+
+ Aspect Model Diagram +
+
+
+ + +
+
+

Properties

+
+ +
+ +
+

Header

+
+ +Contains standardized attributes for message processing common across several use cases. + +
+
Name
+
header
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.message_header:1.0.0#MessageHeader + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
header
+
+ + +
+
+ +
+

Production Forecast Response

+
+ +The concrete information about a production forecast + +
+
Name
+
productionForecastResponse
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#ProductionForecastItem + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productionForecastResponse
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

Forecast Item

+
+
+ ForecastItem entry for the requested order +
+ +
+

Properties

+
+
+ +
+
Position Id
+
+ +Identifier of a position of an order + +
+
Name
+
positionId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
00000000-0000-0000-C000-000000000046
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
positionId
+
+ + +
+
+ +
+
Production Forecast
+
+ +Date of completion + +
+
Name
+
productionForecast
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-06-19T21:24:00+07:00
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productionForecast
+
+ + +
+
+ +
+
Precision Of Forecast
+
+ +Accuracy of the prediction + +
+
Name
+
precisionOfForecast
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#TimeValue + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
precisionOfForecast
+
+ + +
+
+ +
+
Production Status
+
+ +Status of the order/position within MP + +
+
Name
+
productionStatus
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • itemReceived
    • +
  • itemPlanned
    • +
  • itemInProduction
    • +
  • itemCompleted
    • +
  • statusUndefined
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
itemPlanned
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productionStatus
+
+ + +
+
+ +
+
Reasons For Delay
+
+ +Optional field to provide information to the customer why a delivery date is not met + +
+
Name
+
reasonsForDelay
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • supplyProblems
    • +
  • otherCircumstances
    • +
  • internalProblems
    • +
  • noInformationAvailable
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
supplyProblems
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
reasonsForDelay
+
+ + +
+
+ +
+
Return Code
+
+ +Return code that indicates whether a single item of an order matches the customers desired request + +
+
Name
+
returnCode
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • ok
    • +
  • lowerAccuracyOfPrecision
    • +
  • noForecastAvailable
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
ok
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
returnCode
+
+ + +
+
+ +
+
Forecast Date
+
+ +Date/time of the forecast calculation + +
+
Name
+
forecastDate
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-06-19T21:24:00+07:00
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
forecastDate
+
+ + +
+
+
+
+

Message Header

+
+
+ The Catena-X Message Header contains standardized attributes for message processing that are common across several use cases. It targets a minimal set of aspects that are needed for overall message handling, and not for the processing of the business related payload part. By standardizing the message header structure, we support a harmonized modelling approach and re-use of concepts. The message header originated from discussions on push notifications but has since then been abstracted for overall message handling – and does not only apply to notification anymore. +
+ +
+

Properties

+
+
+ +
+
Message ID
+
+ +Unique ID identifying the message. The purpose of the ID is to uniquely identify a single message, therefore it MUST not be reused. + +
+
Name
+
messageId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
3b4edc05-e214-47a1-b0c2-1d831cdd9ba9
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
messageId
+
+ + +
+
+ +
+
Context
+
+ +Information about the context the message should be considered in. +The value MUST consist of two parts: an identifier of the context (e.g. business domain, etc.) followed by a version number. +Both the identifier and the version number MUST correspond to the content of the message. +If 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. +In 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). +Versioning only refers to major versions in both default and fallback cases. +Note: The version of the message's header is specified in the version field. + +
+
Name
+
context
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
urn:samm:io.catenax.<ASPECT-MODEL-NAME>:1.x.x
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
context
+
+ + +
+
+ +
+
Sent Date Time
+
+ +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 + +
+
Name
+
sentDateTime
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-06-19T21:24:00+07:00
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sentDateTime
+
+ + +
+
+ +
+
Sender BPN
+
+ +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 + +
+
Name
+
senderBpn
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL7588787849VQ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
senderBpn
+
+ + +
+
+ +
+
Receiver BPN
+
+ +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. + +
+
Name
+
receiverBpn
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL6666787765VQ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
receiverBpn
+
+ + +
+
+ +
+
Expected Response By
+
+ +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 + +
+
Name
+
expectedResponseBy
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-06-19T21:24:00+07:00
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
expectedResponseBy
+
+ + +
+
+ +
+
Related Message ID
+
+ +Unique ID identifying a message somehow related to the current one + +
+
Name
+
relatedMessageId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
d9452f24-3bf3-4134-b3eb-68858f1b2362
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
relatedMessageId
+
+ + +
+
+ +
+
Version
+
+ +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. + +
+
Name
+
version
+
+ + + +
+
Characteristic
+
+
+
+
+ Reference +
+
    +
  • https://semver.org
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
urn:samm:io.catenax.message_header:1.0.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
version
+
+ + +
+
+
+
+

Production Forecast Item

+
+
+ Datamodel of the concrete production forecast for one forecast item +
+ +
+

Properties

+
+
+ +
+
List Of Forecast Items
+
+ +List of ForecastItems matching the items to an order + +
+
Name
+
listOfForecastItems
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.shopfloor_information.provide_production_forecast:1.0.0#ForecastItem + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
listOfForecastItems
+
+ + +
+
+ +
+
Iteration Number
+
+ +Only set in CommunicationMode == "notification/cyclic" to be able to check the order of the notifications. + +Not required for communication mode = "synchronous" + +
+
Name
+
iterationNumber
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#integer + +
+
+
+
+
+ +
+
Example
+
6
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
iterationNumber
+
+ + +
+
+ +
+
Communication Mode
+
+ +Specification of the communication mode + +
+
Name
+
communicationMode
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • synchronous
    • +
  • cyclic
    • +
  • notification
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
synchronous
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
communicationMode
+
+ + +
+
+ +
+
Version Data Model
+
+ +Specifies the used version of the data model + +
+
Name
+
versionDataModel
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
versionDataModel
+
+ + +
+
+
+
+

Time Value

+
+
+ Datatype to express a time value +
+ +
+

Properties

+
+
+ +
+
Time Unit
+
+ +Specifies the unit in which the time is represented + +
+
Name
+
timeUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:secondUnitOfTime
    • +
  • unit:minuteUnitOfTime
    • +
  • unit:hour
    • +
  • unit:day
    • +
  • unit:week
    • +
  • unit:month
    • +
  • unit:year
    • +
+
+
+
+
+ Type urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#curie + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
timeUnit
+
+ + +
+
+ +
+
Value
+
+ +The amount of timeUnits considered + +
+
Name
+
value
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#integer + +
+
+
+
+
+ +
+
Example
+
12
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/io.catenax.shopfloor_information.provide_production_forecast/1.0.0/gen/ProvideProductionForecast.json b/io.catenax.shopfloor_information.provide_production_forecast/1.0.0/gen/ProvideProductionForecast.json new file mode 100644 index 00000000..1d85e2ea --- /dev/null +++ b/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.: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" + } +} \ No newline at end of file diff --git a/io.catenax.shopfloor_information.provide_production_forecast/1.0.0/gen/ProvideProductionForecast.yml b/io.catenax.shopfloor_information.provide_production_forecast/1.0.0/gen/ProvideProductionForecast.yml new file mode 100644 index 00000000..fff15c53 --- /dev/null +++ b/io.catenax.shopfloor_information.provide_production_forecast/1.0.0/gen/ProvideProductionForecast.yml @@ -0,0 +1,299 @@ +--- +openapi: 3.0.3 +info: + title: Provide Production Forecast + version: v1 +servers: +- url: catenax.io/api/v1 + variables: + api-version: + default: v1 +paths: + /{tenant-id}/provide-production-forecast: + get: + tags: + - ProvideProductionForecast + operationId: getProvideProductionForecast + parameters: + - name: tenant-id + in: path + description: The ID of the tenant owning the requested Twin. + required: true + schema: + type: string + format: uuid + responses: + "200": + $ref: '#/components/responses/ProvideProductionForecast' + "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 + 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. + The value MUST consist of two parts: an identifier of the context (e.g. business domain, etc.) followed by a version number. + Both the identifier and the version number MUST correspond to the content of the message. + If 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.:1.x.x) MUST be used as a value of the context field. This is considered the default case. + In all other cases the value of the context field MUST follow the pattern --:<[major] version> (e.g. TRACE-QM-Alert:1.x.x). + Versioning only refers to major versions in both default and fallback cases. + Note: 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 + ProvideProductionForecast: + description: Answer to a customer with all information about the requested items + type: object + 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 + 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' + ProvideProductionForecast: + content: + application/json: + schema: + $ref: '#/components/schemas/ProvideProductionForecast' + description: The request was successful. + requestBodies: + ProvideProductionForecast: + content: + application/json: + schema: + $ref: '#/components/schemas/ProvideProductionForecast' diff --git a/io.catenax.shopfloor_information.provide_production_forecast/2.0.0/gen/ProvideProductionForecast-aas.xml b/io.catenax.shopfloor_information.provide_production_forecast/2.0.0/gen/ProvideProductionForecast-aas.xml new file mode 100644 index 00000000..b3e7d7ba --- /dev/null +++ b/io.catenax.shopfloor_information.provide_production_forecast/2.0.0/gen/ProvideProductionForecast-aas.xml @@ -0,0 +1,1926 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#ProvideProductionForecast + + Type + + + + ModelReference + + + Submodel + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#ProvideProductionForecast/submodel + + + + + + + + + ProvideProductionForecast + + + en + Answer to a customer with all information about the requested items + + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#ProvideProductionForecast/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#ProvideProductionForecast + + + + + + ProductionForecastItem + + + en + Production Forecast Item + + + + + en + Datamodel of the concrete production forecast for one forecast item + + + + + listOfForecastItems + + + en + List Of Forecast Items + + + + + en + List of ForecastItems matching the items to an order + + + true + DataElement + + + ForecastItem + + + en + Forecast Item + + + + + en + ForecastItem entry for the requested order + + + + + positionId + + + en + Position Id + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#positionId + + + + xs:string + + + + productionForecast + + + en + Production Forecast + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#productionForecast + + + + xs:dateTime + + + + TimeValue + + + en + Time Value + + + + + en + Datatype to express a time value + + + + + timeUnit + + + en + Time Unit + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.shopfloor_information_types:2.0.0#timeUnit + + + + xs:string + + + + value + + + en + Value + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.shopfloor_information_types:2.0.0#value + + + + xs:integer + + + + + + productionStatus + + + en + Production Status + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#productionStatus + + + + xs:string + + + + reasonsForDelay + + + en + Reasons For Delay + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#reasonsForDelay + + + + xs:string + + + + returnCode + + + en + Return Code + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#returnCode + + + + xs:string + + + + forecastDate + + + en + Forecast Date + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#forecastDate + + + + xs:dateTime + + + + + + + + iterationNumber + + + en + Iteration Number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#iterationNumber + + + + xs:integer + + + + communicationMode + + + en + Communication Mode + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.shopfloor_information_types:2.0.0#communicationMode + + + + xs:string + + + + version + + + en + Version + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.message_header:2.0.0#version + + + + xs:string + + + + + + MessageHeader + + + en + Message Header + + + + + en + The Catena-X Message Header contains standardized attributes for message processing that are common across several use cases. It targets a minimal set of aspects that are needed for overall message handling, and not for the processing of the business related payload part. By standardizing the message header structure, we support a harmonized modelling approach and re-use of concepts. The message header originated from discussions on push notifications but has since then been abstracted for overall message handling ? and does not only apply to notification anymore. + + + + + messageId + + + en + Message ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.message_header:2.0.0#messageId + + + + xs:string + + + + context + + + en + Context + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.message_header:2.0.0#context + + + + xs:string + + + + sentDateTime + + + en + Sent Date Time + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.message_header:2.0.0#sentDateTime + + + + xs:dateTime + + + + senderBpn + + + en + Sender BPN + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.message_header:2.0.0#senderBpn + + + + xs:string + + + + receiverBpn + + + en + Receiver BPN + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.message_header:2.0.0#receiverBpn + + + + xs:string + + + + expectedResponseBy + + + en + Expected Response By + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.message_header:2.0.0#expectedResponseBy + + + + xs:dateTime + + + + relatedMessageId + + + en + Related Message ID + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.message_header:2.0.0#relatedMessageId + + + + xs:string + + + + version + + + en + Version + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shared.message_header:2.0.0#version + + + + xs:string + + + + + + + + + + APPLICATION_CLASS + ProvideProductionForecast + + + en + Provide Production Forecast + + + + + en + Answer to a customer with all information about the requested items + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#ProvideProductionForecast + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Provide Production Forecast + + + + + en + ProvideProductionForecast + + + + + en + Answer to a customer with all information about the requested items + + + + + + + + + positionId + + + en + Position Id + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#positionId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Position Id + + + + + en + positionId + + + STRING + + + en + Identifier of a position of an order + + + + + + + + + productionForecast + + + en + Production Forecast + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#productionForecast + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Production Forecast + + + + + en + productionForecast + + + STRING + + + en + Date of completion + + + + + + + + + timeUnit + + + en + Time Unit + + + urn:samm:io.catenax.shared.shopfloor_information_types:2.0.0#timeUnit + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Time Unit + + + + + en + timeUnit + + + STRING + + + en + Specifies the unit in which the time is represented + + + + + + unit:secondUnitOfTime + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.shopfloor_information_types:2.0.0#TimeUnitEnum:unit:secondUnitOfTime + + + + + + unit:minuteUnitOfTime + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.shopfloor_information_types:2.0.0#TimeUnitEnum:unit:minuteUnitOfTime + + + + + + unit:hour + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.shopfloor_information_types:2.0.0#TimeUnitEnum:unit:hour + + + + + + unit:day + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.shopfloor_information_types:2.0.0#TimeUnitEnum:unit:day + + + + + + unit:week + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.shopfloor_information_types:2.0.0#TimeUnitEnum:unit:week + + + + + + unit:month + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.shopfloor_information_types:2.0.0#TimeUnitEnum:unit:month + + + + + + unit:year + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.shopfloor_information_types:2.0.0#TimeUnitEnum:unit:year + + + + + + + + + + + + + value + + + en + Value + + + urn:samm:io.catenax.shared.shopfloor_information_types:2.0.0#value + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Value + + + + + en + value + + + INTEGER_MEASURE + + + en + The amount of timeUnits considered + + + + + + + + + precisionOfForecast + + + en + Precision Of Forecast + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#precisionOfForecast + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Precision Of Forecast + + + + + en + precisionOfForecast + + + STRING + + + en + Accuracy of the prediction + + + + + + + + + productionStatus + + + en + Production Status + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#productionStatus + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Production Status + + + + + en + productionStatus + + + STRING + + + en + Status of the order/position within MP + + + + + + itemReceived + + ModelReference + + + DataElement + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#ProductionStatusEnum:itemReceived + + + + + + itemPlanned + + ModelReference + + + DataElement + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#ProductionStatusEnum:itemPlanned + + + + + + itemInProduction + + ModelReference + + + DataElement + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#ProductionStatusEnum:itemInProduction + + + + + + itemCompleted + + ModelReference + + + DataElement + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#ProductionStatusEnum:itemCompleted + + + + + + statusUndefined + + ModelReference + + + DataElement + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#ProductionStatusEnum:statusUndefined + + + + + + + + + + + + + reasonsForDelay + + + en + Reasons For Delay + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#reasonsForDelay + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Reasons For Delay + + + + + en + reasonsForDelay + + + STRING + + + en + Optional field to provide information to the customer why a delivery date is not met + + + + + + supplyProblems + + ModelReference + + + DataElement + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#ReasonsForDelayEnum:supplyProblems + + + + + + otherCircumstances + + ModelReference + + + DataElement + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#ReasonsForDelayEnum:otherCircumstances + + + + + + internalProblems + + ModelReference + + + DataElement + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#ReasonsForDelayEnum:internalProblems + + + + + + noInformationAvailable + + ModelReference + + + DataElement + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#ReasonsForDelayEnum:noInformationAvailable + + + + + + + + + + + + + returnCode + + + en + Return Code + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#returnCode + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Return Code + + + + + en + returnCode + + + STRING + + + en + Return code that indicates whether a single item of an order matches the customers desired request + + + + + + ok + + ModelReference + + + DataElement + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#ReturnCodeEnum:ok + + + + + + lowerAccuracyOfPrecision + + ModelReference + + + DataElement + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#ReturnCodeEnum:lowerAccuracyOfPrecision + + + + + + noForecastAvailable + + ModelReference + + + DataElement + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#ReturnCodeEnum:noForecastAvailable + + + + + + + + + + + + + forecastDate + + + en + Forecast Date + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#forecastDate + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Forecast Date + + + + + en + forecastDate + + + STRING + + + en + Date/time of the forecast calculation + + + + + + + + + listOfForecastItems + + + en + List Of Forecast Items + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#listOfForecastItems + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + List Of Forecast Items + + + + + en + listOfForecastItems + + + STRING + + + en + List of ForecastItems matching the items to an order + + + + + + + + + iterationNumber + + + en + Iteration Number + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#iterationNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Iteration Number + + + + + en + iterationNumber + + + INTEGER_MEASURE + + + en + Only set in CommunicationMode == "notification/cyclic" to be able to check the order of the notifications. + +Not required for communication mode = "synchronous" + + + + + + + + + communicationMode + + + en + Communication Mode + + + urn:samm:io.catenax.shared.shopfloor_information_types:2.0.0#communicationMode + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Communication Mode + + + + + en + communicationMode + + + STRING + + + en + Specification of the communication mode + + + + + + synchronous + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.shopfloor_information_types:2.0.0#CommunicationModeEnum:synchronous + + + + + + cyclic + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.shopfloor_information_types:2.0.0#CommunicationModeEnum:cyclic + + + + + + notification + + ModelReference + + + DataElement + urn:samm:io.catenax.shared.shopfloor_information_types:2.0.0#CommunicationModeEnum:notification + + + + + + + + + + + + + version + + + en + Version + + + urn:samm:io.catenax.shared.message_header:2.0.0#version + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Version + + + + + en + version + + + STRING + + + en + 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. + + + + + + + + + productionForecastResponse + + + en + Production Forecast Response + + + urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#productionForecastResponse + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Production Forecast Response + + + + + en + productionForecastResponse + + + STRING + + + en + The concrete information about a production forecast + + + + + + + + + messageId + + + en + Message ID + + + urn:samm:io.catenax.shared.message_header:2.0.0#messageId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Message ID + + + + + en + messageId + + + STRING + + + en + Unique ID identifying the message. The purpose of the ID is to uniquely identify a single message, therefore it MUST not be reused. + + + + + + + + + context + + + en + Context + + + urn:samm:io.catenax.shared.message_header:2.0.0#context + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Context + + + + + en + context + + + STRING + + + en + Information about the context the message should be considered in. +The value MUST consist of two parts: an identifier of the context (e.g. business domain, etc.) followed by a version number. +Both the identifier and the version number MUST correspond to the content of the message. +If 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. +In 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). +Versioning only refers to major versions in both default and fallback cases. +Note: The version of the message's header is specified in the version field. + + + + + + + + + sentDateTime + + + en + Sent Date Time + + + urn:samm:io.catenax.shared.message_header:2.0.0#sentDateTime + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Sent Date Time + + + + + en + sentDateTime + + + STRING + + + en + 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 + + + + + + + + + senderBpn + + + en + Sender BPN + + + urn:samm:io.catenax.shared.message_header:2.0.0#senderBpn + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Sender BPN + + + + + en + senderBpn + + + STRING + + + en + 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 + + + + + + + + + receiverBpn + + + en + Receiver BPN + + + urn:samm:io.catenax.shared.message_header:2.0.0#receiverBpn + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Receiver BPN + + + + + en + receiverBpn + + + STRING + + + en + 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. + + + + + + + + + expectedResponseBy + + + en + Expected Response By + + + urn:samm:io.catenax.shared.message_header:2.0.0#expectedResponseBy + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Expected Response By + + + + + en + expectedResponseBy + + + STRING + + + en + 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 + + + + + + + + + relatedMessageId + + + en + Related Message ID + + + urn:samm:io.catenax.shared.message_header:2.0.0#relatedMessageId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Related Message ID + + + + + en + relatedMessageId + + + STRING + + + en + Unique ID identifying a message somehow related to the current one + + + + + + + + + version + + + en + Version + + + urn:samm:io.catenax.shared.message_header:2.0.0#version + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Version + + + + + en + version + + + STRING + + + en + 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. + + + + + + + + + header + + + en + Header + + + urn:samm:io.catenax.shared.message_header:2.0.0#header + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Header + + + + + en + header + + + STRING + + + en + Contains standardized attributes for message processing common across several use cases. + + + + + + + + + diff --git a/io.catenax.shopfloor_information.provide_production_forecast/2.0.0/gen/ProvideProductionForecast-schema.json b/io.catenax.shopfloor_information.provide_production_forecast/2.0.0/gen/ProvideProductionForecast-schema.json new file mode 100644 index 00000000..55d5c624 --- /dev/null +++ b/io.catenax.shopfloor_information.provide_production_forecast/2.0.0/gen/ProvideProductionForecast-schema.json @@ -0,0 +1,193 @@ +{ + "$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.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_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_2.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_2.0.0_IntegerValueCharacteristic" : { + "type" : "number", + "description" : "The value of the specified timeUnit as an integer value" + }, + "urn_samm_io.catenax.shared.shopfloor_information_types_2.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_2.0.0_TimeUnitEnum" + }, + "value" : { + "description" : "The amount of timeUnits considered", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.shopfloor_information_types_2.0.0_IntegerValueCharacteristic" + } + }, + "required" : [ "timeUnit", "value" ] + }, + "urn_samm_io.catenax.shopfloor_information.provide_production_forecast_2.0.0_ProductionStatusEnum" : { + "type" : "string", + "description" : "Enumeration with all possible states of an order within modular production", + "enum" : [ "itemReceived", "itemPlanned", "itemInProduction", "itemCompleted", "statusUndefined" ] + }, + "urn_samm_io.catenax.shopfloor_information.provide_production_forecast_2.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_2.0.0_ReturnCodeEnum" : { + "type" : "string", + "description" : "Enumeration with all Return Codes", + "enum" : [ "ok", "lowerAccuracyOfPrecision", "noForecastAvailable" ] + }, + "urn_samm_io.catenax.shopfloor_information.provide_production_forecast_2.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.uuid_1.0.0_UuidV4Trait" + }, + "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_2.0.0_TimeValueCharacteristic" + }, + "productionStatus" : { + "description" : "Status of the order/position within MP", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.provide_production_forecast_2.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_2.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_2.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_2.0.0_ForecastItemList" : { + "description" : "List with the forecast items", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.provide_production_forecast_2.0.0_ForecastItem" + } + }, + "urn_samm_io.catenax.shared.shopfloor_information_types_2.0.0_CommunicationModeEnum" : { + "type" : "string", + "description" : "Enumerates all possible communication modes", + "enum" : [ "synchronous", "cyclic", "notification" ] + }, + "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_forecast_2.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_2.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_2.0.0_IntegerValueCharacteristic" + }, + "communicationMode" : { + "description" : "Specification of the communication mode", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.shopfloor_information_types_2.0.0_CommunicationModeEnum" + }, + "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" : [ "listOfForecastItems", "communicationMode", "version" ] + }, + "urn_samm_io.catenax.shared.message_header_2.0.0_ContextCharacteristic" : { + "type" : "string", + "description" : "Defining a string value for the context" + }, + "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.: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 --:<[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" : { + "productionForecastResponse" : { + "description" : "The concrete information about a production forecast", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.provide_production_forecast_2.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_2.0.0_HeaderCharacteristic" + } + }, + "required" : [ "productionForecastResponse", "header" ] +} \ No newline at end of file diff --git a/io.catenax.shopfloor_information.provide_production_forecast/2.0.0/gen/ProvideProductionForecast.aasx b/io.catenax.shopfloor_information.provide_production_forecast/2.0.0/gen/ProvideProductionForecast.aasx new file mode 100644 index 0000000000000000000000000000000000000000..c07e10cb86bbddba349940a81989862ba3e78c4b GIT binary patch literal 7204 zcmaKR1yEeewl?k(+}+&?Zo%E%HTb~?2oe$?I1C!x-3f#Nf(;PdZEz1Zzz`$^$xqI! zTPN@S_uaK?ckQm~wf5d$uhrH4ecEb>NQ7``XlQUN+S0~we;C2@v)L<84_^llUn~8< zzZ`rlxB>2N2|5!lU|y_HqLLHkTqy65@(MUK(F}JT5lu-$onY12RAn<%H5+V5dS#p3 zO>>lb0u{tLkpCEhg}s(ZM2f-PCgqF$2D%x?!pli&N@-h&GC9z=K7a2+FIOHLN!qolQ7&n$coDj!egliNC6xga3A z*cGDpxbT0lkzNNN1Q1vVLEi6(lby=_w*V;d8 zA5jTvDxaTG@c|Nm@#OlKoiK?25gSML;9U0EQm=4FUa^~#EvVitvjFk{r>%yHHor^p z;`$krWq7#f{{Mv<=JN@Jlp0Cwq<>MQc-AvUr9vf7(*Cb2EW+5mVnYN zMRd)tV1bD&OePIsMnge!UEY1l8#zYFnTV>(x8|}aG$i8=2_E{q|HLPx}hz)v-1x-ZJv8vI)FxN9N_%`tlo3PgpB0@#t&bU5oT+TN%F9*+6tg z!!jD_zmd8cmz0J*&Y?2FF)}`-Ha=3NuROuU zS~ZXOcT93+>n!4D55njB|3;tUUorn@3jT=v_iPv>$!ZSpVktD>2Np0>DWhnwLg<Nt<_vlQ)?K1<_;fxH~x*_k>D^;@AT)RAW|5MJt z>lkWrpR_6he3A@9PC?}U-1|wq1rdulB$fKg)iGW}x_%uUMT8Q;wAjv_afU;69eQ`t z5F0d0%rpvn)rOA6?@^^pENw_64Z9m_Xn3oYZ^9@+9SXSJ-Fg)7my7PS{BaHL)Y9t7 zd)QrX_~sc}q@UY#0f_^UHu5qjvlBX9T!B}eDW?V?M{ItGJQ8?%2lt3c1^u0K1)7^Z z6Y^G(nXwUjV`F1m`xWp>-T6Os4j_DeA*MN_y0T-?($82ebyu=6Na> zmKGSf2{iX6czYfKZ-y$imvkuMd$mr5LbIog*|hOg4vqXL`#-(k=_|I!GC7-6Bm(u!ngii+IM><8I^nLt_I&I2X+JMNn-x4zwcr}R0B7tE)+Q+#wl|RIg0XPkY3 zvg3|idntM{)HMgt5#bbrunnGwy2co7+vltUzRZ#AviiZECQzjmCryo3&BrAEyyF%w z`+};1M(C&MDs6pLHA7cFQ@y&KB4fcNCcxZR%sL%s=>(RSY9HurIUUVI3@PwT6Z}4> zY||6+aMJU!q>03Q2!sp!0)VAyZ?dEtviOdtW)0{m(%+oFkI4cJ#F^0I2xM>?AIoXq zF(aa2I!dJ#m^cYpDz}8!v&Bm~9ddsvF4|q{2>CLX39g2{caO#H8q~-pqsdMnKltNq6sy<-(bYs*OJBi|I zs^}EGZl>f;S4##es2nn0RX7Y^3Q|rr$RIuBY(YWH^Q%Wjw6vwAqkSQp$CkzpHT2JI zUcyFCGAH(vRX#D$I54SXjSIGy3XZZ4qE=E_ysMn@%e@pJ7ct~*u|EPr&YLStfU|Rx zKNa~gR#aox_~PZ-fXy@R7;FMdIs*wB74oF3o2-c>BUoQ5(%h>&I!P8}X7^N1-Xr1B zS>w)_qXeYKxBb+ivP|GBoG8Fx5-KBcRmHBZU8=70rk(nQ5U>#%g5xf7 zYv7d_DQ8&2a$zIurykk9tC}#Cf^`&BlHDwJc0;qe1@Q@n&KtZ1C7^SMUHVN6xZ>Q)*g$- zeOg6Mi!8)d30U39XO35@&6C)srQ8WUwU$07Bc)W(9(6mk7%v_ZL;L;w=HcSH&$SqB zBXt!^oR`kWqRsy9a& z-+sW{*7S%~ZkYh20onW?u_=Q|MA+LpJ$1mCb~i#aC95{eyo^vPvb)n<9c8&Gxab@g?yLGSx;!yo(( z^A0*v6h;bFB^s}~)fIFXVAKAak{V>r4~NCXQj2ROcY;?^Hus_dq4IqD(ZzLFK8|{mMklo)d!Qzr|1m`QTt$z zBvMOOnkM$?Z7(kVW&5(Kt`5hlrHJMhkGUQR-`e2`kSy;$cjs3LK!*EU`tgBTXRNob zbuY`?Q)ayTw_UvSKnT`2u?rj@@-c@Fa3h=@PYjW&QXsur;S{L`w_3zm9`Qwf2If}E z?E+?*f9eNRB+joYNGMFQaMLFA<;H5B!0Q_X7ot}%xMoyH@gyCYK$Liw*H|mTXE>$M z^kWdEDbe*#Bb4#DHymX%hwwj&Lmg3k4e75^(U=po7J z9$Lpw51KMM)1A;C(*_16Co*QzMR@tJNcL1+rxR5(?=lA; zNUJoNX1?1(30%V%Bp+)dzO-ZSa(l94w#}l-g{AYRB>!3s&nN4)ODXg!i_J~a`6U07 zJ;!1up_Ofeh~nUy60@TO;c0WAji;yiG4ou`UTo^vP;2L6>*ATI*c_xa`a1F20sQIn zy-@jW7B=^4)0aFy3qQve*YjhOUk)tbIvU8xMXN^CQY_n71EZvL!-BN0I^t>*W|CP! zckVhJZ?H9frYn8_9v2;*1g?pz*nV8ktVtp%(J?iLb!Q(2Pqx;7r+XJ}O^r4Rmt3WU zHI?IniLydlSdjcOE8eQi_KQSga0Ti^i}kp9CI~=0iT1%;bneSEsc9cm={j>vIzoqV z)(K*u$>_NhO~8@h?1xeimR;4&9p8cN-9oac^sgUtQ|GXo_^8VIn8WKCiI&ncciIXl z@f5I*Wa7FWIhgqzD_nE@Ly?4j*$jhkAcwP2Atx0>2F5pxp9kxvh@@;SeIg!63#^%I z25!LaOjx*9G z*#+IsQMhf2eklh1wfxg>0p{+x5hyKtOr$;x|Ad6WXsK*jo-dHDwTDededanO{;Idr zxFRLp&-ZpA%OHTpX!Hdd5p%Z{Pj@f+u? z!Mf9$@7{}qoa=oC7D5YM`WhoR*$knnYCljwrHxkUpwzTz^r>jnlX&QQm?mIAF zCCN~?N!&`70$Cr2fe2+P27pwnPQyLXkZha7PlU20TfhZ0f8aKXW?3bdq^`6-S2fT?y;$v#pB!Lut13-5&{(SY3!qTkzI;M++|My4Q9qU2Q?tvJaP zfMo;;a5dVU;GN6z%6hi41Tww2@@FV(mrDmj-j(Uy2Zq6fMag{!xjFi3Mt4Hf!_vy(cx-Q8_s$6w@0HdmMVb@C&JKjHQ z4#!70=4_X@BE_egmU@cU$(^#XB-g^GE0c=&dSt+^JFcSNk%9x9wGoUX*`}WSeM(d64C3P*^&hmW86)_|ws3Tv$lx zO;y0X73zkPZN_rZww|V-uguicml*LGFA@P1tx)Q{4=Pv~kCPETK_Q`NcPuTRZX zD<f4_V^I=RUY-7-dxr zctK2h`GzK!inj8t)4QS17?--8)Q~(X(nDe1WHY13kqq*Eh45YYhzbMypI{T6Toj3-Zg_rx#TQHd> zx;e`5{t`acMU{`%b7Ku=%&nAsf=}DMD>UX1!d+EYGcXqi4W0IH#%aAe{ zbJ_OT1H=sl@x0sQ{Lxs#a83#P4$iqojervTeD5NH_>Htd3}wbfWiHFR$k@;=(=E$0$5&Tqk(>I>zuZ3?$2GB^E(gD8 zVa)c@aVwYi0@2V@VZgpA9A9pgaX#W^!Hr{xAi!+B@13t0wUB89@SEgi)IWc+@rfgT z^}dy+bi2BGJdq5Hz?;Ei+&#_Mk@TjhZ(aW|F`83kovum0=)GsVAVxB`SX!YW+bbzG zz6?)fZN#;{t;lyTy%iBHr1s%2-8=61L$~b}ON?{3smJ!K(z~*L*}iK)4_F~fi*a?ZE`sCrl3Vr-nGyTkKcfdhN0T&DQ*ZQSp&v zIej_X_Anu?#)~}&a9Sft;ESAJ_J@OSw%eT82f(TMWF6sG@=wY`K!vh%p%yJ|O{uc9 z{aiVNC84JZnqRkrhua6oM|(FzcaWraOMNGsv!kz8=|mAN@Khl7m|S!X z(X#$%OyIEe3`Mp^%j_S3l_;6;!r5-Ey+^c5ouG$usZITuPm=qqWC=~KjFmwvhu>I! zm@)1i7rc4k3BP&33j5_L^J}o=*VyWf1mfNiZ0Go3FU&)W`wj7+Ng1lAROZ}k%7DA! zEoRaBapoxn&GLj9;3au6x<;YD-SHc>6XD)E@l*AWJ#*@pbl&t(m(n=ap)7j0BUt%i z6C4vPH;aYmaD;Fj4UAeXubStto_-?J{04Hl|6F`~W6=5vdVs{IKv4wav$a4mY%Tix zxajz4k`Jv&TFeA|*pBw2AunmXeP$lKRoQWQYMPHpVhM3;361SLB3RSdQiP{k7UY;d zQ;#uBA(U$L?oiUUIPJ=3(-?;XcHBe_qEEmct*px;$|{4+zpwpsBTKMi^?9Px{Ylroktd%M_ml(INy z0Pd9oxL=^;2gJ~Lv`fO=s*@VMu?;Abq7x5`-#Rem z-A|+| z3YXMUwa;IcH3_cMbri7fxo+F6#J^DM)hSQ;zd7n{HXrq_`aQS0j@*^c3#)py6uvQa zYkr9JKEGohqVPTsBe>HTFE6}l3;6A?6Q>DkT%ksmWeCBki)z!CUwBtfH%OgK%BSeh z$Hyc)t;QM^hZw~bx5q8AFnwPL--NbJ6DPPi{`b;N7UZOtB2EqDgT{Z@CuIsc|5V|K3RJB!#m1^hz6&4)V5mm1THlM zqpGxwgPnMGY-ktm!+sO4WYf=CO9ThkVgvtQIB2|Q!qwi>PTSk_FP~?^)!X4W+v=XI zqXy|d~T!0c8&V=9PQok#RcU=ROIV#6a4J~RCPQltJW{JZ0yYQt}x;vcg{`2SUlfA{{AnE$Ov{9~W~<^7-aiGL6D wXTtsF@&B=}i2s?@|Mv)g!uvZh|1lA=|B$BIYRD+RhoC%P5zi3ClmG7hKT^jXZvX%Q literal 0 HcmV?d00001 diff --git a/io.catenax.shopfloor_information.provide_production_forecast/2.0.0/gen/ProvideProductionForecast.html b/io.catenax.shopfloor_information.provide_production_forecast/2.0.0/gen/ProvideProductionForecast.html new file mode 100644 index 00000000..4fefc5dc --- /dev/null +++ b/io.catenax.shopfloor_information.provide_production_forecast/2.0.0/gen/ProvideProductionForecast.html @@ -0,0 +1,2014 @@ + + + + + + + + + + + + + + Documentation Provide Production Forecast + + +
+
+
+
+

Aspect Model Provide Production Forecast

+
urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#ProvideProductionForecast
+
+
+
+
+
+
+
+ +
+ + +
+ Answer to a customer with all information about the requested items +
+ + +
+

Overview

+
+
+
+
+ Aspect Model Diagram +
+
+
+ + +
+
+

Properties

+
+ +
+ +
+

Header

+
+ +Contains standardized attributes for message processing common across several use cases. + +
+
Name
+
header
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.message_header:2.0.0#MessageHeader + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
header
+
+ + +
+
+ +
+

Production Forecast Response

+
+ +The concrete information about a production forecast + +
+
Name
+
productionForecastResponse
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#ProductionForecastItem + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productionForecastResponse
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

Forecast Item

+
+
+ ForecastItem entry for the requested order +
+ +
+

Properties

+
+
+ +
+
Position Id
+
+ +Identifier of a position of an order + +
+
Name
+
positionId
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://tools.ietf.org/html/rfc4122
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
00000000-0000-0000-C000-000000000046
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
positionId
+
+ + +
+
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}$)
    +
    + +
    • +
+
+
+
+
+ +
+
Production Forecast
+
+ +Date of completion + +
+
Name
+
productionForecast
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-06-19T21:24:00+07:00
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productionForecast
+
+ + +
+
+ +
+
Precision Of Forecast
+
+ +Accuracy of the prediction + +
+
Name
+
precisionOfForecast
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.shopfloor_information_types:2.0.0#TimeValue + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
precisionOfForecast
+
+ + +
+
+ +
+
Production Status
+
+ +Status of the order/position within MP + +
+
Name
+
productionStatus
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • itemReceived
    • +
  • itemPlanned
    • +
  • itemInProduction
    • +
  • itemCompleted
    • +
  • statusUndefined
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
itemPlanned
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productionStatus
+
+ + +
+
+ +
+
Reasons For Delay
+
+ +Optional field to provide information to the customer why a delivery date is not met + +
+
Name
+
reasonsForDelay
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • supplyProblems
    • +
  • otherCircumstances
    • +
  • internalProblems
    • +
  • noInformationAvailable
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
supplyProblems
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
reasonsForDelay
+
+ + +
+
+ +
+
Return Code
+
+ +Return code that indicates whether a single item of an order matches the customers desired request + +
+
Name
+
returnCode
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • ok
    • +
  • lowerAccuracyOfPrecision
    • +
  • noForecastAvailable
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
ok
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
returnCode
+
+ + +
+
+ +
+
Forecast Date
+
+ +Date/time of the forecast calculation + +
+
Name
+
forecastDate
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-06-19T21:24:00+07:00
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
forecastDate
+
+ + +
+
+
+
+

Message Header

+
+
+ The Catena-X Message Header contains standardized attributes for message processing that are common across several use cases. It targets a minimal set of aspects that are needed for overall message handling, and not for the processing of the business related payload part. By standardizing the message header structure, we support a harmonized modelling approach and re-use of concepts. The message header originated from discussions on push notifications but has since then been abstracted for overall message handling ? and does not only apply to notification anymore. +
+ +
+

Properties

+
+
+ +
+
Message ID
+
+ +Unique ID identifying the message. The purpose of the ID is to uniquely identify a single message, therefore it MUST not be reused. + +
+
Name
+
messageId
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://tools.ietf.org/html/rfc4122
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
3b4edc05-e214-47a1-b0c2-1d831cdd9ba9
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
messageId
+
+ + +
+
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}$)
    +
    + +
    • +
+
+
+
+
+ +
+
Context
+
+ +Information about the context the message should be considered in. +The value MUST consist of two parts: an identifier of the context (e.g. business domain, etc.) followed by a version number. +Both the identifier and the version number MUST correspond to the content of the message. +If 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. +In 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). +Versioning only refers to major versions in both default and fallback cases. +Note: The version of the message's header is specified in the version field. + +
+
Name
+
context
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
urn:samm:io.catenax.<ASPECT-MODEL-NAME>:1.x.x
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
context
+
+ + +
+
+ +
+
Sent Date Time
+
+ +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 + +
+
Name
+
sentDateTime
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-06-19T21:24:00+07:00
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
sentDateTime
+
+ + +
+
+ +
+
Sender BPN
+
+ +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 + +
+
Name
+
senderBpn
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL7588787849VQ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
senderBpn
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two uppercase letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[0-9]{8}[a-zA-Z0-9]{4}$
    +
    + +
    • +
+
+
+
+
+ +
+
Receiver BPN
+
+ +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. + +
+
Name
+
receiverBpn
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL6666787765VQ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
receiverBpn
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + BPNL Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two uppercase letters.
    +
    + + +
    +
    Regular expression
    +
    ^BPNL[0-9]{8}[a-zA-Z0-9]{4}$
    +
    + +
    • +
+
+
+
+
+ +
+
Expected Response By
+
+ +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 + +
+
Name
+
expectedResponseBy
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime + +
+
+
+
+
+ +
+
Example
+
2023-06-19T21:24:00+07:00
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
expectedResponseBy
+
+ + +
+
+ +
+
Related Message ID
+
+ +Unique ID identifying a message somehow related to the current one + +
+
Name
+
relatedMessageId
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://tools.ietf.org/html/rfc4122
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
d9452f24-3bf3-4134-b3eb-68858f1b2362
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
relatedMessageId
+
+ + +
+
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}$)
    +
    + +
    • +
+
+
+
+
+ +
+
Version
+
+ +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. + +
+
Name
+
version
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://semver.org
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2.0.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
version
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Semantic Versioning Constraint +
    + +
    +
    Description
    +
    Constraint for defining a SemVer version.
    +
    + + +
    +
    Regular expression
    +
    ^(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-]+)*)?$
    +
    + +
    • +
+
+
+
+
+
+
+

Production Forecast Item

+
+
+ Datamodel of the concrete production forecast for one forecast item +
+ +
+

Properties

+
+
+ +
+
List Of Forecast Items
+
+ +List of ForecastItems matching the items to an order + +
+
Name
+
listOfForecastItems
+
+ + + +
+
Characteristic
+
+
+
+
List
+
+
+
Has a certain order
+
+
+
Duplicates allowed
+
+
+
+ Type urn:samm:io.catenax.shopfloor_information.provide_production_forecast:2.0.0#ForecastItem + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
listOfForecastItems
+
+ + +
+
+ +
+
Iteration Number
+
+ +Only set in CommunicationMode == "notification/cyclic" to be able to check the order of the notifications. + +Not required for communication mode = "synchronous" + +
+
Name
+
iterationNumber
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#integer + +
+
+
+
+
+ +
+
Example
+
6
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
iterationNumber
+
+ + +
+
+ +
+
Communication Mode
+
+ +Specification of the communication mode + +
+
Name
+
communicationMode
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • synchronous
    • +
  • cyclic
    • +
  • notification
    • +
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
synchronous
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
communicationMode
+
+ + +
+
+ +
+
Version
+
+ +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. + +
+
Name
+
version
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Reference +
+
    +
  • https://semver.org
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
2.0.0
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
version
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Semantic Versioning Constraint +
    + +
    +
    Description
    +
    Constraint for defining a SemVer version.
    +
    + + +
    +
    Regular expression
    +
    ^(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-]+)*)?$
    +
    + +
    • +
+
+
+
+
+
+
+

Time Value

+
+
+ Datatype to express a time value +
+ +
+

Properties

+
+
+ +
+
Time Unit
+
+ +Specifies the unit in which the time is represented + +
+
Name
+
timeUnit
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
  • unit:secondUnitOfTime
    • +
  • unit:minuteUnitOfTime
    • +
  • unit:hour
    • +
  • unit:day
    • +
  • unit:week
    • +
  • unit:month
    • +
  • unit:year
    • +
+
+
+
+
+ Type urn:samm:org.eclipse.esmf.samm:meta-model:2.1.0#curie + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
timeUnit
+
+ + +
+
+ +
+
Value
+
+ +The amount of timeUnits considered + +
+
Name
+
value
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#integer + +
+
+
+
+
+ +
+
Example
+
12
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
value
+
+ + +
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/io.catenax.shopfloor_information.provide_production_forecast/2.0.0/gen/ProvideProductionForecast.json b/io.catenax.shopfloor_information.provide_production_forecast/2.0.0/gen/ProvideProductionForecast.json new file mode 100644 index 00000000..5f5649df --- /dev/null +++ b/io.catenax.shopfloor_information.provide_production_forecast/2.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" + } ], + "version" : "2.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.:1.x.x", + "messageId" : "3b4edc05-e214-47a1-b0c2-1d831cdd9ba9", + "receiverBpn" : "BPNL6666787765VQ", + "sentDateTime" : "2023-06-19T21:24:00+07:00", + "version" : "2.0.0" + } +} \ No newline at end of file diff --git a/io.catenax.shopfloor_information.provide_production_forecast/2.0.0/gen/ProvideProductionForecast.yml b/io.catenax.shopfloor_information.provide_production_forecast/2.0.0/gen/ProvideProductionForecast.yml new file mode 100644 index 00000000..d653f4a5 --- /dev/null +++ b/io.catenax.shopfloor_information.provide_production_forecast/2.0.0/gen/ProvideProductionForecast.yml @@ -0,0 +1,309 @@ +--- +openapi: 3.0.3 +info: + title: Provide Production Forecast + version: v2 +servers: +- url: catenax.io/api/v2 + variables: + api-version: + default: v2 +paths: + /{tenant-id}/provide-production-forecast: + get: + tags: + - ProvideProductionForecast + operationId: getProvideProductionForecast + parameters: + - name: tenant-id + in: path + description: The ID of the tenant owning the requested Twin. + required: true + schema: + type: string + format: uuid + responses: + "200": + $ref: '#/components/responses/ProvideProductionForecast' + "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 + 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_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_2.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_2.0.0_IntegerValueCharacteristic: + type: number + description: The value of the specified timeUnit as an integer value + urn_samm_io.catenax.shared.shopfloor_information_types_2.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_2.0.0_TimeUnitEnum' + value: + description: The amount of timeUnits considered + $ref: '#/components/schemas/urn_samm_io.catenax.shared.shopfloor_information_types_2.0.0_IntegerValueCharacteristic' + required: + - timeUnit + - value + urn_samm_io.catenax.shopfloor_information.provide_production_forecast_2.0.0_ProductionStatusEnum: + type: string + description: Enumeration with all possible states of an order within modular + production + enum: + - itemReceived + - itemPlanned + - itemInProduction + - itemCompleted + - statusUndefined + urn_samm_io.catenax.shopfloor_information.provide_production_forecast_2.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_2.0.0_ReturnCodeEnum: + type: string + description: Enumeration with all Return Codes + enum: + - ok + - lowerAccuracyOfPrecision + - noForecastAvailable + urn_samm_io.catenax.shopfloor_information.provide_production_forecast_2.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.uuid_1.0.0_UuidV4Trait' + 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_2.0.0_TimeValueCharacteristic' + productionStatus: + description: Status of the order/position within MP + $ref: '#/components/schemas/urn_samm_io.catenax.shopfloor_information.provide_production_forecast_2.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_2.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_2.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_2.0.0_ForecastItemList: + description: List with the forecast items + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.shopfloor_information.provide_production_forecast_2.0.0_ForecastItem' + urn_samm_io.catenax.shared.shopfloor_information_types_2.0.0_CommunicationModeEnum: + type: string + description: Enumerates all possible communication modes + enum: + - synchronous + - cyclic + - notification + 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_forecast_2.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_2.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_2.0.0_IntegerValueCharacteristic' + communicationMode: + description: Specification of the communication mode + $ref: '#/components/schemas/urn_samm_io.catenax.shared.shopfloor_information_types_2.0.0_CommunicationModeEnum' + 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: + - listOfForecastItems + - communicationMode + - version + urn_samm_io.catenax.shared.message_header_2.0.0_ContextCharacteristic: + type: string + description: Defining a string value for the context + 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. + The value MUST consist of two parts: an identifier of the context (e.g. business domain, etc.) followed by a version number. + Both the identifier and the version number MUST correspond to the content of the message. + If 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.:1.x.x) MUST be used as a value of the context field. This is considered the default case. + In all other cases the value of the context field MUST follow the pattern --:<[major] version> (e.g. TRACE-QM-Alert:1.x.x). + Versioning only refers to major versions in both default and fallback cases. + Note: 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 + ProvideProductionForecast: + description: Answer to a customer with all information about the requested items + type: object + properties: + productionForecastResponse: + description: The concrete information about a production forecast + $ref: '#/components/schemas/urn_samm_io.catenax.shopfloor_information.provide_production_forecast_2.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_2.0.0_HeaderCharacteristic' + required: + - productionForecastResponse + - header + 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' + ProvideProductionForecast: + content: + application/json: + schema: + $ref: '#/components/schemas/ProvideProductionForecast' + description: The request was successful. + requestBodies: + ProvideProductionForecast: + content: + application/json: + schema: + $ref: '#/components/schemas/ProvideProductionForecast'