postWeekBasedMaterialDemand

Version: Next

Endpoint to receive a Week Based Material Demand with header information from a Catena-X DCM partner.

application/json

Request Body

messageHeader object
The Capacity Group ID uniquely identifies the capacity group within the business relationship between a supplier and its customer.
header object required
Contains standardized attributes for message processing common across several use cases.
messageId string required
Possible values: Value must match 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}$)
Unique ID identifying the message. The purpose of the ID is to uniquely identify a single message, therefore it MUST not be reused.
context string required
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 --
sentDateTime string required
Possible values: Value must match regular expression -?([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))?
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 string required
Possible values: Value must match regular expression ^BPNL[a-zA-Z0-9]{12}$
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 string required
Possible values: Value must match regular expression ^BPNL[a-zA-Z0-9]{12}$
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 string
Possible values: Value must match regular expression -?([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))?
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 string
Possible values: Value must match 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}$)
Unique ID identifying a message somehow related to the current one
version string required
Possible values: Value must match 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-]+)*)?$
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.
content object
Bundles all business objects in this property.
informationObject object[]
Property to collect all transferred business objects.
materialDemandId string required
Possible values: Value must match 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}$)
The Material Demand ID uniquely identifies the material demand within the business relationship between a customer and its supplier.
demandSeries object[] required
The demands for a dedicated material in a given time period of a given demand rate, distinguished by their demand location and demand category.
customerLocation string required
Possible values: Value must match regular expression ^BPNS[a-zA-Z0-9]{12}$
The Business Partner Number Site (BPNS) of the site at which the customer needs the specified material for this demand series.
demandCategory object required
Type of demand for this demand series.
oneOf
MOD1
MOD2
MOD3
MOD4
MOD5
MOD6
MOD7
MOD8
demandCategoryCode string required
Possible values: [0001]
The code identifying a demand category.
demands object[] required
A time series with a specified demand rate along a given time period to describe the demand values for this demand series.
demand number required
Possible values: <= 1000000000000000000
Quantity of materials required in the specified point in time according specified demand rate. This demand should be as close as possible to demand that is derived from the actual production program.
pointInTime date required
Defines the start of the demand rate as a point in time. The point in time must be interpreted according to the demand rate.
expectedSupplierLocation string
Possible values: Value must match regular expression ^BPNS[a-zA-Z0-9]{12}$
The Business Partner Number Site (BPNS) of the site from where the customer expects the supplier to fulfill the demands of the demand series. The value is used for informational purposes only and is therefore not binding for the supplier.
customer string required
Possible values: Value must match regular expression ^BPNL[a-zA-Z0-9]{12}$
The Business Partner Number Legal Entity (BPNL) of the party requesting materials from a supplier.
supplier string required
Possible values: Value must match regular expression ^BPNL[a-zA-Z0-9]{12}$
The Business Partner Number Legal Entity (BPNL) of the party providing materials to a customer.
unitOfMeasure string
Possible values: Value must match regular expression [a-zA-Z]*:[a-zA-Z]+, [unit:piece, unit:set, unit:pair, unit:page, unit:cycle, unit:kilowattHour, unit:gram, unit:kilogram, unit:tonneMetricTon, unit:tonUsOrShortTonUkorus, unit:ounceAvoirdupois, unit:pound, unit:metre, unit:centimetre, unit:kilometre, unit:inch, unit:foot, unit:yard, unit:squareCentimetre, unit:squareMetre, unit:squareInch, unit:squareFoot, unit:squareYard, unit:cubicCentimetre, unit:cubicMetre, unit:cubicInch, unit:cubicFoot, unit:cubicYard, unit:litre, unit:millilitre, unit:hectolitre, unit:secondUnitOfTime, unit:minuteUnitOfTime, unit:hourUnitOfTime, unit:day]
Unit of measurement for demand quantities.
materialNumberCustomer string required
Material identifier as assigned by customer. This material number identifies the material (as planned) in customer's database. Must be unique for each Material Demand in the customer-supplier relationship.
materialNumberSupplier string
Material identifier as assigned by supplier. This material number identifies the material (as planned) in supplier's database.
materialDescriptionCustomer string required
Description of the material.
changedAt date-time required
Point in time when the content (any property according to the data model) of the material demand was changed, at the customer, either by a human user or an automated process.
materialGlobalAssetId string
Possible values: Value must match 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}$)
Identifier used uniquely to identify part type twin.
unitOfMeasureIsOmitted boolean required
Explicit indicator of whether the unit of measure is left out of the payload intentionally. If "true" it means the sending application sends demand values without unit of measure intentionally and the unit of measure MUST NOT be contained in the payload. If "false" a unit of measure MUST be supplied.
materialDemandIsInactive boolean required
Indicates that this material demand is currently not in use/maintained by the supplier.

Responses

postWeekBasedMaterialDemand​

postWeekBasedMaterialDemand