diff --git a/io.catenax.shopfloor_information.get_production_forecast/1.0.0/gen/GetProductionForecast-aas.xml b/io.catenax.shopfloor_information.get_production_forecast/1.0.0/gen/GetProductionForecast-aas.xml new file mode 100644 index 00000000..945d9e52 --- /dev/null +++ b/io.catenax.shopfloor_information.get_production_forecast/1.0.0/gen/GetProductionForecast-aas.xml @@ -0,0 +1,2013 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:io.catenax.shopfloor_information.get_production_forecast:1.0.0#GetProductionForecast + + Type + + + + ModelReference + + + Submodel + urn:samm:io.catenax.shopfloor_information.get_production_forecast:1.0.0#GetProductionForecast/submodel + + + + + + + + + GetProductionForecast + + + en + Aspect Model to request a production forecast + + + + urn:samm:io.catenax.shopfloor_information.get_production_forecast:1.0.0#GetProductionForecast/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:io.catenax.shopfloor_information.get_production_forecast:1.0.0#GetProductionForecast + + + + + + RequestEntity + + + en + Request Entity + + + + + en + Entity for a request of a production forecast + + + + + 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 + + + + + + customerId + + + en + customerId + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shopfloor_information.get_production_forecast:1.0.0#customerId + + + + xs:string + + + + 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 + + + + + + productionForecastForAll + + + en + Production forecast for all + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shopfloor_information.get_production_forecast:1.0.0#productionForecastForAll + + + + xs:boolean + + + + orderId + + + en + orderId + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shopfloor_information.get_production_forecast:1.0.0#orderId + + + + xs:string + + + + 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 + + + + + + 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 + + + + + + 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 + GetProductionForecast + + + en + Get Production Forecast + + + + + en + Aspect Model to request a production forecast + + + urn:samm:io.catenax.shopfloor_information.get_production_forecast:1.0.0#GetProductionForecast + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Get Production Forecast + + + + + en + GetProductionForecast + + + + + en + Aspect Model to request a production forecast + + + + + + + + + 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 + + + + + + + + + offset + + + en + offset + + + urn:samm:io.catenax.shopfloor_information.get_production_forecast:1.0.0#offset + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + offset + + + + + en + offset + + + STRING + + + en + Send/start time of the first message/notification +- "0" ==> immediate response + + + + + + + + + customerId + + + en + customerId + + + urn:samm:io.catenax.shopfloor_information.get_production_forecast:1.0.0#customerId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + customerId + + + + + en + customerId + + + STRING + + + en + Internal customerId + + + + + + + + + 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 + + + + + + + + + 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.get_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 time specification of the completion date. +- default: implicitly defined by production +- only as a REQUEST of the requester since it cannot be guaranteed that the store floor can provide the data in this accuracy. + + + + + + + + + productionForecastForAll + + + en + Production forecast for all + + + urn:samm:io.catenax.shopfloor_information.get_production_forecast:1.0.0#productionForecastForAll + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Production forecast for all + + + + + en + productionForecastForAll + + + BOOLEAN + + + en + Boolean variable that detemines whether the customer request information about each position of an order, or information about the complete order + + + + + + + + + orderId + + + en + orderId + + + urn:samm:io.catenax.shopfloor_information.get_production_forecast:1.0.0#orderId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + orderId + + + + + en + orderId + + + STRING + + + en + The Id identifying subject of the request + + + + + + + + + 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 + + + + + + + + + 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 + + + + + + + + + deviationOfSchedule + + + en + Deviation of Schedule + + + urn:samm:io.catenax.shopfloor_information.get_production_forecast:1.0.0#deviationOfSchedule + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Deviation of Schedule + + + + + en + deviationOfSchedule + + + STRING + + + en + Mandatory property for the notification mode. The property specifies the deviation from targeted delivery date that must be met to send a notification to a subscriber + +mandatory for CommunicationMode = "notification" + + + + + + + + + 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 + + + + + + + + + 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 + + + + + + + + + notificationInterval + + + en + Notification Interval + + + urn:samm:io.catenax.shopfloor_information.get_production_forecast:1.0.0#notificationInterval + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Notification Interval + + + + + en + notificationInterval + + + STRING + + + en + Interval time that either specifies the cyclic send time or limits the notification time +mandatory for CommunicationMode = "cyclic" + + + + + + + + + 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 + + + + + + + + + request + + + en + Request + + + urn:samm:io.catenax.shopfloor_information.get_production_forecast:1.0.0#request + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Request + + + + + en + request + + + STRING + + + en + Data model for a request + + + + + + + + + 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.get_production_forecast/1.0.0/gen/GetProductionForecast-schema.json b/io.catenax.shopfloor_information.get_production_forecast/1.0.0/gen/GetProductionForecast-schema.json new file mode 100644 index 00000000..4c3da426 --- /dev/null +++ b/io.catenax.shopfloor_information.get_production_forecast/1.0.0/gen/GetProductionForecast-schema.json @@ -0,0 +1,157 @@ +{ + "$schema" : "http://json-schema.org/draft-04/schema", + "description" : "Aspect Model to request a production forecast", + "type" : "object", + "components" : { + "schemas" : { + "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.shopfloor_information.get_production_forecast_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.shared.message_header_1.0.0_BpnCharacteristic" : { + "type" : "string", + "description" : "Characteristic for defining BPN values" + }, + "urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" : { + "type" : "boolean", + "description" : "Represents a boolean value (i.e. a \"flag\")." + }, + "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_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.shopfloor_information.get_production_forecast_1.0.0_RequestCharacteristic" : { + "description" : "Data type for a request", + "type" : "object", + "properties" : { + "offset" : { + "description" : "Send/start time of the first message/notification\n- \"0\" ==> immediate response", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.get_production_forecast_1.0.0_TimeValueCharacteristic" + }, + "customerId" : { + "description" : "Internal customerId", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.message_header_1.0.0_BpnCharacteristic" + }, + "precisionOfForecast" : { + "description" : "Accuracy of the time specification of the completion date.\n- default: implicitly defined by production\n- only as a REQUEST of the requester since it cannot be guaranteed that the store floor can provide the data in this accuracy.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.get_production_forecast_1.0.0_TimeValueCharacteristic" + }, + "productionForecastForAll" : { + "description" : "Boolean variable that detemines whether the customer request information about each position of an order, or information about the complete order", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "orderId" : { + "description" : "The Id identifying subject of the request", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.message_header_1.0.0_UuidCharacteristic" + }, + "deviationOfSchedule" : { + "description" : "Mandatory property for the notification mode. The property specifies the deviation from targeted delivery date that must be met to send a notification to a subscriber\n\nmandatory for CommunicationMode = \"notification\"", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.get_production_forecast_1.0.0_TimeValueCharacteristic" + }, + "notificationInterval" : { + "description" : "Interval time that either specifies the cyclic send time or limits the notification time\nmandatory for CommunicationMode = \"cyclic\"", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.get_production_forecast_1.0.0_TimeValueCharacteristic" + }, + "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" : [ "offset", "customerId", "productionForecastForAll", "orderId", "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_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.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" : { + "request" : { + "description" : "Data model for a request", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.get_production_forecast_1.0.0_RequestCharacteristic" + }, + "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" : [ "header" ] +} \ No newline at end of file diff --git a/io.catenax.shopfloor_information.get_production_forecast/1.0.0/gen/GetProductionForecast.aasx b/io.catenax.shopfloor_information.get_production_forecast/1.0.0/gen/GetProductionForecast.aasx new file mode 100644 index 00000000..51d67850 Binary files /dev/null and b/io.catenax.shopfloor_information.get_production_forecast/1.0.0/gen/GetProductionForecast.aasx differ diff --git a/io.catenax.shopfloor_information.get_production_forecast/1.0.0/gen/GetProductionForecast.html b/io.catenax.shopfloor_information.get_production_forecast/1.0.0/gen/GetProductionForecast.html new file mode 100644 index 00000000..308c7fcf --- /dev/null +++ b/io.catenax.shopfloor_information.get_production_forecast/1.0.0/gen/GetProductionForecast.html @@ -0,0 +1,1549 @@ + + + + + + + + + + + + + + Documentation Get Production Forecast + + +
+
+
+
+

Aspect Model Get Production Forecast

+
urn:samm:io.catenax.shopfloor_information.get_production_forecast:1.0.0#GetProductionForecast
+
+
+
+
+
+
+
+ +
+ + +
+ Aspect Model to request a production forecast +
+ + +
+

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
+
+ + +
+
+ +
+

Request

+
+ +Data model for a request + +
+
Name
+
request
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shopfloor_information.get_production_forecast:1.0.0#RequestEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
request
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

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
+
+ + +
+
+
+
+

Request Entity

+
+
+ Entity for a request of a production forecast +
+ +
+

Properties

+
+
+ +
+
offset
+
+ +Send/start time of the first message/notification +- "0" ==> immediate response + +
+
Name
+
offset
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#TimeValue + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
offset
+
+ + +
+
+ +
+
customerId
+
+ +Internal customerId + +
+
Name
+
customerId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
BPNL7588787849VQ
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
customerId
+
+ + +
+
+ +
+
Precision of forecast
+
+ +Accuracy of the time specification of the completion date. +- default: implicitly defined by production +- only as a REQUEST of the requester since it cannot be guaranteed that the store floor can provide the data in this accuracy. + +
+
Name
+
precisionOfForecast
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#TimeValue + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
precisionOfForecast
+
+ + +
+
+ +
+
Production forecast for all
+
+ +Boolean variable that detemines whether the customer request information about each position of an order, or information about the complete order + +
+
Name
+
productionForecastForAll
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
false
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productionForecastForAll
+
+ + +
+
+ +
+
orderId
+
+ +The Id identifying subject of the request + +
+
Name
+
orderId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
00000000-0000-0000-C000-000000000046
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
orderId
+
+ + +
+
+ +
+
Deviation of Schedule
+
+ +Mandatory property for the notification mode. The property specifies the deviation from targeted delivery date that must be met to send a notification to a subscriber + +mandatory for CommunicationMode = "notification" + +
+
Name
+
deviationOfSchedule
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#TimeValue + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
deviationOfSchedule
+
+ + +
+
+ +
+
Notification Interval
+
+ +Interval time that either specifies the cyclic send time or limits the notification time +mandatory for CommunicationMode = "cyclic" + +
+
Name
+
notificationInterval
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#TimeValue + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
notificationInterval
+
+ + +
+
+ +
+
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.get_production_forecast/1.0.0/gen/GetProductionForecast.json b/io.catenax.shopfloor_information.get_production_forecast/1.0.0/gen/GetProductionForecast.json new file mode 100644 index 00000000..78a14972 --- /dev/null +++ b/io.catenax.shopfloor_information.get_production_forecast/1.0.0/gen/GetProductionForecast.json @@ -0,0 +1,35 @@ +{ + "request" : { + "precisionOfForecast" : { + "value" : 12, + "timeUnit" : "unit:secondUnitOfTime" + }, + "offset" : { + "value" : 12, + "timeUnit" : "unit:secondUnitOfTime" + }, + "orderId" : "00000000-0000-0000-C000-000000000046", + "customerId" : "BPNL7588787849VQ", + "deviationOfSchedule" : { + "value" : 12, + "timeUnit" : "unit:secondUnitOfTime" + }, + "productionForecastForAll" : false, + "versionDataModel" : "urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0", + "notificationInterval" : { + "value" : 12, + "timeUnit" : "unit:secondUnitOfTime" + }, + "communicationMode" : "synchronous" + }, + "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.get_production_forecast/1.0.0/gen/GetProductionForecast.yml b/io.catenax.shopfloor_information.get_production_forecast/1.0.0/gen/GetProductionForecast.yml new file mode 100644 index 00000000..68271590 --- /dev/null +++ b/io.catenax.shopfloor_information.get_production_forecast/1.0.0/gen/GetProductionForecast.yml @@ -0,0 +1,266 @@ +--- +openapi: 3.0.3 +info: + title: Get Production Forecast + version: v1 +servers: +- url: catenax.io/api/v1 + variables: + api-version: + default: v1 +paths: + /{tenant-id}/get-production-forecast: + get: + tags: + - GetProductionForecast + operationId: getGetProductionForecast + 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/GetProductionForecast' + "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.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.shopfloor_information.get_production_forecast_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.shared.message_header_1.0.0_BpnCharacteristic: + type: string + description: Characteristic for defining BPN values + urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean: + type: boolean + description: Represents a boolean value (i.e. a "flag"). + 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_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.shopfloor_information.get_production_forecast_1.0.0_RequestCharacteristic: + description: Data type for a request + type: object + properties: + offset: + description: |- + Send/start time of the first message/notification + - "0" ==> immediate response + $ref: '#/components/schemas/urn_samm_io.catenax.shopfloor_information.get_production_forecast_1.0.0_TimeValueCharacteristic' + customerId: + description: Internal customerId + $ref: '#/components/schemas/urn_samm_io.catenax.shared.message_header_1.0.0_BpnCharacteristic' + precisionOfForecast: + description: |- + Accuracy of the time specification of the completion date. + - default: implicitly defined by production + - only as a REQUEST of the requester since it cannot be guaranteed that the store floor can provide the data in this accuracy. + $ref: '#/components/schemas/urn_samm_io.catenax.shopfloor_information.get_production_forecast_1.0.0_TimeValueCharacteristic' + productionForecastForAll: + description: "Boolean variable that detemines whether the customer request\ + \ information about each position of an order, or information about the\ + \ complete order" + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + orderId: + description: The Id identifying subject of the request + $ref: '#/components/schemas/urn_samm_io.catenax.shared.message_header_1.0.0_UuidCharacteristic' + deviationOfSchedule: + description: |- + Mandatory property for the notification mode. The property specifies the deviation from targeted delivery date that must be met to send a notification to a subscriber + + mandatory for CommunicationMode = "notification" + $ref: '#/components/schemas/urn_samm_io.catenax.shopfloor_information.get_production_forecast_1.0.0_TimeValueCharacteristic' + notificationInterval: + description: |- + Interval time that either specifies the cyclic send time or limits the notification time + mandatory for CommunicationMode = "cyclic" + $ref: '#/components/schemas/urn_samm_io.catenax.shopfloor_information.get_production_forecast_1.0.0_TimeValueCharacteristic' + 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: + - offset + - customerId + - productionForecastForAll + - orderId + - 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_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.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 + GetProductionForecast: + description: Aspect Model to request a production forecast + type: object + properties: + request: + description: Data model for a request + $ref: '#/components/schemas/urn_samm_io.catenax.shopfloor_information.get_production_forecast_1.0.0_RequestCharacteristic' + 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: + - 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' + GetProductionForecast: + content: + application/json: + schema: + $ref: '#/components/schemas/GetProductionForecast' + description: The request was successful. + requestBodies: + GetProductionForecast: + content: + application/json: + schema: + $ref: '#/components/schemas/GetProductionForecast' diff --git a/io.catenax.shopfloor_information.get_production_forecast/2.0.0/gen/GetProductionForecast-aas.xml b/io.catenax.shopfloor_information.get_production_forecast/2.0.0/gen/GetProductionForecast-aas.xml new file mode 100644 index 00000000..9956afac --- /dev/null +++ b/io.catenax.shopfloor_information.get_production_forecast/2.0.0/gen/GetProductionForecast-aas.xml @@ -0,0 +1,2013 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:io.catenax.shopfloor_information.get_production_forecast:2.0.0#GetProductionForecast + + Type + + + + ModelReference + + + Submodel + urn:samm:io.catenax.shopfloor_information.get_production_forecast:2.0.0#GetProductionForecast/submodel + + + + + + + + + GetProductionForecast + + + en + Aspect Model to request a production forecast + + + + urn:samm:io.catenax.shopfloor_information.get_production_forecast:2.0.0#GetProductionForecast/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:io.catenax.shopfloor_information.get_production_forecast:2.0.0#GetProductionForecast + + + + + + RequestEntity + + + en + Request Entity + + + + + en + Entity for a request of a production forecast + + + + + 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 + + + + + + customerId + + + en + customer identification number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shopfloor_information.get_production_forecast:2.0.0#customerId + + + + xs:string + + + + 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 + + + + + + productionForecastForAll + + + en + Production forecast for all + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shopfloor_information.get_production_forecast:2.0.0#productionForecastForAll + + + + xs:boolean + + + + orderId + + + en + order identification number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.shopfloor_information.get_production_forecast:2.0.0#orderId + + + + xs:string + + + + 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 + + + + + + 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 + + + + + + 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 + GetProductionForecast + + + en + Get Production Forecast + + + + + en + Aspect Model to request a production forecast + + + urn:samm:io.catenax.shopfloor_information.get_production_forecast:2.0.0#GetProductionForecast + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Get Production Forecast + + + + + en + GetProductionForecast + + + + + en + Aspect Model to request a production forecast + + + + + + + + + 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 + + + + + + + + + offset + + + en + offset + + + urn:samm:io.catenax.shopfloor_information.get_production_forecast:2.0.0#offset + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + offset + + + + + en + offset + + + STRING + + + en + Send/start time of the first message/notification +- "0" ==> immediate response + + + + + + + + + customerId + + + en + customer identification number + + + urn:samm:io.catenax.shopfloor_information.get_production_forecast:2.0.0#customerId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + customer identification number + + + + + en + customerId + + + STRING + + + en + Internal customer Id + + + + + + + + + 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 + + + + + + + + + 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.get_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 time specification of the completion date. +- default: implicitly defined by production +- only as a REQUEST of the requester since it cannot be guaranteed that the store floor can provide the data in this accuracy. + + + + + + + + + productionForecastForAll + + + en + Production forecast for all + + + urn:samm:io.catenax.shopfloor_information.get_production_forecast:2.0.0#productionForecastForAll + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Production forecast for all + + + + + en + productionForecastForAll + + + BOOLEAN + + + en + Boolean variable that detemines whether the customer request information about each position of an order, or information about the complete order + + + + + + + + + orderId + + + en + order identification number + + + urn:samm:io.catenax.shopfloor_information.get_production_forecast:2.0.0#orderId + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + order identification number + + + + + en + orderId + + + STRING + + + en + The Id identifying subject of the request + + + + + + + + + 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 + + + + + + + + + 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 + + + + + + + + + deviationOfSchedule + + + en + Deviation of Schedule + + + urn:samm:io.catenax.shopfloor_information.get_production_forecast:2.0.0#deviationOfSchedule + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Deviation of Schedule + + + + + en + deviationOfSchedule + + + STRING + + + en + Mandatory property for the notification mode. The property specifies the deviation from targeted delivery date that must be met to send a notification to a subscriber + +mandatory for CommunicationMode = "notification" + + + + + + + + + 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 + + + + + + + + + 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 + + + + + + + + + notificationInterval + + + en + Notification Interval + + + urn:samm:io.catenax.shopfloor_information.get_production_forecast:2.0.0#notificationInterval + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Notification Interval + + + + + en + notificationInterval + + + STRING + + + en + Interval time that either specifies the cyclic send time or limits the notification time +mandatory for CommunicationMode = "cyclic" + + + + + + + + + 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. + + + + + + + + + request + + + en + Request + + + urn:samm:io.catenax.shopfloor_information.get_production_forecast:2.0.0#request + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Request + + + + + en + request + + + STRING + + + en + Data model for a request + + + + + + + + + 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.get_production_forecast/2.0.0/gen/GetProductionForecast-schema.json b/io.catenax.shopfloor_information.get_production_forecast/2.0.0/gen/GetProductionForecast-schema.json new file mode 100644 index 00000000..b23ca2b2 --- /dev/null +++ b/io.catenax.shopfloor_information.get_production_forecast/2.0.0/gen/GetProductionForecast-schema.json @@ -0,0 +1,160 @@ +{ + "$schema" : "http://json-schema.org/draft-04/schema", + "description" : "Aspect Model to request a production forecast", + "type" : "object", + "components" : { + "schemas" : { + "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.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_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" : { + "type" : "boolean", + "description" : "Represents a boolean value (i.e. a \"flag\")." + }, + "urn_samm_io.catenax.shared.uuid_1.0.0_UuidV4Trait" : { + "type" : "string", + "description" : "The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by \"urn:uuid:\" to make it an IRI.", + "pattern" : "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)" + }, + "urn_samm_io.catenax.shared.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.get_production_forecast_2.0.0_RequestCharacteristic" : { + "description" : "Data type for a request", + "type" : "object", + "properties" : { + "offset" : { + "description" : "Send/start time of the first message/notification\n- \"0\" ==> immediate response", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.shopfloor_information_types_2.0.0_TimeValueCharacteristic" + }, + "customerId" : { + "description" : "Internal customer Id", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_1.0.0_BpnlTrait" + }, + "precisionOfForecast" : { + "description" : "Accuracy of the time specification of the completion date.\n- default: implicitly defined by production\n- only as a REQUEST of the requester since it cannot be guaranteed that the store floor can provide the data in this accuracy.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.shopfloor_information_types_2.0.0_TimeValueCharacteristic" + }, + "productionForecastForAll" : { + "description" : "Boolean variable that detemines whether the customer request information about each position of an order, or information about the complete order", + "$ref" : "#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean" + }, + "orderId" : { + "description" : "The Id identifying subject of the request", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.uuid_1.0.0_UuidV4Trait" + }, + "deviationOfSchedule" : { + "description" : "Mandatory property for the notification mode. The property specifies the deviation from targeted delivery date that must be met to send a notification to a subscriber\n\nmandatory for CommunicationMode = \"notification\"", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.shopfloor_information_types_2.0.0_TimeValueCharacteristic" + }, + "notificationInterval" : { + "description" : "Interval time that either specifies the cyclic send time or limits the notification time\nmandatory for CommunicationMode = \"cyclic\"", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shared.shopfloor_information_types_2.0.0_TimeValueCharacteristic" + }, + "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" : [ "offset", "customerId", "productionForecastForAll", "orderId", "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_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.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" : { + "request" : { + "description" : "Data model for a request", + "$ref" : "#/components/schemas/urn_samm_io.catenax.shopfloor_information.get_production_forecast_2.0.0_RequestCharacteristic" + }, + "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" : [ "header" ] +} \ No newline at end of file diff --git a/io.catenax.shopfloor_information.get_production_forecast/2.0.0/gen/GetProductionForecast.aasx b/io.catenax.shopfloor_information.get_production_forecast/2.0.0/gen/GetProductionForecast.aasx new file mode 100644 index 00000000..599e6c87 Binary files /dev/null and b/io.catenax.shopfloor_information.get_production_forecast/2.0.0/gen/GetProductionForecast.aasx differ diff --git a/io.catenax.shopfloor_information.get_production_forecast/2.0.0/gen/GetProductionForecast.html b/io.catenax.shopfloor_information.get_production_forecast/2.0.0/gen/GetProductionForecast.html new file mode 100644 index 00000000..520d15e7 --- /dev/null +++ b/io.catenax.shopfloor_information.get_production_forecast/2.0.0/gen/GetProductionForecast.html @@ -0,0 +1,1881 @@ + + + + + + + + + + + + + + Documentation Get Production Forecast + + +
+
+
+
+

Aspect Model Get Production Forecast

+
urn:samm:io.catenax.shopfloor_information.get_production_forecast:2.0.0#GetProductionForecast
+
+
+
+
+
+
+
+ +
+ + +
+ Aspect Model to request a production forecast +
+ + +
+

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
+
+ + +
+
+ +
+

Request

+
+ +Data model for a request + +
+
Name
+
request
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shopfloor_information.get_production_forecast:2.0.0#RequestEntity + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
request
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

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-]+)*)?$
    +
    + +
    • +
+
+
+
+
+
+
+

Request Entity

+
+
+ Entity for a request of a production forecast +
+ +
+

Properties

+
+
+ +
+
offset
+
+ +Send/start time of the first message/notification +- "0" ==> immediate response + +
+
Name
+
offset
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.shopfloor_information_types:2.0.0#TimeValue + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
offset
+
+ + +
+
+ +
+
customer identification number
+
+ +Internal customer Id + +
+
Name
+
customerId
+
+ + + +
+
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
+
customerId
+
+ + +
+
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}$
    +
    + +
    • +
+
+
+
+
+ +
+
Precision of forecast
+
+ +Accuracy of the time specification of the completion date. +- default: implicitly defined by production +- only as a REQUEST of the requester since it cannot be guaranteed that the store floor can provide the data in this accuracy. + +
+
Name
+
precisionOfForecast
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.shopfloor_information_types:2.0.0#TimeValue + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
precisionOfForecast
+
+ + +
+
+ +
+
Production forecast for all
+
+ +Boolean variable that detemines whether the customer request information about each position of an order, or information about the complete order + +
+
Name
+
productionForecastForAll
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#boolean + +
+
+
+
+
+ +
+
Example
+
false
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productionForecastForAll
+
+ + +
+
+ +
+
order identification number
+
+ +The Id identifying subject of the request + +
+
Name
+
orderId
+
+ + + +
+
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
+
orderId
+
+ + +
+
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}$)
    +
    + +
    • +
+
+
+
+
+ +
+
Deviation of Schedule
+
+ +Mandatory property for the notification mode. The property specifies the deviation from targeted delivery date that must be met to send a notification to a subscriber + +mandatory for CommunicationMode = "notification" + +
+
Name
+
deviationOfSchedule
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.shopfloor_information_types:2.0.0#TimeValue + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
deviationOfSchedule
+
+ + +
+
+ +
+
Notification Interval
+
+ +Interval time that either specifies the cyclic send time or limits the notification time +mandatory for CommunicationMode = "cyclic" + +
+
Name
+
notificationInterval
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.shared.shopfloor_information_types:2.0.0#TimeValue + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
notificationInterval
+
+ + +
+
+ +
+
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.get_production_forecast/2.0.0/gen/GetProductionForecast.json b/io.catenax.shopfloor_information.get_production_forecast/2.0.0/gen/GetProductionForecast.json new file mode 100644 index 00000000..729b3c32 --- /dev/null +++ b/io.catenax.shopfloor_information.get_production_forecast/2.0.0/gen/GetProductionForecast.json @@ -0,0 +1,35 @@ +{ + "request" : { + "precisionOfForecast" : { + "value" : 12, + "timeUnit" : "unit:secondUnitOfTime" + }, + "offset" : { + "value" : 12, + "timeUnit" : "unit:secondUnitOfTime" + }, + "orderId" : "00000000-0000-0000-C000-000000000046", + "customerId" : "BPNL7588787849VQ", + "deviationOfSchedule" : { + "value" : 12, + "timeUnit" : "unit:secondUnitOfTime" + }, + "productionForecastForAll" : false, + "version" : "2.0.0", + "notificationInterval" : { + "value" : 12, + "timeUnit" : "unit:secondUnitOfTime" + }, + "communicationMode" : "synchronous" + }, + "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.get_production_forecast/2.0.0/gen/GetProductionForecast.yml b/io.catenax.shopfloor_information.get_production_forecast/2.0.0/gen/GetProductionForecast.yml new file mode 100644 index 00000000..807bbc78 --- /dev/null +++ b/io.catenax.shopfloor_information.get_production_forecast/2.0.0/gen/GetProductionForecast.yml @@ -0,0 +1,275 @@ +--- +openapi: 3.0.3 +info: + title: Get Production Forecast + version: v2 +servers: +- url: catenax.io/api/v2 + variables: + api-version: + default: v2 +paths: + /{tenant-id}/get-production-forecast: + get: + tags: + - GetProductionForecast + operationId: getGetProductionForecast + 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/GetProductionForecast' + "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.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.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_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean: + type: boolean + description: Represents a boolean value (i.e. a "flag"). + urn_samm_io.catenax.shared.uuid_1.0.0_UuidV4Trait: + type: string + description: "The provided regular expression ensures that the UUID is composed\ + \ of five groups of characters separated by hyphens, in the form 8-4-4-4-12\ + \ for a total of 36 characters (32 hexadecimal characters and 4 hyphens),\ + \ optionally prefixed by \"urn:uuid:\" to make it an IRI." + pattern: "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)" + urn_samm_io.catenax.shared.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.get_production_forecast_2.0.0_RequestCharacteristic: + description: Data type for a request + type: object + properties: + offset: + description: |- + Send/start time of the first message/notification + - "0" ==> immediate response + $ref: '#/components/schemas/urn_samm_io.catenax.shared.shopfloor_information_types_2.0.0_TimeValueCharacteristic' + customerId: + description: Internal customer Id + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_1.0.0_BpnlTrait' + precisionOfForecast: + description: |- + Accuracy of the time specification of the completion date. + - default: implicitly defined by production + - only as a REQUEST of the requester since it cannot be guaranteed that the store floor can provide the data in this accuracy. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.shopfloor_information_types_2.0.0_TimeValueCharacteristic' + productionForecastForAll: + description: "Boolean variable that detemines whether the customer request\ + \ information about each position of an order, or information about the\ + \ complete order" + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' + orderId: + description: The Id identifying subject of the request + $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_1.0.0_UuidV4Trait' + deviationOfSchedule: + description: |- + Mandatory property for the notification mode. The property specifies the deviation from targeted delivery date that must be met to send a notification to a subscriber + + mandatory for CommunicationMode = "notification" + $ref: '#/components/schemas/urn_samm_io.catenax.shared.shopfloor_information_types_2.0.0_TimeValueCharacteristic' + notificationInterval: + description: |- + Interval time that either specifies the cyclic send time or limits the notification time + mandatory for CommunicationMode = "cyclic" + $ref: '#/components/schemas/urn_samm_io.catenax.shared.shopfloor_information_types_2.0.0_TimeValueCharacteristic' + 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: + - offset + - customerId + - productionForecastForAll + - orderId + - 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_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.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 + GetProductionForecast: + description: Aspect Model to request a production forecast + type: object + properties: + request: + description: Data model for a request + $ref: '#/components/schemas/urn_samm_io.catenax.shopfloor_information.get_production_forecast_2.0.0_RequestCharacteristic' + 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: + - 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' + GetProductionForecast: + content: + application/json: + schema: + $ref: '#/components/schemas/GetProductionForecast' + description: The request was successful. + requestBodies: + GetProductionForecast: + content: + application/json: + schema: + $ref: '#/components/schemas/GetProductionForecast'