Skip to main content
Version: 24.08

postIdBasedRequestForUpdate​

Endpoint to receive an Id Based Request for Update with header information from a Catena-X DCM partner.

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 --:<[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 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.

  • weekBasedMaterialDemand object[]

    Material demands the supplier requests an update for. If within the array, no specific ID (array empty), than an update of all IDs is requested).

  • 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 the supplier requests an update for within the business relationship between the customer and its supplier.

  • changedAt 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))?

    Point in time of the last update known to the requesting business partner. If the requested entity has been changed more recently, the requested party should resend the data. If the changedAt property is not given, the latest entity should be send without precondition.

  • weekBasedCapacityGroup object[]

    Capacity groups the customer requests an update for. If within the array, no specific ID (array empty), than an update of all IDs is requested).

  • 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 the supplier requests an update for within the business relationship between the supplier and its customer.

  • changedAt 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))?

    Point in time of the last update known to the requesting business partner. If the requested entity has been changed more recently, the requested party should resend the data. If the changedAt property is not given, the latest entity should be send without precondition.

Responses

OK

POST /internal-dcm-application-id-based-request-for-update-post-endpoint

Request

Body
{

  "messageHeader": {

    "header": {

      "messageId": "string",

      "context": "string",

      "sentDateTime": "string",

      "senderBpn": "string",

      "receiverBpn": "string",

      "expectedResponseBy": "string",

      "relatedMessageId": "string",

      "version": "string"

    }

  },

  "content": {

    "informationObject": [

      {

        "weekBasedMaterialDemand": [

          {

            "materialDemandId": "string",

            "changedAt": "string"

          }

        ],

        "weekBasedCapacityGroup": [

          {

            "capacityGroupId": "string",

            "changedAt": "string"

          }

        ]

      }

    ]

  }

}

curl -L -X POST 'https://eclipse-tractusx.github.io/internal-dcm-application-id-based-request-for-update-post-endpoint' \
-H 'Content-Type: application/json' \
--data-raw '{
  "messageHeader": {
    "header": {
      "messageId": "string",
      "context": "string",
      "sentDateTime": "string",
      "senderBpn": "string",
      "receiverBpn": "string",
      "expectedResponseBy": "string",
      "relatedMessageId": "string",
      "version": "string"
    }
  },
  "content": {
    "informationObject": [
      {
        "weekBasedMaterialDemand": [
          {
            "materialDemandId": "string",
            "changedAt": "string"
          }
        ],
        "weekBasedCapacityGroup": [
          {
            "capacityGroupId": "string",
            "changedAt": "string"
          }
        ]
      }
    ]
  }
}'