--- openapi: 3.0.3 info: title: Catena-X DCM Week Based Capacity Group description: Open API documentation for the Catena-X DCM Week Based Capacity Group version: 3.0.0 paths: /internal-dcm-application-week-based-capacity-group-post-endpoint: post: tags: - WeekBasedCapacityGroup operationId: postWeekBasedCapacityGroup description: Endpoint to receive a Week Based Capacity Group with header information from a Catena-X DCM partner. requestBody: $ref: '#/components/requestBodies/WeekBasedCapacityGroup' responses: "200": description: OK "201": description: Created "400": description: Bad request "401": description: Unauthorized "403": description: Forbidden "405": description: Method not allowed "422": description: Unprocessable Entity "503": description: Service Unavailable components: schemas: urn_samm_io.catenax.shared.uuid_2.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.message_header_3.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.business_partner_number_2.0.0_BpnlTrait: type: string description: "The provided regular expression ensures that the BPNL is composed\ \ of prefix 'BPNL', 10 digits and two alphanumeric letters." pattern: "^BPNL[a-zA-Z0-9]{12}$" urn_samm_io.catenax.shared.message_header_3.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.shared.message_header_3.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_2.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_3.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_2.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_2.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_2.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_3.0.0_SemanticVersioningTrait' required: - messageId - context - sentDateTime - senderBpn - receiverBpn - version MessageHeaderAspect: description: Aspect model describing the shared message header. type: object properties: header: description: Contains standardized attributes for message processing common across several use cases. $ref: '#/components/schemas/urn_samm_io.catenax.shared.message_header_3.0.0_HeaderCharacteristic' required: - header urn_samm_io.catenax.week_based_capacity_group_3.0.0_CapacityGroupName: type: string description: "The name of a capacity group, used to distinguish it from other\ \ capacity groups." urn_samm_io.catenax.week_based_capacity_group_3.0.0_SupplierLocationsCharacteristic: description: Contains a set of locations the supplier fulfills a demand request from. type: array items: type: string description: "The provided regular expression ensures that the BPNS is composed\ \ of prefix 'BPNS', 10 digits and two alphanumeric letters." pattern: "^BPNS[a-zA-Z0-9]{12}$" uniqueItems: true urn_samm_io.catenax.shared.quantity_2.0.0_ItemUnitEnumeration: type: string pattern: "[a-zA-Z]*:[a-zA-Z]+" description: Enumeration for common item units. enum: - 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 urn_samm_io.catenax.week_based_capacity_group_3.0.0_MaterialNumber: type: string description: "The material number is a multi-character string, usually assigned\ \ by an ERP system." urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnsTrait: type: string description: "The provided regular expression ensures that the BPNS is composed\ \ of prefix 'BPNS', 10 digits and two alphanumeric letters." pattern: "^BPNS[a-zA-Z0-9]{12}$" DemandCategoryDefault: type: object properties: demandCategoryCode: description: The code identifying a demand category. type: string enum: - '0001' required: - demandCategoryCode DemandCategoryAfterSales: type: object properties: demandCategoryCode: description: The code identifying a demand category. type: string enum: - A1S1 required: - demandCategoryCode DemandCategorySeries: type: object properties: demandCategoryCode: description: The code identifying a demand category. type: string enum: - SR99 required: - demandCategoryCode DemandCategoryPhaseInPeriod: type: object properties: demandCategoryCode: description: The code identifying a demand category. type: string enum: - PI01 required: - demandCategoryCode DemandCategorySingleOrder: type: object properties: demandCategoryCode: description: The code identifying a demand category. type: string enum: - OS01 required: - demandCategoryCode DemandCategorySmallSeries: type: object properties: demandCategoryCode: description: The code identifying a demand category. type: string enum: - OI01 required: - demandCategoryCode DemandCategoryExtraordinaryDemand: type: object properties: demandCategoryCode: description: The code identifying a demand category. type: string enum: - ED01 required: - demandCategoryCode DemandCategoryPhaseOutPeriod: type: object properties: demandCategoryCode: description: The code identifying a demand category. type: string enum: - PO01 required: - demandCategoryCode urn_samm_io.catenax.week_based_capacity_group_3.0.0_DemandCategoryCharacteristic: description: The classification of demands used to prioritize or allocate capacities. type: object oneOf: - $ref: '#/components/schemas/DemandCategoryDefault' - $ref: '#/components/schemas/DemandCategoryAfterSales' - $ref: '#/components/schemas/DemandCategorySeries' - $ref: '#/components/schemas/DemandCategoryPhaseInPeriod' - $ref: '#/components/schemas/DemandCategorySingleOrder' - $ref: '#/components/schemas/DemandCategorySmallSeries' - $ref: '#/components/schemas/DemandCategoryExtraordinaryDemand' - $ref: '#/components/schemas/DemandCategoryPhaseOutPeriod' urn_samm_io.catenax.week_based_capacity_group_3.0.0_LoadFactorCharacteristic: type: number description: Describes the data type of the load factor. urn_samm_io.catenax.week_based_capacity_group_3.0.0_LinkedDemandSeries: description: Encapsulates information used to reference a specific demand series. type: object properties: materialNumberCustomer: description: Material identifier as assigned by customer. This material number identifies the material (as planned) in the customer's database. $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_MaterialNumber' materialNumberSupplier: description: "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." $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_MaterialNumber' customerLocation: description: The BPNS number of the site at which the customer needs the specified material for the referenced demand series. $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnsTrait' demandCategory: description: Type of demand of the referenced demand series. $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_DemandCategoryCharacteristic' loadFactor: description: "If existent, the load factor indicates that this material\ \ of the material demand collection takes a factor more or less intensity\ \ to produce." $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_LoadFactorCharacteristic' required: - materialNumberCustomer - customerLocation - demandCategory urn_samm_io.catenax.week_based_capacity_group_3.0.0_LinkedDemandSeriesSet: description: A set of demand series assigned to a certain capacity group. type: array items: $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_LinkedDemandSeries' uniqueItems: true urn_samm_io.catenax.week_based_capacity_group_3.0.0_PointInTimeCharacteristic: type: string format: date description: An ISO calendar week in which a given capacity will be provided. Must be given as date of the monday in the week. urn_samm_io.catenax.week_based_capacity_group_3.0.0_QuantityTrait: type: number description: "Constraint to ensure size of quantities: 12 digits plus 3 decimal\ \ places." maximum: 999999999999999999.999 exclusiveMaximum: false minimum: 0 exclusiveMinimum: false urn_samm_io.catenax.week_based_capacity_group_3.0.0_DeltaProductionResultCharacteristic: type: number description: Describes data type of a delta production result information. urn_samm_io.catenax.week_based_capacity_group_3.0.0_Capacity: description: "A supplier's 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." type: object properties: pointInTime: description: ISO Calendar Week of the given time series entry. Must be given as date of the monday in the week. $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_PointInTimeCharacteristic' actualCapacity: description: "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." $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_QuantityTrait' maximumCapacity: description: "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." $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_QuantityTrait' deltaProductionResult: description: 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. $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_DeltaProductionResultCharacteristic' agreedCapacity: description: 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. $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_QuantityTrait' required: - pointInTime - actualCapacity - maximumCapacity urn_samm_io.catenax.week_based_capacity_group_3.0.0_CapacityTimeSeries: description: The weekly actual and maximum capacities in a given time period. type: array items: $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_Capacity' uniqueItems: true urn_samm_io.catenax.week_based_capacity_group_3.0.0_Timestamp: type: string format: date-time description: Point in time. urn_samm_io.catenax.week_based_capacity_group_3.0.0_LinkedCapacityGroupsCharacteristic: description: Contains all capacity groups which are linked to the current one. type: array items: 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}$)" uniqueItems: true 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.week_based_capacity_group_3.0.0_MeasurementTrait: type: number maximum: 999 minimum: 1 description: Trait for measurement parameters to be an integer > 0 exclusiveMaximum: false exclusiveMinimum: false urn_samm_io.catenax.week_based_capacity_group_3.0.0_Decimal: type: number description: Property which is defined by a decimal value urn_samm_io.catenax.week_based_capacity_group_3.0.0_RelativeNegativeDeviationTrait: type: number description: Constraint to be a value between 0 and 1. maximum: 1 exclusiveMaximum: false minimum: 0 exclusiveMinimum: false urn_samm_io.catenax.week_based_capacity_group_3.0.0_RollingHorizonAlertThresholdsEntity: description: Encapsulation of the rolling horizons thresholds parameters. type: object properties: sequenceNumber: description: "Sequence number of the subhorizon \n(positive int values)" $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_MeasurementTrait' subhorizonLength: description: Length of the subhorizon in weeks. (Value must be >= 1) As a subhorizon can not be shorter than one week. $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_MeasurementTrait' relativePositiveDeviation: description: "Relative positive deviation threshold which triggers an alert;\ \ 20% = 0,2" $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_Decimal' relativeNegativeDeviation: description: "Relative negative deviation threshold which triggers an alert;\ \ -30% = 0,3" $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_RelativeNegativeDeviationTrait' absolutePositiveDeviation: description: Absolute positive deviation threshold which triggers an alert; 100 (units) = 100 $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_Decimal' absoluteNegativeDeviation: description: Absolute negative deviation threshold which triggers an alert; 100 (units) = 100 $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_Decimal' required: - sequenceNumber - subhorizonLength urn_samm_io.catenax.week_based_capacity_group_3.0.0_RollingHorizonAlertThresholdsSet: description: A set of subhorizons for which different demand volatility thresholds can be maintained. type: array items: $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_RollingHorizonAlertThresholdsEntity' uniqueItems: true urn_samm_io.catenax.week_based_capacity_group_3.0.0_DemandVolatilityCharacteristic: description: The characteristics of the demand volatility parameterization. type: object properties: startReferenceDateTime: description: |- 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. $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' measurementInterval: description: |- 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. $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_MeasurementTrait' rollingHorizonAlertThresholds: description: |- 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. $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_RollingHorizonAlertThresholdsSet' required: - startReferenceDateTime - measurementInterval WeekBasedCapacityGroup: description: An entity made up of the weekly actual and maximum capacities for a specific customer in a given time period. A capacity group is used to compare demand and capacity data for one or several similar bundled materials in a defined unit of measure. type: object properties: capacityGroupId: description: The Capacity Group ID uniquely identifies the capacity group within the business relationship between a supplier and its customer. $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait' name: description: Name of the capacity group. $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_CapacityGroupName' supplierLocations: description: Set of BPNS indicating the supplier sites that will be fulfilling the demands associated with this capacity group. $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_SupplierLocationsCharacteristic' customer: description: The Business Partner Number (BPNL) of the party requesting materials from a supplier. $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' supplier: description: The Business Partner Number (BPNL) of the party providing materials to a customer. $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnlTrait' unitOfMeasure: description: Unit of measurement for capacity quantities. $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_ItemUnitEnumeration' linkedDemandSeries: description: Set of demand series assigned to this capacity group. $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_LinkedDemandSeriesSet' capacities: description: A time series with week-based granularity along a given time period containing the capacity values. $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_CapacityTimeSeries' changedAt: description: "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." $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_Timestamp' linkedCapacityGroups: description: 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. $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_LinkedCapacityGroupsCharacteristic' unitOfMeasureIsOmitted: description: 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. $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' demandVolatilityParameters: description: The parameters to calibrate the measuring of demand volatility. $ref: '#/components/schemas/urn_samm_io.catenax.week_based_capacity_group_3.0.0_DemandVolatilityCharacteristic' capacityGroupIsInactive: description: Indicates that this capacity group is currently not in use/maintained by the supplier. $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean' required: - capacityGroupId - name - customer - supplier - changedAt - unitOfMeasureIsOmitted - capacityGroupIsInactive InformationObject: description: Bundles all business objects in this property. type: array items: $ref: '#/components/schemas/WeekBasedCapacityGroup' uniqueItems: true Content: description: Object to bundle all transferred business objects. type: object properties: informationObject: description: Property to collect all transferred business objects. $ref: '#/components/schemas/InformationObject' WeekBasedCapacityGroupWithHeader: description: An entity that combines the WeekBasedCapacityGroup with the message header data model in order to be compliant with the DCM standard for the exchange of a capacity groups. type: object properties: messageHeader: description: The Capacity Group ID uniquely identifies the capacity group within the business relationship between a supplier and its customer. $ref: '#/components/schemas/MessageHeaderAspect' content: description: Bundles all business objects in this property. $ref: '#/components/schemas/Content' requestBodies: WeekBasedCapacityGroup: content: application/json: schema: $ref: '#/components/schemas/WeekBasedCapacityGroupWithHeader'