postWeekBasedCapacityGroup

Version: 24.08

Endpoint to receive a Week Based Capacity Group 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.
capacityGroupId 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 Capacity Group ID uniquely identifies the capacity group within the business relationship between a supplier and its customer.
name string required
Name of the capacity group.
supplierLocations string[]
Possible values: Value must match regular expression ^BPNS[a-zA-Z0-9]{12}$
Set of BPNS indicating the supplier sites that will be fulfilling the demands associated with this capacity group.
customer string required
Possible values: Value must match regular expression ^BPNL[a-zA-Z0-9]{12}$
The Business Partner Number (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 (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 capacity quantities.
linkedDemandSeries object[]
Set of demand series assigned to this capacity group.
materialNumberCustomer string required
Material identifier as assigned by customer. This material number identifies the material (as planned) in the customer's database.
materialNumberSupplier string
Material identifier as assigned by supplier. This material number identifies the material (as planned) in the supplier's database. Used as informational field only, not for assigning demand series to capacity groups.
customerLocation string required
Possible values: Value must match regular expression ^BPNS[a-zA-Z0-9]{12}$
The BPNS number of the site at which the customer needs the specified material for the referenced demand series.
demandCategory object required
Type of demand of the referenced demand series.
oneOf
MOD1
MOD2
MOD3
MOD4
MOD5
MOD6
MOD7
MOD8
demandCategoryCode string required
Possible values: [0001]
The code identifying a demand category.
loadFactor number
If existent, the load factor indicates that this material of the material demand collection takes a factor more or less intensity to produce.
capacities object[]
A time series with week-based granularity along a given time period containing the capacity values.
pointInTime date required
ISO Calendar Week of the given time series entry. Must be given as date of the monday in the week.
actualCapacity number required
Possible values: <= 1000000000000000000
The actual capacity is the realistically planned output per calendar week and material for a specific customer in a specific unit of measure, considering all positive or negative impacts on this capacity.
maximumCapacity number required
Possible values: <= 1000000000000000000
The supplier maximum capacity is the maximal available output per calendar week and material for a specific customer in a specific unit of measure. The maximum capacity thereby restricts the flexible capacity, as the flexible capacity is obtained from the difference of a suppliers maximum capacity minus actual capacity.
deltaProductionResult number
Delta related to the aggregated material demand after pre-/post production calculation the supplier wants to send to the customer. Can be positive and negative.
agreedCapacity number
Possible values: <= 1000000000000000000
The agreed capacity of a supplier for a specific customer material(s) within a capacity group. The agreed capacity MUST NOT constitute a legal obligation to deliver.
changedAt date-time required
Point in time when the content (any property according to the data model) of the capacity group was changed, at the supplier, either by a human user or an automated process.
linkedCapacityGroups 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}$)
A set of capacity groups linked to this capacity group. This set contains all children capacity groups of the current capacity group in an unidirectional path.
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.
demandVolatilityParameters object
The parameters to calibrate the measuring of demand volatility.
startReferenceDateTime 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))?
Point in time when the measurement starts on supplier side. It needs to be a point in time after the receival of active flag. This point in time marks the beginning of the first reporting interval. It is also the time of the first week for the rolling sub horizons for alert generation.
measurementInterval number required
Possible values: >= 1 and <= 999
Indicates the length of intervals in weeks. The first interval starts with the point in time given by the “startReferenceDateTime”. The second interval starts [Value] week (s) after this. And so on.
rollingHorizonAlertThresholds object[]
Contains the Parameters that define subhorizons in sequence and length to enable different alert thresholds (per week) over time. The total length of the DCM horizon is 104 weeks. It can be split into subhorizons.
sequenceNumber number required
Possible values: >= 1 and <= 999
Sequence number of the subhorizon
(positive int values)
subhorizonLength number required
Possible values: >= 1 and <= 999
Length of the subhorizon in weeks. (Value must be >= 1) As a subhorizon can not be shorter than one week.
relativePositiveDeviation number
Relative positive deviation threshold which triggers an alert; 20% = 0,2
relativeNegativeDeviation number
Possible values: <= 1
Relative negative deviation threshold which triggers an alert; -30% = 0,3
absolutePositiveDeviation number
Absolute positive deviation threshold which triggers an alert; 100 (units) = 100
absoluteNegativeDeviation number
Absolute negative deviation threshold which triggers an alert; 100 (units) = 100
capacityGroupIsInactive boolean required
Indicates that this capacity group is currently not in use/maintained by the supplier.

Responses

postWeekBasedCapacityGroup​

postWeekBasedCapacityGroup