diff --git a/.github/workflows/trufflehog.yml b/.github/workflows/trufflehog.yml index 68424748663..a8de15ca41c 100644 --- a/.github/workflows/trufflehog.yml +++ b/.github/workflows/trufflehog.yml @@ -53,7 +53,7 @@ jobs: with: path: ./ # Scan the entire repository base: "${{ github.event.repository.default_branch }}" # Set base branch for comparison (pull requests) - extra_args: --filter-entropy=4 --results=verified,unknown --debug + extra_args: --filter-entropy=4 --results=verified,unknown --debug --only-verified - name: Scan Results Status if: steps.trufflehog.outcome == 'failure' diff --git a/README.md b/README.md index 7584ecbd2a0..c7a195afe5e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Eclipse-tractusx website +# Eclipse Tractus-X website This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. @@ -27,14 +27,14 @@ You can also run the linting step manually by running `npm run lint-doc` or `npm ## 3rd Party dependency checks -This repository enforces licence compatibility checks on all Pull Requests. This is demanded by [TRG 7.04](https://eclipse-tractusx.github.io/docs/release/trg-7/trg-7-04#checking-libraries-using-the-eclipse-dash-license-tool). +This repository enforces license compatibility checks on all Pull Requests. This is demanded by [TRG 7.04](https://eclipse-tractusx.github.io/docs/release/trg-7/trg-7-04#checking-libraries-using-the-eclipse-dash-license-tool). Follow these steps if your PR's workflow fails on the action `3rd Party dependency check (Eclipse Dash)`: 1. Make sure the error-message is not `[main] ERROR Error response from XYZ HTTP 524` or anything else pointing to failures in remote services. If that happens, try again tomorrow. If not, continue. 2. Have java installed. Check by executing `java --version` in your bash terminal. For Windows Powershell or command prompt, this and the following commands may look different but should follow the same structure. -3. Download the jar of the dash licence tool's latest release (for instance [distributed via eclipse](https://repo.eclipse.org/content/repositories/dash-licenses/org/eclipse/dash/org.eclipse.dash.licenses/)). +3. Download the jar of the dash license tool's latest release (for instance [distributed via eclipse](https://repo.eclipse.org/content/repositories/dash-licenses/org/eclipse/dash/org.eclipse.dash.licenses/)). 4. Move the file into the top level folder of this repository. Do not add it to git or commit it. 5. Navigate your terminal to the top level folder of this project (eclipse-tractusx.github.io). 6. Execute `java -jar ./org.eclipse.dash.licenses-1.1.0.jar package-lock.json -project automotive.tractusx -summary ./DEPENDENCIES` diff --git a/community/open-meetings.mdx b/community/open-meetings.mdx index 85636af3402..9026a1f1fc6 100644 --- a/community/open-meetings.mdx +++ b/community/open-meetings.mdx @@ -94,3 +94,15 @@ All the times are shown in: /> ## One-time meetings + + diff --git a/docs-kits/kits/Circularity_KIT/page-adoption-view.md b/docs-kits/kits/Circularity_KIT/page-adoption-view.md index 763c4c0aac7..46ab3104ab7 100644 --- a/docs-kits/kits/Circularity_KIT/page-adoption-view.md +++ b/docs-kits/kits/Circularity_KIT/page-adoption-view.md @@ -2,7 +2,7 @@ title: Adoption View --- -![Circulairty Kit banner](/img/kit-icons/circularity-kit-icon.svg) +![Circulairty Kit Banner](/img/kit-icons/circularity-kit-icon.svg) ## Circularity KIT @@ -12,7 +12,7 @@ title: Adoption View The Circularity KIT shall empower stakeholders to transition towards a circular economy by providing frameworks, guidelines and best practices to enhance sustainability credentials, enable data-driven decision-making and foster collaboration and innovation in the automotive industry. -Secondary material content, **material** accounting, dismantling services, the CE-Assistant, and the secondary marketplace are the five focus topics that form the Circularity KIT as of now. The offered content and artifacts address important use cases such as sustainable materials management, waste minimization and resource efficiency, that contribute to more sustainable and circular automotive value loops. +Secondary material content, material accounting, dismantling services, the CE Assistant, and the secondary marketplace are the five focus topics that form the Circularity KIT as of now. The offered content and artifacts address important use cases such as sustainable materials management, waste minimization and resource efficiency, that contribute to more sustainable and circular automotive value loops. The overarching goals of the Circularity KIT, therefore, are to: @@ -32,7 +32,7 @@ The Circularity KIT serves as a practical set of tools, guidelines, and best pra In a world facing increasing environmental pressures and resource scarcity, transitioning to a circular economy is crucial. This approach ensures responsible resource management through R-strategies, secondary material quotas, material accounting, and optimized end-of-life processes. By closing the loop on material flows, we can reduce our environmental impact, drive innovation, and create economic opportunities that secure a sustainable future. -The KIT entails a description of the overall business value, use case context, an introduction to the subtopics secondary material content, material accounting, dismantling services, CE-Assistant as well as a circularity glossary and is complemented by user journeys, business processes, calculation frameworks, interoperable data models and standards needed to adopt the Catena-X circularity focus topics. +The KIT entails a description of the overall business value, use case context, an introduction to the subtopics secondary material content, material accounting, dismantling services, CE Assistant as well as a circularity glossary and is complemented by user journeys, business processes, calculation frameworks, interoperable data models and standards needed to adopt the Catena-X circularity focus topics. All described specifications in the KIT are based on Catena-X standards like Asset Administration Shell, SSI and a decentral Digital Twin Registry. They refer to other Catena-X KITs like the Traceability KIT to ensure interoperability and data sovereignty according to IDSA and Gaia-X principles. @@ -40,26 +40,34 @@ All described specifications in the KIT are based on Catena-X standards like Ass The Circularity KIT provides business opportunities for service providers in various ways: -1. **Unified Circular Economy Framework:** Service providers can leverage a comprehensive and standardized framework for implementing circular economy principles in the automotive industry. This unified approach simplifies integration and collaboration with other stakeholders, reducing investment costs and accelerating the development and deployment of innovative solutions. -2. **Access to New Market Opportunities:** The KIT enables service providers to tap into emerging market opportunities driven by the increasing demand for sustainable solutions. By offering tailored services on the Catena-X marketplace, service providers can scale their customer base, expand their reach, and unlock new revenue streams. -3. **Enhanced Sustainability Credentials:** By aligning with the principles of the Circularity KIT, service providers can demonstrate their commitment to sustainability and strengthen their reputation in the market. This commitment can lead to increased customer trust, better brand positioning, and a competitive advantage in the Catena-X network. -4. **Data-Driven Decision Making:** The Circularity KIT promotes data-driven decision making by offering access to material accounting data and insights into end-of-life processes within the automotive industry. Service providers can use this data to develop targeted solutions, optimize their offerings, and drive continuous improvement in their services. -5. **Collaboration and Innovation:** By using the Circularity KIT, service providers can actively participate in a network of automotive industry stakeholders committed to fostering a circular economy. This collaborative environment enables the exchange of ideas, knowledge, and best practices, driving innovation and enhancing the overall value of solutions offered in the Catena-X marketplace. +1. **Unified Circular Economy Framework**: Service providers can leverage a comprehensive and standardized framework for implementing circular economy principles in the automotive industry. This unified approach simplifies integration and collaboration with other stakeholders, reducing investment costs and accelerating the development and deployment of innovative solutions. +2. **Access to New Market Opportunities**: The KIT enables service providers to tap into emerging market opportunities driven by the increasing demand for sustainable solutions. By offering tailored services on the Catena-X marketplace, service providers can scale their customer base, expand their reach, and unlock new revenue streams. +3. **Enhanced Sustainability Credentials**: By aligning with the principles of the Circularity KIT, service providers can demonstrate their commitment to sustainability and strengthen their reputation in the market. This commitment can lead to increased customer trust, better brand positioning, and a competitive advantage in the Catena-X network. +4. **Data-Driven Decision Making**: The Circularity KIT promotes data-driven decision making by offering access to material accounting data and insights into end-of-life processes within the automotive industry. Service providers can use this data to develop targeted solutions, optimize their offerings, and drive continuous improvement in their services. +5. **Collaboration and Innovation**: By using the Circularity KIT, service providers can actively participate in a network of automotive industry stakeholders committed to fostering a circular economy. This collaborative environment enables the exchange of ideas, knowledge, and best practices, driving innovation and enhancing the overall value of solutions offered in the Catena-X marketplace. #### Circularity KIT Wheel In its first version the KIT covers 5 focus topics along an automotive value loop. -1. **Secondary Material Content:** promotes the use of secondary materials in the automotive industry by providing a standardized data model for data exchange and a calculation framework. -2. **Material Accounting:** provides standardized scrap/waste and secondary material data exchange for the ecosystem partners to create transparency about recycling activities and verifiable closed loops. -3. **EoL / Dismantling Services:** offers essential support for the digitalization and automation of the EoL phase to consequently close value loops. -4. **CE-Assistant (Circular Strategy Assistant):** is a decision support system that facilitates the selection of the optimal R-Strategy for end-of-life vehicles, with a focus on Reuse, Remanufacturing, Recycling, and Recovery, guided by a comprehensive technical and environmental assessment process. -5. **Secondary Marketplace:** buying and selling used components and secondary raw materials in order to create and open new opportunities for collaborating across the value chain and closing the loop on component and material level. +1. **EoL / Dismantling Services:** offers essential support for the digitalization and automation of the EoL phase to consequently close value loops. +2. **CE Assistant (Circular Economy strategy Assistant):** is a decision support system that facilitates the selection of the optimal R-Strategy for end-of-life vehicles, with a focus on Reuse, Remanufacturing, Recycling, and Recovery, guided by a comprehensive technical and environmental assessment process. +3. **Secondary Marketplace:** buying and selling used components and secondary raw materials in order to create and open new opportunities for collaborating across the value chain and closing the loop on component and material level. +4. **Material Accounting:** provides standardized scrap/waste and secondary material data exchange for the ecosystem partners to create transparency about recycling activities and verifiable closed loops. +5. **Secondary Material Content:** promotes the use of secondary materials in the automotive industry by providing a standardized data model for data exchange and a calculation framework. ##### Figure 1 ![Circularity KIT Wheel](resources/adoption-view/circularity_kit_wheel.svg) +#### End-to-end User Journey + +The following user journey of the Circularity KIT provides an end-to-end overview of the focus topics, connecting the circular flow of vehicles, components, and materials with the Catena-X solutions developed within this domain. + +##### Figure 2 + +![End-to-end User Journey - Circularity KIT](resources/adoption-view/Circularity_KIT_user_journey.svg) + ### Use Case / Domain Explanation Status Quo / Today's challenge: The automotive industry is one of the largest consumers of raw materials, including metals, plastics, and textiles. Managing these materials sustainably and efficiently is a significant challenge, with an increasing focus on reducing waste, improving recyclability, and ensuring responsible sourcing. Traditional linear models of material consumption led to resource depletion, environmental degradation, and missed economic opportunities. @@ -89,6 +97,248 @@ The following whitepaper addresses the data parameters required to enable disman Addressing the challenging task of closing the loop for materials from an end-of-life vehicle to a new car component of a modern vehicle, has been attempted within the recycling working group, initially focusing on a few promising components and materials, but with the clear perspective to extend to more materials and their data requirements in further iterations and subsequent refinement of data models. Status of the whitepaper and its addressed examples can be found here: [Data requirements for recycling of ELVs](https://catena-x.net/fileadmin/user_upload/Publikationen_und_WhitePaper_des_Vereins/2407_Material_Recycling_WP_v1.pdf). +#### Closing Loops, Preserving Resources: Creating tomorrow's EoL landscape and empower the circularity + +As part of the Circularity KIT, we are committed to developing services for the future of the circular economy in the end-of-life (EoL) sector of vehicles. This phase represents an important stage where decisions are made regarding the fate of vehicles and their components after their initial use. Recognizing the immense value of the world's limited resources, we are dedicated to minimizing waste and maximizing resource efficiency. + +One of our key strategies involves creating a framework for an improved communication among all stakeholders involved in the EoL phase. This collaborative approach allows us to consider the needs and requirements of all participants, facilitating the collection and exchange of essential information. Importantly, we view the end of a vehicle's life as the beginning of a new one in the context of resource conservation. + +Our overarching vision is to create a landscape that closes loops and preserves resources, ultimately empowering circularity in the industry. We aspire to provide digitized and scalable EoL services that align with circular economy principles and prioritize the preservation of components and materials. Simultaneously, we are committed to follow present and future changes in laws and regulations, which emphasizes environmentally friendly vehicle disposal and the recovery of critical raw materials (CRMs), aligning with the growing demand for closing component and material loops. + +Our mission centres on empowering EoL and maintenance stakeholders by fostering continuous collaboration within the Catena-X Network and beyond. Through the Circularity KIT working group, we aim to develop and align various means, including data, business, and network models, to empower all stakeholders involved in the EoL phase. This mission is closely tied to our vision of promoting digitized and scalable end-of-life services across the industry while upholding the principles of circular economy. + +Our strategy for achieving these goals involves several key steps. Firstly, we aim to enable EoL service models through data sharing based on digital twins (DT). This approach allows for efficient information sharing in an interoperable, standardized manner, which, in turn, supports dismantling and recycling operations. Furthermore, we are actively engaging with all relevant stakeholders, including policymakers, product designers (for circularity), and EoL service providers, to promote new "R-approaches" and facilitate their implementation. + +Ultimately, our efforts provide essential support for the digitalization and automation of the EoL phase, with the ultimate goal of closing loops in the automotive sector. Through these digitized and scalable EoL services, we aim to contribute significantly to sustainable development and resource conservation, aligning with the principles of the circular economy. + +### Business Context for End-of-Life + +#### Data Journey "End-of-Life" + +The "Data Journey" represents the entire process of dismantling an End-of-Life (EoL) vehicle. Each process step is accompanied by CX data models that would be necessary for digitally representing the individual process steps. This enables us to elevate the data journey for the dismantling process to a digital level and to gain an understanding of which data attributes and aspect models are required for each process step. It forms the foundation for the creation of digital EoL-solutions and the use of robotics. + +##### Figure 3 End-of-Life + +##### 3.1 + +![Data Journey - End fo Life 1](resources/adoption-view/figure_dataJourney_EOF1.svg) + +##### 3.2 + +![Data Journey - End fo Life 2](resources/adoption-view/figure_dataJourney_EOF2.svg) + +##### 3.3 + +![Data Journey - End fo Life 3](resources/adoption-view/figure_dataJourney_EOF3.svg) + +##### 3.4 + +![Data Journey - End fo Life 4](resources/adoption-view/figure_dataJourney_EOF4.svg) + +Future additions include data models for the following topics: + +- Decommissioning Certificate +- Material for Recycling +- Adress Aspects +- ID Conversion +- Certificate of Dismantler +- Diagnostic Data +- Physical dimensions +- Mandatory dismantling +- Demand request +- Compatibility of components/ Design changes history +- Quality issue history +- Technical drawings & specifications +- PCF Information + +#### User Journey "Certificate of Decomissioning" + +The user journey "Certificate of Decommissioning" (CoDM) describes the moment at which a vehicle is transferred into the End-of-Life (EoL) phase from the perspective of an authorized collection point for EoL-vehicles, such as an authorized dismantling facility. The CoDM resembles the official Certificate of Destruction (CoD) but marks the starting point of the upcoming CX concept of a digital CoD. + +##### Figure 4 + +![User Journey CODM](resources/adoption-view/figure_user_journey_codm.svg) + +##### Data Model and GitHub + +The relevant data model can be found on the following link on GitHub: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.decomissioning_certificate/1.0.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.decomissioning_certificate/1.0.0) + +The open availability on GitHub allows companies to combine their own internal target guidance programs with the data models from Catena-X to the EoL-Services. + +## CE Assistant + +### Introduction + +#### Empowering circular economy decisions: Introducing the CE Assistant + +In the dynamic landscape of sustainability and resource conservation, the Circular Economy strategy Assistant (CE Assistant) provides decision support for the selection of strategies concerning end-of-life vehicles. The core task of the CE-Assistant is to evaluate and select an R-Strategy - namely Reuse, Remanufacturing, Recycling, and Recovery. + +Based on the principles of Catena-X, the CE Assistant is aligned with a comprehensive assessment process that guides its functionality. This process is anchored in the Catena-X Digital Twin Framework, which combines the virtual representation and real-world insights. + +The CE Assistant; a set of standards, aspect models, APIs, system architectures, and decision logics; fosters the development of data-centric, Catena-X compliant decision support system for circular economy strategies. The core circularity lies in the flow of technical information in a collaborative effort involving entities across the automotive value chain. + +The concept of a Digital Twin (DT) builds the basis by providing a holistic virtual counterpart of products. The DT includes a set of unique identifiers, an evolving spectrum of aspects, connections to multiple data sources, and the capacity to track the entire lifecycle of assets and capture both individual and fleet-level knowledge. + +In accordance with IDSA and Gaia-X principles, interconnectivity and data sovereignty, the CE-Assistant bases on the principles of interoperability, realized by the Connector KIT (EDC) and Data Chain KIT (Item Relation Ship, IRS). + +The selection of circular economy strategies requires a comprehensive evaluation of emissions, natural resource preservation, energy management, and waste reduction. However, the effectiveness of such evaluations depends on access to detailed data covering the vehicle’s history, components, materials, and condition + +This is where the CE Assistant can help by supporting a user-centered approach that bridges the gap between data availability and informed decision-making. By offering transparency into the environmental implications of diverse circular economy strategies, the CE Assistant facilitates a faster, information based, and efficient decision rooted in the digital twin's insights. + +### Business Context + +The CE Assistant provides decision support and circular strategies, enabling several key features for businesses: + +1. **Component-level decision support:** The KIT provides decision support for selecting circular strategies at the component level. +2. **Efficient data-driven decisions:** Users can make faster and more efficient decisions based on data analysis. +3. **Enhanced circularity:** The KIT contributes to increasing the circularity of products and meeting reuse quotas. +4. **Sustainability milestones:** It helps achieve sustainability indicators and goals. +5. **Transparency on secondary materials:** The KIT offers transparency regarding the availability of secondary materials. +6. **Streamlined vehicle dismantling:** It optimizes the process of vehicle dismantling for improved resource recovery. + +### User Journey and Architecture Overview + +The user journey describes the system interaction of the CE Assistant with the user, the dismantling lead, with the aim of providing a recommendation for a component-level circular strategy for end-of-life vehicles. This involves breaking down the process of holistic decision-making into individual process steps and identifying the interaction with the user/system at each process step. + +#### Figure 5 + +![User Journey - CE Assistant ](resources/adoption-view/CE_assistant_user_journey.svg) + +The following figure shows how the CE Assistant is embedded in the overall architecture: + +##### Figure 6 + +![Architecture View - CE Assistant ](resources/adoption-view/CE_assistant_architecture_view.svg) + +### Logic / Schema + +To assess the appropriate R-Strategy for individual components, it's essential to have various types of EoL data available at different decision-making stages within the logic. This involves distinguishing between process-related, product type-specific, and instance-specific information. + +Process-related data encompasses details derived from the processes and operations of the executing company, such as the CO2 footprint of processes, energy consumption, and waste streams. Product type-specific data is rooted in the planning and development phase of the evaluated component and is influenced by the vehicle type and its design. This category includes information like weight, dimensions, installation requirements, and the bill of materials as built. Instance-specific data reflects the usage and maintenance conditions of individual components (e.g. mileage, quality status). This information is collected throughout the product's lifecycle using DT technology. + +The decision support regarding the best R-Strategy is a multi-stage process, starting with the logic for the technical feasibility assessment. Because only when the R-Strategy is technically feasible, it must be checked for other indicators afterwards. + +The outcome of the technical feasibility assessment will be analyzed to determine if an R-Strategy has to be excluded at the beginning based on regulatory requirements regarding an R-Strategy or a defect in functionality of specific components. + +As shown in Figure 7, the process is started by entering the vehicle identification number (VIN) into the system, thereby requesting the corresponding Catena-X data. The registered companies in the Catena-X network act as data providers for this vehicle-specific data, as they register respective assets and sub-models. Catena-X Shared Services handle existing data models, contracts, usage and access control policies, and ultimately the final data exchange. + +The system presents the information, such as corresponding vehicle, component and material based on DT data. This data is provided for the first overall manual inspection and evaluation. After that, the user selects the most relevant components for the R-Strategy decision. The decision logic is applied for this component and the possible R-Strategies are identified. + +The following criteria are evaluated in a chronological order: the basic reuse-potential, material composition and remaining lifetime in comparison with the specific thresholds and the disassembly capability. + +If one or more of these criteria are not fulfilled, the component will only be assigned to recovery or recycling. If the component qualifies for disassembly, a manual visual inspection and a functional check are conducted. For components, where the visual condition is relevant, such as body parts and interior components, the visual inspection is conducted first. In contrast, components, for which the technical condition is of significant relevance, such as engines and gearboxes, are first subjected to a functional test. Here, the data can also be provided in the Catena-X network as an update of the DT. Thereafter, a quality comparison of the component condition with threshold values takes place. When the quality is insufficient for reuse, the technical check for remanufacturing is carried out chronologically: assemblability, cleanability and restorability / upgradability. Finally, a possible strategy is given to the user as an intermediate result before further environmental assessment. + +#### Figure 7 + +![Decision logic regarding technical feasibility](resources/adoption-view/CE_assistant_technical_feasibility_logic.svg) + +After assessing the technical feasibility, the environmental impact of the previously selected component is calculated and evaluated using the Life Cycle Assessment (LCA) methodology, following ISO 14040 and ISO 14044 standards. R-strategies that are not technically feasible are excluded from the subsequent decision logic, as depicted in Figure 8. + +First, to obtain LCA-relevant activity data for EoL processes, process-related data of the dismantling and different R-Strategy processes needs to be entered into the decision support system by the user or retrieved from internal or external data collections. Examples for essential process-related data are: Use of process flows, operating resources, such as energy and material consumption, and location factors (e.g. distance to the nearest remanufacturer). + +With the help of the process-related data in combination with product type-specific data requested from the Catena-X network, a subsequent input and output analysis of the dismantling process and remaining R-strategies leads to the collection of parameters in a Life Cycle Inventory (LCI): material consumption, energy consumption (electricity and fuels) and direct emission release (e.g. in CO2, SO2, NOx). Life Cycle Impact Assessment (LCIA) methods are then used to transfer the LCI results into a quantifiable environmental impact, such as global warming potential, of the corresponding R-Strategy in addition to the previous dismantling. To note that the resulting impact values are a pure process view of the EoL, the intermediate results are referred to as "relative total environmental impact" of the assessed R-strategies. + +In order to decide for the best R-Strategy, the respective R-Strategy can be compared with each other and a comparison with production can also be made. + +Finally, all absolute environmental impacts of the R-strategies are compared, and the most environmentally friendly strategy is recommended as a decision support for the dismantling lead. Moreover, the results of the CE Assistant can also be made available to other stakeholders via the Catena-X network to enable, for example, feedback-to-design for product development. + +In the future research, consideration should also be given to the extent to which the use of a reused or remanufactured component causes emissions compared to a new component. Modern technological components can achieve a much higher level of efficiency in use, so that despite high emissions, it may make more sense to produce a new component than to extend the life cycle of the old component, which may have a significantly higher utilization cost. + +##### Figure 8 + +![Decision logic regarding environmental assessment](resources/adoption-view/CE_assistant_environmental_assessment.svg) + +### Whitepapers + +If you are eager to dive deeper into the world of the CE Assistant, including its data provision via the Digital Twin and expert insights on technically feasible circular strategies and environmentally friendly choices, we invite you to explore our informative publications. + +#### End-of-life decision support to enable circular economy in the automotive industry based on digital twin data + +- **Abstract**: With the EU Green Deal and the UN Sustainable Developments Goals, the vision of a greenhouse gas-neutral and resource-efficient economy is already firmly anchored in world politics. In this context, the automotive industry faces many challenges including the increasing scarcity of natural resources, a rising demand in terms of sustainable vehicle design, production and materials sourcing. Due to all this, end-of-life decisions regarding dismantling have become increasingly important. A high proportion of secondary materials will be required in the vehicles of the future. To response to these challenges, companies have turned their focus towards the circular economy as a central approach to close material loops. In the German research project “Catena-X” a new data ecosystem with digital twins is one enabler that is being developed. The digital twins represent a promising approach to the circular economy by ensuring transparent, product-specific and end-to-end data exchange throughout the entire product lifecycle, from the material sourcing to the eventual dismantling and recycling. As one particular and unique solution, a decision framework that facilitates the best circular strategy at the end of a vehicle's life is developed and presented in this paper. The underlying data-driven decision support framework is based on circular economy KPIs. This includes material, components and specific vehicle KPIs to best identify the most suitable circular strategy. The framework was methodologically developed by an interdisciplinary team of partners, who are stakeholders throughout the value chain and participants in the Catena-X project. An integrated approach of user-centered design, an adapted version of the V-model and the Scaled Agile Framework were used for the methodology in the development of the solution. The paper presents the concept of a digital twin for a decision support system, that includes a central decision logic that also includes the relevant KPIs and a survey for evaluating the decision logic utilized with a chosen dismantling company. +- **Link**: [End-of-life decision support to enable circular economy in the automotive industry based on digital twin data - ScienceDirect](https://www.sciencedirect.com/science/article/pii/S2212827123006091) + +##### Empowering End-of-Life Vehicle Decision Making with Cross-Company Data Exchange and Data Sovereignty via Catena-X + +- **Abstract:** The mobility sector is the world’s second-largest producer of energy-related CO2 emissions, and it is facing a global resource shortage. The demand for circular products, the use of secondary materials in future vehicles, and the need for sustainable business models in the mobility sector is increasing. However, a transparent and end-to-end data exchange throughout the entire value network is missing, which is hindering an efficient circular economy. Relevant information on the vehicle, its components and materials at the end of the product life cycle are often missing. In this context, this paper presents a decision support system based on Digital Twin data for a circular economy solution as a software application. It was developed within the German research project Catena-X following an integrated approach of user-centered design, the V-model, and within the Scaled Agile Framework. By combining these methodological approaches, customer-oriented solutions were developed and continuously improved at each stage of development to shorten the time-to-market. Catena-X is based on Gaia-X principles. In Gaia-X, necessary core services are developed, and contraction negotiation for data exchange and usage policies is enabled and implemented. The decision support system provides important information about the exact composition and condition of the vehicle, its components, and its materials. Thus, it helps to improve efficiency, sustainability, and the implementation of the circular economy. The decision support system was tested and validated with a use case that provided Digital Twin data on the end-of-life vehicle. +- **Link**: [Sustainability | Free Full-Text | Empowering End-of-Life Vehicle Decision Making with Cross-Company Data Exchange and Data Sovereignty via Catena-X (mdpi.com)](https://www.mdpi.com/2071-1050/15/9/7187) + +##### Digital Twins for Circular Economy - Enabling Decision Support for R-Strategies + +- **Abstract:** Digital twins (DT) for circular economy (CE) offer a promising approach as part of digital data ecosystems for more sustainable value creation. By mapping and analyzing product, component and material specific data along the lifecycle, it is possible to address current challenges such as climate change and resource scarcity. Within Catena-X, specific solutions based on this cross-company exchanged data and information are developed. Here, the “CE-Assistant” is presented. It is an application, which identifies the best CE Strategy based on DT data at the end of a vehicle's life. +- **Link:** [OA_Mügge_6-2022 | INDUSTRIE-MANAGEMENT](https://www.industrie-management.de/node/556) + +##### Digital Twins within the Circular Economy: Literature Review and Concept Presentation + +- **Abstract:** Digital twins offer a promising approach to sustainable value creation by providing specific life cycle data and enabling the monitoring and implementation of circular economy strategies throughout the product’s life cycle. By analyzing product, component, and material data, as well as process data, it is possible to create transparency throughout a product’s life cycle, build a data-driven product ecosystem, and establish new business and value creation models, from SMEs to large enterprises. This paper identifies application scenarios, their technological readiness level, and the challenges of digital twins for the circular economy in the manufacturing industry based on a systematic literature review. Gaps such as ensuring a continuous flow of information and taking into account the different levels of digitalization of companies are identified. As a main result, a holistic concept for the scoping of a digital twin for the circular economy is presented. One specific use case for end-of-life decision-making is elaborated upon. It is shown that the circular economy can be supported by digital twin data, especially for the optimal decision on end-of-life vehicles. +- **Link:** [https://www.mdpi.com/2071-1050/16/7/2748](https://www.mdpi.com/2071-1050/16/7/2748) + +## Secondary Marketplace + +### Introduction + +A secondary marketplace is fundamental to establish a circular economy where components and materials are available and offered to the interested users creating new value chains and extending the life of the parts and the materials before becoming waste. Digital platforms offering marketplace services are essential to enable trading of secondary materials and components, provide transparency into supply and demand that potential buyers and sellers can expect. + +The main goals of the Marketplace are: (1) to match the demand and the supply of available components and secondary raw materials and (2) to provide transparency on sales opportunities for used components which can be, for example, reused or re-manufactured. + +If offered, additional services such as grading, certifications for the offered listings (components or secondary materials) and transport handling and logistics could support trading processes. + +### Business Context + +A secondary marketplace enables closing the loop on economical and physical layers. Following the logic described in the previous chapter, there could be multiple scenarios related to R-strategies on how secondary marketplaces enable a circular economy. + +Potential sales scenarios: + +- Dismantling companies selling old components and material/scrap; +- Automotive manufacturers selling old unused components; +- Automotive manufacturers selling production waste and scrap; +- and others. + +Potential purchase scenarios: + +- Automotive companies buying components for re-manufacturing; +- Workshops buying components for re-use; +- Recyclers buying production waste and scrap; +- and others. + +In all of those cases, having additional information (e.g. product carbon footprint or digital product passport details) on the products offered on the marketplace is beneficial. + +### User Journey and Architecture Overview + +In general, there are several goals that buyers and sellers pursue on a secondary marketplace: + +- As a (Core) Purchaser, I want to search and filter for market supply on OE number level to match the market offers towards my demand. +- As a (Core) Purchaser, I want to reach as many possible sellers as possible to purchase parts that I cannot procure today. This includes brokers I don't buy from today. +- As a (Core) Seller, I want to place offers on the marketplace with standard upload tools and manually. +- As a (Core) Seller, I want to reach as many possible customers as possible to maximize my turnover. This includes customers I don't sell to today. + +The key user journey relevant in Catena-X circular economy area relates to the need of a buyer to have full reliable information on a product that he is intending to purchase. This is especially important given that many buyers are looking for parts for re-manufacturing or re-use, where product quality plays a vital role. Furthermore, in case of recycling, recyclers are interested to know material composition and additional information that would influence their purchasing decision. + +Some information could be provided by a variety of data models, but the highest value lies within the generic digital product passport (and by extension, battery passport, sealant passport, transmission passport). When a seller is publishing a listing with a product that he is willing to sell, there is only a limited amount of information he can provide with it, mostly the one available from the visual inspection or on-board data (such as mileage, OE-number, brand) as well as logistical/ sales information (such as location or price). When a potential buyer views the listing, he should have a possibility to request additional details from a data provider of the generic digital product passport (if available) for that product (see diagram below). More information on the digital product passport can be found in the [Ecopass KIT](https://eclipse-tractusx.github.io/docs-kits/kits/Eco_Pass_KIT/page-adoption-view/). + +#### Figure 9 + +![User Journey - Secondary Marketplace](resources/adoption-view/user_journey_secondary_marketplace.svg) + +This process is reflected in the architecture for communicating with the Catena-X network and data providers of the battery passport data model, as presented below. + +#### Figure 10 + +![Communication Architecture](resources/adoption-view/communication_architecture.svg) + +When it comes to the data exchange schema and other details, see the [Triangle for Secondary Marketplace](https://catena-x.net/de/standard-library) document for more information on how such a request could be realized within Catena-X environment and according to applicable guidelines (e.g. on interoperability and data sovereignty). In a decentral environment, such attributes as manufacturer part ID and OE number play a vital role in order to get access to the right component and the right data model at data provider’s side. + +### Semantic Models + +In the following, relevant semantic models for the secondary marketplace are listed. For further information about the listed data models please refer to the Catena-X standards library for the respective data model, marked as “CX-“, which contains the standardized data models with further descriptions and explanations. The standards library can be founded here: [Catena-X Standard-Library](https://catena-x.net/de/standard-library) + +The Marketplace Offer is an aspect model that is complementary to the concept of a secondary marketplace. It described a product (e.g. a used, dismantled component) that is placed for sale onto the marketplace, with key supporting information such as quantity, quality, or price. It provides essential information for potential buyers and could be used in the future to exchange product information between multiple marketplaces. This model can therefore be used to exchange offers between multiple marketplaces. As there is no exchange scenario defined yet, the Marketplace Offer is a recommendation and non-normative, since it is so far concerning the business application-internal data structure only. More information on this aspect model can be found under CX-0035 in the standards library or under the following link: [Marketplace Offer](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.market_place_offer) + +Additionally, two other aspect models could play a supporting role for secondary marketplaces. + +The Return Request aspect model could be used to flag a vehicle or product to indicate that there is a demand or a request for return. It specifies the aspect of the recall of a vehicle part and thus provides the information whether and why a return request exists for a product. More information on this aspect model can be found under CX-0033 in the standards library or under the following link: [Return Request](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.return_request) + +The Product Passport aspect model could provide reliable details on the product characteristics or lifecycle information, therefore complementing the basic Marketplace Offer information. More information on this aspect model can be found under CX-0103 in the standards library or under the following link: [Digital Product Passport](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.generic.digital_product_passport) + ## Material Accounting ### Introduction @@ -105,7 +355,7 @@ To realize this ambition, a standardized framework is imperative, one that facil The image below shows the big picture of a circular economy when material is tracked over its complete life cycle excluding the usage phase. -##### Figure 2 +##### Figure 11 ![Overview Material flow](resources/adoption-view/overview_material_flow.svg) @@ -118,7 +368,7 @@ From a business perspective, the material accounting KIT is characterized by the 3. **Increased Material Recycling:** The KIT promotes the recycling of materials within the same industry, increasing sustainability. 4. **Transparency:** It provides higher transparency regarding the availability of secondary materials. -### Use Case / Domain Explanation +### Use Case / Domain #### Material Accounting in Catena-X @@ -126,7 +376,7 @@ Catena-X offers a decentral, sovereign, cross-organizational data exchange. For The goal of the Material Accounting Feature inside the Catena-X consortium and association is to collaborate on exchanging standardized secondary material information across the upstream & downstream value in order to develop a standardized data model. To do so, we identified potential data points along a closed loop with OEM, recycler and supplier as stakeholders as seen in the picture below. Further feature content will follow in upcoming versions of the Circularity KIT. -##### Figure 3 +##### Figure 12 ![Data Points along the Value Chain](resources/adoption-view/datapoints_along_valuechain.svg) @@ -150,7 +400,7 @@ The secondary material content chapter of the Circularity KIT explores how the s This user journey illustrates the data exchange process through Catena-X in the context of secondary material content. The user journey outlines the various stakeholders along the value chain and within the individual tiers and their involvement. -##### Figure 4 +##### Figure 13 ![User Journey - SMC](resources/adoption-view/userJourney_smc.svg) @@ -167,7 +417,7 @@ The user journey follows the same process during all four lifecycle stages and d There are different scenarios in which SMC Data can be exchanged. According to the semantic model framework, this implies that there is a specific data model for each purpose (scenario). -_To ensure efficiency by avoiding redundancy and maintaining multiple data models, the concept of a shared aspect model was used: This means that there is one Secondary Material “base model”, which is the SecondaryMaterialContent. This serves as an enabler for data modelling and not for data exchange itself, it is bad practice to use it for data exchange._ +_In order to ensure efficiency by avoiding redundancy and maintaining multiple data models, the concept of a shared aspect model was used: This means that there is one Secondary Material “base model”, which is the SecondaryMaterialContent. This serves as an enabler for data modelling and not for data exchange itself, it is bad practice to use it for data exchange._ Instead, SecondaryMaterialContentCalculated or SecondaryMaterialContentVerifiable should be used when exchanging SMC data, depending on the actual scenario. @@ -181,7 +431,7 @@ In the table below, different scenarios are described to clarify which data mode | Prognosis-based SMC data exchange | In this scenario, SMC data is exchanged based on a prediction or forecast of future events in the automotive sector. | When the production of a previously produced car is continued, a prognosis of the SMC is made based on the previous production. | [SecondaryMaterialContentCalculated](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.secondary_material_content_calculated) | | Measured-information-based SMC data exchange | In this scenario, the SMC data that is exchanged is based on actual measured information and data. The relevant data is therefore verifiable. | During the production of a component, the order information of the used material clearly indicates the SMC of the used materials. | [SecondaryMaterialContentVerifiable](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.secondary_material_content_verifiable) | -#### Figure 5 +#### Figure 14 ![Depiction of SMC Data Models - SMC](resources/adoption-view/depiction_of_smc_data_models.svg) @@ -206,11 +456,11 @@ In addition to filling out the data model for Secondary Material Content, other #### 1. Material -The Model is designed to address the material at the lowest level requiring descriptive information, such as the material name in accordance with a standardized format, as well as the name and code of the referenced standard _(materialNameStandardizedValue; referencedStandard; referencedStandardID)._ For example, a material name may be given based on the ISO 1043 standard, in which case ISO would be the referenced standard and ‘1043’ the referenced standard ID. The material class _(materialClass)_ must be provided in accordance with the VDA standard 231-106. To provide relevant data regarding the material mass per declared unit of the material, the unit of measure, such as gram or kilogram _(unitOfMeasureKey)_, must first be defined. Next, the gross material input weight _(grossMaterialInputMass)_ as well as the net mass of the material _(materialNetMass)_ shall be provided. +The Model is designed to address the material at the lowest level requiring descriptive information, such as the material name in accordance with a standardized format, as well as the name and code of the referenced standard _(materialNameStandardizedValue; referencedStandard; referencedStandardID)_. For example, a material name may be given based on the ISO 1043 standard, in which case ISO would be the referenced standard and ‘1043’ the referenced standard ID. The material class _(materialClass)_ must be provided in accordance with the VDA standard 231-106. To provide relevant data regarding the material mass per declared unit of the material, the unit of measure, such as gram or kilogram _(unitOfMeasureKey)_, must first be defined. Next, the gross material input weight _(grossMaterialInputMass)_ as well as the net mass of the material _(materialNetMass)_ shall be provided. -Essential material characteristics that are mandatory within the data model include the use of bio-based materials and their material class _(bioBasedClass)_, as well as the percentage of material weight of each primary and secondary bio-based material _(primaryBioBased; secondaryBioBased)._ For secondary bio-based material it can be chosen whether a mass balancing approach was followed or not _(isMassBalanced)_. Further information on mass-balancing can be found under [_B. Accounting for chain of custody models_](#b-chain-of-custody-models). +Essential material characteristics that are mandatory within the data model include the use of bio-based materials and their material class _(bioBasedClass)_, as well as the percentage of material weight of each primary and secondary bio-based material _(primaryBioBased; secondaryBioBased)_. For secondary bio-based material it can be chosen whether a mass balancing approach was followed or not _(isMassBalanced)_. Further information on mass-balancing can be found under [_B. Accounting for chain of custody models_](#b-accounting-for-chain-of-custody-models). -Further, information regarding inorganic/fossil-based materials is required. The percentage of primary inorganic/fossil-based material weight _(percentageOfMaterialWeight)_ shall be provided. When it comes to secondary material, the percentage of material weight of chemically and mechanically recycled pre-consumer and post-consumer material according to ISO 14021 should be included _(percentageOfMaterialWeight)_. Post-Consumer material is divided into two streams: Post consumer material from end-of-life vehicles as well as post consumer from other sources. When chemical or mechanical recycling has been applied, it is important to disclose information whether a mass balancing approach was followed _(isMassBalanced)._ +Further, information regarding inorganic/fossil-based materials is required. The percentage of primary inorganic/fossil-based material weight _(percentageOfMaterialWeight)_ shall be provided. When it comes to secondary material, the percentage of material weight of chemically and mechanically recycled pre-consumer and post-consumer material according to ISO 14021 should be included _(percentageOfMaterialWeight)_. Post-Consumer material is divided into two streams: Post consumer material from end-of-life vehicles as well as post consumer from other sources. When chemical or mechanical recycling has been applied, it is important to disclose information whether a mass balancing approach was followed _(isMassBalanced)_. _Definition of pre-consumer material:_ @@ -230,9 +480,9 @@ _Definition of Reutilization:_ Even though Reutilization fosters the avoidance of waste, it does not count as recyclate according to ISO 14021 and is an optional attribute for this data model. -If available, the name of a certificate verifying the recycling content and a link to its PDF validating the provided information can be included _(certificate)._ +If available, the name of a certificate verifying the recycling content and a link to its PDF validating the provided information can be included _(certificate)_. -##### Figure 6 +##### Figure 15 ![Material Characteristics](resources/adoption-view/Relationship_between_Material_Characteristics.svg) @@ -240,15 +490,13 @@ The schematic depiction above provides a visual representation of the connection #### 2. Order Data -To clearly identify the order and relevant material, the order number _(orderNumber)_ can be provided on an optional basis. - -#### B. Chain of Custody Models +To clearly identify the order and relevant material, the order number (orderNumber) can be provided on an optional basis. -Disclaimer: For information regarding the calculation of a PCF on basis of the Chain of Custody Models please see the Catena-X [(PCF) Rulebook.](https://catena-x.net/de/standard-library) +#### B. Accounting for Chain of Custody Models -Chain of custody is an administrative process by which information about materials is transferred, monitored, and controlled as those materials move through supply chains [ISO 22095:2020]. There are in principle four chains of custody models possible, illustrated in the figure below. Their common objective is to guarantee correct bookkeeping and to corroborate a link between in-going content, e.g., ‘sustainable’, ‘recycled’ or ‘organic’ by harmonized definitions, and the finally out-going product. They differ regarding physical or administrative links. Furthermore, they differ on the set of rules for balancing, and the possibility to keep materials streams segregated or not. +Please see the Catena-X Product Carbon Footprint (PCF) Rulebook for further information. Chain of custody is an administrative process by which information about materials is transferred, monitored, and controlled as those materials move through supply chains [ISO 22095:2020]. There are in principle four chains of custody models possible, illustrated in the figure below. Their common objective is to guarantee correct bookkeeping and to corroborate a link between in-going content, e.g., ‘sustainable’, ‘recycled’ or ‘organic’ by harmonized definitions, and the finally out-going product. They differ regarding physical or administrative links. Furthermore, they differ on the set of rules for balancing, and the possibility to keep materials streams segregated or not. -##### Figure 7 +##### Figure 16 ![figure custody models](resources/adoption-view/custody_models.svg)[^1] @@ -256,18 +504,18 @@ Chain of custody is an administrative process by which information about materia The following table is adapted from the [Mass Balance EMF White Paper](https://emf.thirdlight.com/link/f1phopemqs36-8xgjzx/@/preview/1?o) and provides high-level explanations and differentiations for the four chain of custody models: -| Model | Explanation | Example | -| ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Identity Preservation | It is possible to physically track the product to its desired origin, ensuring unique traceability and physical separation of products from other sources along the supply chain. | Buying food from a single certified producer. | -| Segregation | Consists in the aggregation of volumes of products of identical origin or produced according to the same standards in one stock item. | Buying food from a trader that exclusively handles identically certified supplies. | -| Mass Balance | Considering the output, no physical or chemical difference exists between in-scope and out-of-scope. It involves balancing volume reconciliation to ensure the exact account of volumes of in- and out-of-scope source is maintained along the supply chain, provided that the volume or the ratio of sustainable material integrated is reflected in the product produced and sold to customers. This model requires that a reconciliation period is defined (e.g. a month, a year). | Buying a certain percentage of a supply from certified origin. Applies to, e.g., sustainable forestry for wooden materials, recycled, bio-based or renewable materials, organic cotton | -| Book and Claim – Restricted Certificate Trading | The certified product / component is disconnected from the certification data but belongs to the same production system or value chain. The certified product evolves in separate flows from the certified supply. Certificates are issued at the beginning of the supply chain by an independent body reflecting the sustainable content of supplies. The intended outcome is that outputs from one supply chain are associated with total claims corresponding to the certified input. | Buying material with renewable/recycled/ biobased content. Certificates with guarantee of origin or comparable certifications declaring e.g. recycled, renewable, biobased content. | +| Model | Explanation | Example | +| ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Identity Preservation | It is possible to physically track the product to its desired origin, ensuring unique traceability and physical separation of products from other sources along the supply chain. | Buying food from a single certified producer. | +| Segregation | Consists in the aggregation of volumes of products of identical origin or produced according to the same standards in one stock item. | Buying food from a trader that exclusively handles identically certified supplies. | +| Mass Balance | Considering the output, no physical or chemical difference exists between in-scope and out-of-scope. It involves balancing volume reconciliation to ensure the exact account of volumes of in- and out-of-scope source is maintained along the supply chain, provided that the volume or the ratio of sustainable material integrated is reflected in the product produced and sold to customers. This model requires that a reconciliation period is defined (e.g. a month, a year). | Buying a certain percentage of a supply from certified origin. Applies to, e.g., sustainable forestry for wooden materials, recycled, bio-based or renewable materials, organic cotton | +| Book and Claim – Restricted Certificate Trading | The certified product / component is disconnected from the certification data but belongs to the same production system or value chain. The certified product evolves in separate flows from the certified supply. Certificates are issued at the beginning of the supply chain by an independent body reflecting the sustainable content of supplies. The intended outcome is that outputs from one supply chain are associated with total claims corresponding to the certified input. | Buying material with renewable/recycled/ biobased content. Certificates with guarantee of origin or comparable certifications declaring e.g. recycled, renewable, biobased content. CO2 capture certificates from a production system controlled by the company, e.g. carbon capture and storage. | -Explanation chain of custody models [adapted from the above cited EMF Whitepaper] +For calculating the PCF according to the Catena-X rulebook all types of models may be taken into account, if the requirements listed below are met and an independent third-party chain of custody verification for the balance of materials is available. The balance between input and output shall be correct. The mass balance approach helps enabling fossil raw materials to be replaced by more sustainable alternative materials (e.g. with recycled content, bio-content). In contrast to a segregated use of alternative raw materials, mass balance enables to use existing production networks with minimized or no investments into new process technologies and production facilities. A book and claim model can be applied when there is no direct connection between the final product and the certified supply. An example for a book and claim model is applied in green electricity markets and receives more attention in other sectors as a way to support circular transformation of the industry, therefore it is accepted as a solution. There will be a regular review by Catena-X to decide about the further necessity. -#### Guiding Principles +##### Guiding Principles In implementing chain-of-custody methods, including the mass balance one, the following set of guiding principles shall be fulfilled: @@ -307,7 +555,7 @@ All secondary material usage types are being expressed as percentages of the rel ![pre consumer material content equation](resources/adoption-view/eq_pre_consumer_material_content.svg) -_Definition of pre-consumer material:_ +**Definition of pre-consumer material:** “Material diverted from the waste stream during a manufacturing process. Excluded is reutilization of materials such as rework, regrind or scrap generated in a process and capable of being reclaimed within the same process that generated it. Pre consumer material can be used in form of recovered or recycled material as a substitute for primary material.” @@ -315,7 +563,7 @@ _Definition of pre-consumer material:_ ![post consumer material content equation](resources/adoption-view/eq_post_consumer_material_content.svg) -_Definition of post-consumer material:_ +**Definition of post-consumer material:** “Material generated by households or by commercial, industrial and institutional facilities in their role as end-users of the product which can no longer be used for its intended purpose. This includes returns of material from the distribution chain. Post-consumer material can be used in form of recovered or recycled material as a substitute for primary material.” @@ -323,7 +571,7 @@ _Definition of post-consumer material:_ ![Reutilization content Equation](resources/adoption-view/equation_Reutilization_content.svg) -###### Definition of reutilization +**Definition of reutilization:** “Reutilization of materials such as rework, regrind, or scrap materials generated within the process and capable of being reused within the same process that generated it. Any operation by which products or components that are not waste are used again for the same purpose for which they were originally intended. Reutilization allows waste to be reduced and materials can be kept in cycle.” @@ -343,13 +591,13 @@ It is important to note that data quality may vary during different stages of th To calculate the average portion of, for instance, the amount of mechanical recycling of post-consumer material content in the whole material, the values along the data model must be multiplied. For example, the content of inorganic or fossil-based material, content of secondary inorganic or fossil-based material, post-consumer material content, and mechanical recycling would be multiplied as can be seen in the schematic depiction below. -##### Figure 8 +##### Figure 17 ![material_characteristics](resources/adoption-view/material_charactersitics.svg) #### D. Data Models and Github -The relevant data models can be found on GitHub: +The relevant data models can be found via the following links on GitHub: - [Secondary Material Content](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.shared.secondary_material_content) - [Secondary Material Content Calculated](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.secondary_material_content_calculated) @@ -357,209 +605,6 @@ The relevant data models can be found on GitHub: The open availability on GitHub allows companies to combine their own internal target guidance programs with the data models from Catena-X to SMC. -## End of Life / Dismantling Services - -### Introduction - -#### Closing Loops, Preserving Resources: Creating tomorrow's EoL landscape and empower the circularity - -As part of the Circularity KIT, we are committed to developing services for the future of the circular economy in the end-of-life (EoL) sector of vehicles. This phase represents an important stage where decisions are made regarding the fate of vehicles and their components after their initial use. Recognizing the immense value of the world's limited resources, we are dedicated to minimizing waste and maximizing resource efficiency. - -One of our key strategies involves creating a framework for an improved communication among all stakeholders involved in the EoL phase. This collaborative approach allows us to consider the needs and requirements of all participants, facilitating the collection and exchange of essential information. Importantly, we view the end of a vehicle's life as the beginning of a new one in the context of resource conservation. - -Our overarching vision is to create a landscape that closes loops and preserves resources, ultimately empowering circularity in the industry. We aspire to provide digitized and scalable EoL services that align with circular economy principles and prioritize the preservation of components and materials. Simultaneously, we are committed to follow present and future changes in laws and regulations, which emphasizes environmentally friendly vehicle disposal and the recovery of critical raw materials (CRMs), aligning with the growing demand for closing component and material loops. - -Our mission centres on empowering EoL and maintenance stakeholders by fostering continuous collaboration within the Catena-X Network and beyond. Through the Circularity KIT working group, we aim to develop and align various means, including data, business, and network models, to empower all stakeholders involved in the EoL phase. This mission is closely tied to our vision of promoting digitized and scalable end-of-life services across the industry while upholding the principles of circular economy. - -Our strategy for achieving these goals involves several key steps. Firstly, we aim to enable EoL service models through data sharing based on digital twins (DT). This approach allows for efficient information sharing in an interoperable, standardized manner, which, in turn, supports dismantling and recycling operations. Furthermore, we are actively engaging with all relevant stakeholders, including policymakers, product designers (for circularity), and EoL service providers, to promote new "R-approaches" and facilitate their implementation. - -Ultimately, our efforts provide essential support for the digitalization and automation of the EoL phase, with the ultimate goal of closing loops in the automotive sector. Through these digitized and scalable EoL services, we aim to contribute significantly to sustainable development and resource conservation, aligning with the principles of the circular economy. - -### Business Context - -#### Data Journey "End-of-Life" - -The "Data Journey" represents the entire process of dismantling an End-of-Life (EoL) vehicle. Each process step is accompanied by CX data models that would be necessary for digitally representing the individual process steps. This enables us to elevate the data journey for the dismantling process to a digital level and to gain an understanding of which data attributes and aspect models are required for each process step. It forms the foundation for the creation of digital EoL-solutions and the use of robotics. - -##### Figure 9 - -![Data Journey - End of LIfe](resources/adoption-view/figure_dataJourney_EOF.svg) - -Future additions include data models for the following topics: - -- Decommissioning Certificate -- Material for Recycling -- Adress Aspects -- ID Conversion -- Certificate of Dismantler -- Diagnostic Data -- Physical dimensions -- Mandatory dismantling -- Demand request -- Compatibility of components/ Design changes history -- Quality issue history -- Technical drawings & specifications -- PCF Information - -#### User Journey "Certificate of Decomissioning" - -The user journey "Certificate of Decommissioning" (CoDM) describes the moment at which a vehicle is transferred into the End-of-Life (EoL) phase from the perspective of an authorized collection point for EoL-vehicles, such as an authorized dismantling facility. The CoDM resembles the official Certificate of Destruction (CoD) but marks the starting point of the upcoming CX concept of a digital CoD. - -##### Figure 10 - -![User Journey CODM](resources/adoption-view/figure_user_journey_codm.svg) - -##### Data Model and GitHub - -The relevant data model can be found on the following link on GitHub: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.decomissioning_certificate/1.0.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.decomissioning_certificate/1.0.0) - -The open availability on GitHub allows companies to combine their own internal target guidance programs with the data models from Catena-X to the EoL-Services. - -## CE-Assistant - -### Introduction - -#### Empowering Circular Economy Decisions: Introducing the Circular Strategy Assistant - -In the dynamic landscape of sustainability and resource conservation, the Circular Strategy Assistant (CE-Assistant) emerges as a pioneering solution, providing decision support for the selection of optimal strategies concerning end-of-life vehicles. At its core, the CE-Assistant tackles the task of evaluating and choosing from a spectrum of R-Strategies—namely Reuse, Remanufacturing, Recycling, and Recovery. - -Rooted within the principles of Catena-X, the CE-Assistant is deeply aligned with a comprehensive assessment process that guides its functionality. This process is chiefly anchored in the Catena-X Digital Twin Framework, which encapsulates the essence of virtual representation and real-world insights. - -Central to this endeavor is the CE-Assistant—a set of standards, aspect models, APIs, system architectures, and decision logics—all designed to foster the development of data-centric, Catena-X compliant decision support systems for Circular Economy Strategies. The core circularity lies in the orchestrated flow of engineering information—a collaborative effort involving entities across the automotive value chain. - -The concept of Digital Twin (DT) serves as the backbone, offering a holistic virtual counterpart of assets. Defined with precision, the DT embodies a set of unique identifiers, an evolving spectrum of aspects, connectivity to diverse data sources, and the capacity to traverse the entire lifecycle of assets, encapsulating both individual and fleet-level knowledge. - -In accordance with IDSA and Gaia-X principles, interconnectivity and data sovereignty, the CE-Assistant thrives on the principles of interoperability, substantiated by the Connector KIT (EDC) and Data Chain KIT (Item Relationship Service - IRS). - -Undeniably, the selection of Circular Economy Strategies necessitates a comprehensive evaluation of emissions, natural resource preservation, energy management, and waste reduction. However, the effectiveness of such evaluation’s hinges on access to granular data encompassing the vehicle’s history, components, materials, and condition. - -This is precisely where the CE-Assistant can help by supporting a user-centered approach that bridges the gap between data availability and informed decision-making. By offering transparency into the environmental implications of diverse circular economy strategies, the CE-Assistant facilitates swifter, well-informed, and efficient decisions rooted in the digital twin's insights. - -### Business Context - -The CE-Assistant provides decision support and circular strategies, enabling several key features for businesses: - -1. **Component-Level Decision Support:** The KIT provides decision support for selecting circular strategies at the component level. -2. **Efficient Data-Driven Decisions:** Users can make faster and more efficient decisions based on data analysis. -3. **Enhanced Circularity:** The KIT contributes to increasing the circularity of products and meeting reuse quotas. -4. **Sustainability Milestones:** It helps achieve sustainability indicators and goals. -5. **Transparency on Secondary Materials:** The KIT offers transparency regarding the availability of secondary materials. -6. **Streamlined Vehicle Dismantling:** It optimizes the process of vehicle dismantling for improved resource recovery. - -#### Use Case / Domain Explanation - -The User Journey describes the system interaction of the CE Assistant with the user, the Dismantling Lead, with the aim of providing a recommendation for a component-level circular strategy for end-of-life vehicles. This involves breaking down the process of holistic decision-making into individual process steps and identifying the interaction with the user/system at each process step. - -##### Figure 11 - -![Figure UserJourney CE Assistant](resources/adoption-view/figure_userstory_ce_assistant.svg) - -#### Whitepaper - -If you are eager to dive deeper into the world of the CE-Strategy Assistant, including its data provision via the Digital Twin and expert insights on technically feasible circular strategies and environmentally friendly choices, we invite you to explore our informative publications. - -##### End-of-life decision support to enable circular economy in the automotive industry based on digital twin data - -- **Abstract**: With the EU Green Deal and the UN Sustainable Developments Goals, the vision of a greenhouse gas-neutral and resource-efficient economy is already firmly anchored in world politics. In this context, the automotive industry faces many challenges including the increasing scarcity of natural resources, a rising demand in terms of sustainable vehicle design, production and materials sourcing. Due to all this, end-of-life decisions regarding dismantling have become increasingly important. A high proportion of secondary materials will be required in the vehicles of the future. To response to these challenges, companies have turned their focus towards the circular economy as a central approach to close material loops. In the German research project “Catena-X” a new data ecosystem with digital twins is one enabler that is being developed. The digital twins represent a promising approach to the circular economy by ensuring transparent, product-specific and end-to-end data exchange throughout the entire product lifecycle, from the material sourcing to the eventual dismantling and recycling. As one particular and unique solution, a decision framework that facilitates the best circular strategy at the end of a vehicle's life is developed and presented in this paper. The underlying data-driven decision support framework is based on circular economy KPIs. This includes material, components and specific vehicle KPIs to best identify the most suitable circular strategy. The framework was methodologically developed by an interdisciplinary team of partners, who are stakeholders throughout the value chain and participants in the Catena-X project. An integrated approach of user-centered design, an adapted version of the V-model and the Scaled Agile Framework were used for the methodology in the development of the solution. The paper presents the concept of a digital twin for a decision support system, that includes a central decision logic that also includes the relevant KPIs and a survey for evaluating the decision logic utilized with a chosen dismantling company. -- **Link**: [End-of-life decision support to enable circular economy in the automotive industry based on digital twin data - ScienceDirect](https://www.sciencedirect.com/science/article/pii/S2212827123006091) - -##### Empowering End-of-Life Vehicle Decision Making with Cross-Company Data Exchange and Data Sovereignty via Catena-X - -- **Abstract:** The mobility sector is the world’s second-largest producer of energy-related CO2 emissions, and it is facing a global resource shortage. The demand for circular products, the use of secondary materials in future vehicles, and the need for sustainable business models in the mobility sector is increasing. However, a transparent and end-to-end data exchange throughout the entire value network is missing, which is hindering an efficient circular economy. Relevant information on the vehicle, its components and materials at the end of the product life cycle are often missing. In this context, this paper presents a decision support system based on Digital Twin data for a circular economy solution as a software application. It was developed within the German research project Catena-X following an integrated approach of user-centered design, the V-model, and within the Scaled Agile Framework. By combining these methodological approaches, customer-oriented solutions were developed and continuously improved at each stage of development to shorten the time-to-market. Catena-X is based on Gaia-X principles. In Gaia-X, necessary core services are developed, and contraction negotiation for data exchange and usage policies is enabled and implemented. The decision support system provides important information about the exact composition and condition of the vehicle, its components, and its materials. Thus, it helps to improve efficiency, sustainability, and the implementation of the circular economy. The decision support system was tested and validated with a use case that provided Digital Twin data on the end-of-life vehicle. -- **Link**: [Sustainability | Free Full-Text | Empowering End-of-Life Vehicle Decision Making with Cross-Company Data Exchange and Data Sovereignty via Catena-X (mdpi.com)](https://www.mdpi.com/2071-1050/15/9/7187) - -##### Digital Twins for Circular Economy - Enabling Decision Support for R-Strategies - -- **Abstract:** Digital twins (DT) for circular economy (CE) offer a promising approach as part of digital data ecosystems for more sustainable value creation. By mapping and analyzing product, component and material specific data along the lifecycle, it is possible to address current challenges such as climate change and resource scarcity. Within Catena-X, specific solutions based on this cross-company exchanged data and information are developed. Here, the “CE-Assistant” is presented. It is an application, which identifies the best CE-Strategy based on DT data at the end of a vehicle's life. -- **Link:** [OA_Mügge_6-2022 | INDUSTRIE-MANAGEMENT](https://www.industrie-management.de/node/556) - -#### Logic / Schema - -In order to evaluate which R-Strategy can be applied to individual components, instance-specific data must be available. This is ensured using DT data throughout the product lifecycle. Such an DT enables the collection of instance-specific data on the product, and thus provides the missing EoL data for vehicle disassembly. - -Depending on the decision-making step, instance specific data for the vehicle disassembly is partly necessary or product specific data is sufficient. Decision support regarding the best R-Strategy is preceded by the logic for the technical feasibility. Thus, only when the R-Strategy is technically feasible, it must be checked for other indicators. - -The outcome of the technical feasibility is to analyze if an R-Strategy has to be excluded at the beginning based on regulatory requirements regarding an R-Strategy or a defect in functionality of specific components. - -The process is started by entering the vehicle identification number (VIN) into the system, thereby requesting the corresponding Catena-X data. The registered companies in the Catena-X network act as data providers for this vehicle-specific data, as they register respective assets and sub-models. Catena-X Shared Services handle existing data models, contract, usage and access control policies, and ultimately the final data exchange. - -The system shows the first information, such as corresponding vehicle, component and material based on data from the DT. This data is provided for the first overall manual inspection and evaluation. After that, the user selects the most relevant components for the R-Strategy decision. The decision logic is applied for this component and the possible R-Strategies are identified. - -The core process means in a chronological order: The basic reuse-potential, material composition and remaining lifetime in comparison with the specific thresholds and the disassembly capability. - -If one or more of these criteria are not fulfilled, the component will only be assigned to recovery or recycling. If the component qualifies for disassembly, a manual visual inspection and a functional check are conducted. For components, where the visual condition is relevant, such as body parts and interior components, the visual inspection is conducted first. In contrast, components, for which the technical condition is of significant relevance, such as engines and gearboxes, are first subjected to a functional test. Here, the data can also be provided in the Catena-X network as an update of the DT. Thereafter, a quality comparison of the component condition with threshold values takes place. When the quality is insufficient for reuse, the technical check for remanufacturing is carried out chronologically: Assimilability, cleanability and restorability/upgradability. Finally, a possible strategy is given to the user as a result. - -##### Figure 12 - -![user story flowchart](resources/adoption-view/figure11.svg) - -## Secondary Marketplace - -### Introduction - -A secondary marketplace is fundamental to establish a circular economy where components and materials are available and offered to the interested users creating new value chains and extending the life of the parts and the materials before becoming waste. Digital platforms offering marketplace services are essential to enable trading of secondary materials and components, provide transparency into supply and demand that potential buyers and sellers can expect. - -The main goals of the Marketplace are: (1) to match the demand and the supply of available components and secondary raw materials and (2) to provide transparency on sales opportunities for used components which can be, for example, reused or re-manufactured. - -If offered, additional services such as grading, certifications for the offered listings (components or secondary materials) and transport handling and logistics could support trading processes. - -### Business Context - -A secondary marketplace enables closing the loop on economical and physical layers. Following the logic described in the previous chapter, there could be multiple scenarios related to R-strategies on how secondary marketplaces enable a circular economy. - -Potential sales scenarios: - -- Dismantling companies selling old components and material/scrap; -- Automotive manufacturers selling old unused components; -- Automotive manufacturers selling production waste and scrap; -- and others. - -Potential purchase scenarios: - -- Automotive companies buying components for re-manufacturing; -- Workshops buying components for re-use; -- Recyclers buying production waste and scrap; -- and others. - -In all of those cases, having additional information (e.g. product carbon footprint or digital product passport details) on the products offered on the marketplace is beneficial. - -### User Journey and Architecture Overview - -In general, there are several goals that buyers and sellers pursue on a secondary marketplace: - -- As a (Core) Purchaser, I want to search and filter for market supply on OE number level to match the market offers towards my demand. -- As a (Core) Purchaser, I want to reach as many possible sellers as possible to purchase parts that I cannot procure today. This includes brokers I don't buy from today. -- As a (Core) Seller, I want to place offers on the marketplace with standard upload tools and manually. -- As a (Core) Seller, I want to reach as many possible customers as possible to maximize my turnover. This includes customers I don't sell to today. - -The key user journey relevant in Catena-X circular economy area relates to the need of a buyer to have full reliable information on a product that he is intending to purchase. This is especially important given that many buyers are looking for parts for re-manufacturing or re-use, where product quality plays a vital role. Furthermore, in case of recycling, recyclers are interested to know material composition and additional information that would influence their purchasing decision. - -Some information could be provided by a variety of data models, but the highest value lies within the generic digital product passport (and by extension, battery passport, sealant passport, transmission passport). When a seller is publishing a listing with a product that he is willing to sell, there is only a limited amount of information he can provide with it, mostly the one available from the visual inspection or on-board data (such as mileage, OE-number, brand) as well as logistical/ sales information (such as location or price). When a potential buyer views the listing, he should have a possibility to request additional details from a data provider of the generic digital product passport (if available) for that product (see diagram below). More information on the digital product passport can be found in the [Ecopass KIT](https://eclipse-tractusx.github.io/docs-kits/kits/Eco_Pass_KIT/page-adoption-view/). - -#### Figure 13 - -![User Journey - Secondary Marketplace](resources/adoption-view/user_journey_secondary_marketplace.svg) - -This process is reflected in the architecture for communicating with the Catena-X network and data providers of the battery passport data model, as presented below. - -#### Figure 14 - -![Communication Architecture](resources/adoption-view/communication_architecture.svg) - -When it comes to the data exchange schema and other details, see the [Triangle for Secondary Marketplace](https://catena-x.net/de/standard-library) document for more information on how such a request could be realized within Catena-X environment and according to applicable guidelines (e.g. on interoperability and data sovereignty). In a decentral environment, such attributes as manufacturer part ID and OE number play a vital role in order to get access to the right component and the right data model at data provider’s side. - -### Semantic Models - -In the following, relevant semantic models for the secondary marketplace are listed. For further information about the listed data models please refer to the Catena-X standards library for the respective data model, marked as “CX-“, which contains the standardized data models with further descriptions and explanations. The standards library can be founded here: [Catena-X Standard-Library](https://catena-x.net/de/standard-library) - -The Marketplace Offer is an aspect model that is complementary to the concept of a secondary marketplace. It described a product (e.g. a used, dismantled component) that is placed for sale onto the marketplace, with key supporting information such as quantity, quality, or price. It provides essential information for potential buyers and could be used in the future to exchange product information between multiple marketplaces. This model can therefore be used to exchange offers between multiple marketplaces. As there is no exchange scenario defined yet, the Marketplace Offer is a recommendation and non-normative, since it is so far concerning the business application-internal data structure only. More information on this aspect model can be found under CX-0035 in the standards library or under the following link: [Marketplace Offer](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.market_place_offer) - -Additionally, two other aspect models could play a supporting role for secondary marketplaces. - -The Return Request aspect model could be used to flag a vehicle or product to indicate that there is a demand or a request for return. It specifies the aspect of the recall of a vehicle part and thus provides the information whether and why a return request exists for a product. More information on this aspect model can be found under CX-0033 in the standards library or under the following link: [Return Request](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.return_request) - -The Product Passport aspect model could provide reliable details on the product characteristics or lifecycle information, therefore complementing the basic Marketplace Offer information. More information on this aspect model can be found under CX-0103 in the standards library or under the following link: [Digital Product Passport](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.generic.digital_product_passport) - ## NOTICE This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). diff --git a/docs-kits/kits/Circularity_KIT/page-glossary.md b/docs-kits/kits/Circularity_KIT/page-glossary.md index d9f79eb6880..3a0266e9cd1 100644 --- a/docs-kits/kits/Circularity_KIT/page-glossary.md +++ b/docs-kits/kits/Circularity_KIT/page-glossary.md @@ -2,283 +2,100 @@ title: Glossary --- - -| Term | Definition | Source | -| ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Allocation | Partitioning the input or output flows of a process or a product system between the product system under study and one or more other product systems | DIN EN ISO 14040 | -| Attributable process | Those processes that consists of all service, material and energy flows that become, make and carry a product throughout its life cycle. | WBCSD Pathfinder | -| Bio-based Materials | Material of biological origin (biomass excluding material embededded in geological formations and / or fossilised) | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172132, P. 9 | -| Bio-based products | wholly or partly derived from materials of biological origin, excluding materials embedded in geological formations and/or fossilised. | | -| Biomass | Material of biological origin, excluding material embedded in geological formations or transformed material of biological origin, excluding material embedded in geological formations or transformed to fossilized material and excluding peat | DIN ISO 14021 | -| By-Product | Substance or object, resulting from a production process, the primary aim of which is not the production of that item, and does not constitute waste (as defined in Directive 2008/98/E on waste) | Art. 5 No. 1 WFD (Waste framework directive 2008/98/EC) | -| Biodiversity | Biological diversity means the variability among living organisms from all sources including, inter alia, terrestrial, marine and other aquatic ecosystems and the ecological complexes of which they are part: diversity in species, between species and of ecosystems. | Art. 2 UN Convention on biological diversity; ESRS E4 (COM(2023) 5303 final | -| Carbon offsetting | Mechanism for compensatingfor a full PCF or a partial PCF through the prevention of the release of,reduction in, or removal of an amount of GHG emissions in a process outside the product system under study | DIN EN ISO 14067 | -| CAS Number | a unique numerical identifier assigned by the Chemical Abstracts Service (CAS) to every chemical substance described in the open scientific literature. / Except for a small selection of most common substances released under CCBY-NC license the CAS numbers are a proprietary identification scheme to be licensed from CAS (USA) | [CAS REGISTRY / CAS](https://www.cas.org/cas-data/cas-registry) | -| Certificate of Decstruction | An official document issued in accordance with the minimum requirements set out by the European Commission's Decision of February 19, 2002. It confirms the proper disposal of an end-of-life vehicle and is required for vehicle deregistration. | 2000/53/EC | -| Chain-of-Custody approach | A process by which inputs and outputs and associated information are transferred, monitored and controlled as they move through each step in the relevant supply chain. See Mass Balance for details | ISO 22095 | -| Chemical Recycling | Chemical or feedstock recycling refers to the conversion of plastic polymers into their monomers or chemical building blocks or basic chemicals, i. e. depolymerisation by means of thermochemical or chemical processes, although there is currently no uniform, legally binding definition. | Background Paper pn Chemical Recycling - German Environmental Agency, Dec 2020 | -| Circular Econamy | See chapter 3.1; but also “An ec economic system that uses a systemic approach to maintain a circular flow of resources, by recovering, retaining or adding to their value, while contributing to sustainable development | ISO/DIS 59004:2023(E) | -| Circular Economy Principles | The Circular Economy is based on three principles, driven by design: (i) eliminate waste and pollution; (ii) circulate products and materials at their highest value; and (iii) regenerate nature. | EFRAG-Draft ESRS (11/2022) | -| Carbon offsetting | Mechanism for compensatingfor a full PCF or a partial PCF through the prevention of the release of,reduction in, or removal of an amount of GHG emissions in a process outside the product system under study | DIN EN ISO 14067, Feb. 2019, p. 18 | -| Closed-loop recycling | In a closed loop, the secondary material from one product system is either reused in the same product system (real closed-loop) or used in another product system without changing the inherent technical properties of the material (quasi closed-loop). | | -| CO2e (carbon dioxide equivalent) | Unit for comparing the radiative forcing of a greenhouse gas to that of carbon dioxide | DIN EN ISO 14067, Feb. 2019, p.20 | -| component | part or small assembly of parts used as part of a larger assembly | Artikel 2 Begriffsbestimmungen 200053EG | -| Compostable | characteristic of a product, packaging or associated component that allows it to biodegrade, generating a relatively homogeneous and stable humus-like substance. | DIN ISO 14021 | -| Consumer | Any natural person who, in contracts covered by this Directive, is acting for purposes which are outside his trade, business, craft or profession | 2011/83/EU on conusmer rights | -| Co-product | Any of two or more products comning from the same unit process or product system | DIN EN ISO 14067, Feb. 2019, p.22 | -| Core | A core is a previously sold, worn or non-functional product or part, intended for the remanufacturing process. During reverse logistics, a core is protected, handled and identified for remanufacturing to avoid damage and to preserve its value. A core is not waste or scrap and is not intended to be reused before remanufacturing. | CLEPA, MERA, APRA, ANRAP, FIRM, CPRA | -| Cradle-to-gate PCF | Part of a product’s full lifecycle, covering all emissions allocated to a product upstream of a company plus all emissions resulting from processes within the company until the product leaves the suppliers' gate | WBCSD Pathfinder | -| Cut-off criteria | Specification of the amount of material or energy flow or the level of significance of GHG emissions associated with unit processor the product system, to be excluded from a PCF study | DIN EN ISO 14067, Feb. 2019 p.24 | -| Declared unit | Quantity of a product for use as a reference unit in the quantification of a Cradle-to-Gate PCF | adapted from DIN EN iso 14067 | -| Degradable | A characteristic of a product or packaging that, with respect to specific conditions, allows it to break down to a specific extent within a given time. | DIN ISO 14021 | -| Digital Twin | The Digital Twin is a virtual representation of assets and adheres to the following characteristics: The DT has at least one Catena-X-wide unique ID. Digital Twins are organized by a set of Aspects. The set can be extended over lifetime. An Aspect of a DT includes both structural as well as behavioral data and models (including operations and simulation models). The semantics of an Aspect can be described via semantic models A single Aspect can be connected to different heterogenous data sources (including behavioural models) The DT can represent asset types (e.g. virtual prototype of a car) and asset instances (e.g. real car) A DT can cover the whole asset lifecycle including (e.g. planning phase, production, sales, use and decommissioning phase). However, in practice there may be more than one twin with different IDs representing different lifecycle phases (e.g. a twin for types and multiple twins for instances). An asset can have more than one DT The DT represents current available information about an asset (synchronized at a specified frequency and fidelity) which can be leveraged for simulation and business process integration By using aspects the DT can reference other DT to express "part of" or "consists of" relations | Catena-X definition | -| Direct emissions | GHG emissions from the processes that are owned or controlled by the reporting company | WBCSD Pathfinder | -| Downstream emissions | Indirect GHG emissions that occur in the value chain following the processes owned or controlled by the reporting company | WBCSD PAthfinder | -| Durability | The ability of a product, component or material to remain functional and relevant when used as intended. | EFRAG - Draft ESRS (11/2022) | -| ecological assessment | compilation and evoluation of the inputs, outputs, and potential environmental impacts of a product system throughout its life cycle | Artikel 2 Begriffsbestimmungen 200053EG | -| end-of-life | the point at which a product or component is taken out of use | Artikel 2 Begriffsbestimmungen 200053EG | -| end-of-life vehicle | vehicles that are considered waste under Article 1 letter a) of Directive 75/442/EC | Artikel 2 Begriffsbestimmungen 200053EG | -| End-of-waste | The end-of-waste state for waste in Europe is reached when the material is no longer considered waste under the national implementation of the Waste Framework Directive. | EN 15804 | -| Functional unit | Quantified benefit of a product system for use as a comparison unit | | -| Fossile Materials | Fossil raw materials are all raw materials derived from organic material. They incldude coal, crude oil and natural gas. | Bundesverband Geothermie | -| Global warming potential (GWP) | Index, based on radiative properties of GHGs, measuring the radiative forcing following a pulse emission of a unit mass of a given GHG in the present-day atmosphere integrated over a chosen time horizon, relative to that of carbon dioxide (CO2) | DIN EN ISO 14067, Feb. 2019, p. 21 | -| Greenhouse gases (GHGs) | Gaseous constitient of the atmosphere, both natural and anthropogenic, that absorbs and emits radiation at specific wavelengths within the spectrum of infrared radiation emitted by the Earth´s surface, the atmosphere, and clouds | DIN ISO 14067, Feb. 2019, p. 19 | -| ILCD Format | International Life Cycle Data Format | | -| intermediate product | output from a unit process that is input to other unit processes that require further transformation within the system | | -| input | product, material, or energy flow that enters a unit process. Products and materials include raw materials, intermediate products, and coproducts. | WBCSD Pathfinder | -| Land use | Human use or management of land within the relevant boundary | DIN EN ISO 14067, Feb. 2019 p. 30 | -| life cycle | consecutive and interlinked stages to a product, from raw material acquisition or generation from natural resources to final disposal. | DIN EN ISO 14067, Feb. 2019 p. 25 | -| Life cycle assesment (LCA) | Compilation and evaluation of the inputs, outputs and potential environmental impacts of a product system throughout its life cycle | DIN EN ISO 14067, Feb. 2019, p. 25 | -| Life cycle emissions | The sum of GHG emissions resulting from all stages of the life cycle of a product and within the specified boundaries of the product | WBCSD Pathfinder | -| Life cycle inventory (LCI) | The phase of life cycle assessment involving the compilation and quantification of inputs and outputs for a product throughout its life cycle (such as a product´s GHG emissions and sources) | DIN EN ISO 14067, Feb. 2019, p. 25 | -| Life cycle inventory results | GHG impact of the studied product per unit of analysis | WBCSD Pathfinder | -| Mass | In physics, mass is not the same as weight. Mass is both a property of a physical body and a measure of its resistance to acceleration. For disambiguation see definition of "Weight" below | | -| Mass Balance | Mass balance is one of several well-known chain of custody approaches that can be used to track the flow of materials through the value chain. The total quantity of the content in question is tracked through the production system and the allocation of this content is made to the end products based on verifiable accounting. The goal of this method is to ensure proper accounting and to confirm a link between the incoming content (e.g., "sustainable," "recycled," or "organic" according to some definition) and the eventual outgoing product. | [https://www.basf.com/global/documents/de/sustainability/we-source-responsibly/Mass-Balance-White-Paper-2020.pdf](https://www.basf.com/global/documents/de/sustainability/we-source-responsibly/Mass-Balance-White-Paper-2020.pdf) | -| Material | Physical good used as input for production processes of goods or services, or physical good suppliedto a customer as output | adapted from WBCSD Pathfinder | -| Material / Raw Material | Materials are composed of basic substances, (1) either one or more chemical element(s) (like iron, copper) (2) or one or more chemical compound(s) (like acrylic resin, zinc oxide) (3) or one or more materials (like polyamide and glas fibre). Therefore, a material definition is only valid if a definition of (see chemical composition) is given alongside it. | Catena-X Definition, IMDS | -| Material Composition | see chemical composition | Own Catena-X definition | -| Material Declaration | Material declaration (MD) is the process mandated to meet the obligations placed on (automobile) manufacturers, and thus on their suppliers, by national and international standards, laws and regulations. | IMDS Information Pages - Home - IMDS Public Pages (mdsystem.com) | -| Material Details | Collection of material information defined by given context in an information model | Catena-X Definition | -| Material Identifier | Material Identifier is a alphanumerical identifier that serves programmatic functions (e.g., as data ID) but also satisfies chemical regulation (see material declaration) under national and international law. | Catena-X definition | -| Material Name | Trivial name (often name of a chemical group) used to denote some material in everyday speech or jargon. Entirely dependent on specific context. | Catena-X definition | -| Material Type | Groups of materials defined by convention (e.g., IMDS) or ISO Standard (e.g., ISO 62474) in order to simplify communication of relevance of material information (in search or filtering) | [https://std.iec.ch/iec62474/iec62474.nsf/Index?open&q=180013](https://www.basf.com/global/documents/de/sustainability/we-source-responsibly/Mass-Balance-White-Paper-2020) | -| Mechanical Recycling | End-of-life materials can be processed via collecting, sorting, shredding, melting and transforming it into secondary raw materials for a new application. This form of recycling involves processes in which e.g. the polymer structure is not significantly changed and the plastic is preserved as a material. Thus, in terms of its complexity, mechanical recycling takes place at a lower technical level than chemical recycling. | [Mechanical recycling (basf.com)](https://www.basf.com/global/en/who-we-are/sustainability/we-drive-sustainable-solutions/circular-economy/mechanical-recycling.html) [Glossar und Methoden / Statistikportal.de](https://www.statistikportal.de/de/ugrdl/glossar-und-methoden#P) | -| Multi-input-output unit process | Operation or process with multiple inputs, such as materials and energy, and multiple outputs, such as co-products and waste | WBCSD Pathfinder | -| Negative emissions | Removal of greenhouse gases (GHGs) from the atmosphere by deliberate human activities, i.e., in addition to the removal that would occur via natural carbon cycle processes | IPCC glossary | -| Net negative emissions | A situation of net negative emissions is achieved when,as the result of human activities, more greenhouse gases are removed from the atmosphere than are emitted into it. Where multiple greenhouse gases are involved, the quantification of negative emissions depends on the climate metric chosen to compare emissions of different gases (such as global warming potential, global temperature change potential, and others, as well as the chosen time horizon). | IPCC glossary | -| Net zero CO2 emissions | Net zero carbon dioxide (CO2) emissions are achieved when anthropogenic CO2 emissions are balanced globally by anthropogenic CO2 removals over a specified period. Net zero CO2 emissions are also referred to as carbon neutrality. | IPCC glossary | -| Net zero emissions | Net zero emissions are achieved when anthropogenic emissions of greenhouse gases into the atmosphere are balanced by anthropogenic removals over a specified period. Where multiple greenhouse gases are involved, the quantification of net zero emissions depends on the climate metric chosen to compare emissions of different gases (such as global warming potential, global temperature change potential, and others, as well as the chosen time horizon). | IPCC glossary | -| Open-loop recycling | In open-loop recycling, the material is reused in other productsystems and its inherent properties are changed (e.g., recycled material may have a different chemical composition, a different structure or a higher concentration of dissolved impurities compared to primary material). | | -| output | product, material, or energy flow that leaves a unit process. Products and material include raw materials, intermediate products, co-products, and releases. | WBCSD Pathfinder | -| Partial PCF | Sum of GHG emissions and GHG removals of one or more selected process(es) in a product system, expressed as carbon dioxide equivalents and based on the selected stages or processes within the life cycle. | DIN EN ISO 14067, Feb. 2019, p. 16 | -| Post-consumer Recyclate | Post-Consumer (PCR) recycled content represents the total proportion, by mass, of post-consumer input materials incorporated in the process. | SP-Recycled-Content-Definition-Final-09102021-1.pdf | -| Post-consumer material | Material generated by households or by commercial, industrial and institutional facilities in their role as end-users of the product which can no longer be used for its intended purpose. This includes returns of material from the distribution chain. Post-consumer material can be used in the form of recovered or recycled material as a substitute for primary material. | DIN ISO 14021 | -| Pre-consumer Material | Material diverted from the waste stream during a manufacturing process. Excluded is reutilization of materials such as rework, regrind or scrap generated in a process and capable of being reclaimed within the same process that generated it. Pre-consumer material can be used in the form of recovered or recycled material as a substitute for primary material. | DIN ISO 14021 | -| Primary data | Data pertaining to a specific product or activity within a company’s value chain. Such data may take the form of activity data, emissions, or emission factors. Primary data is site-specific, company-specific (if there are multiple sites for the same product) or supply chain–specific. | WBCSD Pathfinder | -| Primary Material | Raw material coming from the environment, as well as materials of differing stages of processing (Raw materials, semi- and finished goods), which are used in the production process for the first time. | | -| Process | Set of interrelated or interacting activities that transforms inputs into outputs. | DIN EN ISO 14067, feb. 2019, p. 23 | -| prevention | measures to reduce the quantity and environmental harm of end-of-life vehicles, their materials, and substances. | | -| producer / Manufacturer | the vehicle manufacturer or the commercial importer of a vehicle into a EU Member State | | -| product | a product refers to any goods or service, which can be categorized as services (e.g. transport), software (e.g. computer program, dictionary), hardware (e.g. engine mechanical part), and processed materials (e.g. lubricant). Services have both tangible and intangible elements. The provision of a service can involve activities such as repairing a customer-supplied tangible product (e.g. an automobile) or working on a customer-supplied intangible product (e.g. preparing a tax return using an income statement). | | -| Product carbon footprint (PCF) | Total GHG emissions generated during the life cycle of a product, measured in CO2e. Within the boundary of the CX-PCF Rulebook, emissions related to the product use and end-of-life stages are excluded from the PCF. | WBCSD Pathfinder | -| Product category | Group of products that can fulfill equivalent functions. | WBCSD Pathfinder | -| Product category rules (PCR) | A set of specific rules, requirements, and guidelines for calculating PCFs (among other things) and developing environmental declarations for one or more product categories according to EN ISO 14040:2006. | WBCSD Pathfinder | -| Production | Process of combining various inputs, both material (such as metal, wood, glass, or plastics) and immaterial (such as plans, or knowledge) in order to create output. | | -| product system | collection of unit processes with elementary and product flows, performing one or more defined functions, and which models the life cycle of a product | DIN EN ISO 14067, Feb. 2019, p. 22 | -| Production waste | Waste generated in different industries in connection with production and the opposite to consumption waste, which primarily comprise municipal waste and waste comparable to it. | [Production waste/Concepts/Statistics Finland](https://www.stat.fi/meta/kas/tuotantojate_en.html) | -| R-Strategies | Various approaches to implement circular economy, known as R-strategies, have been developed to achieve less resource and material consumption in product chains and make the economy more circular. | Potting, J., et al. "Circular economy: measuring innovation in the product chain." Planbureau voor de Leefomgeving 2544 (2017). | -| raw materials | primary or secondary material that is used to produce a product. Secondary material includes recycled material. | | -| Recovery | Any operation the principal result of which is waste serving a useful purpose by replacing other materials which would otherwise have been used to fulfill a particular function, or waste being prepared to fulfill that function, in the plant or in the wider economy. | Art. 3 (15) of directive 2008/98 EC | -| Recovered Material | Material that would have otherwise been disposed of as waste or used for energy recovery, but has instead been collected and recovered [reclaimed] as a material input, in lieu of new primary material, for a recycling or a manufacturing process. | DIN ISO 14021 | -| Recyclate | Secondary raw materials that have been generated by means of the recovery of waste or are generated in the disposal of waste and are suitable for the production of products. | | -| Recycled Content | Proportion, by mass, of recycled material in a product or packaging. The recycled content is the sum of pre-consumer material and post-consumer material. | DIN ISO 14021 | -| Recycled Material | Material, that has been reprocessed from (reclaimed) material by means of a manufacturing process and made into a final product or into a component for incorporation into a product. | DIN ISO 1402 | -| Recycling | Any recovery operation by which waste materials are reprocessed into products, materials or substances whether for the original or other purposes. It includes the reprocessing of organic material but does not include energy recovery and the reprocessing into materials that are to be used as fuels or for backfilling operations. ‘recycling’ means the reprocessing in a production process of the waste materials for the original purpose or for other purposes but excluding energy recovery. Energy recovery means the use of combustible waste as a means to generate energy through direct incineration with or without other waste but with recovery of the heat; | EFRAG – Draft ESRS (11/2022) | -| Reduce | Increase efficiency in product manufacture or use by consuming fewer natural resources and materials | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172131, p. 7 | -| Reference flow | Measure of the inputs to or outputs from processes in a given product system required to fulfil the function expressed by the functional unit. | DIN EN ISO 14067, Feb. 2019, p. 24 | -| Refurbish | Restore an old product and bring it up to date (to specified quality level) | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172131, p. 7 | -| Refuse | Make product redundant by abandoning its function or by offering the same function by a radically different (e.g. digital) product or service | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172131, p. 7 | -| Releases | tbd. | | -| Remanufacture | Remanufacturing is a standardized industrial process by which a used product or part are returned to same-as-new, or better, condition and performance. The process is in line with specific technical specifications, including engineering, quality and testing standards. The process yields fully warranted products. Collecting discarded products or materials that can be refinished and sanitised to serve their original functions | CLEPA, European Environmental Agency - Eionet report ETC/WMGE 2021/10, P. 3 | -| Renewable Energy | Energy from renewable sources’ or ‘renewable energy’ means energy from renewable non-fossil sources, namely wind, solar (solar thermal and solar photovoltaic) and geothermal energy, ambient energy, tide, wave and other ocean energy, hydropower, biomass, landfill gas, sewage treatment plant gas, and biogas. | Renewable Energy Directive (2018/2001) | -| Renewable materials | Material that is derived from resources that are quickly replenished by ecological cycles or agricultural processes, so that the services provided by these and other linked resources are not endangered and remain available for the next generation. | EFRAG – Draft ESRS (11/2022) | -| Repair | Repair and maintenance of defective product so it can be used with its original function | [Link, ESPR Draft](https://op.europa.eu/en/publication-detail/-/publication/ca9846a8-6289-11ea-b735-01aa75ed71a1/language-en/format-PDF/source-120460723) | -| Repurpose | Use a redundant product or its parts in a new product with different function | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172131, p. 7 | -| Rethink | Make product use more intensive (e.g. through product-as-a-service, reuse and sharing models or by putting multi-functional products on the market) | European Commission, Categorisation System for the Circular Economy Circular Economy, doi: 10.2777 / 172131, p. 7 | -| Reuse | Reuse of a product which is still in good condition and fulfils its original function (and is not waste) for the same purpose for which it was conceived | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172131, p. 7 | -| Reutilization | Reutilization of materials such as rework, regrind, or scrap materials generated within the process and capable of being reused within the same process that generated it. Any operation by which products or components that are not waste are used again for the same purpose for which they were originally intended. Reutilization allows waste to be reduced and materials can be kept in cycle. | Adapted from ISO 14021 | -| Representative product | The representative product can be a real or an averaged (non-existing) product. The averaged product should be calculated based on sales-weighted characteristics of all technologies/materials used in the company’s production system. | | -| Resource inflow | Resource that enters the organisation's infrastructure. | EFRAG – Draft ESRS (11/2022) | -| Resource outflow | Resource that leaves the organisation's infrastructure. | EFRAG – Draft ESRS (11/2022) | -| Reuse | Any operation by which products and components that are not waste are used again for the same purpose for which they were conceived. This may involve cleaning or small adjustments so it is ready for the next use without significant definition. | Art. 3 (13) of the Directive 2008/98/EC & EFRAG-Draft ESRS (11/2022) | -| Risk management | Plans, actions, strategies, or policies to reduce the likelihood and/or consequences of risks or to respond to consequences. | IPCC Glossary, p. 45 | -| Secondary data | Secondary data can include data from databases and published literature, default emission factors from national inventories, calculated data estimates or other representative data, validated by competent authorities. | DIN EN ISO 14067, Feb. 2019, p. 28 | -| Secondary Material | Secondary materials are any materials that are not the primary products from manufacturing and other industrial sectors. These materials can include scrap and residuals from production processes and products that have been recovered at the end of their useful life. | [United States Environmental Protection Agency](https://www.epa.gov/smm/sustainable-management-industrial-non-hazardous-secondary-materials) | -| Secondary Material Framework | Secondary Material Quota = on vehicle level, Secondary Material Content = on component level | | -| Secondary Material Quota (on vehicle level) | not found | | -| Secondary Raw Material | Material that serves as a substitute for primary material and is kept in cycle. | | -| Secondary Raw Material Content | The content of materials that serve as substitutes for primary materials and are kept in cycle. The secondary raw material content is calculated in proportion of secondary material and product weight. | | -| Supplier gate | Supplier's production site or supplier's distribution site. | | -| Supply chain | Those involved, through upstream and downstream linkages, in process and activities relating to the provision of products to the user. | DIN EN ISO 14067, Feb. 2019, p. 28 | -| Sustainability | A dynamic process that guarantees the persistence of natural and human systems in an equitable manner. | IPCC Glossary, p. 49 | -| System boundary | Boundary based on a set of criteria representing which unit processes are a part of the system under study. | DIN EN ISO 14040, Feb. 2021, p. 13 | -| Treatment | Activities carried out after the end-of-life vehicle is handed over to a facility for the elimination of pollutants, dismantling, coarse crushing, shredding, recycling or preparation for disposal of shredder waste, as well as other activities related to the recycling and/or disposal of end-of-life vehicles and end-of-life vehicle components. | | -| Unit process | Smallest element considered in the life cycle inventory analysis for which input and output data are quantified. | DIN EN ISO 14067, Feb. 2019, p. 23 | -| Upstream emissions | Indirect GHG emissions that occur in the value chain prior to the processes owned or controlled by the reporting company. All upstream transportation emissions are also included as part of upstream emissions. | WBCSD Pathfinder | -| Use stage | That part of the life cycle of a product that occurs between the transfer of the product to the consumer and the end-of-life of the product. | Adapted from WBCSD Pathfinder | -| Value chain | All the upstream and downstream activities associated with the operations of a company. | WBCSD Pathfinder | -| Vehicle | Vehicles of classes M1 or N1 according to Annex II Section A of Directive 70/156/EC and three-wheeled vehicles according to Directive 92/61/EC, however excluding three-wheeled motorcycles. | | -| VIN | vehicle identification number | ISO 3779:2009-10 | -| Waste | Materials, co-products, products, or emissions without economic value that the holder intends or is required to dispose of. | DIN EN ISO 14067, Feb. 2019, p. 26; WBCSD Pathfinder | -| Waste | Any substance or object which the holder discards or intends or is required to discard. | Art. 3(1) of the Directive 2008/98/EC | -| Waste hierarchy | The waste hierarchy is the following priority order in waste prevention and management: (a) prevention; (b) preparing for re-use; (c) recycling; (d) other recovery, e.g., energy recovery; and (e) disposal. | Art. 4 (1) of the Directive 2008/98/EC | -| Waste Prevention | Waste prevention is any measure taken to ensure that a substance, material or article does not become a waste. It is used to reduce the amount of waste, the harmful effects of the waste on people and the environment, or the content of harmful substances in materials and articles. | Kreislaufwirtschaftsgesetz | -| Term | Definition | Source | -| - | - | - | -| Allocation | Partitioning the input or output flows of a process or a product system between the product system under study and one or more other product systems | DIN EN ISO 14040 | -| Attributable process | Those processes that consists of all service, material and energy flows that become, make and carry a product throughout its life cycle. | WBCSD Pathfinder | -| Bio-based Materials | Material of biological origin (biomass excluding material embededded in geological formations and / or fossilised) | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172132, P. 9 | -| Bio-based products | wholly or partly derived from materials of biological origin, excluding materials embedded in geological formations and/or fossilised. | | -| Biomass | Material of biological origin, excluding material embedded in geological formations or transformed material of biological origin, excluding material embedded in geological formations or transformed to fossilized material and excluding peat | DIN ISO 14021 | -| By-Product | Substance or object, resulting from a production process, the primary aim of which is not the production of that item, and does not constitute waste (as defined in Directive 2008/98/E on waste) | Art. 5 No. 1 WFD (Waste framework directive 2008/98/EC) | -| Biodiversity | Biological diversity means the variability among living organisms from all sources including, inter alia, terrestrial, marine and other aquatic ecosystems and the ecological complexes of which they are part: diversity in species, between species and of ecosystems. | Art. 2 UN Convention on biological diversity; ESRS E4 (COM(2023) 5303 final | -| Carbon offsetting | Mechanism for compensatingfor a full PCF or a partial PCF through the prevention of the release of,reduction in, or removal of an amount of GHG emissions in a process outside the product system under study | DIN EN ISO 14067 | -| CAS Number | a unique numerical identifier assigned by the Chemical Abstracts Service (CAS) to every chemical substance described in the open scientific literature. / Except for a small selection of most common substances released under CCBY-NC license the CAS numbers are a proprietary identification scheme to be licensed from CAS (USA) | [CAS REGISTRY / CAS](https://www.cas.org/cas-data/cas-registry) | -| Certificate of Decstruction | An official document issued in accordance with the minimum requirements set out by the European Commission's Decision of February 19, 2002. It confirms the proper disposal of an end-of-life vehicle and is required for vehicle deregistration. | 2000/53/EC | -| Chain-of-Custody approach | A process by which inputs and outputs and associated information are transferred, monitored and controlled as they move through each step in the relevant supply chain. See Mass Balance for details | ISO 22095 | -| Chemical Recycling | Chemical or feedstock recycling refers to the conversion of plastic polymers into their monomers or chemical building blocks or basic chemicals, i. e. depolymerisation by means of thermochemical or chemical processes, although there is currently no uniform, legally binding definition. | Background Paper pn Chemical Recycling - German Environmental Agency, Dec 2020 | -| Circular Econamy | See chapter 3.1; but also “An ec economic system that uses a systemic approach to maintain a circular flow of resources, by recovering, retaining or adding to their value, while contributing to sustainable development | ISO/DIS 59004:2023(E) | -| Circular Economy Principles | The Circular Economy is based on three principles, driven by design: (i) eliminate waste and pollution; (ii) circulate products and materials at their highest value; and (iii) regenerate nature. | EFRAG-Draft ESRS (11/2022) | -| Carbon offsetting | Mechanism for compensatingfor a full PCF or a partial PCF through the prevention of the release of,reduction in, or removal of an amount of GHG emissions in a process outside the product system under study | DIN EN ISO 14067, Feb. 2019, p. 18 | -| Closed-loop recycling | In a closed loop, the secondary material from one product system is either reused in the same product system (real closed-loop) or used in another product system without changing the inherent technical properties of the material (quasi closed-loop). | | -| CO2e (carbon dioxide equivalent) | Unit for comparing the radiative forcing of a greenhouse gas to that of carbon dioxide | DIN EN ISO 14067, Feb. 2019, p.20 | -| component | part or small assembly of parts used as part of a larger assembly | Artikel 2 Begriffsbestimmungen 200053EG | -| Compostable | characteristic of a product, packaging or associated component that allows it to biodegrade, generating a relatively homogeneous and stable humus-like substance. | DIN ISO 14021 | -| Consumer | Any natural person who, in contracts covered by this Directive, is acting for purposes which are outside his trade, business, craft or profession | 2011/83/EU on conusmer rights | -| Co-product | Any of two or more products comning from the same unit process or product system | DIN EN ISO 14067, Feb. 2019, p.22 | -| Cradle-to-gate PCF | Part of a product’s full lifecycle, covering all emissions allocated to a product upstream of a company plus all emissions resulting from processes within the company until the product leaves the suppliers' gate | WBCSD Pathfinder | -| Cut-off criteria | Specification of the amount of material or energy flow or the level of significance of GHG emissions associated with unit processor the product system, to be excluded from a PCF study | DIN EN ISO 14067, Feb. 2019 p.24 | -| Declared unit | Quantity of a product for use as a reference unit in the quantification of a Cradle-to-Gate PCF | adapted from DIN EN iso 14067 | -| Degradable | A characteristic of a product or packaging that, with respect to specific conditions, allows it to break down to a specific extent within a given time. | DIN ISO 14021 | -| Digital Twin | The Digital Twin is a virtual representation of assets and adheres to the following characteristics: The DT has at least one Catena-X-wide unique ID. Digital Twins are organized by a set of Aspects. The set can be extended over lifetime. An Aspect of a DT includes both structural as well as behavioral data and models (including operations and simulation models). The semantics of an Aspect can be described via semantic models A single Aspect can be connected to different heterogenous data sources (including behavioural models) The DT can represent asset types (e.g. virtual prototype of a car) and asset instances (e.g. real car) A DT can cover the whole asset lifecycle including (e.g. planning phase, production, sales, use and decommissioning phase). However, in practice there may be more than one twin with different IDs representing different lifecycle phases (e.g. a twin for types and multiple twins for instances). An asset can have more than one DT The DT represents current available information about an asset (synchronized at a specified frequency and fidelity) which can be leveraged for simulation and business process integration By using aspects the DT can reference other DT to express "part of" or "consists of" relations | Catena-X definition | -| Direct emissions | GHG emissions from the processes that are owned or controlled by the reporting company | WBCSD Pathfinder | -| Downstream emissions | Indirect GHG emissions that occur in the value chain following the processes owned or controlled by the reporting company | WBCSD PAthfinder | -| Durability | The ability of a product, component or material to remain functional and relevant when used as intended. | EFRAG - Draft ESRS (11/2022) | -| ecological assessment | compilation and evoluation of the inputs, outputs, and potential environmental impacts of a product system throughout its life cycle | Artikel 2 Begriffsbestimmungen 200053EG | -| end-of-life | the point at which a product or component is taken out of use | Artikel 2 Begriffsbestimmungen 200053EG | -| end-of-life vehicle | vehicles that are considered waste under Article 1 letter a) of Directive 75/442/EC | Artikel 2 Begriffsbestimmungen 200053EG | -| End-of-waste | The end-of-waste state for waste in Europe is reached when the material is no longer considered waste under the national implementation of the Waste Framework Directive. | EN 15804 | -| Functional unit | Quantified benefit of a product system for use as a comparison unit | | -| Fossile Materials | Fossil raw materials are all raw materials derived from organic material. They incldude coal, crude oil and natural gas. | Bundesverband Geothermie | -| Global warming potential (GWP) | Index, based on radiative properties of GHGs, measuring the radiative forcing following a pulse emission of a unit mass of a given GHG in the present-day atmosphere integrated over a chosen time horizon, relative to that of carbon dioxide (CO2) | DIN EN ISO 14067, Feb. 2019, p. 21 | -| Greenhouse gases (GHGs) | Gaseous constitient of the atmosphere, both natural and anthropogenic, that absorbs and emits radiation at specific wavelengths within the spectrum of infrared radiation emitted by the Earth´s surface, the atmosphere, and clouds | DIN ISO 14067, Feb. 2019, p. 19 | -| ILCD Format | International Life Cycle Data Format | | -| intermediate product | output from a unit process that is input to other unit processes that require further transformation within the system | | -| input | product, material, or energy flow that enters a unit process. Products and materials include raw materials, intermediate products, and coproducts. | WBCSD Pathfinder | -| Land use | Human use or management of land within the relevant boundary | DIN EN ISO 14067, Feb. 2019 p. 30 | -| life cycle | consecutive and interlinked stages to a product, from raw material acquisition or generation from natural resources to final disposal. | DIN EN ISO 14067, Feb. 2019 p. 25 | -| Life cycle assesment (LCA) | Compilation and evaluation of the inputs, outputs and potential environmental impacts of a product system throughout its life cycle | DIN EN ISO 14067, Feb. 2019, p. 25 | -| Life cycle emissions | The sum of GHG emissions resulting from all stages of the life cycle of a product and within the specified boundaries of the product | WBCSD Pathfinder | -| Life cycle inventory (LCI) | The phase of life cycle assessment involving the compilation and quantification of inputs and outputs for a product throughout its life cycle (such as a product´s GHG emissions and sources) | DIN EN ISO 14067, Feb. 2019, p. 25 | -| Life cycle inventory results | GHG impact of the studied product per unit of analysis | WBCSD Pathfinder | -| Mass | In physics, mass is not the same as weight. Mass is both a property of a physical body and a measure of its resistance to acceleration. For disambiguation see definition of "Weight" below | | -| Mass Balance | Mass balance is one of several well-known chain of custody approaches that can be used to track the flow of materials through the value chain. The total quantity of the content in question is tracked through the production system and the allocation of this content is made to the end products based on verifiable accounting. The goal of this method is to ensure proper accounting and to confirm a link between the incoming content (e.g., "sustainable," "recycled," or "organic" according to some definition) and the eventual outgoing product. | [https://www.basf.com/global/documents/de/sustainability/we-source-responsibly/Mass-Balance-White-Paper-2020.pdf](https://www.basf.com/global/documents/de/sustainability/we-source-responsibly/Mass-Balance-White-Paper-2020.pdf) | -| Material | Physical good used as input for production processes of goods or services, or physical good suppliedto a customer as output | adapted from WBCSD Pathfinder | -| Material / Raw Material | Materials are composed of basic substances, (1) either one or more chemical element(s) (like iron, copper) (2) or one or more chemical compound(s) (like acrylic resin, zinc oxide) (3) or one or more materials (like polyamide and glas fibre). Therefore, a material definition is only valid if a definition of (see chemical composition) is given alongside it. | Catena-X Definition, IMDS | -| Material Composition | see chemical composition | Own Catena-X definition | -| Material Declaration | Material declaration (MD) is the process mandated to meet the obligations placed on (automobile) manufacturers, and thus on their suppliers, by national and international standards, laws and regulations. | IMDS Information Pages - Home - IMDS Public Pages (mdsystem.com) | -| Material Details | Collection of material information defined by given context in an information model | Catena-X Definition | -| Material Identifier | Material Identifier is a alphanumerical identifier that serves programmatic functions (e.g., as data ID) but also satisfies chemical regulation (see material declaration) under national and international law. | Catena-X definition | -| Material Name | Trivial name (often name of a chemical group) used to denote some material in everyday speech or jargon. Entirely dependent on specific context. | Catena-X definition | -| Material Type | Groups of materials defined by convention (e.g., IMDS) or ISO Standard (e.g., ISO 62474) in order to simplify communication of relevance of material information (in search or filtering) | [https://std.iec.ch/iec62474/iec62474.nsf/Index?open&q=180013](https://std.iec.ch/iec62474/iec62474.nsf/Index?open&q=180013) | -| Mechanical Recycling | End-of-life materials can be processed via collecting, sorting, shredding, melting and transforming it into secondary raw materials for a new application. This form of recycling involves processes in which e.g. the polymer structure is not significantly changed and the plastic is preserved as a material. Thus, in terms of its complexity, mechanical recycling takes place at a lower technical level than chemical recycling. | [Mechanical recycling (basf.com)](https://www.basf.com/global/en/who-we-are/sustainability/we-drive-sustainable-solutions/circular-economy/mechanical-recycling.html) [Glossar und Methoden/Statistikportal.de](https://www.statistikportal.de/de/ugrdl/glossar-und-methoden#P) | -| Multi-input-output unit process | Operation or process with multiple inputs, such as materials and energy, and multiple outputs, such as co-products and waste | WBCSD Pathfinder | -| Negative emissions | Removal of greenhouse gases (GHGs) from the atmosphere by deliberate human activities, i.e., in addition to the removal that would occur via natural carbon cycle processes | IPCC glossary | -| Net negative emissions | A situation of net negative emissions is achieved when,as the result of human activities, more greenhouse gases are removed from the atmosphere than are emitted into it. Where multiple greenhouse gases are involved, the quantification of negative emissions depends on the climate metric chosen to compare emissions of different gases (such as global warming potential, global temperature change potential, and others, as well as the chosen time horizon). | IPCC glossary | -| Net zero CO2 emissions | Net zero carbon dioxide (CO2) emissions are achieved when anthropogenic CO2 emissions are balanced globally by anthropogenic CO2 removals over a specified period. Net zero CO2 emissions are also referred to as carbon neutrality. | IPCC glossary | -| Net zero emissions | Net zero emissions are achieved when anthropogenic emissions of greenhouse gases into the atmosphere are balanced by anthropogenic removals over a specified period. Where multiple greenhouse gases are involved, the quantification of net zero emissions depends on the climate metric chosen to compare emissions of different gases (such as global warming potential, global temperature change potential, and others, as well as the chosen time horizon). | IPCC glossary | -| Open-loop recycling | In open-loop recycling, the material is reused in other productsystems and its inherent properties are changed (e.g., recycled material may have a different chemical composition, a different structure or a higher concentration of dissolved impurities compared to primary material). | | -| output | product, material, or energy flow that leaves a unit process. Products and material include raw materials, intermediate products, co-products, and releases. | WBCSD Pathfinder | -| Partial PCF | Sum of GHG emissions and GHG removals of one or more selected process(es) in a product system, expressed as carbon dioxide equivalents and based on the selected stages or processes within the life cycle. | DIN EN ISO 14067, Feb. 2019, p. 16 | -| Post-consumer Recyclate | Post-Consumer (PCR) recycled content represents the total proportion, by mass, of post-consumer input materials incorporated in the process. | SP-Recycled-Content-Definition-Final-09102021-1.pdf | -| Post-consumer material | Material generated by households or by commercial, industrial and institutional facilities in their role as end-users of the product which can no longer be used for its intended purpose. This includes returns of material from the distribution chain. Post-consumer material can be used in the form of recovered or recycled material as a substitute for primary material. | DIN ISO 14021 | -| Pre-consumer Material | Material diverted from the waste stream during a manufacturing process. Excluded is reutilization of materials such as rework, regrind or scrap generated in a process and capable of being reclaimed within the same process that generated it. Pre-consumer material can be used in the form of recovered or recycled material as a substitute for primary material. | DIN ISO 14021 | -| Primary data | Data pertaining to a specific product or activity within a company’s value chain. Such data may take the form of activity data, emissions, or emission factors. Primary data is site-specific, company-specific (if there are multiple sites for the same product) or supply chain–specific. | WBCSD Pathfinder | -| Primary Material | Raw material coming from the environment, as well as materials of differing stages of processing (Raw materials, semi- and finished goods), which are used in the production process for the first time. | | -| Process | Set of interrelated or interacting activities that transforms inputs into outputs. | DIN EN ISO 14067, feb. 2019, p. 23 | -| prevention | measures to reduce the quantity and environmental harm of end-of-life vehicles, their materials, and substances. | | -| producer / Manufacturer | the vehicle manufacturer or the commercial importer of a vehicle into a EU Member State | | -| product | a product refers to any goods or service, which can be categorized as services (e.g. transport), software (e.g. computer program, dictionary), hardware (e.g. engine mechanical part), and processed materials (e.g. lubricant). Services have both tangible and intangible elements. The provision of a service can involve activities such as repairing a customer-supplied tangible product (e.g. an automobile) or working on a customer-supplied intangible product (e.g. preparing a tax return using an income statement). | | -| Product carbon footprint (PCF) | Total GHG emissions generated during the life cycle of a product, measured in CO2e. Within the boundary of the CX-PCF Rulebook, emissions related to the product use and end-of-life stages are excluded from the PCF. | WBCSD Pathfinder | -| Product category | Group of products that can fulfill equivalent functions. | WBCSD Pathfinder | -| Product category rules (PCR) | A set of specific rules, requirements, and guidelines for calculating PCFs (among other things) and developing environmental declarations for one or more product categories according to EN ISO 14040:2006. | WBCSD Pathfinder | -| Production | Process of combining various inputs, both material (such as metal, wood, glass, or plastics) and immaterial (such as plans, or knowledge) in order to create output. | | -| product system | collection of unit processes with elementary and product flows, performing one or more defined functions, and which models the life cycle of a product | DIN EN ISO 14067, Feb. 2019, p. 22 | -| Production waste | Waste generated in different industries in connection with production and the opposite to consumption waste, which primarily comprise municipal waste and waste comparable to it. | [Production waste / Concepts / Statistics Finland](https://www.stat.fi/meta/kas/tuotantojate_en.html) | -| R-Strategies | Various approaches to implement circular economy, known as R-strategies, have been developed to achieve less resource and material consumption in product chains and make the economy more circular. | Potting, J., et al. "Circular economy: measuring innovation in the product chain." Planbureau voor de Leefomgeving 2544 (2017). | -| raw materials | primary or secondary material that is used to produce a product. Secondary material includes recycled material. | | -| Recovery | Any operation the principal result of which is waste serving a useful purpose by replacing other materials which would otherwise have been used to fulfill a particular function, or waste being prepared to fulfill that function, in the plant or in the wider economy. | Art. 3 (15) of directive 2008/98 EC | -| Recovered Material | Material that would have otherwise been disposed of as waste or used for energy recovery, but has instead been collected and recovered [reclaimed] as a material input, in lieu of new primary material, for a recycling or a manufacturing process. | DIN ISO 14021 | -| Recyclate | Secondary raw materials that have been generated by means of the recovery of waste or are generated in the disposal of waste and are suitable for the production of products. | | -| Recycled Content | Proportion, by mass, of recycled material in a product or packaging. The recycled content is the sum of pre-consumer material and post-consumer material. | DIN ISO 14021 | -| Recycled Material | Material, that has been reprocessed from (reclaimed) material by means of a manufacturing process and made into a final product or into a component for incorporation into a product. | DIN ISO 1402 | -| Recycling | Any recovery operation by which waste materials are reprocessed into products, materials or substances whether for the original or other purposes. It includes the reprocessing of organic material but does not include energy recovery and the reprocessing into materials that are to be used as fuels or for backfilling operations. ‘recycling’ means the reprocessing in a production process of the waste materials for the original purpose or for other purposes but excluding energy recovery. Energy recovery means the use of combustible waste as a means to generate energy through direct incineration with or without other waste but with recovery of the heat; | EFRAG – Draft ESRS (11/2022) | -| Reduce | Increase efficiency in product manufacture or use by consuming fewer natural resources and materials | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172131, p. 7 | -| Reference flow | Measure of the inputs to or outputs from processes in a given product system required to fulfil the function expressed by the functional unit. | DIN EN ISO 14067, Feb. 2019, p. 24 | -| Refurbish | Restore an old product and bring it up to date (to specified quality level) | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172131, p. 7 | -| Refuse | Make product redundant by abandoning its function or by offering the same function by a radically different (e.g. digital) product or service | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172131, p. 7 | -| Releases | tbd. | | -| Remanufacture | Remanufacturing is a standardized industrial process by which a used product or part are returned to same-as-new, or better, condition and performance. The process is in line with specific technical specifications, including engineering, quality and testing standards. The process yields fully warranted products. Collecting discarded products or materials that can be refinished and sanitised to serve their original functions | CLEPA, European Environmental Agency - Eionet report ETC/WMGE 2021/10, P. 3 | -| Renewable Energy | Energy from renewable sources’ or ‘renewable energy’ means energy from renewable non-fossil sources, namely wind, solar (solar thermal and solar photovoltaic) and geothermal energy, ambient energy, tide, wave and other ocean energy, hydropower, biomass, landfill gas, sewage treatment plant gas, and biogas. | Renewable Energy Directive (2018/2001) | -| Renewable materials | Material that is derived from resources that are quickly replenished by ecological cycles or agricultural processes, so that the services provided by these and other linked resources are not endangered and remain available for the next generation. | EFRAG – Draft ESRS (11/2022) | -| Repair | Repair and maintenance of defective product so it can be used with its original function | [Link, ESPR Draft](https://op.europa.eu/en/publication-detail/-/publication/ca9846a8-6289-11ea-b735-01aa75ed71a1/language-en/format-PDF/source-120460723) | -| Repurpose | Use a redundant product or its parts in a new product with different function | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172131, p. 7 | -| Rethink | Make product use more intensive (e.g. through product-as-a-service, reuse and sharing models or by putting multi-functional products on the market) | European Commission, Categorisation System for the Circular Economy Circular Economy, doi: 10.2777 / 172131, p. 7 | -| Reuse | Reuse of a product which is still in good condition and fulfils its original function (and is not waste) for the same purpose for which it was conceived | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172131, p. 7 | -| Reutilization | Reutilization of materials such as rework, regrind, or scrap materials generated within the process and capable of being reused within the same process that generated it. Any operation by which products or components that are not waste are used again for the same purpose for which they were originally intended. Reutilization allows waste to be reduced and materials can be kept in cycle. | Adapted from ISO 14021 | -| Representative product | The representative product can be a real or an averaged (non-existing) product. The averaged product should be calculated based on sales-weighted characteristics of all technologies/materials used in the company’s production system. | | -| Resource inflow | Resource that enters the organisation's infrastructure. | EFRAG – Draft ESRS (11/2022) | -| Resource outflow | Resource that leaves the organisation's infrastructure. | EFRAG – Draft ESRS (11/2022) | -| Reuse | Any operation by which products and components that are not waste are used again for the same purpose for which they were conceived. This may involve cleaning or small adjustments so it is ready for the next use without significant definition. | Art. 3 (13) of the Directive 2008/98/EC & EFRAG-Draft ESRS (11/2022) | -| Risk management | Plans, actions, strategies, or policies to reduce the likelihood and/or consequences of risks or to respond to consequences. | IPCC Glossary, p. 45 | -| Secondary data | Secondary data can include data from databases and published literature, default emission factors from national inventories, calculated data estimates or other representative data, validated by competent authorities. | DIN EN ISO 14067, Feb. 2019, p. 28 | -| Secondary Material | Secondary materials are any materials that are not the primary products from manufacturing and other industrial sectors. These materials can include scrap and residuals from production processes and products that have been recovered at the end of their useful life. | [United States Environmental Protection Agency](https://www.epa.gov/smm/sustainable-management-industrial-non-hazardous-secondary-materials) | -| Secondary Material Framework | Secondary Material Quota = on vehicle level, Secondary Material Content = on component level | | -| Secondary Material Quota (on vehicle level) | not found | | -| Secondary Raw Material | Material that serves as a substitute for primary material and is kept in cycle. | | -| Secondary Raw Material Content | The content of materials that serve as substitutes for primary materials and are kept in cycle. The secondary raw material content is calculated in proportion of secondary material and product weight. | | -| Supplier gate | Supplier's production site or supplier's distribution site. | | -| Supply chain | Those involved, through upstream and downstream linkages, in process and activities relating to the provision of products to the user. | DIN EN ISO 14067, Feb. 2019, p. 28 | -| Sustainability | A dynamic process that guarantees the persistence of natural and human systems in an equitable manner. | IPCC Glossary, p. 49 | -| System boundary | Boundary based on a set of criteria representing which unit processes are a part of the system under study. | DIN EN ISO 14040, Feb. 2021, p. 13 | -| Treatment | Activities carried out after the end-of-life vehicle is handed over to a facility for the elimination of pollutants, dismantling, coarse crushing, shredding, recycling or preparation for disposal of shredder waste, as well as other activities related to the recycling and/or disposal of end-of-life vehicles and end-of-life vehicle components. | | -| Unit process | Smallest element considered in the life cycle inventory analysis for which input and output data are quantified. | DIN EN ISO 14067, Feb. 2019, p. 23 | -| Upstream emissions | Indirect GHG emissions that occur in the value chain prior to the processes owned or controlled by the reporting company. All upstream transportation emissions are also included as part of upstream emissions. | WBCSD Pathfinder | -| Use stage | That part of the life cycle of a product that occurs between the transfer of the product to the consumer and the end-of-life of the product. | Adapted from WBCSD Pathfinder | -| Value chain | All the upstream and downstream activities associated with the operations of a company. | WBCSD Pathfinder | -| Vehicle | Vehicles of classes M1 or N1 according to Annex II Section A of Directive 70/156/EC and three-wheeled vehicles according to Directive 92/61/EC, however excluding three-wheeled motorcycles. | | -| VIN | vehicle identification number | ISO 3779:2009-10 | -| Waste | Materials, co-products, products, or emissions without economic value that the holder intends or is required to dispose of. | DIN EN ISO 14067, Feb. 2019, p. 26; WBCSD Pathfinder | -| Waste | Any substance or object which the holder discards or intends or is required to discard. | Art. 3(1) of the Directive 2008/98/EC | -| Waste hierarchy | The waste hierarchy is the following priority order in waste prevention and management: (a) prevention; (b) preparing for re-use; (c) recycling; (d) other recovery, e.g., energy recovery; and (e) disposal. | Art. 4 (1) of the Directive 2008/98/EC | -| Waste Prevention | Waste prevention is any measure taken to ensure that a substance, material or article does not become a waste. It is used to reduce the amount of waste, the harmful effects of the waste on people and the environment, or the content of harmful substances in materials and articles. | Kreislaufwirtschaftsgesetz | +| Term | Definition | Source | +| ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Aggregate State/ State of Matter | State of matter (German: "Aggregatzustand") is one of the distinct forms in which matter can exist. Three states of matter are observable at ambient conditions and free of electrical charge: solid, liquid, gas | State of matter - Wikipedia | +| Base Quantity | The International System of Quantities defines seven base quantities. The set of base quantities is chosen by convention where no base quantity can be expressed in terms of the others, but where every quantity in the system can be expressed in terms of the base quantities. | International System of Quantities - Wikipedia | +| Bio-based Materials | Material of biological origin excluding material embedded in geological formations and/or fossilised | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172132, P. 9 | +| Biomass | Material of biological origin, excluding material embedded in geological formations or transformed material of biological origin, excluding material embedded in geological formations or transformed to fossilized material and excluding peat | DIN ISO 14021 | +| By-Product | Substance or object, resulting from a production process, the primary aim of which is not the production of that item, and does not constitute waste (as defined in Directive 2008/98/E on waste) | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172132, P. 9 | +| CAS Number | a unique numerical identifier assigned by the Chemical Abstracts Service (CAS) to every chemical substance described in the open scientific literature. / Except for a small selection of most common substances released under CC-BY-NC license the CAS numbers are a proprietary identification scheme to be licensed from CAS (USA) | CAS Registry Number - Wikipedia | +| Chain-of-Custody approach | Mass balance is one of several well-known chain of custody approaches that can be used to track the flow of materials through the value chain. The total quantity of the content in question is tracked through the production system and the allocation of this content is made to the end products based on verifiable accounting. The goal of this method is to ensure proper accounting and to confirm a link between the incoming content (e.g., "sustainable," "recycled," or "organic" according to some definition) and the eventual outgoing product. | [https://www.basf.com/global/documents/de/sustainability/we-source-responsibly/Mass-Balance-White-Paper-2020.pdf](https://www.basf.com/global/documents/de/sustainability/we-source-responsibly/Mass-Balance-White-Paper-2020.pdf) | +| Chemical Composition | Chemical composition refers to identity and number of the chemical elements that make up any particular chemical compound. In order to provide unambiguous information, "chemical element" and "chemical compound" must be defined as context. | Chemical composition - Wikipedia | +| Chemical Recycling | Chemical or feedstock recycling refers to the conversion of plastic polymers into their monomers or chemical building blocks or basic chemicals, i. e. depolymerisation by means of thermochemical or chemical processes, although there is currently no uniform, legally binding definition [13]. | Background Paper on Chemical Recycling - German Environmental Agency, Dec 2020 | +| Circular Economy | The circular economy is a model of production and consumption, which involves sharing, leasing, reusing, repairing, refurbishing and recycling existing materials and products as long as possible. In this way, the life cycle of products is extended. | European Parliament | +| Closed-Loop-Recycling | In a closed loop, the secondary material from one product system is either reused in the same product system or used in another product system without changing the inherent properties of the material. | PCF Rulebook | +| Component | Part or small assembly of parts used as part of a larger assembly | Article 2 Definitions 200053EG | +| Compostable | Characteristic of a product, packaging or associated component that allows it to biodegrade, generating a relatively homogeneous and stable humus-like substance. | DIN ISO 14021 | +| Consumer | Any natural person who, in contracts covered by this Directive, is acting for purposes which are outside his trade, business, craft or profession | 2011/83/EU on consumer rights | +| Co-Product | Any two or more products coming from the same unit process or product system. | PCF Rulebook, DIN EN ISO 14067, Feb. 2019, p.22 | +| Degradable | A characteristic of a product or packaging that, with respect to specific conditions, allows it to break down to a specific extent within a given time. | DIN ISO 14021 | +| Disposal | Disposal means any of the applicable operations provided for in Annex IIA to Directive 75/442/EEC, for instance deposit into or onto land, land treatment, deep injection, surface impoundment, release into water body, biological treatment, physico-chemical treatment. | Guideline 2000/53/EG | +| Dismantling ability | The ability of components to be removed from the vehicle. | ISO 22628:2002-02 | +| Dismantling Information | All information necessary for the proper and environmentally sound treatment of an end-of-life vehicle. It is provided to authorized treatment facilities by vehicle manufacturers and suppliers in the form of manuals or electronic media (such as CD-ROMs, online services). | Guideline 2000/53/E | +| Downcycling | Downcycling, or cascading, is the recycling of waste where the recycled material is of lower quality and functionality than the original material. | Downcycling - Wikipedia | +| Ecological Assessment | Compilation and evaluation of the inputs, outputs, and potential environmental impacts of a product system throughout its life cycle | Article 2 Definitions 200053EG | +| Economic operators | Manufacturers, distributors, take-back points, motor vehicle insurance companies, dismantling facilities, shredder plant operators, recovery facilities, recycling facilities, as well as other facilities for the treatment of end-of-life vehicles, including their components and materials. | Guideline 2000/53/EG | +| End-of-Life | The point at which a product or component is taken out of use | Article 2 Definitions 200053EG | +| End-of-Life Vehicle | Vehicles that are considered waste under Article 1 letter a) of Directive 75/442/EC | Article 2 Definitions 200053EG | +| End-of-Waste | The end-of-waste state for waste in Europe reached when the material is no longer considered a waste under the national implementation of the Waste Framework Directive. | PCF Rulebook, EN 15804 | +| Energy recovery | Energy recovery includes any process that refers to the use of waste as a raw material or the treatment of waste that cannot be recycled. The aim is to recover energy from materials and associated with this, to convert them into usable heat, electricity or fuel. | U.S. Environmental Protection Agency (2016) Energy Recovery from Waste | +| Fossil Materials | Fossil raw materials are all raw materials derived from organic material. They include coal, crude oil and natural gas. | Federal Geothermal Office | +| Hazardous substances | Any substance that is classified as hazardous according to Directive 67/548/EEC. | Guideline 2000/53/EG | +| ILCD Format | International Life Cycle Data Format | PCF Rulebook | +| Input | Product, material or energy flow that enters a unit process. | Pathfinder / PCF Rulebook | +| Intermediate Product | Output from a unit process that is input to other unit processes that require further transformation within the system | Article 2 Definitions 200053EG | +| Life Cycle | Consecutive and interlinked stages related to a product, from raw material acquisition or generation from natural resources to end-of-life treatment. | DIN EN ISO 14067, PCF Rulebook | +| Mass | In physics, mass is not the same as weight. Mass is both a property of a physical body and a measure of its resistance to acceleration. For disambiguation see definition of "Weight" below | Wikipedia | +| Mass-Balancing | Considering the output, no physical or chemical difference exists between in-scope and out-of-scope. It involves balancing volume reconciliation to ensure the exact account of volumes of in- and out-of-scope source is maintained along the supply chain, provided that the volume or the ratio of sustainable material integrated is reflected in the product produced and sold to customers. This model requires that a reconciliation period is defined (e.g. a month, a year). | PCF Rulebook | +| Material | Physical good used as input for production processes of goods or services or physical good supplied to a customer as output | Pathfinder / PCF Rulebook | +| Material Declaration | Material declaration (MD) is the process mandated to meet the obligations placed on (automobile) manufacturers, and thus on their suppliers, by national and international standards, laws and regulations. | IMDS Information Pages - Home - IMDS Public Pages (mdsystem.com) | +| Material Details | Collection of material information defined by given context in an information model | Catena-X definition | +| Material Identifier | Material Identifier is a alphanumerical identifier that serves programmatic functions (e.g., as data ID) but also satisfies chemical regulation (see material declaration) under national and international law. | Catena-X definition | +| Material Name | Trivial name (often name of a chemical group) used to denote some material in everyday speech or jargon. Entirely dependent on specific context. | Catena-X definition | +| Material Recovery | Material recovery is recovery by processes in which virgin material of the same substance is replaced or the material remains available for further material use. | Packaging Act § 3 para. 19 | +| Material Type | Groups of materials defined by convention (e.g., IMDS) or ISO Standard (e.g., ISO 62474) in order to simplify communication of relevance of material information (in search or filtering) | IEC 62474 – Material Declaration | +| Mechanical Recycling | End-of-life materials can be processed via collecting, sorting, shredding, melting and transforming it into secondary raw materials for a new application. This form of recycling involves processes in which e.g. the polymer structure is not significantly changed, and plastic is preserved as a material. Thus, in terms of its complexity, mechanical recycling takes place at a lower technical level than chemical recycling. | Mechanical recycling (basf.com) | +| Glossary and methods Open-loop recycling | In open-loop recycling, the material is reused in other product systems and is inherent properties are changed (e.g. recycled material may have a different chemical composition, a different chemical structure or a higher concentration of dissolved impurities compared to primary material) | PCF Rulebook | +| Output | Product, material or energy that leaves a unit process. | Pathfinder / PCF Rulebook | +| Post-consumer material | Material generated by households or by commercial, industrial and institutional facilities in their role as end-users of the product which can no longer be used for its intended purpose. This includes returns of material from the distribution chain. Post-consumer material can be used in the form of recovered or recycled material as a substitute for primary material. | DIN ISO 14021 | +| Pre-consumer Material | Material diverted from the waste stream during a manufacturing process. Excluded is reutilization of materials such as rework, regrind or scrap generated in a process and capable of being reclaimed within the same process that generated it. Pre-consumer material can be used in the form of recovered or recycled material as a substitute for primary material. | DIN ISO 14021 | +| Primary Material | Raw material coming from the environment, as well as materials of differing stages of processing (Raw materials, semi- and finished goods), which are used in the production process for the first time. | | +| Prevention | Measures to reduce the quantity and environmental harm of end-of-life vehicles, their materials, and substances | Guideline 2000/53/EG | +| Process | Set of interrelated or interacting activities that transform inputs into outputs. | DIN EN ISO 14067, PCF Rulebook | +| Producer | The vehicle manufacturer or the commercial importer of a vehicle into an EU Member State | Article 2 Definitions 200053EG | +| Product | Any good (tangible product) or service (intangible product) | PCF Rulebook | +| Production | Process of combining various inputs, both material (such as metal, wood, glass, or plastics) and immaterial (such as plans, or knowledge) in order to create output. | Production (economics) - Wikipedia | +| Production Waste | Waste generated in different industries in connection with production and the opposite to consumption waste, which primarily comprise municipal waste and waste comparable to it. | Production waste Concepts Statistics Finland | +| Raw Material | Primary or secondary material, that is used for production of a product. | Pathfinder / PCF Rulebook | +| Recoverability | The ability of components and/or materials to be directed to a recovery process from the waste stream. | ISO 22628:2002-02 | +| Recoverability quote | The percentage of the mass of the new vehicle that can potentially be recovered and/or reused. | ISO 22628:2002-02 | +| Recovered Material | Material that would have otherwise been disposed of as waste or used for energy recovery, but has instead been collected and recovered [reclaimed] as a material input, in lieu of new primary material, for a recycling or a manufacturing process. | DIN ISO 14021 | +| Recyclate | Secondary raw materials that have been generated by means of the recovery of waste or are generated in the disposal of waste and are suitable for the production of products. | KrWG, Framework Waste Directive | +| Recyclability quote | The percentage of the mass of the new vehicle that can potentially be recycled and/or reused. | ISO 22628:2002-02 | +| Recycled Content | Proportion, by mass, of recycled material in a product or packaging. The recycled content is the sum of pre-consumer material and post-consumer material. | DIN ISO 14021 | +| Recycled Material | Material, that has been reprocessed from (reclaimed) material by means of a manufacturing process and made into a final product or into a component for incorporation into a product. | DIN ISO 14021 | +| Recycling | Recycling is the process of collecting, sorting, and processing waste to release materials that can be reused for their original purpose or other purposes, except for the energy recovery. Energy recovery is the use of combustible waste for energy production by direct combustion with or without other types of waste, but with the recovery of heat. | DIRECTIVE 2002/96/EC | +| Reduce | Increase efficiency in product manufacture or use by consuming fewer natural resources and materials | European Commission, Categorization System for the Circular Economy, doi:10.2777/172131, p. 7 | +| Refurbish | Restore an old product and bring it up to date (to specified quality level) | European Commission, Categorization System for the Circular Economy, doi:10.2777/172131, p. 7 | +| Refurbishment | Includes the same process steps as remanufacturing, that is repairing, restoring, rebuilding and/or replacing. A refurbished product is not comparable to a new one but has been updated to a specific quality level and should be fully functional. | Refurbishing – Wikipedia | +| Refuse | Make product redundant by abandoning its function or by offering the same function by a radically different (e.g. digital) product or service | European Commission, Categorization System for the Circular Economy, doi:10.2777/172131, p. 7 | +| Remanufacture | Use parts of a discarded product in a new product with the same function (and as-new-condition) | European Commission, Categorization System for the Circular Economy, doi:10.2777/172131, p. 7 | +| Remanufacturing | Remanufacturing is a standardized industrial process that restores used products to their original performance level or better, with a warranty equivalent to or surpassing that of newly manufactured products. The remanufacturing effort includes dismantling the product, restoring and replacing components, and testing individual parts and the whole product to ensure it meets its original design and performance specifications, as seen from the customer’s perspective. | BS 8887-2:2009 | +| Repair | Repair is the process of returning a faulty or broken product or component to a usable state. The effort put into the repair is minimal and only addresses the specified fault to ensure the useability of the product; however, the performance of the repaired part may not be guaranteed. The warranty for a repaired product is generally less than that of a new or remanufactured product and may only apply to the replaced or repaired component | BS 8887-2:2009 | +| Repurpose | Use a redundant product or its parts in a new product with different function | European Commission, Categorization System for the Circular Economy, doi:10.2777/172131, p. 7 | +| Resource (Rohstoff) | Resource that is used or can be used in a process. A resource can be of a material or immaterial nature. When the term "resource" is used in the context of environmental science, it refers to a "natural resource". Unlike here, the term resource is often used very narrowly in the sense of raw materials. | | +| Resource Protection | Economical use of natural resources with the aim of preserving their quantity and function. | | +| Rethink | Make product use more intensive (e.g. through product-as-a service, reuse and sharing models or by putting multi-functional products on the market) | European Commission, Categorization System for the Circular Economy, doi:10.2777/172131, p. 7 | +| R-Strategies | R-Strategies, as part of circular economy, encompass a range of sustainable resource management approaches that prioritize actions such as reuse, remanufacturing, recycling, and recovery. These strategies aim to extend the life of products and materials, reduce waste generation, and minimize environmental impacts by promoting the efficient and responsible use of resources throughout their life cycle, thus contributing to the implementation of the circular economy model. | Inspired by Potting et al.: Potting, J.; Hekkert, M.P.; Worrell, E.; Hanemaaijer, A. Circular Economy: Measuring Innovation in the Product Chain; Planbureau voor de Leefomgeving: Hague, The Netherlands, 2017. | +| Re-use | Re-use of a product which is still in good condition and fulfils its original function (and is not waste) for the same purpose for which it was conceived | European Commission, Categorization System for the Circular Economy, doi:10.2777/172131, p. 7 | +| Reusability | The ability of components to be diverted from the waste stream and reused. | ISO 22628:2002-02 | +| Reutilization | Reutilization of materials such as rework, regrind, or scrap materials generated within the process and capable of being reused within the same process that generated it. | Adapted from ISO 14021 | +| Scrap | Iron and steel material in metallic form that is recovered in multiple life cycle stages, including steel production processes, the manufacturing processes of final products and the end of life of final products | Adapted from ISO 20915:2018 | +| Secondary Raw Material | Secondary materials are any materials that are not the primary products from manufacturing and other industrial sectors. These materials can include scrap and residuals from production processes and products that have been recovered at the end of their useful life. | [US EPA, 17.08.2023](https://www.epa.gov/smm/sustainable-management-industrial-non-hazardous-secondary-materials#:~:text=Secondary%20materials%20are%20any%20materials,end%20of%20their%20useful%20life) | +| Shredder | Any facility that is used to crush or shred end-of-life vehicles, including for the purpose of recovering directly reusable metal scrap. | Guideline 2000/53/EG | +| Treatment | Activities carried out after the end-of-life vehicle is handed over to a facility for the elimination of pollutants, dismantling, coarse crushing, shredding, recycling or preparation for disposal of shredder waste, as well as other activities related to the recycling and/or disposal of end-of-life vehicles and end-of-life vehicle components. | Guideline 2000/53/EG | +| Vehicle | Vehicles of classes M1 or N1 according to Annex II Section A of Directive 70/156/EC and three-wheeled vehicles according to Directive 92/61/EC, however excluding three-wheeled motorcycles. | Article 2 Definitions 200053EG | +| Vehicle mass | Unladen mass of the operational vehicle (code: ISO-M06), according to DIN ISO 1176, term 4.6: unladen mass of the dry vehicle (term 4.5) plus the mass of lubricants, coolant (if required), washing fluids, fuel (tank filled to at least 90% of the manufacturer's specified capacity), spare wheel(s), fire extinguisher, standard spare parts, wheel chocks, standard tool ship. | ISO 22628:2002-02 | +| Waste | Materials, co-products, products, or emissions without economic value that the holder intends or is required to dispose of. | DIN EN ISO 14067, PCF Rulebook, Pathfinder | +| Waste Prevention | Waste prevention is any measure taken to ensure that a substance, material or article does not become a waste. It is used to reduce the amount of waste, the harmful effects of the waste on people and the environment, or the content of harmful substances in materials and articles. | Closed Substance Cycle Waste Management Act | +| Weight | In science and engineering, the weight of an object is the _force_ acting on the object due to gravity. For disambiguation see definition of "Mass" above | Mass - Wikipedia | +| | ## NOTICE This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). -- Copyright (c) 2023,2024 BMW AG -- Copyright (c) 2023,2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) -- Copyright (c) 2023,2024 BASF SE -- Copyright (c) 2023,2024 SAP Deutschland SE & Co.KG -- Copyright (c) 2023,2024 T-Systems International GmbH -- Copyright (c) 2023,2024 LRP Auto-Recycling Leipzig GmbH -- Copyright (c) 2023,2024 Robert Bosch GmbH -- Copyright (c) 2023,2024 tec4U-Ingenieurgesellschaft mbH -- Copyright (c) 2023,2024 Contributors to the Eclipse Foundation# NOTICE - -This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - - Copyright (c) 2023,2024 BMW AG - Copyright (c) 2023,2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) - Copyright (c) 2023,2024 BASF SE diff --git a/docs-kits/kits/Circularity_KIT/page_changelog.md b/docs-kits/kits/Circularity_KIT/page_changelog.md index 38529d5b1cf..ff8bbee334b 100644 --- a/docs-kits/kits/Circularity_KIT/page_changelog.md +++ b/docs-kits/kits/Circularity_KIT/page_changelog.md @@ -5,7 +5,7 @@ description: "Circularity KIT" sidebar_position: 1 --- -![Circulairty kit banner](/img/kit-icons/circularity-kit-icon.svg) +![Circularity kit banner](/img/kit-icons/circularity-kit-icon.svg) All notable changes to this Kit will be documented in this file. ## [1.3.0] - 17.09.2024 @@ -18,7 +18,17 @@ All notable changes to this Kit will be documented in this file. ### Added -- add Informational Requirements at End of Life +- add new figures +- add license files for new figures + +### Changed + +- change structure of the contents. Same content chapters are in different order +- change wording + +### Removed + +- ./. ## [1.1.0] - 15.05.2024 diff --git a/docs-kits/kits/Circularity_KIT/resources/adoption-view/CE_assistant_architecture_view.svg b/docs-kits/kits/Circularity_KIT/resources/adoption-view/CE_assistant_architecture_view.svg new file mode 100644 index 00000000000..035619e60d8 --- /dev/null +++ b/docs-kits/kits/Circularity_KIT/resources/adoption-view/CE_assistant_architecture_view.svg @@ -0,0 +1 @@ +CE Assistant ArchitectureDATA CONSUMERClient, Supplier, etc…Discovery FinderDATA PROVIDEROEMs, etc.CATENA-X OPERATOREDC DiscoveryBPN DiscoveryPortal IAMManagedIdentityWalletsCEAssistantEDCVaultVaultEDCData ServiceDigital TwinRegistryDescriptionCommunications inscopeEncryptedApplicationsinscopeData planeproxycommunicationsDataproviderspecificAsset ID publish \ No newline at end of file diff --git a/docs-kits/kits/Circularity_KIT/resources/adoption-view/CE_assistant_architecture_view.svg.license b/docs-kits/kits/Circularity_KIT/resources/adoption-view/CE_assistant_architecture_view.svg.license new file mode 100644 index 00000000000..086356bd4e6 --- /dev/null +++ b/docs-kits/kits/Circularity_KIT/resources/adoption-view/CE_assistant_architecture_view.svg.license @@ -0,0 +1,14 @@ +## NOTICE + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- Copyright (c) 2023 BMW AG +- Copyright (c) 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) +- Copyright (c) 2023 BASF SE +- Copyright (c) 2023 SAP Deutschland SE & Co.KG +- Copyright (c) 2023 T-Systems International GmbH +- Copyright (c) 2023 LRP Auto-Recycling Leipzig GmbH +- Copyright (c) 2023 Robert Bosch GmbH +- Copyright (c) 2023 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Circularity_KIT/resources/adoption-view diff --git a/docs-kits/kits/Circularity_KIT/resources/adoption-view/CE_assistant_environmental_assessment.svg b/docs-kits/kits/Circularity_KIT/resources/adoption-view/CE_assistant_environmental_assessment.svg new file mode 100644 index 00000000000..28d7aa3b539 --- /dev/null +++ b/docs-kits/kits/Circularity_KIT/resources/adoption-view/CE_assistant_environmental_assessment.svg @@ -0,0 +1,2261 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Szenario_4R + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Teilsystem + + + + + + + + + + + + + + + + Tabelle.2 + + Tabelle.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.4 + User (Dismantling Lead) + + Tabelle.5 + + + + + + + + + + + + + + + + + + + + + + + User (Dismantling Lead) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Teilsystem.54 + + + + + + + + + + + + + + + + Tabelle.7 + + Tabelle.8 + Remanufacturing + + + + + + + + + + + + + + + + Remanufacturing + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.9 + CE-Strategy Assistant + + Tabelle.10 + + + + + + + + + + + + + + + + + + + + + + + CE-Strategy Assistant + + + + Anfangsknoten + + + + + + + Aktion.1001 + Technical feasible R-Strategy + + + + + + + Technical feasible R-Strategy + + Tabelle.29 + + Anfangsknoten.1406 + + + + + + + Anfangsknoten.1409 + + + + + + + Tabelle.32 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.33 + 1 + + + + 1 + + + Antwortnachricht.1429 + + + + + + + + + + Aktion.1563 + Show technical feasible R-Strategy + + + + + + + Show technical feasible R-Strategy + + Aktion.1676 + Weight Environmental Indicators/Impacts (set preference on LC... + + + + + + + Weight Environmental Indicators/Impacts (set preference on LCIA impact category) + + Aktion.1680 + Collect environmental data for disassembly and determine proc... + + + + + + + Collect environmental data for disassembly and determine process Inventory + + Aktion.1871 + If necessary: Enter the way of disassembly and process-relate... + + + + + + + If necessary: Enter the way of disassembly and process-related information (Equipment, Sequence, Location) + + Verzweigungsknoten + + + + + + + Antwortnachricht.1991 + + + + + + + + + + Antwortnachricht.226 + + + + + + + + + + Aktion.228 + Calculate Material consumption for disassembly + + + + + + + Calculate Material consumption for disassembly + + Tabelle.229 + Total Material consumption disassembly + + + + Total Material consumption disassembly + + Antwortnachricht.230 + + + + + + + + + + Antwortnachricht.455 + + + + + + + + + + Aktion.462 + Calculate Energy consumption (power) for disassembly + + + + + + + Calculate Energy consumption (power) for disassembly + + Tabelle.471 + Total Energy consumption (power) disassembly + + + + Total Energy consumption (power) disassembly + + Antwortnachricht.472 + + + + + + + + + + Antwortnachricht.480 + + + + + + + + + + Antwortnachricht.481 + + + + + + + + + + Antwortnachricht.482 + + + + + + + + + + Aktion.487 + Calculate Energy consumption (fuel) for disassembly + + + + + + + Calculate Energy consumption (fuel) for disassembly + + Tabelle.495 + Total Energy consumption (fuel) disassembly + + + + Total Energy consumption (fuel) disassembly + + Antwortnachricht.496 + + + + + + + + + + Aktion.501 + Calculate emissions for disassembly + + + + + + + Calculate emissions for disassembly + + Tabelle.504 + Total Emissions consumption (fuel) disassembly + + + + Total Emissions consumption (fuel) disassembly + + Antwortnachricht.505 + + + + + + + + + + Antwortnachricht.509 + + + + + + + + + + Antwortnachricht.510 + + + + + + + + + + Aktion.511 + Calculate relative environmental impact for Remanufacturing-S... + + + + + + + Calculate relative environmental impact for Remanufacturing-Strategy (EoL only) + + Aktion.513 + Collect environmental data for Reuse + + + + + + + Collect environmental data for Reuse + + Antwortnachricht.514 + + + + + + + + + + Antwortnachricht.520 + + + + + + + + + + Aktion.573 + Collect environmental data for Remanufacturing + + + + + + + Collect environmental data for Remanufacturing + + Antwortnachricht.574 + + + + + + + + + + Antwortnachricht.614 + + + + + + + + + + Antwortnachricht.630 + + + + + + + + + + Antwortnachricht.633 + + + + + + + + + + Antwortnachricht.637 + + + + + + + + + + Aktion.643 + Collect environmental data for Recycling + + + + + + + Collect environmental data for Recycling + + Antwortnachricht.663 + + + + + + + + + + Antwortnachricht.670 + + + + + + + + + + Antwortnachricht.674 + + + + + + + + + + Aktion.702 + Collect environmental data for Recover + + + + + + + Collect environmental data for Recover + + Antwortnachricht.712 + + + + + + + + + + Antwortnachricht.713 + + + + + + + + + + Antwortnachricht.714 + + + + + + + + + + Antwortnachricht.722 + + + + + + + + + + Antwortnachricht.730 + + + + + + + + + + Antwortnachricht.742 + + + + + + + + + + Antwortnachricht.754 + + + + + + + + + + Antwortnachricht.757 + + + + + + + + + + Antwortnachricht.759 + + + + + + + + + + Verzweigungsknoten.760 + + + + + + + Antwortnachricht.763 + + + + + + + + + + Antwortnachricht.764 + + + + + + + + + + Aktion.1061 + Collect data for R-Strategies and calculate Inventory + + + + + + + Collect data for R-Strategies and calculate Inventory + + Antwortnachricht.1065 + + + + + + + + + + Verzweigungsknoten.1066 + + + + + + + Antwortnachricht.1068 + + + + + + + + + + Antwortnachricht.1069 + + + + + + + + + + Antwortnachricht.1070 + + + + + + + + + + Antwortnachricht.1071 + + + + + + + + + + Aktion.1089 + Calculate relative total environmental impact for Recycling-S... + + + + + + + Calculate relative total environmental impact for Recycling-Strategy (EoL only) + + Aktion.1097 + Calculate relative total environmental impact for Recover-Str... + + + + + + + Calculate relative total environmental impact for Recover-Strategy (EoL only) + + Aktion.1099 + Calculate relative environmental impact for Reuse-Strategy (E... + + + + + + + Calculate relative environmental impact for Reuse-Strategy (EoL only) + + Tabelle.1101 + Relative Total environmental impact Reuse + + + + Relative Total environmental impact Reuse + + Antwortnachricht.1102 + + + + + + + + + + Tabelle.1105 + Relative Total environmental impact Recycling + + + + Relative Total environmental impact Recycling + + Tabelle.1106 + Relative Total environmental impact Recover + + + + Relative Total environmental impact Recover + + Antwortnachricht.1108 + + + + + + + + + + Antwortnachricht.1109 + + + + + + + + + + Aktion.1110 + Calculate difference between new production and Remanufacturi... + + + + + + + Calculate difference between new production and Remanufacturing-Strategy + + Aktion.1112 + Consider environmental impact of Remanufacturing in compariso... + + + + + + + Consider environmental impact of Remanufacturing in comparison to new production + + Aktion.1113 + Recommend R-Strategy with lowest environmental impact (=most ... + + + + + + + Recommend R-Strategy with lowest environmental impact (=most ecological) + + Verzweigungsknoten.1117 + + + + + + + Antwortnachricht.1118 + + + + + + + + + + Antwortnachricht.1119 + + + + + + + + + + Antwortnachricht.1120 + + + + + + + + + + Antwortnachricht.1121 + + + + + + + + + + Verzweigungsknoten.1122 + + + + + + + Antwortnachricht.1123 + + + + + + + + + + Antwortnachricht.1124 + + + + + + + + + + Antwortnachricht.1129 + + + + + + + + + + Antwortnachricht.1131 + + + + + + + + + + Tabelle.1132 + Absolute Total environmental impact Remanufacturing + + + + Absolute Total environmental impact Remanufacturing + + Antwortnachricht.1133 + + + + + + + + + + Aktion.1134 + Calculate difference between new production and Reuse-Strategy + + + + + + + Calculate difference between new production and Reuse-Strategy + + Aktion.1135 + Consider environmental impact of Reuse in comparison to new p... + + + + + + + Consider environmental impact of Reuse in comparison to new production + + Tabelle.1136 + Remaining lifetime through Reuse + + + + Remaining lifetime through Reuse + + Tabelle.1137 + OEM Lifetime (new production) + + + + OEM Lifetime (new production) + + Tabelle.1138 + Environmental impact new production of component + + + + Environmental impact new production of component + + Verzweigungsknoten.1139 + + + + + + + Antwortnachricht.1140 + + + + + + + + + + Antwortnachricht.1141 + + + + + + + + + + Antwortnachricht.1142 + + + + + + + + + + Antwortnachricht.1143 + + + + + + + + + + Verzweigungsknoten.1144 + + + + + + + Antwortnachricht.1145 + + + + + + + + + + Antwortnachricht.1146 + + + + + + + + + + Antwortnachricht.1147 + + + + + + + + + + Antwortnachricht.1148 + + + + + + + + + + Tabelle.1149 + Absolute Total environmental impact Reuse + + + + Absolute Total environmental impact Reuse + + Antwortnachricht.1150 + + + + + + + + + + Antwortnachricht.1151 + + + + + + + + + + Aktion.1152 + Calculate difference between new production and Recycling-Str... + + + + + + + Calculate difference between new production and Recycling-Strategy + + Aktion.1153 + Consider environmental impact of Recycling comparison to new ... + + + + + + + Consider environmental impact of Recycling comparison to new production + + Tabelle.1167 + Absolute Total environmental impact Recycling + + + + Absolute Total environmental impact Recycling + + Antwortnachricht.1168 + + + + + + + + + + Antwortnachricht.1169 + + + + + + + + + + Aktion.1187 + Calculate difference between new production and Recover-Strat... + + + + + + + Calculate difference between new production and Recover-Strategy + + Aktion.1188 + Consider environmental impact of Recover in comparison to new... + + + + + + + Consider environmental impact of Recover in comparison to new production + + Tabelle.1190 + Energy recovery + + + + Energy recovery + + Tabelle.1191 + Environmental impact new production energy + + + + Environmental impact new production energy + + Antwortnachricht.1193 + + + + + + + + + + Antwortnachricht.1196 + + + + + + + + + + Verzweigungsknoten.1197 + + + + + + + Antwortnachricht.1201 + + + + + + + + + + Tabelle.1202 + Absolute Total environmental impact Recover + + + + Absolute Total environmental impact Recover + + Antwortnachricht.1203 + + + + + + + + + + Antwortnachricht.1205 + + + + + + + + + + Verzweigungsknoten.1206 + + + + + + + Antwortnachricht.1212 + + + + + + + + + + Antwortnachricht.1213 + + + + + + + + + + Antwortnachricht.1214 + + + + + + + + + + Antwortnachricht.1216 + + + + + + + + + + Antwortnachricht.1217 + + + + + + + + + + Antwortnachricht.1221 + + + + + + + + + + Tabelle.1222 + + Anfangsknoten.1406 + + + + + + + Anfangsknoten.1409 + + + + + + + Tabelle.231 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.1225 + 2 + + + + 2 + + + Antwortnachricht.1229 + + + + + + + + + + Antwortnachricht.1230 + + + + + + + + + + Antwortnachricht.1231 + + + + + + + + + + Antwortnachricht.1232 + + + + + + + + + + Verzweigungsknoten.1192 + + + + + + + Antwortnachricht.1235 + + + + + + + + + + Antwortnachricht.1237 + + + + + + + + + + Antwortnachricht.1239 + + + + + + + + + + Antwortnachricht.1240 + + + + + + + + + + Antwortnachricht.1241 + + + + + + + + + + Antwortnachricht.1248 + + + + + + + + + + Antwortnachricht.1257 + + + + + + + + + + Antwortnachricht.1258 + + + + + + + + + + Antwortnachricht.1259 + + + + + + + + + + Tabelle.1260 + + Tabelle.1114 + Extended Lifetime through Remanufacturing + + + + Extended Lifetime through Remanufacturing + + Tabelle.1115 + OEM Lifetime (new production) + + + + OEM Lifetime (new production) + + Tabelle.1116 + Environmental impact new production of component + + + + Environmental impact new production of component + + + Tabelle.1265 + Relative Total environmental impact Remanufacturing + + + + Relative Total environmental impact Remanufacturing + + Antwortnachricht.1267 + + + + + + + + + + Antwortnachricht.1268 + + + + + + + + + + Verzweigungsknoten.1270 + + + + + + + Antwortnachricht.1271 + + + + + + + + + + Tabelle.1272 + + Tabelle.1156 + Environmental impact material new production + + + + Environmental impact material new production + + Tabelle.1228 + Environmental impact new production of component + + + + Environmental impact new production of component + + + Verzweigungsknoten.1273 + + + + + + + Antwortnachricht.1274 + + + + + + + + + + Antwortnachricht.1275 + + + + + + + + + + Antwortnachricht.1285 + + + + + + + + + + Antwortnachricht.1287 + + + + + + + + + + Feld + + + + + + + Feld.1446 + + + + + + + Feld.1447 + + + + + + + Feld.1632 + + + + + + + Feld.1637 + Activity data collection (LCI) - Dismantling - + + + + + + + Activity data collection (LCI) - Dismantling - + + Feld.1638 + Activity data collection (LCI) - R-Strategies - + + + + + + + Activity data collection (LCI) - R-Strategies - + + Feld.1641 + Relative environmental impact of R-Strategies (LCIA - EoL only) + + + + + + + Relative environmental impact of R-Strategies (LCIA - EoL only) + + Feld.1644 + Absolute environmental impact of R-Strategies (LCIA - EoL plu... + + + + + + + Absolute environmental impact ofR-Strategies (LCIA - EoL plus lifetime credit) + + Tabelle.1646 + + Abschlussknoten + + + + + + + + + Aktion.1000 + Implement R-Strategy + + + + + + + Implement R-Strategy + + Antwortnachricht.1057 + + + + + + + + + + + Antwortnachricht.1647 + + + + + + + + + + Antwortnachricht.1648 + + + + + + + + + + diff --git a/docs-kits/kits/Circularity_KIT/resources/adoption-view/CE_assistant_environmental_assessment.svg.license b/docs-kits/kits/Circularity_KIT/resources/adoption-view/CE_assistant_environmental_assessment.svg.license new file mode 100644 index 00000000000..086356bd4e6 --- /dev/null +++ b/docs-kits/kits/Circularity_KIT/resources/adoption-view/CE_assistant_environmental_assessment.svg.license @@ -0,0 +1,14 @@ +## NOTICE + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- Copyright (c) 2023 BMW AG +- Copyright (c) 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) +- Copyright (c) 2023 BASF SE +- Copyright (c) 2023 SAP Deutschland SE & Co.KG +- Copyright (c) 2023 T-Systems International GmbH +- Copyright (c) 2023 LRP Auto-Recycling Leipzig GmbH +- Copyright (c) 2023 Robert Bosch GmbH +- Copyright (c) 2023 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Circularity_KIT/resources/adoption-view diff --git a/docs-kits/kits/Circularity_KIT/resources/adoption-view/CE_assistant_technical_feasibility_logic.svg b/docs-kits/kits/Circularity_KIT/resources/adoption-view/CE_assistant_technical_feasibility_logic.svg new file mode 100644 index 00000000000..d2e1f3f21b1 --- /dev/null +++ b/docs-kits/kits/Circularity_KIT/resources/adoption-view/CE_assistant_technical_feasibility_logic.svg @@ -0,0 +1,1402 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Technische Machbarkeit + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Teilsystem + + + + + + + + + + + + + + + + Tabelle.50 + + Tabelle.51 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.52 + User (Dismantling Lead) + + Tabelle.53 + + + + + + + + + + + + + + + + + + + + + + User (Dismantling Lead) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Teilsystem.54 + + + + + + + + + + + + + + + + Tabelle.1046 + + Tabelle.1047 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.1048 + R-Strategy Assistant / Digital Twin + + Tabelle.1049 + + + + + + + + + + + + + + + + + + + + + + R-Strategy Assistant / Digital Twin + + + + Anfangsknoten + + + + + + + Antwortnachricht.45 + + + + + + + + + + Abschlussknoten + + + + + + + + + Aktion.1000 + Implement R-Strategy + + + + + + + Implement R-Strategy + + Aktion.1001 + Enter VIN + + + + + + + Enter VIN + + Aktion.47 + Show vehicle and component information (Digital Twin data) (S... + + + + + + + Show vehicle and component information (Digital Twin data) (State of Health, mileage, material contained…) + + Aktion.1004 + Check possible R-Strategies (exclusion criteria) + + + + + + + Check possible R-Strategies (exclusion criteria) + + Antwortnachricht.1010 + + + + + + + + + + Zusammenführungsknoten.1011 + + + + + + + Aktion.1038 + Carry out the visual inspection and or functional check (dama... + + + + + + + Carry out the visual inspection and or functional check (damage, corrosion...) + + Aktion.1043 + Enter result of the visual inspection + + + + + + + Enter result of the visual inspection + + Antwortnachricht.1044 + + + + + + + + + + Antwortnachricht.1050 + + + + + + + + + + Antwortnachricht.1057 + + + + + + + + + + Tabelle.1069 + Basic Reuse Potential = 0 + + + + Basic Reuse Potential = 0 + + Tabelle.1284 + Quality ≥ Categorie of quality b component-specific threshold1 + + + + Quality ≥ Categorie of quality b component-specific threshold1 + + Tabelle.1321 + Possible R-Strategy: Reuse, Recycle, Recover + + + + Possible R-Strategy: Reuse, Recycle, Recover + + Tabelle.1322 + Possible R-Strategy: Remanufacture, Recycle, Recover + + + + Possible R-Strategy: Remanufacture, Recycle, Recover + + Tabelle.1325 + Possible R-Strategy: Recycle, Recover + + + + Possible R-Strategy: Recycle, Recover + + Antwortnachricht.1327 + + + + + + + + + + + Antwortnachricht.1335 + + + + + + + + + + Antwortnachricht.1336 + + + + + + + + + + Antwortnachricht.1337 + + + + + + + + + + Antwortnachricht.1346 + + + + + + + + + + Aktion.1371 + Select component + + + + + + + Select component + + Antwortnachricht.1379 + + + + + + + + + + Antwortnachricht.1380 + + + + + + + + + + Antwortnachricht.1372 + + + + + + + + + + Antwortnachricht.1422 + + + + + + + + + + Tabelle.1424 + + Anfangsknoten.1406 + + + + + + + Anfangsknoten.1409 + + + + + + + Tabelle.54 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.1411 + 1 + + + + 1 + + + Tabelle.1425 + + Anfangsknoten.1406 + + + + + + + Anfangsknoten.1409 + + + + + + + Tabelle.56 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.1428 + 2 + + + + 2 + + + Antwortnachricht.1429 + + + + + + + + + + Tabelle.1430 + + Anfangsknoten.1406 + + + + + + + Anfangsknoten.1409 + + + + + + + Tabelle.57 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.1433 + 3 + + + + 3 + + + Antwortnachricht.1437 + + + + + + + + + + Zusammenführungsknoten.1445 + + + + + + + Zusammenführungsknoten.1446 + + + + + + + Zusammenführungsknoten.1447 + + + + + + + Antwortnachricht.1448 + + + + + + + + + + Antwortnachricht.1449 + + + + + + + + + + Antwortnachricht.1450 + + + + + + + + + + Tabelle.1451 + Material Composition = 1 + + + + Material Composition = 1 + + Tabelle.1452 + Remaining Lifetime < Component-specific threshold + + + + Remaining Lifetime < Component-specific threshold + + Tabelle.1453 + Disassembly Capability = 0 + + + + Disassembly Capability = 0 + + Tabelle.1454 + Basic Reuse Potential = 1 + + + + Basic Reuse Potential = 1 + + Tabelle.1455 + Material Composition = 0 + + + + Material Composition = 0 + + Tabelle.1456 + Remaining Lifetime ≥ Component-specific threshold + + + + Remaining Lifetime ≥ Component-specific threshold + + Tabelle.1457 + Disassembly Capability = 1 + + + + Disassembly Capability = 1 + + Antwortnachricht.1458 + + + + + + + + + + Antwortnachricht.1459 + + + + + + + + + + Antwortnachricht.1460 + + + + + + + + + + Antwortnachricht.1461 + + + + + + + + + + Zusammenführungsknoten.1482 + + + + + + + Tabelle.1483 + Quality < Categorie of quality b component-specific threshold2 + + + + Quality < Categorie of quality b component-specific threshold2 + + Zusammenführungsknoten.1485 + + + + + + + Zusammenführungsknoten.1486 + + + + + + + Zusammenführungsknoten.1487 + + + + + + + Antwortnachricht.1488 + + + + + + + + + + Antwortnachricht.1489 + + + + + + + + + + Antwortnachricht.1490 + + + + + + + + + + Tabelle.1491 + Assemblability = 0 + + + + Assemblability = 0 + + Tabelle.1492 + Cleanability = 0 + + + + Cleanability = 0 + + Tabelle.1493 + Restorability/Upgradability = 0 + + + + Restorability/Upgradability = 0 + + Tabelle.1495 + Assemblability = 1 + + + + Assemblability = 1 + + Tabelle.1496 + Cleanability = 1 + + + + Cleanability = 1 + + Tabelle.1497 + Restorability/Upgradability = 1 + + + + Restorability/Upgradability = 1 + + Antwortnachricht.1498 + + + + + + + + + + Antwortnachricht.1499 + + + + + + + + + + Antwortnachricht.1500 + + + + + + + + + + Antwortnachricht.1502 + + + + + + + + + + Tabelle.1505 + Quality < Categorie of quality b component-specific threshold... + + + + Quality < Categorie of quality b component-specific threshold1 and Quality ≥ Categorie of quality b component-specific threshold2 + + Antwortnachricht.1613 + + + + + + + + + + Antwortnachricht.1614 + + + + + + + + + + Tabelle.1615 + + Aktion + Recommend identified R-Strategy to use + + + + + + + Recommend identified R-Strategy to use + + Antwortnachricht.1444 + + + + + + + + + + Verbindungsknoten + + + + + + + + diff --git a/docs-kits/kits/Circularity_KIT/resources/adoption-view/CE_assistant_technical_feasibility_logic.svg.license b/docs-kits/kits/Circularity_KIT/resources/adoption-view/CE_assistant_technical_feasibility_logic.svg.license new file mode 100644 index 00000000000..086356bd4e6 --- /dev/null +++ b/docs-kits/kits/Circularity_KIT/resources/adoption-view/CE_assistant_technical_feasibility_logic.svg.license @@ -0,0 +1,14 @@ +## NOTICE + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- Copyright (c) 2023 BMW AG +- Copyright (c) 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) +- Copyright (c) 2023 BASF SE +- Copyright (c) 2023 SAP Deutschland SE & Co.KG +- Copyright (c) 2023 T-Systems International GmbH +- Copyright (c) 2023 LRP Auto-Recycling Leipzig GmbH +- Copyright (c) 2023 Robert Bosch GmbH +- Copyright (c) 2023 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Circularity_KIT/resources/adoption-view diff --git a/docs-kits/kits/Circularity_KIT/resources/adoption-view/CE_assistant_user_journey.svg b/docs-kits/kits/Circularity_KIT/resources/adoption-view/CE_assistant_user_journey.svg new file mode 100644 index 00000000000..ce2735a430c --- /dev/null +++ b/docs-kits/kits/Circularity_KIT/resources/adoption-view/CE_assistant_user_journey.svg @@ -0,0 +1 @@ +Vehiclelookupfor dismantling in Catena-X networkDismantler requests general information about the individual vehicle and its components via VINComponentselectionforanalysisDismantler selects one component for detailed information and analysisData request of component and materialCE Assistant requests detailed information about the component and contained materials in a vehicleTechnicalassessmentofR-StrategiesCEAssistantcalculates the technical feasibility of different R-Strategies for the component based on standardized decision logicEnvironmentalassessmentofR-StrategiesCE Assistant calculates the environmental impact of different (technically feasible) R-Strategies based on an LCA of subsequentprocesses and recommends an optimalR-StrategyCE Assistant User Journey–R-Strategy decision-makingUpdateofDigital TwinCE Assistant updates Digital Twin of component with calculation result and selected R-strategy to allow for further monitoring,and digital traceability for second lifeFeedback-to-​designCE Assistant enables feedback-to-design updates regarding dismantling and circular economy capabilities to manufacturer of the vehicle / component \ No newline at end of file diff --git a/docs-kits/kits/Circularity_KIT/resources/adoption-view/CE_assistant_user_journey.svg.license b/docs-kits/kits/Circularity_KIT/resources/adoption-view/CE_assistant_user_journey.svg.license new file mode 100644 index 00000000000..086356bd4e6 --- /dev/null +++ b/docs-kits/kits/Circularity_KIT/resources/adoption-view/CE_assistant_user_journey.svg.license @@ -0,0 +1,14 @@ +## NOTICE + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- Copyright (c) 2023 BMW AG +- Copyright (c) 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) +- Copyright (c) 2023 BASF SE +- Copyright (c) 2023 SAP Deutschland SE & Co.KG +- Copyright (c) 2023 T-Systems International GmbH +- Copyright (c) 2023 LRP Auto-Recycling Leipzig GmbH +- Copyright (c) 2023 Robert Bosch GmbH +- Copyright (c) 2023 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Circularity_KIT/resources/adoption-view diff --git a/docs-kits/kits/Circularity_KIT/resources/adoption-view/Circularity_KIT_user_journey.svg b/docs-kits/kits/Circularity_KIT/resources/adoption-view/Circularity_KIT_user_journey.svg new file mode 100644 index 00000000000..7eb0093877c --- /dev/null +++ b/docs-kits/kits/Circularity_KIT/resources/adoption-view/Circularity_KIT_user_journey.svg @@ -0,0 +1 @@ +1. Vehicleuse-phase2. Vehicle ​reachesEnd-of-Life (EoL)3.TransferofEnd-of-Life Vehicle (ELV)todismantler•Evaluation of ​vehicle value•Vehicle acceptance and change in ownership•Issue of certificate of decommissioning4.Determining the best CE-Strategy using Catena-X​•Vehicle and digital twin (DT) ​lookup for dismantling in Catena-X•Component​selectionforanalysis•Request of data on vehicle fromCatena-X on selectedcomponents and material•Technical assessment ​of CE-Strategies•Environmental assessment ​of CE-Strategies•Decision-making for the best CE-Strategy•Update of vehicle / component digital twin•Feedback-to-​DesignCircularityKIT–E2E User Journey5.Dismantling of mandatory and valuable components•DismantlingoftheHigh-Voltage-Battery(HVB)•Draining•Neutralizingpyrotechnics•Mandatorydismantling•Maindisassembly•Storagingcomponents and vehicles with residual value•Transferring​ secondary componentsto aftermarket (e.g.repairment)7.Dismantling vehicle scrap on material level•Core scrap ​removal•Vehicle ​compaction•Transferring scrap ​to ​recycler•IssueofEoLcertificate for waste​8.Material recycling•Material pre-treatment•Shredding•Separation and sorting•Purifying•Recycling•Refinement•Creation of secondary material•Transferring secondary material ​to component manufacturer•Issue ofEoLcertificate for recycled material​9.Manufacturing of components with secondary material•Processing secondary ​material•Usage of secondary material for production•Transferring ​components and material ​to OEM10.Vehicle Assembly with secondary material componentsReuseofcomponentsFeaturesClosed loops ofsecondary materialsEoLServicesSecondaryMarketplaceCE AssistentSecondaryMaterial ContentMaterial AccountingEoLServicesELV6. Refurbishment/Remanufacturingofcomponents•Usage of secondary components in vechicle manufacturing / assembly•IssueofEoLcertificatesMaterialrecoveryWastestreamSecondaryMarketplaceCEAssistantSecondaryMarketplaceEoLServicesSecondaryMarketplaceEoLServicesMaterial AccountingSecondaryMaterial ContentSecondaryMarketplace \ No newline at end of file diff --git a/docs-kits/kits/Circularity_KIT/resources/adoption-view/Circularity_KIT_user_journey.svg.license b/docs-kits/kits/Circularity_KIT/resources/adoption-view/Circularity_KIT_user_journey.svg.license new file mode 100644 index 00000000000..086356bd4e6 --- /dev/null +++ b/docs-kits/kits/Circularity_KIT/resources/adoption-view/Circularity_KIT_user_journey.svg.license @@ -0,0 +1,14 @@ +## NOTICE + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- Copyright (c) 2023 BMW AG +- Copyright (c) 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) +- Copyright (c) 2023 BASF SE +- Copyright (c) 2023 SAP Deutschland SE & Co.KG +- Copyright (c) 2023 T-Systems International GmbH +- Copyright (c) 2023 LRP Auto-Recycling Leipzig GmbH +- Copyright (c) 2023 Robert Bosch GmbH +- Copyright (c) 2023 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Circularity_KIT/resources/adoption-view diff --git a/docs-kits/kits/Circularity_KIT/resources/adoption-view/Relationship_between_Material_Characteristics.svg.license b/docs-kits/kits/Circularity_KIT/resources/adoption-view/Relationship_between_Material_Characteristics.svg.license index 7c4b5318016..086356bd4e6 100644 --- a/docs-kits/kits/Circularity_KIT/resources/adoption-view/Relationship_between_Material_Characteristics.svg.license +++ b/docs-kits/kits/Circularity_KIT/resources/adoption-view/Relationship_between_Material_Characteristics.svg.license @@ -2,12 +2,13 @@ This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). -- Copyright (c) 2023,2024 BMW AG -- Copyright (c) 2023,2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) -- Copyright (c) 2023,2024 BASF SE -- Copyright (c) 2023,2024 SAP Deutschland SE & Co.KG -- Copyright (c) 2023,2024 T-Systems International GmbH -- Copyright (c) 2023,2024 LRP Auto-Recycling Leipzig GmbH -- Copyright (c) 2023,2024 Robert Bosch GmbH -- Copyright (c) 2023,2024 tec4U-Ingenieurgesellschaft mbH -- Copyright (c) 2023,2024 Contributors to the Eclipse Foundation +- Copyright (c) 2023 BMW AG +- Copyright (c) 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) +- Copyright (c) 2023 BASF SE +- Copyright (c) 2023 SAP Deutschland SE & Co.KG +- Copyright (c) 2023 T-Systems International GmbH +- Copyright (c) 2023 LRP Auto-Recycling Leipzig GmbH +- Copyright (c) 2023 Robert Bosch GmbH +- Copyright (c) 2023 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Circularity_KIT/resources/adoption-view diff --git a/docs-kits/kits/Circularity_KIT/resources/adoption-view/circularity_kit_wheel.svg.license b/docs-kits/kits/Circularity_KIT/resources/adoption-view/circularity_kit_wheel.svg.license index 7c4b5318016..086356bd4e6 100644 --- a/docs-kits/kits/Circularity_KIT/resources/adoption-view/circularity_kit_wheel.svg.license +++ b/docs-kits/kits/Circularity_KIT/resources/adoption-view/circularity_kit_wheel.svg.license @@ -2,12 +2,13 @@ This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). -- Copyright (c) 2023,2024 BMW AG -- Copyright (c) 2023,2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) -- Copyright (c) 2023,2024 BASF SE -- Copyright (c) 2023,2024 SAP Deutschland SE & Co.KG -- Copyright (c) 2023,2024 T-Systems International GmbH -- Copyright (c) 2023,2024 LRP Auto-Recycling Leipzig GmbH -- Copyright (c) 2023,2024 Robert Bosch GmbH -- Copyright (c) 2023,2024 tec4U-Ingenieurgesellschaft mbH -- Copyright (c) 2023,2024 Contributors to the Eclipse Foundation +- Copyright (c) 2023 BMW AG +- Copyright (c) 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) +- Copyright (c) 2023 BASF SE +- Copyright (c) 2023 SAP Deutschland SE & Co.KG +- Copyright (c) 2023 T-Systems International GmbH +- Copyright (c) 2023 LRP Auto-Recycling Leipzig GmbH +- Copyright (c) 2023 Robert Bosch GmbH +- Copyright (c) 2023 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Circularity_KIT/resources/adoption-view diff --git a/docs-kits/kits/Circularity_KIT/resources/adoption-view/communication_architecture.svg.license b/docs-kits/kits/Circularity_KIT/resources/adoption-view/communication_architecture.svg.license index f493e6d5bf0..086356bd4e6 100644 --- a/docs-kits/kits/Circularity_KIT/resources/adoption-view/communication_architecture.svg.license +++ b/docs-kits/kits/Circularity_KIT/resources/adoption-view/communication_architecture.svg.license @@ -2,12 +2,13 @@ This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). -- Copyright (c) 2024 BMW AG -- Copyright (c) 2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) -- Copyright (c) 2024 BASF SE -- Copyright (c) 2024 SAP Deutschland SE & Co.KG -- Copyright (c) 2024 T-Systems International GmbH -- Copyright (c) 2024 LRP Auto-Recycling Leipzig GmbH -- Copyright (c) 2024 Robert Bosch GmbH -- Copyright (c) 2024 tec4U-Ingenieurgesellschaft mbH -- Copyright (c) 2024 Contributors to the Eclipse Foundation +- Copyright (c) 2023 BMW AG +- Copyright (c) 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) +- Copyright (c) 2023 BASF SE +- Copyright (c) 2023 SAP Deutschland SE & Co.KG +- Copyright (c) 2023 T-Systems International GmbH +- Copyright (c) 2023 LRP Auto-Recycling Leipzig GmbH +- Copyright (c) 2023 Robert Bosch GmbH +- Copyright (c) 2023 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Circularity_KIT/resources/adoption-view diff --git a/docs-kits/kits/Circularity_KIT/resources/adoption-view/custody_models.svg.license b/docs-kits/kits/Circularity_KIT/resources/adoption-view/custody_models.svg.license index 9ffcef3ef98..086356bd4e6 100644 --- a/docs-kits/kits/Circularity_KIT/resources/adoption-view/custody_models.svg.license +++ b/docs-kits/kits/Circularity_KIT/resources/adoption-view/custody_models.svg.license @@ -11,3 +11,4 @@ This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses - Copyright (c) 2023 Robert Bosch GmbH - Copyright (c) 2023 tec4U-Ingenieurgesellschaft mbH - Copyright (c) 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Circularity_KIT/resources/adoption-view diff --git a/docs-kits/kits/Circularity_KIT/resources/adoption-view/datapoints_along_valuechain.svg.license b/docs-kits/kits/Circularity_KIT/resources/adoption-view/datapoints_along_valuechain.svg.license index 9ffcef3ef98..086356bd4e6 100644 --- a/docs-kits/kits/Circularity_KIT/resources/adoption-view/datapoints_along_valuechain.svg.license +++ b/docs-kits/kits/Circularity_KIT/resources/adoption-view/datapoints_along_valuechain.svg.license @@ -11,3 +11,4 @@ This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses - Copyright (c) 2023 Robert Bosch GmbH - Copyright (c) 2023 tec4U-Ingenieurgesellschaft mbH - Copyright (c) 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Circularity_KIT/resources/adoption-view diff --git a/docs-kits/kits/Circularity_KIT/resources/adoption-view/depiction_of_smc_data_models.svg.license b/docs-kits/kits/Circularity_KIT/resources/adoption-view/depiction_of_smc_data_models.svg.license index 7c4b5318016..086356bd4e6 100644 --- a/docs-kits/kits/Circularity_KIT/resources/adoption-view/depiction_of_smc_data_models.svg.license +++ b/docs-kits/kits/Circularity_KIT/resources/adoption-view/depiction_of_smc_data_models.svg.license @@ -2,12 +2,13 @@ This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). -- Copyright (c) 2023,2024 BMW AG -- Copyright (c) 2023,2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) -- Copyright (c) 2023,2024 BASF SE -- Copyright (c) 2023,2024 SAP Deutschland SE & Co.KG -- Copyright (c) 2023,2024 T-Systems International GmbH -- Copyright (c) 2023,2024 LRP Auto-Recycling Leipzig GmbH -- Copyright (c) 2023,2024 Robert Bosch GmbH -- Copyright (c) 2023,2024 tec4U-Ingenieurgesellschaft mbH -- Copyright (c) 2023,2024 Contributors to the Eclipse Foundation +- Copyright (c) 2023 BMW AG +- Copyright (c) 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) +- Copyright (c) 2023 BASF SE +- Copyright (c) 2023 SAP Deutschland SE & Co.KG +- Copyright (c) 2023 T-Systems International GmbH +- Copyright (c) 2023 LRP Auto-Recycling Leipzig GmbH +- Copyright (c) 2023 Robert Bosch GmbH +- Copyright (c) 2023 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Circularity_KIT/resources/adoption-view diff --git a/docs-kits/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF1.svg b/docs-kits/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF1.svg new file mode 100644 index 00000000000..372695112a1 --- /dev/null +++ b/docs-kits/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF1.svg @@ -0,0 +1 @@ +© 2023 Catena-X or a Catena-X affiliate company. All rights reserved.1Data Journey–End of Life1.Evaluation ofvehiclevalue1.1Readvehicleparameters1.2Visual inspection2.Vehicle acceptanceVehiclearrival2.1Vehicle reception and registration in the system3.Vehicle detectionAcceptance and dismantling order creation3.1Vehicle acceptance3.2Decomissioningcertificatecreation3.3Vehicle dismantling strategydefinition3.4Dismantlingordercreation4.Dismantling HVB (optional)HV batterydismantling4.1HV Battery state of health analysis4.2HV battery dismounting from vehicle4.3Battery shipment for recyclingCX-0038Fleet Diagnostic dataCX-0035Marketplace OfferCX-0059RemainingUseful LifeCX-0033Return requestCX-0039Fleet Claim DataCX-0126Industry Core: PartType (PartTypeInformation, SingleLevelBomAsPlanned,SingleLevelUsageAsPlanned)CX-0149 Verified Company IdentityCX-0037 Vehicle Product descriptionCX-0034 BatteryPassCX-0127 Industry Core: Part Instance (SerialPart, Batch, JustInSequencePart,SingleLevelBomAsBuilt, SingleLevelUsageAsBuilt)CX-0149 Verified Company IdentityCX-0038 Fleet Diagnostic DataCX-0039 Fleet Claim DataCX-0099 Decomissioning CertificateCX-0066 End of Life Of Vehicle ComplianceCX-0035 Marketplace OfferCX-0037 VehicleProduct DescriptionCX-0059 Remaining Useful LifeCX-0032 PartAsSpecifiedCX-0034Battery passCX-0038Fleet Diagnostic Data \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/Relationship_between_Material_Characteristics.svg.license b/docs-kits/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF1.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/Relationship_between_Material_Characteristics.svg.license rename to docs-kits/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF1.svg.license diff --git a/docs-kits/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF2.svg b/docs-kits/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF2.svg new file mode 100644 index 00000000000..e9323cfa00d --- /dev/null +++ b/docs-kits/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF2.svg @@ -0,0 +1 @@ +© 2023 Catena-X or a Catena-X affiliate company. All rights reserved.2Data Journey–EoL5.NeutralizingpyrotechnicsAirbagsneutralization5.1Vehicle parameters read5.2Neutralizing pyrotechnics (all or partial)6.Draining6.1Vehicle liquids strategy definition6.2Draining7. Main disassembly7.1Predefined parts disassembly (re-use, re-manufacture)7.2Parts quality evaluation7.3Parts registration in thesystem8. Further mandatory dismantling8.1Further mandatory dismantling(due to legal requirements some partsneed to be removedbeforeshredding and treated in a different way)8.2Registration in the systemCX-0127 Part Instance (SerialPart, Batch, JustInSequencePart, SingleLevelBomAsBuilt,SingleLevelUsageAsBuilt)CX-0127PartInstanceCX-0127PartInstance \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/circularity_kit_wheel.svg.license b/docs-kits/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF2.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/circularity_kit_wheel.svg.license rename to docs-kits/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF2.svg.license diff --git a/docs-kits/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF3.svg b/docs-kits/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF3.svg new file mode 100644 index 00000000000..0bf69c223b1 --- /dev/null +++ b/docs-kits/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF3.svg @@ -0,0 +1 @@ +© 2023 Catena-X or a Catena-X affiliate company. All rights reserved.39. Core scrap removal9.1Core scrap removal9.2Registration inthesystem10. Vehiclecompaction10.1Vehicle pressing10.2Registration in the system11. Shredding11.1 Shredding11.2 Material separation11.3 Material quality/parameters check11.4 Registration in the system12. Material recycling12.1 Material recycling12.2 Recycled material registration in the systemData Journey–EoLCX-0127PartInstanceCX-0066 End of life of vehicle complianceCX-0034 Battery PassCX-0034 Battery Pass \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/depiction_of_smc_data_models.svg.license b/docs-kits/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF3.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/depiction_of_smc_data_models.svg.license rename to docs-kits/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF3.svg.license diff --git a/docs-kits/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF4.svg b/docs-kits/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF4.svg new file mode 100644 index 00000000000..1c97ca70061 --- /dev/null +++ b/docs-kits/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF4.svg @@ -0,0 +1 @@ +© 2023 Catena-X or a Catena-X affiliate company. All rights reserved.413. Marketplace & Sales13.1Sales offer creation13.2Price negotiations13.3Sales13.4DeliveryMissing data modelsBom asmaintainedDemand requestCompability of components / Design changes historyQuality issue historyTechnical drawings & specificationsID ConversionPhysical dimensionsPCF InformationMandatory DismantlingCX-0035 Marketplace offerCX-0032 Part as specifiedCX-0037 Vehicle Product descriptionCX-0059 Remaining useful lifeData Journey–EoL \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/figure11.svg.license b/docs-kits/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF4.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/figure11.svg.license rename to docs-kits/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF4.svg.license diff --git a/docs-kits/kits/Industry Core Kit/Software Development View/part_aspect-model-overview.mdx b/docs-kits/kits/Industry Core Kit/Software Development View/part_aspect-model-overview.mdx index 7ee08781d09..bc60a352e98 100644 --- a/docs-kits/kits/Industry Core Kit/Software Development View/part_aspect-model-overview.mdx +++ b/docs-kits/kits/Industry Core Kit/Software Development View/part_aspect-model-overview.mdx @@ -32,6 +32,3 @@ The following section shows an overview of all aspect models that are currently | | JustInSequencePart | 3.0.0 | | Industry Core | CX-0127 Industry Core: Part Instance v2.0.0 | | | SingleLevelBomAsBuilt | 3.0.0 | | Industry Core | CX-0127 Industry Core: Part Instance v2.0.0 | | | SingleLevelUsageAsBuilt | 3.0.0 | | Industry Core | CX-0127 Industry Core: Part Instance v2.0.0 | -| | TractionBatteryCode | 2.0.0 | | Traceability | CX-0125 Traceability Use Case v2.0.0 | -| | SoftwareInformation | 1.0.0 | | Traceability | N/A | -| | CertificateSigningRequests | 1.0.0 | | Traceability | N/A | diff --git a/docs-kits/kits/Industry Core Kit/page_changelog.mdx b/docs-kits/kits/Industry Core Kit/page_changelog.mdx index 8457e549817..48fb3ab0cbc 100644 --- a/docs-kits/kits/Industry Core Kit/page_changelog.mdx +++ b/docs-kits/kits/Industry Core Kit/page_changelog.mdx @@ -29,6 +29,15 @@ import Notice from './part_notice.mdx' All notable changes to this Kit will be documented in this file. +## [1.3.0] - 2024-12-01 + +Compatible for **release 24.08**. + +### Removed +- **Development View:** + - **Aspect Models:** + - Removed the listed Traceability aspect models in the overview (were moved to the Traceability KIT) + ## [1.2.0] - 2024-10-22 Compatible for **release 24.08**. diff --git a/docs-kits/kits/Traceability Kit/Software Development View/page_app-provider_software-development-view.mdx b/docs-kits/kits/Traceability Kit/Software Development View/page_app-provider_software-development-view.mdx index afc543ee8cd..91be16ba70c 100644 --- a/docs-kits/kits/Traceability Kit/Software Development View/page_app-provider_software-development-view.mdx +++ b/docs-kits/kits/Traceability Kit/Software Development View/page_app-provider_software-development-view.mdx @@ -35,7 +35,8 @@ The traceability app providers are supposed to implement the capabilities to ena This feature will enable the whole industry to exchange and act upon quality issues in a more standardized, integrated, accelerated and precise manner in order to streamline claim management, avoid general and inaccurate recalls as well as reduce cost and safeguard brand reputation. In order to uniquely reference the affected parts across the network in the context of a quality incident, the exchange of quality notifications uses Catena-X Unique ID, which are the network-wide unique identifiers for a serialized part or batch, for which a digital twin has been created. Therefore, an app provider should also deliver capabilities for standardized creation of digital twins of vehicles, parts and materials as described in the [Industry Core KIT](../../../category/industry-core-kit) and [Digital Twin KIT](../../../category/digital-twin-kit). -![Quality Notifications](../assets/quality_notifications.png) + +![Quality Notifications](../assets/quality_notifications.svg) ### Quality Notification Process The notification process takes place between traceability applications or application stacks, and the focus is on minimal interaction, which must be supported by all applications participating in a quality notification or quality investigation scenario. This minimal interaction includes sending and receiving of quality notification as well as updating of the notification state. Application internals like user journeys, process steps or workflows for notification creation and management in an application are not standardized within Catena-X, and therefore omitted. @@ -46,7 +47,32 @@ The notification states and their cycle are described in the following figure. ### Quality Notification API A standardized set of APIs and payloads are specified to enable partners to send quality notifications in a standardized way while already knowing which parts (i.e., serialized parts or batches) and which direct customers or suppliers are affected. Notifications are - in contrast to classical data offers in Catena-X which is created for consumption by external stakeholders - a way to push notification related data from a sender to a receiver. For now, this notification API is limited to the sending and receiving of quality notifications as well as the update of the notification status following a state model. It is important to mention that the notification API shall be implemented into each participant's traceability solution or solution stack in order to be able to receive information related to quality issues. The implemented endpoints shall be able to process the defined request body and respond with the HTTP status codes and - if required - reply with the defined response body. -Meanwhile, this notification API shall only be accessible after successful contract negotiation via Connector based on [Dataspace Protocol (DSP)](https://docs.internationaldataspaces.org/dataspace-protocol/), since the API is made available as part of an EDC data asset with usage policy attached. Please refer to the Notification API ([v1.2.1](../openapi/notifications_1-2-1.yaml), [v2.0.0](../openapi/notifications_2-0-0.yaml)) for more details. +Meanwhile, this notification API shall only be accessible after successful contract negotiation via Connector based on [Dataspace Protocol (DSP)](https://docs.internationaldataspaces.org/dataspace-protocol/), since the API is made available as part of an EDC data asset with usage policy attached. Please refer to the corresponding Notification API specifications for more details: +- [Notification API (v1.2.1)](../openapi/notifications_1-2-1.yaml) +- [Notification API (v2.0.0)](../openapi/notifications_2-0-0.yaml) + +> :raised_hand: For the current release, **version 1.2.1 is mandatory** and must be supported by every App provider. The newer version 2.0.0 can be supported optionally. + +## Block Notifications +While quality notifications are primarily aimed at (first) contact between business partners, block notifications represent an extended form of data exchange in order to actively initiate an immediate measure to block or sort out the produced parts at the customer's production or logistics. As the quality notifications, block notifications take place between traceability applications or other application stacks, so that this functionality must be implemented by both business partners application. + +In this case, block notifications include a **notification status similar to quality notifications** to track communication, but **also include a new status model** for each individual part of the block notification to provide additional information. For example, whether the part was blocked or whether the process to block a part was canceled. + +> :raised_hand: Since the Catena-x unique ID is used for the individually listed (damaged) parts in the block notification, the app provider should also provide functions for the standardized creation of digital twins of vehicles, parts and materials, as already mentioned in the quality notifications section. + +### Block Status Model +In order to track the blocking process in the Catena X network, a defined status model is used for each part of the block notification: +![Block Status Model](../assets/block-notification-state-model.svg) + +- ACTIVE means that the part has been identified as a damaged and safety-critical part and must therefore be blocked on the customer side. +- PART_BLOCKED is used when the recipient has received the block notification and actually blocks / sorts out the damaged parts as a measure. +- CANCELED serves as the update status of the component originally identified to be blocked if the supplier subsequently determines that the original part does meet safety requirements, is not damaged or that the information was sent by mistake. This status can also be set by the manufacturer if, after an (initial) analysis, the part does not require a block. + +### Block Notification API +A standardized API and corresponding payloads are specified for block notification to enable and ensure the exchange of information that is critical to the blocking process in a standardized way. At this point, the notification API is focused on sending and receiving notifications with a full stack of block information and on updating a previously sent notification by changing the block status. The implemented endpoints shall be able to process the defined request body and respond with the HTTP status codes and - if required - reply with the defined response body. Meanwhile, the Block Notification API shall only be accessible after successful contract negotiation via Connector based on [Dataspace Protocol (DSP)](https://docs.internationaldataspaces.org/dataspace-protocol/), since the API is made available as part of an EDC data asset with usage policy attached. Please refer to the corresponding Block Notification API specification for more details: +- [Block Notification API (v1.0.0)](../openapi/block-notifications-1-0-0.yaml) + +> :raised_hand: For the current release, **version 1.0.0 is optional** and MUST be supported by every App provider from the next (major) release. The block notifications are not standardized yet, but will be released as a new optional functionality in the CX-0125 Traceability Use Case Standard as of the next release 25.03. ## Asset Registration via Connector Since the notification APIs are published towards the network using a data asset/contract definition in terms of the dataspace protocol (DSP), there are general guidelines defined for registering a notification receiving endpoint within a data asset. The traceability solutions are supposed to implement a similar data asset with the same structure and provisioning towards Catena-X. @@ -57,9 +83,11 @@ The notification endpoint providers must set properties `dct:type` and `cx-commo In general, during EDC asset creation, the notification API version needs to provided for `cx-common:version` as specified in OpenAPI documentation. For `dct:type` the following asset typizations should be used during implementation: - ReceiveQualityInvestigationNotification -- ReceiveQualityAlertNotification -- ReceiveQualityAlertNotification - UpdateQualityInvestigationNotification +- ReceiveQualityAlertNotification +- UpdateQualityAlertNotification +- ReceiveBlockNotification +- UpdateBlockNotification Please refer to the [Digital Twin KIT](../../../category/digital-twin-kit) for more details. @@ -100,7 +128,9 @@ For general guidelines for policy creation, please refer to [Industry Core KIT]( It is possible to restrict visibility of data offer for notification API with access policy either for members of Catena-X (“Membership”) and one or several Data Consumers identified by a specific business partner number ("BusinessPartnerNumber"). As for usage policy, participants and related services must restrict the data usage for notification endpoints by using the following policy rules: - Data Exchange Governance (leftOperand: “FrameworkAgreement”) – The official "Data Exchange Governance" is published on [Catena-X website](https://catena-x.net/en/catena-x-introduce-implement/governance-framework-for-data-space-operations) -- at least one use case purpose (“UsagePurpose”) from the [ODRL policy repository](https://github.com/catenax-eV/cx-odrl-profile). +- at least one use case purpose (“UsagePurpose”) from the [ODRL policy repository](https://github.com/catenax-eV/cx-odrl-profile) + - for quality notifications, the corresponding usage policy MUST be used (leftOperand: “qualityNotifications”) + - for block notifications, the same usage policy as quality notifications MUST be used (leftOperand: “qualityNotifications”) Additionally, respective usage policies MAY include the following policy rule: - Reference Contract (“ContractReference”). diff --git a/docs-kits/kits/Traceability Kit/Software Development View/part_aspect-models.mdx b/docs-kits/kits/Traceability Kit/Software Development View/part_aspect-models.mdx index 8f2074c6f0f..cd60fc7f943 100644 --- a/docs-kits/kits/Traceability Kit/Software Development View/part_aspect-models.mdx +++ b/docs-kits/kits/Traceability Kit/Software Development View/part_aspect-models.mdx @@ -26,6 +26,16 @@ Aspect models are mostly easy to create by transforming a company's internal dat + +The following section shows an overview of all aspect models of the Traceability Use Case that can be attached to part instance twins. + +| Digital Twin Type | Aspect Model | Mandatory Version | Optional Versions | KIT | Standard | +| :-- | :-- | :-- | :-- | :-- | :-- | +| PartInstance | TractionBatteryCode | 2.0.0 | | Traceability | CX-0125 Traceability Use Case v2.0.0 | +| | SoftwareInformation | 1.0.0 | | Traceability | N/A | +| | CertificateSigningRequests | 1.0.0 | | Traceability | N/A | +| | SpecialCharacteristics | 1.0.0 | | Traceability | N/A | + ### TractionBatteryCode The aspect provides the information of the Traction battery code of a battery cell, a battery module or a battery pack according to the chinese standard GB/T 34014-2017. Furthermore, it provides the traction battery codes for the assembled sub parts of the component, e.g. Traction battery code of a battery module plus all the traction battery codes of the assembled battery cells of this battery module. @@ -154,3 +164,91 @@ Aspect model in GitHub: ] } ``` + +### SpecialCharacteristicMeasurement +Special Characteristics are measureable and these measurements are of interest for a consumer who defined these characteristics. The proposal is a data model "result" which represents a measurement related to a specific measurement and product. A measurement result is identified by the identification of a characteristic and the product. + +Aspect model in GitHub: +- Version 1.0.0: https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.special_characteristics.measurement/1.0.0 + +#### Example: Submodel `SpecialCharacteristicMeasurement` + +```json +{ + "localIdentifiers": [ + { + "value": "SN12345678", + "key": "partInstanceId" + }, + { + "value": "SN12345678", + "key": "manufactuererId" + } + ], + "customerPartId": "PRT-12345", + "revisionIndex": "01", + "measurementType": "simple", + "characteristicId": "S1", + "results": [ ] +} +``` +#### Recommended Pattern (Key Value Pair) +Due to the amount of different characteristics we opted not to require a specific format for the measurement objects contained in the **"results": [ ]** object list. We rather provide a set of format we recommend to use. These recommendations depend on the most common characteristics and their requirements for the results. + +##### Simple Measurements +We consider for characteristics a simple measurement if it just requires to measure a single value. For example the thickness of a rolled steel plate. We designed the measurement object to be able to represent any measurement where it is required to measure a value with a unit. + +**Data model** +| Attribute | Plausability | Type | Example | +| :-- | :-- | :-- | :-- | +| value | mandatory | string | -2.9426523E38 | +| unit | mandatory | string | -eOMtThyhVNLWUZNRcBaQKxI | +| measurementTimeStamp | mandatory | timestamp | 2024-10-01 | + +**Example: Submodel Simple Measurements** +```json +{ + "measurement" : { + "value" : -2.9426523E38, + "unit" : "eOMtThyhVNLWUZNRcBaQKxI" + }, + "measurementTimestamp" : "2024-10-01" +} +``` + +##### Qualitative Measurements +We consider a qualitative measurement a measurement where a value has to be extracted and a read Qualitity has to be determined. An example would be the serial number which has to be etched onto the product. The result of the etching has to be of a certain quality where this quality is measured by some metric. + +**Data model** +| Attribute | Plausability | Type | Example | +| :-- | :-- | :-- | :-- | +| extractedValue | mandatory | string | eOMtThyhVNLWUZNRcBaQKxI | +| readQuality | mandatory | string | 5 | +| measurementTimeStamp | mandatory | timestamp | 2024-10-01 | + +**Example: Submodel Qualitative Measurements** +```json +{ + "extractedValue" : "eOMtThyhVNLWUZNRcBaQKxI", + "readQuality" : 5, + "measurementTimestamp" : "2024-10-01" +} +``` + +##### Functional Measurements +Functional Measurements are for characteristics where the result just confirms that the function is at it is expected. + +**Data model** +| Attribute | Plausability | Type | Example | +| :-- | :-- | :-- | :-- | +| value | mandatory | boolean | true | +| measurementTimeStamp | mandatory | timestamp | 2024-10-01 | + +**Example** +```json +{ + "value" : true, + "measurementTimestamp" : "2024-10-01" +} +``` + diff --git a/docs-kits/kits/Traceability Kit/assets/architecture_level_1.png b/docs-kits/kits/Traceability Kit/assets/architecture_level_1.png deleted file mode 100644 index 514bafb2f38..00000000000 Binary files a/docs-kits/kits/Traceability Kit/assets/architecture_level_1.png and /dev/null differ diff --git a/docs-kits/kits/Traceability Kit/assets/architecture_level_1.svg b/docs-kits/kits/Traceability Kit/assets/architecture_level_1.svg new file mode 100644 index 00000000000..da4412718ef --- /dev/null +++ b/docs-kits/kits/Traceability Kit/assets/architecture_level_1.svg @@ -0,0 +1,4 @@ + + + +

Catena-X Core Services
«Catena-X Partner»
Traceability at Another Catena-X Partner
«Catena-X Partner»
Traceability at Catena-X Partner
Register Digital Twins 
Lookup EDC adress
 
for Catena-X partners
«Component»
Data Provisioning
Fetch Data from Digital Twins 
Optionally: Lookup Digital Twins
«Component»
Traceability App
«Service»
Eclipse Dataspace
Connector
(EDC)
Internal Systems
«Service»
Eclipse Dataspace
Connector
(EDC)
Optional: 

«Service»
Item Relationship Service
(IRS)
Internal Systems
«Service»
EDC Discovery
«Service»
Digital Twin Registry
«Service»
Digital Twin Registry
DTR via EDC:
Lookup Digital Twins for Catena-X Partners

Register Quality Investigation & Alert Topics
as EDC Assets

Register Block Information as EDC Assets

Receive and send
 Quality Investigation & Alert notifications

Receive and send Block notifications

Optionally: Fetch Data from Digital Twins 
Lookup EDC adress
 
for Catena-X partners
DTR via EDC:
Lookup Digital Twins for Catena-X Partners

Register Submodels as EDC Assets

Process requests for EDC Assets

Register Unique ID Push Topics as EDC Assets

Receive and send Unique ID Push notifications
 \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/datachain_oneup_onedown.png.license b/docs-kits/kits/Traceability Kit/assets/architecture_level_1.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/datachain_oneup_onedown.png.license rename to docs-kits/kits/Traceability Kit/assets/architecture_level_1.svg.license diff --git a/docs-kits/kits/Traceability Kit/assets/block-notification-state-model-interaction.svg b/docs-kits/kits/Traceability Kit/assets/block-notification-state-model-interaction.svg new file mode 100644 index 00000000000..682dd0a849b --- /dev/null +++ b/docs-kits/kits/Traceability Kit/assets/block-notification-state-model-interaction.svg @@ -0,0 +1,4 @@ + + + +
Scenario 2 (Update)
Block information of one or more parts 
was sent by mistake. Therefore, the 
block status of the previously sent parts 
must be updated.

Note: The CANCELED status can also 
be updated by the recipient if it has 
been determined that the part is faultless 
and therefore does not need to be 
sorted out. 
Update Block Notification
Scenario 1 (Default)
Block information was sent for faulty 
parts that needs to be sorted out.
Scenario 1 (Update)
Parts were blocked and therefore the 
status was updated.
Receiver


Block Notifcation
Data
Data: all block information
Status: VALID
ID: 884267902
VALID
Data: all block information
Status: VALID
VALID
ID: 864267903
ID: 864287306


Block Notifcation
Data
Data: all block information
Status: VALID
ID: 884267902
VALID
Data: all block information
Status: VALID
VALID
ID: 864267903
Data: all block information
Status: VALID
ID: 884267902
VALID
Data: all block information
Status: VALID
VALID
ID: 864267903


. . .
Block Notifcation
Data
ID: 884267902
ID: 864267903
Block Notifcation
Data
Block Notifcation
Data
Block Notification
Data
Receive Block
Notification
Update Block 
Notification
ONLY status update
BlockStatus: 
PART_BLOCKED
BlockStatus: 
PART_BLOCKED
Sender


. . .
Block Notifcation
Data
Data: all block information
Status: VALID
ID: 884267902
VALID
Data: all block information
Status: VALID
VALID
ID: 864267903
Data: all block information
Status: VALID
VALID
ID: 864287306


. . .
Block Notifcation
Data
Data: all block information
Status: VALID
ID: 884267902
VALID
Data: all block information
Status: VALID
VALID
ID: 864267903
Data: all block information
Status: VALID
VALID
ID: 864287306


. . .
Block Notifcation
Data
Data: all block information
Status: VALID
ID: 884267902
VALID
Data: all block information
Status: VALID
VALID
ID: 864267903
Data: all block information
Status: VALID
VALID
ID: 864287306


. . .
Block Notifcation
Data
Data: block information
BlockStatus: 
ID: 884267902
Data: block information
ID: 864267903
Data: block information
ID: 864287306
Block Notifcation
Data
Block Notifcation
Data
Block Notification
Status Update
ACTIVE
BlockStatus: 
ACTIVE
BlockStatus: 
ACTIVE
Block Notifcation
Data


Block Notifcation
Data


Block Notifcation
Data


. . .
Block Notification
Status Update
ID: 864287306
ONLY status update
BlockStatus: 
CANCELED
 \ No newline at end of file diff --git a/docs-kits/kits/Traceability Kit/assets/block-notification-state-model-interaction.svg.license b/docs-kits/kits/Traceability Kit/assets/block-notification-state-model-interaction.svg.license new file mode 100644 index 00000000000..ae4bfbd15fb --- /dev/null +++ b/docs-kits/kits/Traceability Kit/assets/block-notification-state-model-interaction.svg.license @@ -0,0 +1,6 @@ +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Traceability%20Kit (latest version) diff --git a/docs-kits/kits/Traceability Kit/assets/block-notification-state-model.svg b/docs-kits/kits/Traceability Kit/assets/block-notification-state-model.svg new file mode 100644 index 00000000000..a9b1bcc4e99 --- /dev/null +++ b/docs-kits/kits/Traceability Kit/assets/block-notification-state-model.svg @@ -0,0 +1,4 @@ + + + +
ACTIVE
CANCELED
ONLY by 
the Sender
by the Sender OR
the Receiver
Legend
Sender
Receiver
PART_BLOCKED
ONLY by
the Receiver
X
X
 \ No newline at end of file diff --git a/docs-kits/kits/Traceability Kit/assets/block-notification-state-model.svg.license b/docs-kits/kits/Traceability Kit/assets/block-notification-state-model.svg.license new file mode 100644 index 00000000000..ae4bfbd15fb --- /dev/null +++ b/docs-kits/kits/Traceability Kit/assets/block-notification-state-model.svg.license @@ -0,0 +1,6 @@ +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Traceability%20Kit (latest version) diff --git a/docs-kits/kits/Traceability Kit/assets/block_notifications.svg b/docs-kits/kits/Traceability Kit/assets/block_notifications.svg new file mode 100644 index 00000000000..4c375ece037 --- /dev/null +++ b/docs-kits/kits/Traceability Kit/assets/block_notifications.svg @@ -0,0 +1,4 @@ + + + +
B
BLOCK INFORMATION - BOTTOM UP
Tier-n
Tier-2
Tier-1
OEM
Field
Localization and sorting out the affected parts in the production or logitics process based on stuctured data
Identification of affected components, which should be blocked based on the current analysis
NO action needed, if the defective parts were sorted out before installation
X
Z
W
c
2
a
Identification of potential issues
Identification of affected components with customer
Identification of affected components with customer
Analysis and containment of affected vehicles
Countermeasures for affected vehicles
PREVENTIVE QUALITY ALERTS - BOTTOM UP
Tier-n
Tier-2
Tier-1
OEM
Field
B
x
y
z
w
b
c
A
1
2
a
b
Y
potential immediate measure 
 \ No newline at end of file diff --git a/docs-kits/kits/Traceability Kit/assets/block_notifications.svg.license b/docs-kits/kits/Traceability Kit/assets/block_notifications.svg.license new file mode 100644 index 00000000000..ae4bfbd15fb --- /dev/null +++ b/docs-kits/kits/Traceability Kit/assets/block_notifications.svg.license @@ -0,0 +1,6 @@ +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Traceability%20Kit (latest version) diff --git a/docs-kits/kits/Traceability Kit/assets/quality_notifications.png b/docs-kits/kits/Traceability Kit/assets/quality_notifications.png deleted file mode 100644 index da8b0f195f6..00000000000 Binary files a/docs-kits/kits/Traceability Kit/assets/quality_notifications.png and /dev/null differ diff --git a/docs-kits/kits/Traceability Kit/assets/quality_notifications.svg b/docs-kits/kits/Traceability Kit/assets/quality_notifications.svg new file mode 100644 index 00000000000..c0d23cd0390 --- /dev/null +++ b/docs-kits/kits/Traceability Kit/assets/quality_notifications.svg @@ -0,0 +1,4 @@ + + + +
Identification of potential issues
Identification of affected components with customer
Identification of affected components with customer
Analysis and containment of affected vehicles
Countermeasures for affected vehicles
PREVENTIVE QUALITY ALERTS - BOTTOM UP
Tier-n
Tier-2
Tier-1
OEM
Field
B
x
y
z
w
b
c
A
1
2
a
PREVENTIVE QUALITY INVESTIGATION - TOP DOWN
Frequent error
Analysis & containment of relevant components
Identification & data exchange with supplier
Cause analysis & countermeasures
Tier-n
Tier-2
Tier-1
OEM
Field
B
X
Y
Z
W
b
c
A
1
2
a
 \ No newline at end of file diff --git a/docs-kits/kits/Traceability Kit/assets/architecture_level_1.png.license b/docs-kits/kits/Traceability Kit/assets/quality_notifications.svg.license similarity index 100% rename from docs-kits/kits/Traceability Kit/assets/architecture_level_1.png.license rename to docs-kits/kits/Traceability Kit/assets/quality_notifications.svg.license diff --git a/docs-kits/kits/Traceability Kit/diagrams/block-notification-send-receive.svg b/docs-kits/kits/Traceability Kit/diagrams/block-notification-send-receive.svg new file mode 100644 index 00000000000..6609f40dfb7 --- /dev/null +++ b/docs-kits/kits/Traceability Kit/diagrams/block-notification-send-receive.svg @@ -0,0 +1,4 @@ + + + +
RECEIVER
SENDER
EDC
Some (Traceability) App
Identify affected Part(s) /
Batch(es) who needs to be 
blocked / sorted out
Identify BPN for affected
Part(s) / Batch(es)
Create Notification
Status:= CREATED
[05]
Create Block Status for each 
affected Part(s) / Batch(es).
Block Status:= ACTIVE
Update Notification
Status:= SENT
Update Notification
Status:= RECEIVED
Notification 
EDC Adapter
Find and Select
Contract
EDC
Some (Traceability) App
Resolve EDC Endpoint
OK
Send Notification Update
Fetch 
Catalog
Initiate Contract 
Negotiation
Contract 
Negotiation
Establish 
Channel
POST /public/...
POST /public/...
POST /notifications/
blocknotification/receive
BPN of supply chain partner (as given in existing notification)
Find the correct contract offer with:

"asset:Prop:notificationtype" : "blocknotification",
"asset:prop:notificationmethod" : "receive"
The http path depends on the DataAddress in the EDC Data Asset. Thus, it depends on the (Trace) app.
201 OK
Discovery
Service
Fetch 
Catalog
201 OK
201 OK
201 OK
Some 
(Traceability) App
Notification 
EDC Adapter
EDC
Discovery
Service
EDC
Some 
(Traceability) App
OK
[01]
Create EDC Asset for 
"ReceiveBlockNotification" 
with DataAddress as HTTP 
POST endpoint
[02]
[03]
[04]
[06]
Not mandatory as the interaction with the EDC can be implemented also in an (traceabililty) app.

However, a similar functionality (e.g. fetch catalog) - as shown below - must be provided.
[07]
[08]
[09]
Payload as described in the Block Notification API specification
[10]
[11]
[12]
[13]
[13]
[14]
Initiate Data 
Transfer
[15]
[16]
[17]
Payload as described in the Block Notification API specification
[18]
[19]
Payload as described in the Block Notification API specification
[20]
[21]
[22]
[23]
[24]
 \ No newline at end of file diff --git a/docs-kits/kits/Traceability Kit/diagrams/block-notification-send-receive.svg.license b/docs-kits/kits/Traceability Kit/diagrams/block-notification-send-receive.svg.license new file mode 100644 index 00000000000..ae4bfbd15fb --- /dev/null +++ b/docs-kits/kits/Traceability Kit/diagrams/block-notification-send-receive.svg.license @@ -0,0 +1,6 @@ +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Traceability%20Kit (latest version) diff --git a/docs-kits/kits/Traceability Kit/diagrams/block-notification-update-status.svg b/docs-kits/kits/Traceability Kit/diagrams/block-notification-update-status.svg new file mode 100644 index 00000000000..1defb8e02ba --- /dev/null +++ b/docs-kits/kits/Traceability Kit/diagrams/block-notification-update-status.svg @@ -0,0 +1,4 @@ + + + +
RECEIVER
SENDER
EDC
Some (Traceability) App
Identify affected Part(s) /
Batch(es) whose block status
needs to be updated
Identify BPN for affected
Part(s) / Batch(es)
Create Notification
Status:= CREATED
[05]
Change Block Status of the 
affected Part(s) / Batch(es) 
that needs to be updated
(according to the status model)
Update Notification
Status:= SENT
Update Notification
Status:= RECEIVED
Notification 
EDC Adapter
Find and Select
Contract
EDC
Some (Traceability) App
Resolve EDC Endpoint
OK
Send Notification Update
Fetch 
Catalog
Initiate Contract 
Negotiation
Contract 
Negotiation
Establish 
Channel
POST /public/...
POST /public/...
POST /notifications/
blocknotification/update
BPN of supply chain partner (as given in existing notification)
Find the correct contract offer with:

"asset:Prop:notificationtype" : "blocknotification",
"asset:prop:notificationmethod" : "update"
The http path depends on the DataAddress in the EDC Data Asset. Thus, it depends on the (Trace) app.
201 OK
Discovery
Service
Fetch 
Catalog
201 OK
201 OK
201 OK
Some 
(Traceability) App
Notification 
EDC Adapter
EDC
Discovery
Service
EDC
Some 
(Traceability) App
Depending on whether the process for block parts was canceled or parts were actually blocked and sorted out, a different status is sent during an update.
OK
[01]
Create EDC Asset for 
"UpdateBlockNotification" 
with DataAddress as HTTP 
POST endpoint
[02]
[03]
[04]
[06]
Not mandatory as the interaction with the EDC can be implemented also in an (traceabililty) app.

However, a similar functionality (e.g. fetch catalog) - as shown below - must be provided.
[07]
[08]
[09]
Payload as described in the Block Notification API specification
[10]
[11]
[12]
[13]
[13]
[14]
Initiate Data 
Transfer
[15]
[16]
[17]
Payload as described in the Block Notification API specification
[18]
[19]
Payload as described in the Block Notification API specification
[20]
[21]
[22]
[23]
[24]
 \ No newline at end of file diff --git a/docs-kits/kits/Traceability Kit/diagrams/block-notification-update-status.svg.license b/docs-kits/kits/Traceability Kit/diagrams/block-notification-update-status.svg.license new file mode 100644 index 00000000000..ae4bfbd15fb --- /dev/null +++ b/docs-kits/kits/Traceability Kit/diagrams/block-notification-update-status.svg.license @@ -0,0 +1,6 @@ +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Traceability%20Kit (latest version) diff --git a/docs-kits/kits/Traceability Kit/openapi/block-notifications-1-0-0.yaml b/docs-kits/kits/Traceability Kit/openapi/block-notifications-1-0-0.yaml new file mode 100644 index 00000000000..bc9173bf9f7 --- /dev/null +++ b/docs-kits/kits/Traceability Kit/openapi/block-notifications-1-0-0.yaml @@ -0,0 +1,602 @@ +openapi: '3.0.3' +info: + title: Block Notification API + version: '1.0.0' + description: "The blocking process is a process in the automotive industry to segregate or quarantine nonconforming parts in the supply chain to prevent using them in the production process. Therefore, the supplier must send all relevant information to the customer, so that he is able to identify the affected parts for example at the assembly line or in logistics. \n\n This API is to be used to transfer this information in a standardized manner and to trace the individual parts back to see whether they have been blocked and sorted out on the customer side in order to prevent subsequent damage or major product recalls. In addition, the notification is intended to improve the quality and speed of the block information provided." + license: + name: Apache License v2.0 + url: https://www.apache.org/licenses/LICENSE-2.0 + +servers: +- url: https://example.com/api/v1 + variables: + api-version: + default: '1.0.0' + +paths: + + # Path to send and receive block notifications + /block-notification/receive: + post: + tags: + - Block Notification + requestBody: + $ref: '#/components/requestBodies/BlockNotificationReceive' + responses: + "201": + $ref: '#/components/responses/Successful' + "400": + $ref: '#/components/responses/Malformed' + "401": + $ref: '#/components/responses/Unauthorized' + "403": + $ref: '#/components/responses/Forbidden' + "404": + $ref: '#/components/responses/NotFoundError' + "405": + $ref: '#/components/responses/Duplication' + "422": + $ref: '#/components/responses/SemanticError' + + # Path to send and receive a status update of a existing block notifications + /block-notification/update: + post: + tags: + - Block Notification + requestBody: + $ref: '#/components/requestBodies/BlockNotificationUpdate' + responses: + "201": + $ref: '#/components/responses/Successful' + "400": + $ref: '#/components/responses/Malformed' + "401": + $ref: '#/components/responses/Unauthorized' + "403": + $ref: '#/components/responses/Forbidden' + "404": + $ref: '#/components/responses/NotFoundError' + "405": + $ref: '#/components/responses/Duplication' + "422": + $ref: '#/components/responses/SemanticError' + +components: + + # Schemas to build up the request body and the reponses + schemas: + BlockNotificationReceive: + type: object + description: "Request schema to send block notifications." + properties: + header: + $ref: '#/components/schemas/urn_samm_io.catenax.shared.message_header_3.0.0_HeaderCharacteristic' + content: + $ref: '#/components/schemas/NotificationContentReceive' + required: + - header + - content + + BlockNotificationUpdate: + type: object + description: "Request body schema to send a status update for an existing block notification." + properties: + header: + $ref: '#/components/schemas/urn_samm_io.catenax.shared.message_header_3.0.0_HeaderCharacteristic' + content: + $ref: '#/components/schemas/NotificationContentUpdate' + required: + - header + - content + + # Schemas to build up the header + 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: + $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 + + urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait: + type: string + description: "The fully anonymous Catena-X ID of the serialized part or\ + \ batch, valid for the Catena-X dataspace. \n\nThe 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: |- + 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. + example: 'Traceability-BlockNotification:1.0.0' + + 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. + example: '2024-10-07T10:15+00:00' + + 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-]+)*)?$" + example: '3.0.0' + + # Schemas to build up the content (default notification) + urn_samm_io.catenax.block_notification_receive_1.0.0_PartBlockingInformationSet: + description: The characteristic of the part blocking information defined as + an Array Set. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_PartBlockingInformationEntity' + uniqueItems: true + + urn_samm_io.catenax.block_notification_data_1.0.0_PartBlockingInformationEntity: + description: The entitiy of the part blocking information Array Set. + type: object + properties: + catenaXId: + description: "The fully anonymous Catena-X ID of the serialized part or\ + \ batch, valid for the Catena-X dataspace." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait' + blockStatus: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_1.0.0_BlockStatus' + componentLevelContainment: + description: Section with blocking information at component level. + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_ComponentLevelContainmentCharacteristic' + periodAndVolumeLevelContainment: + description: Section with blocking information at period and volume level. + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_PeriodAndVolumeLevelContainmentCharacteristic' + locationInTheContainer: + description: 'Object which contain information regarding the locality of + the part within a small load carrier. ' + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_LocationInTheContainerCharacteristic' + required: + - catenaXId + - blockStatus + - componentLevelContainment + - periodAndVolumeLevelContainment + + urn_samm_io.catenax.block_notification_1.0.0_BlockStatus: + type: string + description: "Child-element of the partBlockingInformation array.\n\nProvides\ + \ information about the status of the individual part within a blocking\ + \ notification that must be blocked for security reasons. \n\nACTIVE means\ + \ that the part has been identified as a damaged and safety-critical part\ + \ and must therefore be blocked on the customer side.\n\nPART_BLOCKED\ + \ Status when the receiver has accepted the block and has actually blocked\ + \ the part (Note: sender must be informed!).\n\nCANCELED serves as the\ + \ update status of the component originally identified to be blocked if\ + \ the manufacturer subsequently determines that the original part does\ + \ meet safety requirements, is not damaged or that the information was\ + \ sent by mistake. " + enum: + - ACTIVE + - PART_BLOCKED + - CANCELED + + urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaCharacteristic: + type: string + description: "Identifies the respective address of the supplier's location + from which the corresponding components are delivered. \n\n The provided regular expression ensures that the BPNA is composed\ + \ of prefix 'BPNA', 10 digits and two alphanumeric letters." + pattern: "^BPNA[a-zA-Z0-9]{12}$" + + urn_samm_io.catenax.block_notification_data_1.0.0_IntegrationLevelCharacteristic: + type: string + description: "(E/E component generation (hardware and software) with defined\ + \ functional content and coordinated system communication) [Vehicle electrics/electronics]\t" + example: 'S18A-19-03-400' + + urn_samm_io.catenax.serial_part_3.0.0_PartIdCharacteristic: + type: string + description: |- + An ID that consists of two different pieces of information but at least always contains a part number: + + Part Number + identifier of a particular part design (or material used) which unambiguously identifies a part design within a single corporation, sometimes across several corporations + + Change Index (optional) + The change index corresponds to the identification of a version of a technical object (also in the technical drawing). + This provides easy-to-understand version management, which allows older variants to be clearly addressed. The first version usually has an index of 0. When changes are made, this is usually increased by 1. The current edition therefore has the highest change index. Alternatively, it is possible to represent the index in ascending order with letters, i.e. A, B, C,... Z, AA, AB, etc. + example: '884267902' + + urn_samm_io.catenax.serial_part_3.0.0_KeyTrait: + type: string + description: Constraint that ensures that the standard keys and custom key prefixes + can be used. + pattern: ^(manufacturerId|partInstanceId|batchId|van|customKey:\w+)$ + + urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic: + type: string + description: The value of an identifier. + + urn_samm_io.catenax.serial_part_3.0.0_KeyValueList: + description: "A list of key value pairs for local identifiers, which are composed\ + \ of a key and a corresponding value." + type: object + properties: + key: + description: 'The key of a local identifier. ' + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyTrait' + value: + description: The value of an identifier. + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic' + required: + - key + - value + + urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic: + description: "A local identifier enables identification of a part in a specific\ + \ dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers\ + \ may exist. \n\n A single serialized part may have multiple attributes, that uniquely\ + \ identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)" + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyValueList' + uniqueItems: true + example: + - key: 'manufacturerId' + value: 'BPNL0123456789ZZ' + - key: 'partInstanceId' + value: 'SN12345678' + - key: 'customKey:ecuSerialNumber' + value: '220115001384267902201978150063581180' + + urn_samm_io.catenax.block_notification_data_1.0.0_ComponentLevelContainmentCharacteristic: + description: 'The characteristic of the component level containment defined + as a Object. ' + type: object + properties: + manufacturingLocationId: + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaCharacteristic' + integrationLevel: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_IntegrationLevelCharacteristic' + customerPartId: + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_PartIdCharacteristic' + localIdentifiers: + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic' + required: + - manufacturingLocationId + - customerPartId + - localIdentifiers + + 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.shared.quantity_2.0.0_QuantityValueCharacteristic: + type: number + description: The quantity value associated with the unit expressed as float. + example: 20.0 + + urn_samm_io.catenax.block_notification_data_1.0.0_QuantityCharacteristic: + description: 'The characteristic to define the quantity an value of a property. ' + type: object + properties: + itemUnit: + description: "The unit of an item. Common units may be related to mass,\ + \ count, linear, area, volume or misc." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_ItemUnitEnumeration' + quantityValue: + description: The quantity value associated with the unit. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic' + required: + - itemUnit + - quantityValue + + urn_samm_io.catenax.block_notification_data_1.0.0_DeliveryPlaceCharacteristic: + type: string + description: "The identification number of the unloading point. An unloading\ + \ point is an important part of logistics, as it describes the location\ + \ where goods can be loaded or unloaded using a means of transport. In\ + \ addition to the address itself, the spatial conditions at the unloading\ + \ point are also important. Each warehouse has its own type of unloading\ + \ point, such as a ramp that is specifically designed for loading and\ + \ unloading goods. These specific conditions are crucial for the efficient\ + \ and secure processing of deliveries.\t" + example: '22610' + + urn_samm_io.catenax.block_notification_data_1.0.0_DeliveryNoteNumberCharacteristic: + type: string + description: "The number of the delivery note that accompanies the delivery\ + \ and shows the description, unit and quantity of goods included in the\ + \ delivery, etc..\t" + example: '68988545' + + urn_samm_io.catenax.block_notification_data_1.0.0_PackageNumberCharacteristic: + type: string + description: "Identififcation number of the package, the unit of goods and\ + \ packaging material. These can be boxes, pallets, mesh boxes, roll containers\ + \ and other loading equipment." + example: '12295140916130' + + urn_samm_io.catenax.block_notification_data_1.0.0_OrderNumberCharacteristic: + type: string + description: The order number (only for production synchronization requests + (JIS)) + example: '7334663' + + urn_samm_io.catenax.block_notification_data_1.0.0_PeriodAndVolumeLevelContainmentCharacteristic: + description: 'The characteristic of the period and volume level containment + defined as Object. ' + type: object + properties: + sizeOfProductionLot: + description: "A production lot is the combined number of products or manufactured\ + \ parts that are produced in a work process without interruption. There\ + \ is no need to convert production facilities. \t" + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_QuantityCharacteristic' + deliveryNoteNumber: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_DeliveryNoteNumberCharacteristic' + packageNumber: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_PackageNumberCharacteristic' + deliveryPlace: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_DeliveryPlaceCharacteristic' + deliveryDate: + description: "The date, on which the supplier handed over the shipment \ + \ to the carrier. Shiiping date of the manufacturer." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + numberOfPartsPerDeliveryNote: + description: The quanity of delivered parts per delivery note. + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_QuantityCharacteristic' + productionDate: + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + numberOfPartsPerPackage: + description: Number of parts, which are stored in a package. + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_QuantityCharacteristic' + orderNumber: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_OrderNumberCharacteristic' + required: + - sizeOfProductionLot + - deliveryNoteNumber + - packageNumber + - deliveryPlace + - deliveryDate + - numberOfPartsPerDeliveryNote + - productionDate + - numberOfPartsPerPackage + + urn_samm_io.catenax.block_notification_data_1.0.0_XPositionCharacteristic: + type: string + description: "Position along the X coordinate where the faulty component\ + \ (cell) is located within the small charge carrier.\t" + example: 'F' + + urn_samm_io.catenax.block_notification_data_1.0.0_YPositionCharacteristic: + type: string + description: Position along the Y coordinate where the faulty component + (cell) is located within the small charge carrier. + example: '10' + + urn_samm_io.catenax.block_notification_data_1.0.0_SmallLoadCarrierLayerCharacteristic: + type: string + description: |- + The layer within the small load carrier in which the faulty part is located. + (Ideally if available: UCID = Unique Container ID - ID of the small load carrier in which the faulty part is located) + Packaging specific for high-voltage battery cells. Other components (e.g. penthouse are not packaged in small load carriers). + example: '53BUN6555599345283155+000000008' + + urn_samm_io.catenax.block_notification_data_1.0.0_LocationInTheContainerCharacteristic: + description: The characteristic to define the location in the container defined + as entity. + type: object + properties: + xPosition: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_XPositionCharacteristic' + yPosition: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_YPositionCharacteristic' + smallLoadCarrierLayer: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_SmallLoadCarrierLayerCharacteristic' + + # Schemas to build up the content (status udpate notification) + urn_samm_io.catenax.block_notification_status_update_1.0.0_PartBlockingInformationSet: + description: The characteristic of the part blocking information defined as + an Array Set. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_status_update_1.0.0_PartBlockingInformationEntity' + uniqueItems: true + example: + - catenaXId: '580d3adf-1981-44a0-a214-13d6ceed9379' + blockStatus: 'PART_BLOCKED' + - catenaXId: '6a3cA7E1-1682-5F25-FE1d-cF112433C2f4' + blockStatus: 'PART_BLOCKED' + - catenaXId: '550d3swf-1845-55sw-a2s8-13d6ceed4265' + blockStatus: 'PART_BLOCKED' + + urn_samm_io.catenax.block_notification_status_update_1.0.0_PartBlockingInformationEntity: + description: The entitiy of the part blocking information Array Set. + type: object + properties: + catenaXId: + $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait' + blockStatus: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_1.0.0_BlockStatus' + required: + - catenaXId + - blockStatus + + NotificationContentReceive: + type: object + properties: + notificationStatus: + $ref: '#/components/schemas/NotificationStatus' + problemDescription: + type: string + maxLength: 1000 + example: "Gear boxes lose oil while driving." + description: A free text field which provides information why the parts from the provided list must be blocked or sorted out. + blockInformations: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_receive_1.0.0_PartBlockingInformationSet' + required: + - notificationStatus + - blockInformations + + NotificationContentUpdate: + type: object + properties: + notificationStatus: + $ref: '#/components/schemas/NotificationStatus' + updateReason: + type: string + maxLength: 1000 + example: "Defect gear boxes were sorted out to prevent major damage." + description: A free text field that informs why a previously provided list of damaged parts needs to be updated. For example, because the order to block the parts must be canceled due to a user error or because the damaged parts were sorted out by the customer and thus blocked. + blockInformations: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_status_update_1.0.0_PartBlockingInformationSet' + required: + - notificationStatus + - blockInformations + + NotificationStatus: + type: string + enum: + - CREATED + - SENT + - RECEIVED + - ACKNOWLEDGED + - CLOSED + example: 'SENT' + description: The status of the block notification. The following entries are supported and allowed + + - CREATED + This status is an internal status and is used after the initial creation of a notification. It is not communicated to an other CX/business partner. + + - SENT + This status means that the notification has been sent out. This status is shown on the sender side (and not on the receiver side). + + - RECEIVED + This status means that the notification has been received by the receiver. The status is shown on sender and receiver side. It is not communicated to another CX/business partner. + + - ACKNOWLEDGED + Defines that a user has confirmed that the notification has been received. + + - CLOSED + This status is set by the initiator of the notification either to regularly close the notification (i.e., after the receiver has set the status to ACKNOWLEDGED). + + # Response Content + responses: + Successful: + description: Block notification was sent successfully. + Malformed: + description: Request body was malformed. + Unauthorized: + description: The requesting user or client is not authenticated. + Forbidden: + description: The requesting user or client is not authorized to access.resources. + NotFoundError: + description: Method not allowed. + Duplication: + description: Could not accept the sent block notification, because a block notification with that same notification ID already exists. + SemanticError: + description: Could not accept the sent block notification even though it is syntactically correct. The block notification is not accepted, because of semantic reasons (e.g., an affected item is not known by the receiver). + + # Request Body Content + requestBodies: + BlockNotificationReceive: + content: + application/json: + schema: + $ref: '#/components/schemas/BlockNotificationReceive' + BlockNotificationUpdate: + content: + application/json: + schema: + $ref: '#/components/schemas/BlockNotificationUpdate' diff --git a/docs-kits/kits/Traceability Kit/page_architecture-view.mdx b/docs-kits/kits/Traceability Kit/page_architecture-view.mdx index dac73dac88e..87e63bb698f 100644 --- a/docs-kits/kits/Traceability Kit/page_architecture-view.mdx +++ b/docs-kits/kits/Traceability Kit/page_architecture-view.mdx @@ -51,14 +51,14 @@ This KIT describes two core capabilties of Traceability: This overview shows the two core capabilities of Traceabilty and the Catena-X Core Services onto which Traceability is built and which are required by the Traceability architecture. -![Architecture - Level 1](./assets/architecture_level_1.png) +![Architecture - Level 1](./assets/architecture_level_1.svg) ### Traceability Components | Subsystem | Description | |:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Data Provisioning | This component extracts data from a company's internal systems, transforms it into digital twins, and publishes these digital twins in the DTR and their data in the EDC (as submodels, based on aspect models). The published data is used by Traceability apps as well as other use cases that require Traceabiilty data. | -| Traceability App | A Traceability app has two core functionalities:
  • providing an UI to show the parts manufactured by a company and published as digital twins
  • create and process quality alerts and quality investigations for quality actions
| +| Traceability App | A Traceability app has three core functionalities:
  • providing an UI to show the parts manufactured by a company and published as digital twins
  • create and process quality alerts and quality investigations for quality actions
  • create and transfer block information in real time to separate or quarantine faulty parts in the supply chain to prevent them from being used in the production process (currently optional app feature)
| | Internal Systems | These are existing internal systems of a Catena-X partner which provides data to Traceability components, e.g.,
  • for data provisioning: The data provided to Catena-X is fetched from a partner's internal PLM and parts master data systems.
  • for Traceability apps: A Traceability app may show more data to a user than just the data that is provided to Catena-X. Generally, the business scope of COTS software is bigger than just Traceability and they have existing interfaces to fetch all data they need for their business functionality (and not only Traceability data).
Both components can also send data back to internal systems. That's at the discretion of the Catena-X partner and neither required nor prohibited by the Traceability use case. | ### Catena-X Core Services @@ -85,13 +85,16 @@ The following diagram shows a basic data processing flow how a company's interna Data provisioning of Traceabilty is built on the data provisioning of the [Industry Core KIT](../Industry%20Core%20Kit/Architecture%20View%20Industry%20Core%20Kit), i.e., Traceability extends the digital twins PartType and PartInstance with additional aspect models: - Digital Twin "PartType" - + - N/A - Digital Twin "PartInstance" - - Aspect model ["TractionBatteryCode"](../Traceability%20Kit/Software%20Development%20View/Data%20Provider%20Development%20View%20Traceability%20Kit#tractionbatterycode) - + - Aspect model ["TractionBatteryCode"](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Software%20Development%20View/Data%20Provider%20Development%20View%20Traceability%20Kit#tractionbatterycode) + - Aspect model ["SoftwareInformation"](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Software%20Development%20View/Data%20Provider%20Development%20View%20Traceability%20Kit#softwareinformation) + - Aspect model ["CertificateSigningRequests"](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Software%20Development%20View/Data%20Provider%20Development%20View%20Traceability%20Kit#certificatesigningrequests) Details about these aspect models, i.e., the SAMM data model as well as example data, can be found in the [Developer View](../Traceability%20Kit/Software%20Development%20View/Data%20Provider%20Development%20View%20Traceability%20Kit). +> :raised_hand: Beware that the aspect models **_SoftwareInformation_** and **_CertificateSigningRequests_** are not standardized yet, but MAY be released as standardized aspect models in future releases of the CX-0125 Traceability Use Case Standard. + ### Policies To enable data sovereignty, access and usage policies are important to protect the data assets of a data provider in the EDC, described in the following. Further details are described in the [CX - 0018 Sovereign Data Exchange](#standards) standard. @@ -119,7 +122,8 @@ This capability defines what mandatory features a Traceability app must provide | Data Sharing via [CX-0018](#standards) compliant connector | Yes | The data sharing with other Catena-X partners (for Traceability partners, these are their customers and suppliers mostly) must be done via via a [CX-0018](#standards) compliant connector (e.g. EDC). | | Data Sovereignty | Yes | The usage of data in the Traceability app is compliant with the Access and Usage Policies as defined in this KIT. | Quality Alerts | Yes | In the event of an incident the partner's value chain, the partner would like to be informed promptly and in a structured manner by the triggering partners (e.g., manufacturing problem, field problems) so that the partner can respond as quickly as possible (Supplier/Customer). In the same way, the partner wants to inform their value chain partners easily and specifically in the event of relevant incidents. The traceability apps are able to exchange the alerts in the same interoperable way. | -| Quality Investigations | Yes | For a given incident in a partner's supply chain, the partner would like to be able to narrow down the affected products as sharply as possible in order to carry out suitable actions in a targeted manner. The partners in the value chain use interoperable Traceability apps for this purpose.| +| Quality Investigations | Yes | For a given incident in a partner's supply chain, the partner would like to be able to narrow down the affected products as sharply as possible in order to carry out suitable actions in a targeted manner. The partners in the value chain use interoperable Traceability apps for this purpose.| +| Block Information | No | The blocking process is a event where faulty parts in the supply chain are separated or quarantined to prevent them from being used in the production process. Due to the criticality, this part-specific information must be forwarded to the affected manufacturers as quickly as possible so that they can react immediately to sorting out the corresponding components. To overcome this challenge, this information is provided and transmitted via a standardized API.| ### Non-Functional Requirements @@ -137,29 +141,59 @@ The notification itself has various states. The states and their cycle are descr ![Notification State Model](./assets/notification-state-model.svg) -## Runtime View +### Block Information + +The blocking process is a process in the automotive industry to segregate or quarantine nonconforming parts in the supply chain to prevent using them in the production process. Therefore, the supplier must send all relevant information to the customer, so that he is able to identify the affected parts for example at the assembly line or in logistics. + +Catena-X is to be used to transfer this information in a standardized manner and to trace the individual parts back to see whether they have been blocked and sorted out on the customer side in order to prevent subsequent damage or major product recalls. In addition, the notification is intended to improve the quality and speed of the block information provided. + +#### Block Notification Interaction + +The interaction of block notifications is based on events that can be triggered by both the sender and the recipient. These events are represented by a status model and are used to track the progress of the parts that need to be blocked or respectively sorted out by the customer. Details about these status model and the Open API specification for Block Notifications are available in the [Developer View](../Traceability%20Kit/Software%20Development%20View/Data%20Provider%20Development%20View%20Traceability%20Kit). + +**Scenario 1:** In this case, it is assumed that the sender sends a list of parts with the associated block information to the recipient. The block status of each part is set to ACTIVE by default. + +When all block information has been received by the recipient, checked internally, further processed and finally all affected parts were blocked or sorted out, this information is sent back to the sender through a status update (PART_BLOCKED). + +> :raised_hand: Note that the update notification whether one or more parts have been blocked and therefore sorted out by the customer is **not mandatory**. The decision to provide suppliers with this information through a feedback notification **MUST** have been negotiated and accepted by both business partners before implemented. + +**Scenario 2:** +In this case, the sender identified that the block information sent from Scenario 1 was sent incorrectly or unintentionally. + +In order to inform the recipient of this error, the block status of the affected parts is set to CANCELED via an update notification, so that these parts cannot be sorted out and used to be installed by the recipient. -### Processes for Sending, Updating and Resolving Notifications +> :raised_hand: The CANCELED status can also be updated by the recipient if it has been determined that the part(s) are faultless and therefore does not need to be sorted out. -Below the sequence for sending, updating and resolving of notifications between (traceability) applications is shown with UML sequence diagrams. In all cases, Http POST requests are used. Those Http endpoints are described in the section (TRS) Quality Notification Endpoints and EDC Contract Offerings. +![Block State Model Interaction](./assets/block-notification-state-model-interaction.svg) + +## Runtime View + +In the sub-sections below the sequence for sending, updating and resolving of notifications between (traceability) applications is shown with UML sequence diagrams. In all cases, Http POST requests are used. Those Http endpoints are described in the corresponding sections: +- [(TRS) Quality Notification Endpoints](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Software%20Development%20View/App%20Provider%20Development%20View%20Traceability%20Kit#quality-notifications) +- [Block Notification Endpoints](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Software%20Development%20View/App%20Provider%20Development%20View%20Traceability%20Kit#block-notifications) +- [EDC Contract Offerings](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Software%20Development%20View/App%20Provider%20Development%20View%20Traceability%20Kit#asset-registration-via-connector). To read the UML sequence diagrams correctly, some remarks: - The shown Notification EDC Adapter is not mandatory. It is just one option to send a notification via the EDC control and data plane. Important is that a similar functionality must be provided/implemented by the (traceability) application vendor. The Notification EDC Adapter or a similar component / functionality will not be provided as a central service from Catena-X. - To know where a notification must be send to, the (traceability) application must resolve the BPN of the receiver. This can either be happen because the (traceability) application has this information in its data model or it could - alternatively - also be resolved e.g. via a lookup of the digital twin in the central asset administration shell (AAS) registry. - :raised_hand: The (traceability) applications that fully rely on the AAS registry and the corresponding AAS submodels can only support quality investigations. With the release of the AAS submodel SingleLevelUsageAsBuilt or a similar AAS submodel that contains the information, which supply chain partner purchased/assembled a part / batch, it is possible to also support quality alerts for those (traceability) applications. (Warnung) - The resolution of the EDC URL for a given BPN is done via the Discovery Service API. The entry for each EDC into this Discovery Service is done via the CX Portal. - In each UML sequence diagram the step [01] describes the publishing of the notification endpoints as described in the above sections - Similarly, the Http POST request and response bodies are described in the above sections +### Processes for Sending, Updating and Resolving Quality Notifications + #### Sending and Receiving of a Quality Investigation Below, the UML sequence diagram to send and receive a quality investigation is depicted. In addition to the above mentioned general remarks, the following remark: +- The status transition from SENT to RECEIVED has to be done by the sender once it received the Http status code 201 from the receiver + ![NotificationSendReceive](./diagrams/notification_send-receive.svg) #### Sending and Receiving of a Quality Alert +> :raised_hand: The (traceability) applications that fully rely on the AAS registry and the corresponding AAS submodels can only support quality investigations. With the release of the AAS submodel SingleLevelUsageAsBuilt or a similar AAS submodel that contains the information, which supply chain partner purchased/assembled a part / batch, it is possible to also support quality alerts for those (traceability) applications. Below, the UML sequence diagram to send and receive a quality alert is depicted. In addition to the above mentioned general remarks, the following remark: @@ -167,7 +201,6 @@ Below, the UML sequence diagram to send and receive a quality alert is depicted. ![NotificationSendReceiveAlert](./diagrams/notification_send-receive-alert.svg) - #### Update of a Quality Investigation Below, the UML sequence diagram to update a quality investigation is depicted. @@ -175,19 +208,33 @@ Below, the UML sequence diagram to update a quality investigation is depicted. ![NotificationUpdateInvestigation](./diagrams/notification_update-investigation.svg) #### Update of a Quality Alert +> :raised_hand: The (traceability) applications that fully rely on the AAS registry and the corresponding AAS submodels can only support quality investigations. With the release of the AAS submodel SingleLevelUsageAsBuilt or a similar AAS submodel that contains the information, which supply chain partner purchased/assembled a part / batch, it is possible to also support quality alerts for those (traceability) applications. Below, the UML sequence diagram to update a quality alert is depicted. ![NotificationUpdateAlert](./diagrams/notification_update-alert.svg) +### Processes for Sending, Updating and Resolving Block Notifications + +#### Sending and Receiving of Block Information +Below, the UML sequence diagram to send and receive a block information is depicted. + +![BlockNotificationSendReceive](./diagrams/block-notification-send-receive.svg) + +#### Update of Block Information +Below, the UML sequence diagram to update a block information is depicted. +> :raised_hand: The process for sending update notifications regarding an ongoing blocking process must be carried out in the same way as sending block information for the first time. The differences are limited to the following changes: +> - Another data asset “BlockNotificationStatusUpdate” is used for the update +> - The data model of the notification is limited to the ID and block status of a part and therefore does not include full block informations +> - Both 'CANCELED' and 'PART_BLOCKED' can be set for the status depending on which case applies to the notification + +![BlockNotificationUpdateStatus](./diagrams/block-notification-update-status.svg) + ## Standards Our relevant standards can be downloaded from the official [Catena-X Standard Library](https://catena-x.net/de/standard-library): - Traceability is built on the Industry Core. Please check the relevant [standards of the Industry Core](../Industry%20Core%20Kit/Architecture%20View%20Industry%20Core%20Kit#standards). -- [CX - 0022 Notification Process 1.1.1](https://catena-x.net/de/standard-library) -- [CX - 0023 Notification API 1.2.2](https://catena-x.net/de/standard-library) -- [CX - 0062 Traceability Notification Triangle 1.0.0](https://catena-x.net/de/standard-library) -- [CX - 0093 Aspect Model Traction Battery Code 1.0.0](https://catena-x.net/de/standard-library) +- [CX - 0125 Traceability Use Case v2.0.0](https://catenax-ev.github.io/docs/next/standards/CX-0125-TraceabilityUseCase) diff --git a/docs-kits/kits/Traceability Kit/page_business_view.mdx b/docs-kits/kits/Traceability Kit/page_business_view.mdx index dc109e519b8..43e8a5b370d 100644 --- a/docs-kits/kits/Traceability Kit/page_business_view.mdx +++ b/docs-kits/kits/Traceability Kit/page_business_view.mdx @@ -79,7 +79,54 @@ In the worst case, the quality alert can result in a recall of the affected seri The following figure illustrates, how quality investigations and alerts throughout the supply chain enable quality problems to be contained quickly and precisely. -![Quality Notifications](assets/quality_notifications.png) +![Quality Notifications](assets/quality_notifications.svg) + +### Block Notifications + +Equal to quality notifications, block notifications are a form of data exchange to transfer information about defective parts in a standardized way. Quality notifications in general and quality alerts in particular can be used for the (first) mainly **unstructured** contact between business partners to initiate e.g. a supplier self-disclosure. Block notifications, in contrast, are **structured** messages. They are used to report parts with critical defects, enriched with specific information, directly to business partners, as an immediate measure potentially following a preceding quality alert. + +> :raised_hand: Detailed information of the specific data being exchanged are available in the [Development View](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Software%20Development%20View/Data%20Provider%20Development%20View%20Traceability%20Kit#aspect-models). + +In this way, the customer can react quickly and precisely locate the parts based on the block information and sort them out at an early stage to prevent subsequent damage or major recalls and thus save costs and ensure a high quality of the vehicles, delivered to the customer. Block notifications should therefore significantly simplify the data exchange of block information in a standardized way and improve speed and quality. + +The following figure gives an overview of how block notifications are exchanged between business partners: + +![Block Notifications](assets/block_notifications.svg) + +### Special Characteristics +Special characteristics are product or process characteristics that may have an impact on safety or regulatory compliance, fit, function, performance or further processing of the product. + +Special Characteristics are: + +- suitable for communicating, product quality and securing in the supply chain. +- Characteristics that require increased care in order to avoid production issues and ensure the quality of the products. +- defined and recorded with the supplier during development. + +Special Characteristics are divided into three categories: + +- Legal / relevant to legislation / homologation, +- Safety +- Function + +> :raised_hand: All products with safety or legal relevant properties, markings or functions are traceability and compliance relevant. Special Characteristics are also mentioned on VDA organization. More details can be found on [VDA home page](https://www.vda.de/de). + +Data on the Special Characteristics are collected within the supply chain, but not systematically forwarded to the OEM. The aim is to improve data exchange and consistency for special characteristics. + +- Data collection and provision for critical components +- Data collection for a limited period of time, when required, in the event of quality problems or as part of industrialization. + +The exchange between supplier and OEM is currently done on single data exchange with special data format accepted by the partners. That means every data exchange has its single implementation. The more interfaces there are, the more difficult it becomes to manage and operate. + +Catena-X is to be used for data exchange within the supply chain. Since traceability must be ensured for special characteristics, it is advisable to supplement the Catena-X Use Cases Industry Core and Traceability with an additional functionality (additional aspect model) for the special characteristics. The special characteristics will be directly linked to the digital twin. + +#### Processual Approach +The target vision aims to enable an end-to-end (E2E) data exchange of special characteristics via Catena-X in three main steps: + +- **Requesting Special Characteristics:** The customer should have the capability to request special characteristics from the supplier. +- **Exchanging Specification Data:** The exchange of specification data for special characteristics should be possible at the part type level. +- **Consuming Measured Data:** The customer should be able to consume the measured data (special characteristics) provided by the manufacturer. + +In this development phase, both the consumer and the provider are responsible for defining a format for requesting and exchanging information on the specifications of the special characteristics. The consumption of the measurement results is based on the expansion of the digital twin to include the aspect of special characteristics as defined in the [Development View](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Software%20Development%20View/Data%20Provider%20Development%20View%20Traceability%20Kit#specialcharacteristics). ### Benefits for OEM, SME and Solution Provider #### OEM @@ -103,7 +150,6 @@ With the Traceability KIT, we support the Catena-X customer journey for our adop ![Customer Journey](assets/traceability_customer-journey.png) - ## Further Explanations ### Example - Industry Problem diff --git a/docs-kits/kits/Traceability Kit/page_changelog.mdx b/docs-kits/kits/Traceability Kit/page_changelog.mdx index c3a03bd5080..a8a189cdd1f 100644 --- a/docs-kits/kits/Traceability Kit/page_changelog.mdx +++ b/docs-kits/kits/Traceability Kit/page_changelog.mdx @@ -30,6 +30,63 @@ import Notice from './part_notice.mdx' All notable changes to this Kit will be documented in this file. +## [6.0.0] - 2024-12-01 + +Compatible for **release 24.12**. + +### Added + +-**Business View:** + - **Block Notifications:** + - Added new sub-section 'Block Notifications' to introduce the new feature including a picture for further explanation + - **Special Characteristics:** + - Added new section to introduce the special characteristics in general +- **Architecture View:** + - **Traceability Components:** + - Enhanced the existing table 'Traceability Components' by adding a new line for the block notification feature + - **Functional Requirements:** + - Enhanced the existing table 'Functional Requirements' by adding a new row for the block notification feature + - **Digital Twins and Aspect Models:** + - Added references of two new aspect models (SoftwareInformation 1.0.0, CertificateSigningRequests 1.0.0) + - **Traceability Apps:** + - Added new sub-section 'Block Information' to describe the Notification State Model inclusive the corresponding state model picture + - **Runtime View:** + - Added references to the coressponding sections of the HTTP Endpoints for the notifications + - Added new sub-sections to describe the processes for sending, updating and resolving block notifications including its UML sequence diagrams + - **Standards:** + - Added reference to latest Traceability Use Case Standard v.2.0.0 +- **Development View:** + - **App Provider:** + - **Block Notifications:** + - Added new sub-sections to describe the Block Notifications state model and the new Block Notification API specification + - **Asset Creation:** + - Added two lines for the typizations 'ReceiveBlockNotification' and 'UpdateBlockNotification' of the new block notifications + - **Policy Creation:** + - Added two lines to specify the needed (usage) policies for quality- and block notifications + - **Data Provider:** + - **Aspect Models:** + - Added the new SpecialCharacteristics model to the aspect model overview + - **Special Characteristics:** + - Added a new section to describe and reference the aspect model for special characteristics including JSON examples + +### Changed +- **Architecture View:** + - **Build Block View:** + - Updated the Traceability architecture picture with new description regarding Block Notifications + - **Runtime View:** + - Adapted / restructured the remarks text block to be applicable for quality- and the new block notifications +- **Development View:** + - **App Provider:** + - **Quality Notification API:** + - The last sentence, which mentions the Notification APIs, has been restructured to make the references to the Notification API specifications more visible + - **Asset Creation:** + - Fixed / changed asset typization from 'ReceiveQualityAlertNotification' to 'UpdateQualityAlertNotification' + +### Removed +- **Architecture View:** + - **Standards:** + - Removed references to deprecated Traceability standards + ## [5.1.1] - 2024-08-18 ### Changed diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Documentation BPDM/bpdm_arc42.md b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Documentation BPDM/bpdm_arc42.md deleted file mode 100644 index 1830bcb269b..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Documentation BPDM/bpdm_arc42.md +++ /dev/null @@ -1,677 +0,0 @@ ---- -id: bpdm_arc42 -title: Architecture documentation (arc42) -description: 'Architecture documentation (arc42)' -sidebar_position: 1 ---- - -![Business partner kit banner](/img/kit-icons/bp-kit-icon.svg) - -## Business Partner KIT - -## Business Partner Data Management Application for Golden Record (BPDM) - -- [Business Partner Data Management Application for Golden Record (BPDM)](#business-partner-data-management-application-for-golden-record-bpdm) -- [Introduction and Goals](#introduction-and-goals) - - [Goals Overview](#goals-overview) - - [Requirements Overview](#requirements-overview) - - [Quality Goals {#\_quality\_goals}](#quality-goals-quality-goals) - - [Stakeholders](#stakeholders) -- [Architecture Constraints](#architecture-constraints) -- [System Scope and Context](#system-scope-and-context) - - [Business Context](#business-context) - - [Technical Context](#technical-context) -- [Solution Strategy (High Level Picture)](#solution-strategy-high-level-picture) -- [Building Block View](#building-block-view) - - [High-Level Architecture (L/S/A Endpoints)](#high-level-architecture-lsa-endpoints) - - [High-Level Architecture (Generic Endpoint)](#high-level-architecture-generic-endpoint) - - [Keycloak Authentication \& Autorization Flow](#keycloak-authentication--autorization-flow) -- [Runtime View](#runtime-view) - - [Upload Business Partner (BPN-L)](#upload-business-partner-bpn-l) - - [Upsert Generic Business Partner](#upsert-generic-business-partner) - - [Update on Golden Record Change](#update-on-golden-record-change) -- [Business Partner Data Records - States](#business-partner-data-records---states) - - [Automatically executing golden record process](#automatically-executing-golden-record-process) - - [Manually triggering golden record process](#manually-triggering-golden-record-process) -- [Deployment View](#deployment-view) - - [Applications Deployment without Kubernetes](#applications-deployment-without-kubernetes) - - [Single Application Kubernetes Deployment](#single-application-kubernetes-deployment) -- [Crosscutting Concepts](#crosscutting-concepts) - - [Business Partner Data Management Standards](#business-partner-data-management-standards) - - [Logging Behavior](#logging-behavior) -- [Architecture Decisions](#architecture-decisions) -- [Quality Requirements](#quality-requirements) -- [Risks and Technical Debts](#risks-and-technical-debts) -- [Glossary](#glossary) - - [NOTICE](#notice) - -## Introduction and Goals - -This document describes the Catena-X Business Partner Data Management Application, short BPDM. - -In the Catena-X Automotive Network, the so-called Golden Record, together with a unique identifier, the Business Partner Number (BPN), creates an efficient solution to the increasing data retention costs. - -The Golden Record is a concept that identifies, links and harmonizes identical data on legal entites, sites and addresses from different sources (“sharing members"). During the creation of the Golden Record data, duplicates are removed, the quality within the data records is improved, missing information is added and deviations are automatically corrected. This is done using public, commercial or other agreed sources of trust and/or information. This approach reduces costs of business partner data maintenance and validation for all the companies concerned. - -The BPN, as the unique identifier of the Golden Record, can be stored as a verifiable credential used in an SSI solution so that a business partner can provide it for authentication and authorization. - -The Golden Record business partner data in combination with the BPN acts as the basis for a range of supplementary value-added services to optimize business partner data management. These are referred to as value-added services. Together with decentralized, self-determined identity management, they create a global, cross-industry standard for business partner data and a possible 360° view of the value chain. - -> [!NOTE] -> A Business Partner Data cleaning as well as Golden Record Creation Process is **not** part of this reference implementation! - -**Additional Information Material**: - -- Visit BPDM on the official Catena-X Website: [bpdm_catenax_website](https://catena-x.net/en/offers-standards/bpdm) - -## Goals Overview - -The following goals have been established for this system: - -| Priority | Goal | -| -------- | ------------------------------------------------------------------------------------------------------------ | -| 1 | Provide unique global business partner IDs within the Catena-X Network | -| 1 | Provide centralized Master Data Management for business partner data | -| 2 | Enable network-based data sharing for business partner data to increase overall data quality and reliability | -| 2 | Enable also Small and medium-sized Businesses (SMEs) to use the services | -| 3 | Provide a change history für business partner data | - -## Requirements Overview - -> [!IMPORTANT] -> **Cross-Check with CACs** - -![bpdm_usecase_diagram](@site/static/img/usecase_diagram.drawio.svg) - -The following Usecases together with its requirements exist for this system: - -| Req-Id | Requirement | Explanation | -| ------- | ------------------ | ----------- | -| BPDM-R1 | Upload and curate BP data | CX Member can upload their business partner and get curated business partner information back, based on the Golden Record | -| BPDM-R2 | Provide changelog for BP | A changelog is provided to determine which changes on which date are available | -| BPDM-R3 | Provide GR | Based on the shared business partner information and external service providers a Golden Record is created | -| BPDM-R4 | Provide changelog for GR | A changelog is provided to determine which changes on which date are available | -| BPDM-R5 | Keep GR up-to-date based on external resources | Golden Records must regularly checked for changes based on external resources | -| BPDM-R6 | Provide unique business partner IDs | For each Golden Record a unique ID, the so called Business Partner Number (BPN) is created | - -## Quality Goals {#quality goals} - -| Priority | Quality Goal | Scenario | -| -------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 1 | Security | All users and services which access the Golden Record Application must be authenticated and authorized. Only the Golden Record Application itself is allowed to perform changes on data. Consuming services/users are only allowed to read data. In addition they are only allowed to read the specific data that belongs with this, the Data Sovereignty principles of Catena-X has to be fulfilled | -| 1 | Integrity | Only the Golden Record Application is allowed to perform changes on the data. In addition, all changes must be traceable and must be able to be rolled back | -| 1 | Legally | No natural persons are allowed to get uploaded and stored. For all other uploaded Business Partner data it is mandatory that users (CX Members) can only see their own uploaded data and that it is not possible to draw conclusions about other business partner relationships | -| 1 | Integrity & Correctness | It must be ensured that the data of the golden record which is created during the process is correct. | -| 2 | Reliability | The Golden Record Application is a central foundation in the Catena-X Network. It provides all participants and services, business partner data and the unique Business Partner Number (BPN) as identifier. Therefore the BPDM Services must be always/highly available | -| 2 | Functional Stability | Since the Golden Record Application is a central foundation in the Catena-X Network the defined standards of the API and datamodel for the associated Release Version must be fulfilled | -| 1 | Sensitivity of data | the uploaded business partner data is highly sensitive, that's why it must be ensured that no unauthorized user/system can access data which does not belong to it. More over it must be guaranteed that no one can see the business partners related to the specific Catena-X Member. | - -[](@site/static/img/iso_25010.png) - -## Stakeholders - -| Role/Name | Expectations | Example | -| ----------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- | -| Big Company (CX-Member) | Company wants to have cleaned and enriched business partner data objects with a BPN. | | -| SME Company (CX-Member) | Company wants to have cleaned and enriched business partner data objects with a BPN based on a CSV data. | | -| CX Apps | Other apps and their use cases want to use the business partner data objects and the BPN for their processes | The CX Portal will use the BPN for on-boarding new companies into the network. Traceability Apps will use BPN to describe business partners | - -## Architecture Constraints - -| Constraint ID | Constraint | Description | -| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | -| C-1 | Software and third party software must be compliant to the Catena-X and Eclipse Foundation Guidelines/Policies [eclipse_foundation](https://www.eclipse.org/projects/dev_process/) | | -| C-2 | [Eclipse Dataspace Connector](https://github.com/eclipse-tractusx/tractusx-edc/tree/main) must be used for data transfer between different legal entities | | - -## System Scope and Context - -## Business Context - -The following figure depicts the business context setup for BPDM: - -![bpdm_business_context](@site/static/img/cx_bpdm_context_business.drawio.svg) - -The following are the various components of the business context setup: - -### **Master Data Management (Catena-X Member)** - -A backend system that's operated by a company which is participating in the Catena-X Ecosystem and consuming digital services or data assets. - -### **Small-Medium-Enterprises (SME) (Catena-X Member)** - -A SME company that's participating in the Catena-X Ecosystem and consuming digital services or data assets. - -### **Catena-X Portal/Marketplace (CX Portal)** - -The Portal which provides an entry point for the Catena-X Members, to discover Apps that are offered in Catena-X. - -### **Value Added Services** - -- Value Added Services can be provided be either the Operator itself or by an external App/Service Provider. The Value Added Services provide data or service offers based on Catena-X Network data. -- There are several value added services that can be offered in context of business partner data. For example a Fraud Prevention Dashboard/API, Country Risk Scoring and so on. - -### **Catena-X Operative Environment for BPDM** - -- Within Catena-X there will be only one central operation environment that operates the BPDM Application. This operative environment provides the services and data for other operation environment or applications which needs to consume business partner data or golden record data. - -### **Catena-X BPDM Application** - -- The BPDM Application which offers services to Catena-X Members, Catena-X Use Cases and Catena-X BPDM Value Added Services for consuming and processing business partner data as well as Golden Record Information and BPN Numbers. - -### **Curation & Enrichment Services** - -- To offer the BPDM and Golden Record Services, Catena-X uses services from external third party service providers. These can either be operated by the operator itself or external companies that have a contract with the operator. - -## Technical Context - -The technical context setup including deployment is depicted in the following figure: -![cx_bpdm_deployment_context](@site/static/img/cx_bpdm_context_technical.drawio.svg) - -- The BPDM Application follows a microservice approach to separate the different components of the system. -- Within Catena-X there will be only one central operation environment that operates the BPDM Application. This operation environment provides the services and data for other operation environment or applications which needs to consume business partner data or golden record data. - -## Solution Strategy (High Level Picture) - -The following high level view gives a basic overview about the BPDM Components: - -![cx_bpdm_highlevel](@site/static/img/cx_bpdm_highlevel.drawio.svg) - -### **BPDM Gate** - -- The BPDM Gate provides the interfaces for Catena-X Members to manage their business partner data within Catena-X. -- Based on the network data a Golden Record Proposal is created. -- The BPDM Gate has its own persistence layer in which the business partner data of the Catena-X Members are stored. -- For the current reference implementation, multi-tenancy is realized via a 1:1 deployment for each Catena-X Member. This means that every Catena-X Member who shares his business partner data, has its own Gate and own persistence. - -### **BPDM Pool** - -- The BPDM Pool is the central instance for business partner data within Catena-X. -- The BPDM Pool provides the interface and persistance for accessing Golden Record Data and the unique Business Partner Number. -- In comparison to the BPDM Gate, there is only one central instance of the BPDM Pool. - -### **BPN Issuer** - -- Every participant in the Catena-X network shall have a unique Business Partner Number (BPN) according to the concept defined by the Catena-X BPN concept. The task of the BPN Generator is to issue such a BPN for a presented Business Partner data object. In that, the BPN Generator serves as the central issuing authority for BPNs within Catena-X. -- Technically, it constitutes a service that is available as a singleton within the network. -- Currently, creation of BPNs is part of the BPDM Pool implementation. After implementing the BPDM Orchestrator, it can be considered if it should be an independent component. - -### **BPDM Orchestrator** - -- Intention of the BPDM Orchestrator is to provide a passive component that offers standardized APIs for the BPDM Gate, BPDM Pool and Data Curation and Enrichment Services to orchestrate the process of Golden Record Creation and handling the different states a business partner record can have during this process. - -## Building Block View - -### High-Level Architecture (L/S/A Endpoints) - -Due to a transmission phase there are two concepts of Business Partner Upload Models. The target is to only have the generic Business Partner on the BPDM Gate. - -![bpdm_current_architecture_LSA](@site/static/img/cx_bpdm_architecture_v3_2.drawio.svg) - -### High-Level Architecture (Generic Endpoint) - -![bpdm_current_architecture_Generic](@site/static/img/cx_bpdm_architecture_v3_3.drawio.svg) - -#### **Simulator Service** - -- To become more independent in testing the BPDM Application, a Simulator Service was developed. -- The Simulator Services supports the E2E Test Cases to validate the flow from BPDM Gate to BPDM Pool and back again. - -#### **EDC Operator** - -- The diagram above shows two EDCs on Operator side. This is only for visualization purpose. On a technical level there is only one EDC. - -#### **SME** - --Currently there is no SME Application available - -## Keycloak Authentication & Autorization Flow - -```mermaid - -sequenceDiagram - participant BPDM EDC - participant OpenIDConnect Server - participant BPDM Gate - - autonumber - - BPDM EDC -->>OpenIDConnect Server: Send Client Credentials - OpenIDConnect Server-->> BPDM EDC: Respond OAuth2 Token - BPDM EDC -->> BPDM Gate: Send Request with OAuth2 Token in Authorization Header - BPDM Gate -->> OpenIDConnect Server: Validate Token - OpenIDConnect Server -->> BPDM Gate: Confirms validity of Token - BPDM Gate -->> BPDM Gate: Check "resource_access" section of OAuth Token - - -``` - -## Runtime View - -### Upload Business Partner (BPN-L) - -The diagram below describes the flow of uploading a business partner of type "legal entity". -For further information about the different business partner types (Legal Entity, Site, Address), please have a look on the Standards [CX - 0010 Business Partner Number](https://catena-x.net/de/standard-library) - -```mermaid - -sequenceDiagram - participant CX Member - participant BPDM Gate - participant BPDM Simulator - participant BPDM Pool - autonumber - - rect rgb(125, 184, 240) - Note over CX Member,BPDM Gate: EDC enabled - CX Member->>BPDM Gate: Upload Business Partner - Note left of BPDM Gate: PUT api/catena/input/legal-entities - # loop Healthcheck - # John->>John: Fight against hypochondria - # end - # Note right of John: Rational thoughts! - end - BPDM Gate-->BPDM Gate: Update input changelog - BPDM Simulator->>BPDM Gate: Poll for Business Partner changes - Note right of BPDM Gate: POST api/catena/input/changelog/search - BPDM Gate -->> BPDM Simulator: Send Changelog for Business Partners - BPDM Simulator->>BPDM Gate: Request Business Partner based on Changelog (external ID and business partner type) - Note right of BPDM Gate: POST /api/catena/input/legal-entities/search - BPDM Gate -->> BPDM Simulator: Send Business Partners - BPDM Simulator->>BPDM Gate: Request Sharing State for Business Partner based on Changelog - Note right of BPDM Gate: GET api/catena/sharing-state - BPDM Gate -->> BPDM Simulator: Send Sharing State (BPN) of Business Partners (Sharing state determines if BPN exist or not) - BPDM Simulator-->> BPDM Simulator: Update last sync changelog timestamp - BPDM Simulator->>BPDM Pool: Forward Business Partner - Note left of BPDM Pool: POST/PUT api/catena/legal-entities - opt BPN does not exist - BPDM Pool-->>BPDM Pool: Create BPN - end - BPDM Pool-->>BPDM Pool: Update Changelog - BPDM Pool-->>BPDM Simulator: Respond Business Partner with BPN - BPDM Simulator-->>BPDM Gate: Forward Business Partner with BPN - Note right of BPDM Gate: PUT api/catena/output/legal-entities - BPDM Simulator-->>BPDM Gate: Update Sharing State - Note right of BPDM Gate: PUT api/catena/sharing-state - BPDM Gate-->BPDM Gate: Link External ID with BPN - BPDM Gate-->BPDM Gate: Update Output Changelog - - loop Every x hour - rect rgb(125, 184, 240) - Note over CX Member,BPDM Gate: EDC enabled - CX Member->>BPDM Gate: Poll output changelog and fetch updates - Note left of BPDM Gate: POST api/catena/output/changelog/search - BPDM Gate-->>CX Member: Send changelog - CX Member->>BPDM Gate: Fetch updates - Note left of BPDM Gate: POST api/catena/output/legal-entities/search - BPDM Gate-->>CX Member: Send Business Partner changes - end - CX Member-->>CX Member: Update data - CX Member-->>CX Member: Update last polled timestamp - end -``` - -### Upsert Generic Business Partner - -> [!NOTE] -> An additional endpoint was implemented as requirements came up that required business partner data records not to be fed directly into the golden record process after an upload. Instead, this endpoint makes it possible to change the status of a business partner data record from "inital" to "ready". Only data records with the status "ready" are fed into the golden record process. -> We are aware that the existing integration scenarios, such as with the portal team, are impacted by this. For this reason, we recommend that the gate is configured accordingly so that the status is set to "ready" by default when a data record is uploaded. The operator can configure this behavior in the gate individually based on the requirements. - -```mermaid -sequenceDiagram - autonumber - - SharingMember->>Gate: PUT api/catena/input/business-partners
Payload: Business Partner Data A - Gate-->>Gate: Persist Business Partner Data Input - Gate-->>Gate: Set Sharing State to 'Initial' - Gate-->>Gate: Add Changelog Entry 'Create' for Business Partner Input - Gate-->>SharingMember: Upserted Business Partner - - SharingMember->>Gate: POST api/catena/sharing-state/ready
Payload: External ID A - Gate-->>Gate: Set Sharing State to 'Ready' - Gate-->>SharingMember: OK - - loop Polling for Ready Business Partners - Gate-->>Gate: Fetch Business Partners in State 'Ready' - Gate->>Orchestrator: POST api/golden-record-tasks
Payload: Business Partner Input Data in mode 'UpdateFromSharingMember' - Orchestrator-->>Orchestrator: Create Golden Record Task for Business Partner Data - Orchestrator-->>Orchestrator: Set Golden Record Task State
Result State: 'Pending' - Orchestrator-->>Orchestrator: Set Golden Record Task State
Step: 'CleanAndSync'
StepState: 'Queued' - Orchestrator-->>Gate: Created Golden Record Task - Gate-->>Gate: Set Sharing State
Type: 'PENDING'
Task ID: Golden Record Task ID - end - - loop Polling for Step 'CleanAndSync' - CleaningServiceDummy->>Orchestrator: POST api/golden-record-tasks/step-reservations
Payload: Step 'CleanAndSync' - Orchestrator-->>Orchestrator: Set Golden Record Task State
Step: 'CleanAndSync'
StepState: 'Reserved' - Orchestrator-->>CleaningServiceDummy: Golden Record Task - CleaningServiceDummy-->>CleaningServiceDummy: Set L/S/A and Generic Business Partner Dummy Cleaning Result - CleaningServiceDummy-->>CleaningServiceDummy: Set BPN References to L/S/A result - CleaningServiceDummy->>Orchestrator: POST api/golden-record-tasks/step-results
Payload: Dummy Result - Orchestrator-->>Orchestrator: Set Golden Record Task Business Partner Data to Dummy Result - Orchestrator-->>Orchestrator: Set Golden Record Task State
Step: 'PoolSync'
StepState: 'Queued' - Orchestrator-->>CleaningServiceDummy: Accept - end - - loop Polling for Step 'PoolSync' - Pool->>Orchestrator: POST api/golden-record-tasks/step-reservations
Payload: Step 'PoolSync' - Orchestrator-->>Orchestrator: Set Golden Record Task State
Step: 'PoolSync'
StepState: 'Reserved' - Orchestrator-->>Pool: Golden Record Task - opt Golden Record Legal Entity Data marked as changed - Pool-->>Pool: Upsert Legal Entity from Golden Record Task Legal Entity Data - Pool-->>Pool: Add Changelog Entry for BPNL - end - opt Golden Record Site Data marked as changed - Pool-->>Pool: Upsert Site from Golden Record Task Site Data - Pool-->>Pool: Add Changelog Entry for BPNS - end - opt Golden Record Address Data marked as changed - Pool-->>Pool: Upsert Address from Golden Record Task Address Data - Pool-->>Pool: Add Changelog Entry for BPNA - end - Pool-->>Pool: Set BPNs in Golden Record Task Generic Business Partner Data - Pool->>Orchestrator: POST api/golden-record-tasks/step-results
Payload: Updated Result - Orchestrator-->>Pool: Accept - Orchestrator-->>Orchestrator: Set Golden Record Task State
Step: 'PoolSync'
Step State: 'Success' - Orchestrator-->>Orchestrator: Set Golden Record Task State
Result State: 'Success' - end - - loop Polling for finished Golden Record Tasks - Gate-->>Gate: Query sharing states in Sharing State Type 'PENDING' - Gate->>Orchestrator: POST golden-record-tasks/state/search
Payload: Golde Record Task ID - Orchestrator-->Gate: Golden Record Task State and Result - Gate-->>Gate: Persist Business Partner Output - Gate-->>Gate: Set Sharing State 'Success' - Gate-->>Gate: Add Changelog Entry 'Create' for Business Partner Output - end - - SharingMember->>Gate: POST api/catena/output/changelog/search
Payload: From After Last Search Time - Gate-->>SharingMember: Changelog entry with Business Partner External ID - SharingMember->>Gate: POST api/catena/output/business-partners/search
Payload: External ID - Gate-->>SharingMember: Business Partner Output -``` - -### Update on Golden Record Change - -```mermaid -sequenceDiagram - autonumber - - Pool-->Pool: Add Changelog Entry for BPNL - - loop Polling Pool Changelog - Gate->>Pool: POST api/catena/changelog/search
Payload: From After Last Search Time - Pool-->>Gate: Changelog entry for BPNL - Gate-->>Gate: Query Business Partner Output with BPNL - Gate->>Orchestrator: POST api/golden-record-tasks
Payload: Business Partner Output Data in mode 'UpdateFromPool' - Orchestrator-->>Orchestrator: Create Golden Record Task for Business Partner Data - Orchestrator-->>Orchestrator: Set Golden Record Task State
Result State: 'Pending' - Orchestrator-->>Orchestrator: Set Golden Record Task State
Step: 'Clean'
StepState: 'Queued' - Orchestrator-->>Gate: Created Golden Record Task - Gate-->>Gate: Set Sharing State
Type: 'PENDING'
Task ID: Golden Record Task ID - end - - loop Polling for Step 'Clean' - CleaningServiceDummy->>Orchestrator: POST api/golden-record-tasks/step-reservations
Payload: Step 'Clean' - Orchestrator-->>Orchestrator: Set Golden Record Task State
Step: 'CleanAndSync'
StepState: 'Reserved' - Orchestrator-->>CleaningServiceDummy: Golden Record Task - CleaningServiceDummy->>Orchestrator: POST api/golden-record-tasks/step-results
Payload: Golden Record Task Business Partner Data - Orchestrator-->>Orchestrator: Set Golden Record Task Business Partner Data to Dummy Result - Orchestrator-->>Orchestrator: Set Golden Record Task State
Step: 'Clean'
Step State: 'Success' - Orchestrator-->>Orchestrator: Set Golden Record Task State
Result State: 'Success' - Orchestrator-->>CleaningServiceDummy: Accept - end - - loop Polling for finished Golden Record Tasks - Gate-->>Gate: Query sharing states in Sharing State Type 'PENDING' - Gate->>Orchestrator: POST golden-record-tasks/state/search
Payload: Golden Record Task ID - Orchestrator-->Gate: Golden Record Task State and Result - Gate-->>Gate: Persist Business Partner Output - Gate-->>Gate: Set Sharing State 'Success' - Gate-->>Gate: Add Changelog Entry 'Create' for Business Partner Output - end - - SharingMember->>Gate: POST api/catena/output/changelog/search
Payload: From After Last Search Time - Gate-->>SharingMember: Changelog entry with Business Partner External ID - SharingMember->>Gate: POST api/catena/output/business-partners/search
Payload: External ID - Gate-->>SharingMember: Business Partner Output - -``` - -## Business Partner Data Records - States - -This sections describes the different states a business partner data record can have. - -### Automatically executing golden record process - -```mermaid ---- -title: state diagram business partner for automatically executing golden record process ---- -stateDiagram-v2 - [*] --> ready: sharing member uploads bp into gate - note right of ready - Gate is configured to automatically
set state to ready after bp upload - end note - ready --> pending: scheduler initiates
the golden record process - state if_state <> - pending --> if_state: run golden record process - if_state --> success: if golden record process succeeded - if_state --> error: if golden record process failed -``` - -### Manually triggering golden record process - -```mermaid ---- -title: state diagram business partner for manual golden record process triggering ---- -stateDiagram-v2 - [*] --> initial: sharing member uploads bp into gate - note right of initial - POST api/catena/sharing-state/ready
Payload: External ID A - end note - initial --> ready: sharing member or third-party
service calls separate endpoint - ready --> pending: scheduler initiates
the golden record process - state if_state <> - pending --> if_state: run golden record process - if_state --> success: if golden record process succeeded - if_state --> error: if golden record process failed -``` - -## Deployment View - -### Applications Deployment without Kubernetes - -```mermaid -C4Context - - Person(bpdm_user, "(Technical) User of the BPDM APIs") - - System(pool_postgres, "Pool Database" "Postgres: 14.5") - System(gate_postgres, "Gate Database" "Postgres: 14.5") - System(bridge_postgres, "Gate Database" "Postgres: 14.5") - - - Deployment_Node(pool_machine, "OS Environment", "Linux Alpine 3.16"){ - Deployment_Node(pool_java, "Runtime Environment", "JAVA RE 17") { - Container(pool_container, "Pool Application", "Spring Boot: 3.1") - } - } - - Deployment_Node(gate_machine, "OS Environment", "Linux Alpine 3.16"){ - Deployment_Node(gate_java, "Runtime Environment", "JAVA RE 17") { - Container(gate_container, "Gate Application", "Spring Boot: 3.1") - } - } - - Deployment_Node(bridge_machine, "OS Environment", "Linux Alpine 3.16"){ - Deployment_Node(bridge_java, "Runtime Environment", "JAVA RE 17") { - Container(bridge_container, "Bridge Dummy Application", "Spring Boot: 3.1") - } - } - - Deployment_Node(orchestrator_machine, "OS Environment", "Linux Alpine 3.16"){ - Deployment_Node(orchestrator_java, "Runtime Environment", "JAVA RE 17") { - Container(orchestrator_container, "Orchestrator Application", "Spring Boot: 3.1") - } - } - - Deployment_Node(dummy_machine, "OS Environment", "Linux Alpine 3.16"){ - Deployment_Node(dummy_java, "Runtime Environment", "JAVA RE 17") { - Container(dummy_container, "Cleaning Service Dummy Application", "Spring Boot: 3.1") - } - } - - Rel(bpdm_user, pool_container, "HTTP/S") - Rel(pool_container, pool_postgres, "TCP/IP") - - Rel(bpdm_user, gate_container, "HTTP/S") - Rel(gate_container, gate_postgres, "TCP/IP") - - Rel(bpdm_user, bridge_container, "HTTP/S") - Rel(bridge_container, bridge_postgres, "TCP/IP") - - Rel(pool_container, orchestrator_container, "HTTP/S") - Rel(gate_container, orchestrator_container, "HTTP/S") - Rel(dummy_container, orchestrator_container, "HTTP/S") - - Rel(bridge_container, pool_container, "HTTP/S") - Rel(bridge_container, gate_container, "HTTP/S") - -``` - -### Single Application Kubernetes Deployment - -```mermaid -C4Context - - Person(bpdm_user, "(Technical) User of the BPDM APIs") - - Deployment_Node(kubernetes, "Kubernetes Environment", "Kubernetes 1.28"){ - - Container(ingress, "Ingress", "Ingress Kubernetes Resource") - Container(nginx, "Ingress Controller", "Nginx Reverse Proxy") - Container(service, "Service", "Service Kubernetes Resource") - - Container(database, "Database Deployment", "Chart bitnami/postgres:11.9.13") - Container(other_bpdm, "Other BPDM Application Deployment", "Helm Chart") - - Deployment_Node(deployment, "Deployment", "Deployment Kubernetes Resource"){ - Deployment_Node(replicaSet_1, "Replica Set", "Ingress ReplicaSet Resource"){ - Deployment_Node(pod_1, "Pod", "Pod Kubernetes Resource"){ - Container(container_1, "BPDM Application Container", "Spring Boot 3 on Linux Alpine 3.6") - Container(volume_1, "Config Volume", "Kubernetes Volume Mount") - } - } - } - - Deployment_Node(kubernetes_config, "Kubernetes Configurations", "Logical Grouping"){ - Container(configMap, "Application Configuration", "Kubernetes ConfigMap Resource") - Container(secret, "Secret Configuration", "Kubernetes Secret Resource") - - } -} - -Rel(bpdm_user, nginx, "Sends URL", "HTTPS") -Rel(ingress, nginx, "Routing Information") -Rel(nginx, service, "Routes to") -Rel(service, container_1, "HTTP") - -Rel(container_1, volume_1, "mounts") -Rel(volume_1, configMap, "mounts") -Rel(volume_1, secret, "mounts") - -Rel(container_1, database, "TCP/IP") -Rel(container_1, other_bpdm, "") - -UpdateLayoutConfig($c4ShapeInRow="3", $c4BoundaryInRow="1") - - - -``` - -## Crosscutting Concepts - -### Business Partner Data Management Standards - -[bpdm_standards](https://catena-x.net/de/standard-library) - -### Logging Behavior - -As Spring Boot applications BPDM employs Spring -specific [logging behavior](https://docs.spring.io/spring-boot/docs/3.0.0/reference/htmlsingle/#features.logging) - -We enhance the default log entries with user request information including the determined user ID and a generated request ID. -Not all logs belong to an ongoing user request in which case these entries are empty. - -In addition to the Spring standard logs the BPDM applications keep a log of the following events: - -- INFO: User requesting resource with resource name and HTTP verb -- INFO: Request HTTP response -- INFO: Update/Create Golden Record Business Partners -- INFO: Creating BPNs -- ERROR: Uncaught exceptions occurring in the service logic - -## Architecture Decisions - -[Architecture Decision Logs](https://confluence.catena-x.net/display/CORE/BPDM+%7C+Decision+Logs) -(Link will be replaced with ADRs based on Markdown) - -- 001-multitenancy_approach -- 002-edc_for_pool_api -- 003-orchestrator_serviceApi_vs_messagebus_approach -- 004-openapi_descriptions -- 005-edc-usage-for-third-party-services -- 006-bpdm-edc-asset-structuring (TBD) - -## Quality Requirements - -- see: [Quality Goals](#quality-goals-quality-goals) - -## Risks and Technical Debts - -### **Open EDC Questions** - -- What capabilities will be provided in the future? -- How to deal with APIs provided behind an EDC? Swagger documentation cannot be seen by the requesting service? -- How can we authorize and authenticate a User/System with individual permissions after it passes the EDC? -- Will there by a Proxy EDC concept? -- ... - -### **Semantic Model and SSI Integration of the Golden Record** - -- Not in scope. - -### **Dependency on third party service provider** - -- Currently we are not flexible enough to easily change the third party service provider for golden record creation. Therefore the next step will be to introduce an own data persistence layer, getting more independent. -- ✔️Solved via "Simulator Application" - -### **Data Storage and anonymize concept** - -- How to anonymize the relations between CX-Member and its belonging Business Partner? -- 💡 Idea: using kind of "ticket numbering" -- ✔️ Solved via ticketing. - -### **Accessability for SMEs** - -- Uploading via CSV File. Does it requires an EDC? -- ⚠️Current State: Yes, is needed. - -## Glossary - -The Glossary is currently under development and will be added below after internal approval ([DRAFT](https://confluence.catena-x.net/display/CORE/BPDM+Glossary+-+Internal+-+DRAFT)). - -The current version you can find in the Catena-X Standards. - -## NOTICE - -This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). - -- SPDX-License-Identifier: Apache-2.0 -- SPDX-FileCopyrightText: 2023,2024 ZF Friedrichshafen AG -- SPDX-FileCopyrightText: 2023,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -- SPDX-FileCopyrightText: 2023,2024 Mercedes Benz Group -- SPDX-FileCopyrightText: 2023,2024 Schaeffler AG -- SPDX-FileCopyrightText: 2023,2024 Contributors to the Eclipse Foundation -- Source URL: [https://github.com/eclipse-tractusx/bpdm](https://github.com/eclipse-tractusx/bpdm) diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/business-partner-data-management-bridge-dummy.info.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/business-partner-data-management-bridge-dummy.info.mdx deleted file mode 100644 index 53b33323047..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/business-partner-data-management-bridge-dummy.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: business-partner-data-management-bridge-dummy -title: "Business Partner Data Management Bridge Dummy" -description: "Bridge between Gate and Pool as a simple replacement for a dedicated sharing service" -sidebar_label: Introduction -sidebar_position: 0 -hide_title: true -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiDemoPanel/Export"; - -Version: 5.0.1-SNAPSHOT - -# Business Partner Data Management Bridge Dummy - - - -Bridge between Gate and Pool as a simple replacement for a dedicated sharing service - - - \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/sidebar.js b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/sidebar.js deleted file mode 100644 index 26bad89f12c..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Bridge Dummy Api/business-partner-data-management-bridge-dummy"},{"type":"category","label":"bridge-controller","link":{"type":"generated-index","title":"bridge-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/bridge-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Bridge Dummy Api/trigger-sync","label":"Start sync between Gate and Pool","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/trigger-sync.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/trigger-sync.api.mdx deleted file mode 100644 index ec3d08ae1b0..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/trigger-sync.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: trigger-sync -title: "Start sync between Gate and Pool" -description: "Start sync between Gate and Pool" -sidebar_label: "Start sync between Gate and Pool" -hide_title: true -hide_table_of_contents: true -api: {"tags":["bridge-controller"],"operationId":"triggerSync","responses":{"200":{"description":"OK"}},"description":"Start sync between Gate and Pool","method":"post","path":"/api/bridge/sync","servers":[{"url":"http://localhost:8083","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Bridge Dummy","description":"Bridge between Gate and Pool as a simple replacement for a dedicated sharing service","version":"5.0.1-SNAPSHOT"},"postman":{"name":"Start sync between Gate and Pool","description":{"type":"text/plain"},"url":{"path":["api","bridge","sync"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"method":"POST"}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/business-partner-data-management-bridge-dummy -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Start sync between Gate and Pool - - - -Start sync between Gate and Pool - -
- -OK - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Cleaning Dummy Api/sidebar.js b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Cleaning Dummy Api/sidebar.js deleted file mode 100644 index 84f6658d5b7..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Cleaning Dummy Api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Cleaning Dummy Api/business-partner-data-management-cleaning-service-dummy"}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/count-address-types.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/count-address-types.api.mdx deleted file mode 100644 index 5b89c955170..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/count-address-types.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: count-address-types -title: "countAddressTypes" -description: "countAddressTypes" -sidebar_label: "countAddressTypes" -hide_title: true -hide_table_of_contents: true -api: {"tags":["stats-controller"],"operationId":"countAddressTypes","parameters":[{"name":"stage","in":"path","required":true,"schema":{"type":"string","enum":["Input","Output"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["additionalTotal","legalAndSiteTotal","legalTotal","siteTotal"],"type":"object","properties":{"legalAndSiteTotal":{"type":"integer","format":"int32"},"legalTotal":{"type":"integer","format":"int32"},"siteTotal":{"type":"integer","format":"int32"},"additionalTotal":{"type":"integer","format":"int32"}}}}}}},"description":"countAddressTypes","method":"get","path":"/v6/stats/{stage}/address-types","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"6.0.0"},"postman":{"name":"count Address Types","description":{"type":"text/plain"},"url":{"path":["v6","stats",":stage","address-types"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"stage"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## countAddressTypes - - - -countAddressTypes - -
Path Parameters
- -OK - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/count-partners-by-sharing-state.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/count-partners-by-sharing-state.api.mdx deleted file mode 100644 index 516db0e01eb..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/count-partners-by-sharing-state.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: count-partners-by-sharing-state -title: "countPartnersBySharingState" -description: "countPartnersBySharingState" -sidebar_label: "countPartnersBySharingState" -hide_title: true -hide_table_of_contents: true -api: {"tags":["stats-controller"],"operationId":"countPartnersBySharingState","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["errorTotal","initialTotal","pendingTotal","readyTotal","successTotal"],"type":"object","properties":{"initialTotal":{"type":"integer","format":"int32"},"readyTotal":{"type":"integer","format":"int32"},"pendingTotal":{"type":"integer","format":"int32"},"successTotal":{"type":"integer","format":"int32"},"errorTotal":{"type":"integer","format":"int32"}}}}}}},"description":"countPartnersBySharingState","method":"get","path":"/v6/stats/sharing-states","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"6.0.0"},"postman":{"name":"count Partners By Sharing State","description":{"type":"text/plain"},"url":{"path":["v6","stats","sharing-states"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## countPartnersBySharingState - - - -countPartnersBySharingState - -
- -OK - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/count-partners-per-stage.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/count-partners-per-stage.api.mdx deleted file mode 100644 index 0d8ed18ef20..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/count-partners-per-stage.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: count-partners-per-stage -title: "countPartnersPerStage" -description: "countPartnersPerStage" -sidebar_label: "countPartnersPerStage" -hide_title: true -hide_table_of_contents: true -api: {"tags":["stats-controller"],"operationId":"countPartnersPerStage","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["inputTotal","outputTotal"],"type":"object","properties":{"inputTotal":{"type":"integer","format":"int32"},"outputTotal":{"type":"integer","format":"int32"}}}}}}},"description":"countPartnersPerStage","method":"get","path":"/v6/stats/stages","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"6.0.0"},"postman":{"name":"count Partners Per Stage","description":{"type":"text/plain"},"url":{"path":["v6","stats","stages"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## countPartnersPerStage - - - -countPartnersPerStage - -
- -OK - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/get-business-partners-input.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/get-business-partners-input.api.mdx deleted file mode 100644 index be8bc6d7212..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/get-business-partners-input.api.mdx +++ /dev/null @@ -1,82 +0,0 @@ ---- -id: get-business-partners-input -title: "Search business partner by external ID. An empty external ID list returns a paginated list of all business partners." -description: "Get page of business partners filtered by a collection of external IDs." -sidebar_label: "Search business partner by external ID. An empty external ID list returns a paginated list of all business partners." -hide_title: true -hide_table_of_contents: true -api: {"tags":["business-partner-controller"],"description":"Get page of business partners filtered by a collection of external IDs.","operationId":"getBusinessPartnersInput","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"200":{"description":"The requested page of busines partners","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["address","bpnA","bpnL","createdAt","externalId","identifiers","isOwnCompanyData","legalEntity","nameParts","postalAddress","roles","site","states","updatedAt"],"type":"object","properties":{"externalId":{"type":"string","description":"The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner."},"nameParts":{"type":"array","description":"The list of name parts to accommodate the different number of name fields in different systems.","items":{"type":"string"}},"identifiers":{"type":"array","description":"The list of identifiers of the business partner. Sorted and duplicates removed by the service.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the identifier."},"value":{"type":"string","description":"The value of the identifier like “DE123465789."},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Registergericht and Registerart."}}}},"states":{"type":"array","description":"The list of (temporary) states of the business partner. Sorted and duplicates removed by the service.","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}},"roles":{"type":"array","description":"One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.","items":{"type":"string","enum":["SUPPLIER","CUSTOMER","ONE_TIME_SUPPLIER","ONE_TIME_CUSTOMER"]}},"isOwnCompanyData":{"type":"boolean","description":"Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member."},"legalEntity":{"required":["states"],"type":"object","properties":{"legalEntityBpn":{"type":"string","description":"The BPNL of the legal entity, on which the business partner provides a view."},"legalName":{"type":"string","description":"The name of the legal entity, on which the business partner provides a view, according to official registers."},"shortName":{"type":"string","description":"The abbreviated name of the legal entity, on which the business partner provides a view."},"legalForm":{"type":"string","description":"The legal form of the legal entity, on which the business partner provides a view."},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"The legal entity, on which the business partner provides a view."},"site":{"required":["states"],"type":"object","properties":{"siteBpn":{"type":"string","description":"The BPNS of the site, on which the business partner provides a view."},"name":{"type":"string","description":"The name of the site, on which the business partner provides a view. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"The site, on which the business partner provides a view."},"address":{"required":["alternativePostalAddress","physicalPostalAddress","states"],"type":"object","properties":{"addressBpn":{"type":"string","description":"The BPNA of the address, on which the business partner provides a view."},"name":{"type":"string","description":"The name of the address, on which the business partner provides a view. This is not according to official registers but according to the name the sharing members agree on, such as the name of a gate or any other additional names that designate the address in common parlance."},"addressType":{"type":"string","description":"One of the address types: Legal Address, Site Main Address, Legal and Site Main Address, Additional Address. ","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"name":{"type":"string","description":"The name of the street."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"The address, on which the business partner provides a view. "},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"}},"description":"Generic business partner with external id"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"post","path":"/v6/input/business-partners/search","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":["string"],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"6.0.0"},"postman":{"name":"Search business partner by external ID. An empty external ID list returns a paginated list of all business partners.","description":{"content":"Get page of business partners filtered by a collection of external IDs.","type":"text/plain"},"url":{"path":["v6","input","business-partners","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Search business partner by external ID. An empty external ID list returns a paginated list of all business partners. - - - -Get page of business partners filtered by a collection of external IDs. - -
Query Parameters
Request Body array
  • string
- -The requested page of busines partners - -
Schema
    content object[]
    - -Collection of results in the page - -
    identifiers object[]
    - -The list of identifiers of the business partner. Sorted and duplicates removed by the service. - -
    states object[]
    - -The list of (temporary) states of the business partner. Sorted and duplicates removed by the service. - -
    legalEntity object
    - -The legal entity, on which the business partner provides a view. - -
    states object[]
    site object
    - -The site, on which the business partner provides a view. - -
    states object[]
    address object
    - -The address, on which the business partner provides a view. - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    states object[]
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/get-business-partners-output.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/get-business-partners-output.api.mdx deleted file mode 100644 index 6068bb5fc37..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/get-business-partners-output.api.mdx +++ /dev/null @@ -1,82 +0,0 @@ ---- -id: get-business-partners-output -title: "Search business partners by an array of external IDs from the output stage" -description: "Get page of business partners output data filtered by a collection of external IDs. An empty external ID list will return a paginated list of all business partners." -sidebar_label: "Search business partners by an array of external IDs from the output stage" -hide_title: true -hide_table_of_contents: true -api: {"tags":["business-partner-controller"],"description":"Get page of business partners output data filtered by a collection of external IDs. An empty external ID list will return a paginated list of all business partners.","operationId":"getBusinessPartnersOutput","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"200":{"description":"The requested page of business partners","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["address","createdAt","externalId","identifiers","isOwnCompanyData","legalEntity","nameParts","roles","states","updatedAt"],"type":"object","properties":{"externalId":{"type":"string","description":"The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner."},"nameParts":{"type":"array","description":"The list of name parts to accommodate the different number of name fields in different systems.","items":{"type":"string"}},"identifiers":{"type":"array","description":"The list of identifiers of the business partner. Sorted and duplicates removed by the service.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the identifier."},"value":{"type":"string","description":"The value of the identifier like “DE123465789."},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Registergericht and Registerart."}}}},"states":{"type":"array","description":"The list of (temporary) states of the business partner. Sorted and duplicates removed by the service.","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}},"roles":{"type":"array","description":"One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.","items":{"type":"string","enum":["SUPPLIER","CUSTOMER","ONE_TIME_SUPPLIER","ONE_TIME_CUSTOMER"]}},"isOwnCompanyData":{"type":"boolean","description":"Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member."},"legalEntity":{"required":["bpnL","confidenceCriteria","legalEntityBpn","states"],"type":"object","properties":{"legalEntityBpn":{"type":"string","description":"The BPNL of the legal entity, on which the business partner provides a view."},"legalName":{"type":"string","description":"The name of the legal entity, on which the business partner provides a view, according to official registers."},"shortName":{"type":"string","description":"The abbreviated name of the legal entity, on which the business partner provides a view."},"legalForm":{"type":"string","description":"The legal form of the legal entity, on which the business partner provides a view."},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"Legal Entity properties of business partner output data"},"site":{"required":["confidenceCriteria","siteBpn","states"],"type":"object","properties":{"siteBpn":{"type":"string","description":"The BPNS of the site, on which the business partner provides a view."},"name":{"type":"string","description":"The name of the site, on which the business partner provides a view. This is not according to official registers but according to the name the owner chooses."},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"Site properties of business partner output data"},"address":{"required":["addressBpn","alternativePostalAddress","bpnA","confidenceCriteria","physicalPostalAddress","states"],"type":"object","properties":{"addressBpn":{"type":"string","description":"The BPNA of the address, on which the business partner provides a view."},"name":{"type":"string","description":"The name of the address, on which the business partner provides a view. This is not according to official registers but according to the name the sharing members agree on, such as the name of a gate or any other additional names that designate the address in common parlance."},"addressType":{"type":"string","description":"One of the address types: Legal Address, Site Main Address, Legal and Site Main Address, Additional Address. ","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"name":{"type":"string","description":"The name of the street."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"Address properties of business partner output data"},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"}},"description":"Generic business partner output with external id"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"post","path":"/v6/output/business-partners/search","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":["string"],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"6.0.0"},"postman":{"name":"Search business partners by an array of external IDs from the output stage","description":{"content":"Get page of business partners output data filtered by a collection of external IDs. An empty external ID list will return a paginated list of all business partners.","type":"text/plain"},"url":{"path":["v6","output","business-partners","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Search business partners by an array of external IDs from the output stage - - - -Get page of business partners output data filtered by a collection of external IDs. An empty external ID list will return a paginated list of all business partners. - -
Query Parameters
Request Body array
  • string
- -The requested page of business partners - -
Schema
    content object[]
    - -Collection of results in the page - -
    identifiers object[]
    - -The list of identifiers of the business partner. Sorted and duplicates removed by the service. - -
    states object[]
    - -The list of (temporary) states of the business partner. Sorted and duplicates removed by the service. - -
    legalEntity object
    - -Legal Entity properties of business partner output data - -
    confidenceCriteria object
    states object[]
    site object
    - -Site properties of business partner output data - -
    confidenceCriteria object
    states object[]
    address object
    - -Address properties of business partner output data - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    confidenceCriteria object
    states object[]
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/get-confidence-criteria-stats.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/get-confidence-criteria-stats.api.mdx deleted file mode 100644 index 2358cc8daa0..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/get-confidence-criteria-stats.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: get-confidence-criteria-stats -title: "getConfidenceCriteriaStats" -description: "getConfidenceCriteriaStats" -sidebar_label: "getConfidenceCriteriaStats" -hide_title: true -hide_table_of_contents: true -api: {"tags":["stats-controller"],"operationId":"getConfidenceCriteriaStats","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["checkedByExternalDataSourceTotal","confidenceLevelAverage","numberOfBusinessPartnersAverage","sharedByOwnerTotal","uniqueTotal"],"type":"object","properties":{"numberOfBusinessPartnersAverage":{"type":"number","format":"float"},"uniqueTotal":{"type":"integer","format":"int64"},"sharedByOwnerTotal":{"type":"integer","format":"int64"},"checkedByExternalDataSourceTotal":{"type":"integer","format":"int64"},"confidenceLevelAverage":{"type":"number","format":"float"}}}}}}},"description":"getConfidenceCriteriaStats","method":"get","path":"/v6/stats/confidence-criteria","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"6.0.0"},"postman":{"name":"get Confidence Criteria Stats","description":{"type":"text/plain"},"url":{"path":["v6","stats","confidence-criteria"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## getConfidenceCriteriaStats - - - -getConfidenceCriteriaStats - -
- -OK - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/get-input-changelog.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/get-input-changelog.api.mdx deleted file mode 100644 index 19329c32ef7..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/get-input-changelog.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: get-input-changelog -title: "Returns changelog entries for changes to the business partner input stage" -description: "Returns changelog entries as of a specified timestamp from the input stage, optionally filtered by timestamp, an array of external IDs and a business partner type." -sidebar_label: "Returns changelog entries for changes to the business partner input stage" -hide_title: true -hide_table_of_contents: true -api: {"tags":["changelog-controller"],"description":"Returns changelog entries as of a specified timestamp from the input stage, optionally filtered by timestamp, an array of external IDs and a business partner type.","operationId":"getInputChangelog","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"timestampAfter":{"type":"string","description":"Only changelog entries created after this time. Ignored if empty.","format":"date-time","example":"2023-03-20T10:23:28.194Z"},"externalIds":{"uniqueItems":true,"type":"array","description":"Only for business partners with the given array of external IDs. Ignored if empty.","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"The changelog entries for the specified parameters","content":{"application/json":{"schema":{"required":["content","contentSize","errors","invalidEntries","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["changelogType","externalId","timestamp"],"type":"object","properties":{"externalId":{"type":"string","description":"The external identifier of the business partner for which the changelog entry was created."},"timestamp":{"type":"string","description":"The date and time when the changelog entry was created.","format":"date-time"},"changelogType":{"type":"string","description":"One of the actions for which the changelog entry was created: create, update.","enum":["CREATE","UPDATE"]}},"description":"An entry of the changelog, which is created each time a business partner is modified and contains data about the change. The actual new state of the business partner is not included."}},"invalidEntries":{"type":"integer","description":"Number of entries in the page that have been omitted due to being invalid (error)","format":"int32"},"errors":{"type":"array","description":"Infos about the entries with errors","items":{"title":"ErrorInfo","required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string","description":"Error code identifying the error","enum":["ExternalIdNotFound"]},"message":{"type":"string","description":"Error message that explains the error"},"entityKey":{"type":"string","description":"Key (externalId) of the entity that failed"}},"description":"Holds information about failures"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"post","path":"/v6/input/changelog/search","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":{"timestampAfter":"2023-03-20T10:23:28.194Z","externalIds":["string"]},"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"6.0.0"},"postman":{"name":"Returns changelog entries for changes to the business partner input stage","description":{"content":"Returns changelog entries as of a specified timestamp from the input stage, optionally filtered by timestamp, an array of external IDs and a business partner type.","type":"text/plain"},"url":{"path":["v6","input","changelog","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns changelog entries for changes to the business partner input stage - - - -Returns changelog entries as of a specified timestamp from the input stage, optionally filtered by timestamp, an array of external IDs and a business partner type. - -
Query Parameters
Request Body required
- -The changelog entries for the specified parameters - -
Schema
    content object[]
    - -Collection of results in the page - -
    errors object[]
    - -Infos about the entries with errors - -
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/get-output-changelog.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/get-output-changelog.api.mdx deleted file mode 100644 index 7dc34f65c74..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/get-output-changelog.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: get-output-changelog -title: "Returns changelog entries for changes to the business partner output stage" -description: "Returns changelog entries as of a specified timestamp from the output stage, optionally filtered by timestamp, an array of external IDs and a business partner type." -sidebar_label: "Returns changelog entries for changes to the business partner output stage" -hide_title: true -hide_table_of_contents: true -api: {"tags":["changelog-controller"],"description":"Returns changelog entries as of a specified timestamp from the output stage, optionally filtered by timestamp, an array of external IDs and a business partner type.","operationId":"getOutputChangelog","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"timestampAfter":{"type":"string","description":"Only changelog entries created after this time. Ignored if empty.","format":"date-time","example":"2023-03-20T10:23:28.194Z"},"externalIds":{"uniqueItems":true,"type":"array","description":"Only for business partners with the given array of external IDs. Ignored if empty.","items":{"type":"string"}}}}}},"required":true},"responses":{"200":{"description":"The changelog entries for the specified parameters","content":{"application/json":{"schema":{"required":["content","contentSize","errors","invalidEntries","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["changelogType","externalId","timestamp"],"type":"object","properties":{"externalId":{"type":"string","description":"The external identifier of the business partner for which the changelog entry was created."},"timestamp":{"type":"string","description":"The date and time when the changelog entry was created.","format":"date-time"},"changelogType":{"type":"string","description":"One of the actions for which the changelog entry was created: create, update.","enum":["CREATE","UPDATE"]}},"description":"An entry of the changelog, which is created each time a business partner is modified and contains data about the change. The actual new state of the business partner is not included."}},"invalidEntries":{"type":"integer","description":"Number of entries in the page that have been omitted due to being invalid (error)","format":"int32"},"errors":{"type":"array","description":"Infos about the entries with errors","items":{"title":"ErrorInfo","required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string","description":"Error code identifying the error","enum":["ExternalIdNotFound"]},"message":{"type":"string","description":"Error message that explains the error"},"entityKey":{"type":"string","description":"Key (externalId) of the entity that failed"}},"description":"Holds information about failures"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"post","path":"/v6/output/changelog/search","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":{"timestampAfter":"2023-03-20T10:23:28.194Z","externalIds":["string"]},"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"6.0.0"},"postman":{"name":"Returns changelog entries for changes to the business partner output stage","description":{"content":"Returns changelog entries as of a specified timestamp from the output stage, optionally filtered by timestamp, an array of external IDs and a business partner type.","type":"text/plain"},"url":{"path":["v6","output","changelog","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns changelog entries for changes to the business partner output stage - - - -Returns changelog entries as of a specified timestamp from the output stage, optionally filtered by timestamp, an array of external IDs and a business partner type. - -
Query Parameters
Request Body required
- -The changelog entries for the specified parameters - -
Schema
    content object[]
    - -Collection of results in the page - -
    errors object[]
    - -Infos about the entries with errors - -
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/get-sharing-states.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/get-sharing-states.api.mdx deleted file mode 100644 index bfdeb64f014..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/get-sharing-states.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-sharing-states -title: "Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs" -description: "Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs" -sidebar_label: "Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs" -hide_title: true -hide_table_of_contents: true -api: {"tags":["sharing-state-controller"],"operationId":"getSharingStates","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}},{"name":"businessPartnerType","in":"query","description":"Business partner type","required":false,"schema":{"type":"string","enum":["LEGAL_ENTITY","SITE","ADDRESS","GENERIC"]}},{"name":"externalIds","in":"query","description":"External IDs","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Page of sharing states","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["externalId","sharingStateType"],"type":"object","properties":{"externalId":{"type":"string","description":"The external identifier of the business partner for which the sharing state entry was created."},"sharingStateType":{"type":"string","description":"One of the sharing state types of the current sharing state.","enum":["Pending","Success","Error","Initial","Ready"]},"sharingErrorCode":{"type":"string","description":"One of the sharing error codes in case the current sharing state type is \"error\".","enum":["SharingProcessError","SharingTimeout","BpnNotInPool","MissingTaskID"]},"sharingErrorMessage":{"type":"string","description":"The error message in case the current sharing state type is \"error\"."},"sharingProcessStarted":{"type":"string","description":"The date and time when the sharing process was started.","format":"date-time"},"taskId":{"type":"string","description":"The orchestrator task identifier that was created"}},"description":"A sharing state entry shows the progress in the sharing process and is updated each time the progress for a business partner changes. The business partner is identified by a combination of external ID and business partner type."}}},"description":"Paginated collection of results"}}}}},"description":"Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs","method":"get","path":"/v6/sharing-state","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"6.0.0"},"postman":{"name":"Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs","description":{"type":"text/plain"},"url":{"path":["v6","sharing-state"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""},{"disabled":false,"description":{"content":"Business partner type","type":"text/plain"},"key":"businessPartnerType","value":""},{"disabled":false,"description":{"content":"External IDs","type":"text/plain"},"key":"externalIds","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs - - - -Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs - -
Query Parameters
- -Page of sharing states - -
Schema
    content object[]
    - -Collection of results in the page - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/post-sharing-state-ready.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/post-sharing-state-ready.api.mdx deleted file mode 100644 index 4d0a9f5351c..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/post-sharing-state-ready.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: post-sharing-state-ready -title: "Sets the given business partners into ready to be shared state" -description: "The business partners to set the ready state for are identified by their external-id. Only business partners in an initial or error state can be set to ready. If any given business partner could not be set into ready state for any reason (for example, it has not been found or it is in the wrong state) the whole request fails (all or nothing approach)." -sidebar_label: "Sets the given business partners into ready to be shared state" -hide_title: true -hide_table_of_contents: true -api: {"tags":["sharing-state-controller"],"description":"The business partners to set the ready state for are identified by their external-id. Only business partners in an initial or error state can be set to ready. If any given business partner could not be set into ready state for any reason (for example, it has not been found or it is in the wrong state) the whole request fails (all or nothing approach).","operationId":"postSharingStateReady","requestBody":{"content":{"application/json":{"schema":{"required":["externalIds"],"type":"object","properties":{"externalIds":{"type":"array","items":{"type":"string"}}},"description":"Request for setting business partners into ready to be shared to golden record state"}}},"required":true},"responses":{"204":{"description":"All business partners put in ready to be shared state"},"400":{"description":"Business partners can't be put into ready state (e.g. external-ID not found, wrong sharing state)"}},"method":"post","path":"/v6/sharing-state/ready","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":{"externalIds":["string"]},"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"6.0.0"},"postman":{"name":"Sets the given business partners into ready to be shared state","description":{"content":"The business partners to set the ready state for are identified by their external-id. Only business partners in an initial or error state can be set to ready. If any given business partner could not be set into ready state for any reason (for example, it has not been found or it is in the wrong state) the whole request fails (all or nothing approach).","type":"text/plain"},"url":{"path":["v6","sharing-state","ready"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Sets the given business partners into ready to be shared state - - - -The business partners to set the ready state for are identified by their external-id. Only business partners in an initial or error state can be set to ready. If any given business partner could not be set into ready state for any reason (for example, it has not been found or it is in the wrong state) the whole request fails (all or nothing approach). - -
Request Body required
- -All business partners put in ready to be shared state - -
- -Business partners can't be put into ready state (e.g. external-ID not found, wrong sharing state) - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/sidebar.js b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/sidebar.js deleted file mode 100644 index ccc0fede161..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate"},{"type":"category","label":"business-partner-controller","link":{"type":"generated-index","title":"business-partner-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/upsert-business-partners-input","label":"Create or update business partner with given external ID","className":"api-method put"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-business-partners-output","label":"Search business partners by an array of external IDs from the output stage","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-business-partners-input","label":"Search business partner by external ID. An empty external ID list returns a paginated list of all business partners.","className":"api-method post"}]},{"type":"category","label":"sharing-state-controller","link":{"type":"generated-index","title":"sharing-state-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Gate Api/sharing-state-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/post-sharing-state-ready","label":"Sets the given business partners into ready to be shared state","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-sharing-states","label":"Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs","className":"api-method get"}]},{"type":"category","label":"changelog-controller","link":{"type":"generated-index","title":"changelog-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Gate Api/changelog-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-output-changelog","label":"Returns changelog entries for changes to the business partner output stage","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-input-changelog","label":"Returns changelog entries for changes to the business partner input stage","className":"api-method post"}]},{"type":"category","label":"stats-controller","link":{"type":"generated-index","title":"stats-controller","slug":"/category/kits/Business Partner Kit/Software Development View/Gate Api/stats-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/count-address-types","label":"countAddressTypes","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/count-partners-per-stage","label":"countPartnersPerStage","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/count-partners-by-sharing-state","label":"countPartnersBySharingState","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Gate Api/get-confidence-criteria-stats","label":"getConfidenceCriteriaStats","className":"api-method get"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/upsert-business-partners-input.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/upsert-business-partners-input.api.mdx deleted file mode 100644 index 650e13e52f2..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/upsert-business-partners-input.api.mdx +++ /dev/null @@ -1,118 +0,0 @@ ---- -id: upsert-business-partners-input -title: "Create or update business partner with given external ID" -description: "Create or update generic business partner. Updates instead of creating a new business partner if an already existing external ID is used. The same external ID may not occur more than once in a single request. For a single request, the maximum number of business partners in the request is limited to 100 entries." -sidebar_label: "Create or update business partner with given external ID" -hide_title: true -hide_table_of_contents: true -api: {"tags":["business-partner-controller"],"description":"Create or update generic business partner. Updates instead of creating a new business partner if an already existing external ID is used. The same external ID may not occur more than once in a single request. For a single request, the maximum number of business partners in the request is limited to 100 entries.","operationId":"upsertBusinessPartnersInput","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"required":["address","externalId","identifiers","isOwnCompanyData","legalEntity","nameParts","roles","site","states"],"type":"object","properties":{"externalId":{"type":"string","description":"The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner."},"nameParts":{"type":"array","description":"The list of name parts to accommodate the different number of name fields in different systems.","items":{"type":"string"}},"identifiers":{"type":"array","description":"The list of identifiers of the business partner. Sorted and duplicates removed by the service.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the identifier."},"value":{"type":"string","description":"The value of the identifier like “DE123465789."},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Registergericht and Registerart."}}}},"states":{"type":"array","description":"The list of (temporary) states of the business partner. Sorted and duplicates removed by the service.","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}},"roles":{"type":"array","description":"One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.","items":{"type":"string","enum":["SUPPLIER","CUSTOMER","ONE_TIME_SUPPLIER","ONE_TIME_CUSTOMER"]}},"isOwnCompanyData":{"type":"boolean","description":"Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member."},"legalEntity":{"required":["states"],"type":"object","properties":{"legalEntityBpn":{"type":"string","description":"The BPNL of the legal entity, on which the business partner provides a view."},"legalName":{"type":"string","description":"The name of the legal entity, on which the business partner provides a view, according to official registers."},"shortName":{"type":"string","description":"The abbreviated name of the legal entity, on which the business partner provides a view."},"legalForm":{"type":"string","description":"The legal form of the legal entity, on which the business partner provides a view."},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"The legal entity, on which the business partner provides a view."},"site":{"required":["states"],"type":"object","properties":{"siteBpn":{"type":"string","description":"The BPNS of the site, on which the business partner provides a view."},"name":{"type":"string","description":"The name of the site, on which the business partner provides a view. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"The site, on which the business partner provides a view."},"address":{"required":["alternativePostalAddress","physicalPostalAddress","states"],"type":"object","properties":{"addressBpn":{"type":"string","description":"The BPNA of the address, on which the business partner provides a view."},"name":{"type":"string","description":"The name of the address, on which the business partner provides a view. This is not according to official registers but according to the name the sharing members agree on, such as the name of a gate or any other additional names that designate the address in common parlance."},"addressType":{"type":"string","description":"One of the address types: Legal Address, Site Main Address, Legal and Site Main Address, Additional Address. ","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"name":{"type":"string","description":"The name of the street."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"The address, on which the business partner provides a view. "}},"description":"Generic business partner with external id"}}}},"required":true},"responses":{"200":{"description":"Business partner were successfully updated or created","content":{"application/json":{"schema":{"type":"array","items":{"required":["address","bpnA","bpnL","createdAt","externalId","identifiers","isOwnCompanyData","legalEntity","nameParts","postalAddress","roles","site","states","updatedAt"],"type":"object","properties":{"externalId":{"type":"string","description":"The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner."},"nameParts":{"type":"array","description":"The list of name parts to accommodate the different number of name fields in different systems.","items":{"type":"string"}},"identifiers":{"type":"array","description":"The list of identifiers of the business partner. Sorted and duplicates removed by the service.","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the identifier."},"value":{"type":"string","description":"The value of the identifier like “DE123465789."},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Registergericht and Registerart."}}}},"states":{"type":"array","description":"The list of (temporary) states of the business partner. Sorted and duplicates removed by the service.","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}},"roles":{"type":"array","description":"One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.","items":{"type":"string","enum":["SUPPLIER","CUSTOMER","ONE_TIME_SUPPLIER","ONE_TIME_CUSTOMER"]}},"isOwnCompanyData":{"type":"boolean","description":"Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member."},"legalEntity":{"required":["states"],"type":"object","properties":{"legalEntityBpn":{"type":"string","description":"The BPNL of the legal entity, on which the business partner provides a view."},"legalName":{"type":"string","description":"The name of the legal entity, on which the business partner provides a view, according to official registers."},"shortName":{"type":"string","description":"The abbreviated name of the legal entity, on which the business partner provides a view."},"legalForm":{"type":"string","description":"The legal form of the legal entity, on which the business partner provides a view."},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"The legal entity, on which the business partner provides a view."},"site":{"required":["states"],"type":"object","properties":{"siteBpn":{"type":"string","description":"The BPNS of the site, on which the business partner provides a view."},"name":{"type":"string","description":"The name of the site, on which the business partner provides a view. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"The site, on which the business partner provides a view."},"address":{"required":["alternativePostalAddress","physicalPostalAddress","states"],"type":"object","properties":{"addressBpn":{"type":"string","description":"The BPNA of the address, on which the business partner provides a view."},"name":{"type":"string","description":"The name of the address, on which the business partner provides a view. This is not according to official registers but according to the name the sharing members agree on, such as the name of a gate or any other additional names that designate the address in common parlance."},"addressType":{"type":"string","description":"One of the address types: Legal Address, Site Main Address, Legal and Site Main Address, Additional Address. ","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]},"physicalPostalAddress":{"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"name":{"type":"string","description":"The name of the street."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","description":"Date since when the status is/was valid.","format":"date-time"},"validTo":{"type":"string","description":"Date until the status was valid, if applicable.","format":"date-time"},"type":{"type":"string","description":"The type of this specified status.","enum":["ACTIVE","INACTIVE"]}}}}},"description":"The address, on which the business partner provides a view. "},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"}},"description":"Generic business partner with external id"}}}}},"400":{"description":"On malformed legal entity request"}},"method":"put","path":"/v6/input/business-partners","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":[{"externalId":"string","nameParts":["string"],"identifiers":[{"type":"string","value":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"roles":["SUPPLIER"],"isOwnCompanyData":true,"legalEntity":{"legalEntityBpn":"string","legalName":"string","shortName":"string","legalForm":"string","states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}]},"site":{"siteBpn":"string","name":"string","states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}]},"address":{"addressBpn":"string","name":"string","addressType":"LegalAndSiteMainAddress","physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"namePrefix":"string","additionalNamePrefix":"string","name":"string","nameSuffix":"string","additionalNameSuffix":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}]}}],"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"6.0.0"},"postman":{"name":"Create or update business partner with given external ID","description":{"content":"Create or update generic business partner. Updates instead of creating a new business partner if an already existing external ID is used. The same external ID may not occur more than once in a single request. For a single request, the maximum number of business partners in the request is limited to 100 entries.","type":"text/plain"},"url":{"path":["v6","input","business-partners"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create or update business partner with given external ID - - - -Create or update generic business partner. Updates instead of creating a new business partner if an already existing external ID is used. The same external ID may not occur more than once in a single request. For a single request, the maximum number of business partners in the request is limited to 100 entries. - -
Request Body array required
    identifiers object[] required
    - -The list of identifiers of the business partner. Sorted and duplicates removed by the service. - -
    states object[] required
    - -The list of (temporary) states of the business partner. Sorted and duplicates removed by the service. - -
    legalEntity object required
    - -The legal entity, on which the business partner provides a view. - -
    states object[] required
    site object required
    - -The site, on which the business partner provides a view. - -
    states object[] required
    address object required
    - -The address, on which the business partner provides a view. - -
    physicalPostalAddress object required
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object required
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    states object[] required
- -Business partner were successfully updated or created - -
Schema array
    identifiers object[]
    - -The list of identifiers of the business partner. Sorted and duplicates removed by the service. - -
    states object[]
    - -The list of (temporary) states of the business partner. Sorted and duplicates removed by the service. - -
    legalEntity object
    - -The legal entity, on which the business partner provides a view. - -
    states object[]
    site object
    - -The site, on which the business partner provides a view. - -
    states object[]
    address object
    - -The address, on which the business partner provides a view. - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    states object[]
- -On malformed legal entity request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Orchestrator Api/business-partner-data-management-orchestrator.info.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Orchestrator Api/business-partner-data-management-orchestrator.info.mdx deleted file mode 100644 index c0490699968..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Orchestrator Api/business-partner-data-management-orchestrator.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: business-partner-data-management-orchestrator -title: "Business Partner Data Management Orchestrator" -description: "Orchestrator component acts as a passive component and offers for each processing steps individual endpoints" -sidebar_label: Introduction -sidebar_position: 0 -hide_title: true -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiDemoPanel/Export"; - -Version: 6.0.0 - -# Business Partner Data Management Orchestrator - - - -Orchestrator component acts as a passive component and offers for each processing steps individual endpoints - - - \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Orchestrator Api/create-tasks.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Orchestrator Api/create-tasks.api.mdx deleted file mode 100644 index b57391435ab..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Orchestrator Api/create-tasks.api.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: create-tasks -title: "Create new golden record tasks for given business partner data" -description: "Create golden record tasks for given business partner data in given mode. The mode decides through which processing steps the given business partner data will go through. The response contains the states of the created tasks in the order of given business partner data.If there is an error in the request no tasks are created (all or nothing). For a single request, the maximum number of business partners in the request is limited to 100 entries." -sidebar_label: "Create new golden record tasks for given business partner data" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Task Client"],"description":"Create golden record tasks for given business partner data in given mode. The mode decides through which processing steps the given business partner data will go through. The response contains the states of the created tasks in the order of given business partner data.If there is an error in the request no tasks are created (all or nothing). For a single request, the maximum number of business partners in the request is limited to 100 entries.","operationId":"createTasks","requestBody":{"content":{"application/json":{"schema":{"required":["businessPartners","mode"],"type":"object","properties":{"mode":{"type":"string","description":"The mode affecting which processing steps the business partner goes through","enum":["UpdateFromSharingMember","UpdateFromPool"]},"businessPartners":{"type":"array","description":"The list of business partner data to be processed","items":{"required":["legalEntity","nameParts","uncategorized"],"type":"object","properties":{"nameParts":{"type":"array","items":{"required":["name","type"],"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["LegalName","ShortName","LegalForm","SiteName","AddressName"]}}}},"owningCompany":{"type":"string"},"uncategorized":{"required":["identifiers","nameParts","states"],"type":"object","properties":{"nameParts":{"type":"array","items":{"type":"string"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"address":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}}}},"legalEntity":{"required":["bpnReference","confidenceCriteria","identifiers","legalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"legalName":{"type":"string"},"legalShortName":{"type":"string"},"legalForm":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean"},"hasChanged":{"type":"boolean"},"legalAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}}}},"site":{"required":["bpnReference","confidenceCriteria","siteMainIsLegalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"siteName":{"type":"string"},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"hasChanged":{"type":"boolean"},"siteMainAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}},"siteMainIsLegalAddress":{"type":"boolean"}}},"additionalAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}},"type":{"type":"string","enum":["LegalEntity","Site","Address"]}}}}},"description":"Request object to specify for which business partner data tasks should be created and in which mode"}}},"required":true},"responses":{"200":{"description":"The states of successfully created tasks including the task identifier for tracking purposes.","content":{"application/json":{"schema":{"required":["createdTasks"],"type":"object","properties":{"createdTasks":{"type":"array","items":{"required":["businessPartnerResult","processingState","taskId"],"type":"object","properties":{"taskId":{"type":"string"},"businessPartnerResult":{"required":["legalEntity","nameParts","uncategorized"],"type":"object","properties":{"nameParts":{"type":"array","items":{"required":["name","type"],"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["LegalName","ShortName","LegalForm","SiteName","AddressName"]}}}},"owningCompany":{"type":"string"},"uncategorized":{"required":["identifiers","nameParts","states"],"type":"object","properties":{"nameParts":{"type":"array","items":{"type":"string"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"address":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}}}},"legalEntity":{"required":["bpnReference","confidenceCriteria","identifiers","legalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"legalName":{"type":"string"},"legalShortName":{"type":"string"},"legalForm":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean"},"hasChanged":{"type":"boolean"},"legalAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}}}},"site":{"required":["bpnReference","confidenceCriteria","siteMainIsLegalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"siteName":{"type":"string"},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"hasChanged":{"type":"boolean"},"siteMainAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}},"siteMainIsLegalAddress":{"type":"boolean"}}},"additionalAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}},"type":{"type":"string","enum":["LegalEntity","Site","Address"]}}},"processingState":{"required":["createdAt","errors","modifiedAt","resultState","step","stepState","timeout"],"type":"object","properties":{"resultState":{"type":"string","description":"The processing result of the task, can also still be pending","enum":["Pending","Success","Error"]},"step":{"type":"string","description":"The last step this task has entered","enum":["CleanAndSync","PoolSync","Clean"]},"stepState":{"type":"string","description":"Whether the task is queued or already reserved for the latest step","enum":["Queued","Reserved","Success","Error"]},"errors":{"type":"array","description":"The actual errors that happened during processing if the task has an error result state. The errors refer to the latest step.","items":{"required":["description","type"],"type":"object","properties":{"type":{"type":"string","description":"The type of error that occurred","enum":["Timeout","Unspecified"]},"description":{"type":"string","description":"The free text, detailed description of the error"}},"description":"Describes an error that happened during processing of a task"}},"createdAt":{"type":"string","description":"When the task has been created","format":"date-time"},"modifiedAt":{"type":"string","description":"When the task has last been modified","format":"date-time"}},"description":"Contains detailed information about the current processing state of a golden record task"}},"description":"The golden record task's processing state together with optional business partner data in case processing is done"}}},"description":"Response object for giving a list of created tasks"}}}},"400":{"description":"On malformed task create requests or reaching upsert limit"}},"method":"post","path":"/v6/golden-record-tasks","servers":[{"url":"http://localhost:8085","description":"Generated server url"}],"jsonRequestBodyExample":{"mode":"UpdateFromSharingMember","businessPartners":[{"nameParts":[{"name":"string","type":"LegalName"}],"owningCompany":"string","uncategorized":{"nameParts":["string"],"identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"address":{"bpnReference":{"referenceValue":"string","desiredBpn":"string","referenceType":"Bpn"},"addressName":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-05-15","nextConfidenceCheckAt":"2024-05-15","confidenceLevel":0},"physicalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativeAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"hasChanged":true}},"legalEntity":{"bpnReference":{"referenceValue":"string","desiredBpn":"string","referenceType":"Bpn"},"legalName":"string","legalShortName":"string","legalForm":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-05-15","nextConfidenceCheckAt":"2024-05-15","confidenceLevel":0},"isCatenaXMemberData":true,"hasChanged":true,"legalAddress":{"bpnReference":{"referenceValue":"string","desiredBpn":"string","referenceType":"Bpn"},"addressName":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-05-15","nextConfidenceCheckAt":"2024-05-15","confidenceLevel":0},"physicalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativeAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"hasChanged":true}},"site":{"bpnReference":{"referenceValue":"string","desiredBpn":"string","referenceType":"Bpn"},"siteName":"string","states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-05-15","nextConfidenceCheckAt":"2024-05-15","confidenceLevel":0},"hasChanged":true,"siteMainAddress":{"bpnReference":{"referenceValue":"string","desiredBpn":"string","referenceType":"Bpn"},"addressName":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-05-15","nextConfidenceCheckAt":"2024-05-15","confidenceLevel":0},"physicalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativeAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"hasChanged":true},"siteMainIsLegalAddress":true},"additionalAddress":{"bpnReference":{"referenceValue":"string","desiredBpn":"string","referenceType":"Bpn"},"addressName":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-05-15","nextConfidenceCheckAt":"2024-05-15","confidenceLevel":0},"physicalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativeAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"hasChanged":true},"type":"LegalEntity"}]},"info":{"title":"Business Partner Data Management Orchestrator","description":"Orchestrator component acts as a passive component and offers for each processing steps individual endpoints","version":"6.0.0"},"postman":{"name":"Create new golden record tasks for given business partner data","description":{"content":"Create golden record tasks for given business partner data in given mode. The mode decides through which processing steps the given business partner data will go through. The response contains the states of the created tasks in the order of given business partner data.If there is an error in the request no tasks are created (all or nothing). For a single request, the maximum number of business partners in the request is limited to 100 entries.","type":"text/plain"},"url":{"path":["v6","golden-record-tasks"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/business-partner-data-management-orchestrator -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create new golden record tasks for given business partner data - - - -Create golden record tasks for given business partner data in given mode. The mode decides through which processing steps the given business partner data will go through. The response contains the states of the created tasks in the order of given business partner data.If there is an error in the request no tasks are created (all or nothing). For a single request, the maximum number of business partners in the request is limited to 100 entries. - -
Request Body required
    businessPartners object[] required
    - -The list of business partner data to be processed - -
    nameParts object[] required
    uncategorized object required
    identifiers object[] required
    states object[] required
    address object
    bpnReference object required
    identifiers object[] required
    states object[] required
    confidenceCriteria object required
    physicalAddress object required
    geographicCoordinates object required
    street object required
    alternativeAddress object
    geographicCoordinates object required
    legalEntity object required
    bpnReference object required
    identifiers object[] required
    states object[] required
    confidenceCriteria object required
    legalAddress object required
    bpnReference object required
    identifiers object[] required
    states object[] required
    confidenceCriteria object required
    physicalAddress object required
    geographicCoordinates object required
    street object required
    alternativeAddress object
    geographicCoordinates object required
    site object
    bpnReference object required
    states object[] required
    confidenceCriteria object required
    siteMainAddress object
    bpnReference object required
    identifiers object[] required
    states object[] required
    confidenceCriteria object required
    physicalAddress object required
    geographicCoordinates object required
    street object required
    alternativeAddress object
    geographicCoordinates object required
    additionalAddress object
    bpnReference object required
    identifiers object[] required
    states object[] required
    confidenceCriteria object required
    physicalAddress object required
    geographicCoordinates object required
    street object required
    alternativeAddress object
    geographicCoordinates object required
- -The states of successfully created tasks including the task identifier for tracking purposes. - -
Schema
    createdTasks object[]
    businessPartnerResult object
    nameParts object[]
    uncategorized object
    identifiers object[]
    states object[]
    address object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    physicalAddress object
    geographicCoordinates object
    street object
    alternativeAddress object
    geographicCoordinates object
    legalEntity object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    legalAddress object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    physicalAddress object
    geographicCoordinates object
    street object
    alternativeAddress object
    geographicCoordinates object
    site object
    bpnReference object
    states object[]
    confidenceCriteria object
    siteMainAddress object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    physicalAddress object
    geographicCoordinates object
    street object
    alternativeAddress object
    geographicCoordinates object
    additionalAddress object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    physicalAddress object
    geographicCoordinates object
    street object
    alternativeAddress object
    geographicCoordinates object
    processingState object
    - -Contains detailed information about the current processing state of a golden record task - -
    errors object[]
    - -The actual errors that happened during processing if the task has an error result state. The errors refer to the latest step. - -
- -On malformed task create requests or reaching upsert limit - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Orchestrator Api/reserve-tasks-for-step.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Orchestrator Api/reserve-tasks-for-step.api.mdx deleted file mode 100644 index 79866dc0719..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Orchestrator Api/reserve-tasks-for-step.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: reserve-tasks-for-step -title: "Reserve the next golden record tasks waiting in the given step queue" -description: "Reserve up to a given number of golden record tasks in the given step queue. The response entries contain the business partner data to process which consists of the generic and L/S/A data. The reservation has a time limit which is returned. For a single request, the maximum number of reservable tasks is limited to 100." -sidebar_label: "Reserve the next golden record tasks waiting in the given step queue" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Task Worker"],"description":"Reserve up to a given number of golden record tasks in the given step queue. The response entries contain the business partner data to process which consists of the generic and L/S/A data. The reservation has a time limit which is returned. For a single request, the maximum number of reservable tasks is limited to 100.","operationId":"reserveTasksForStep","requestBody":{"content":{"application/json":{"schema":{"required":["amount","step"],"type":"object","properties":{"amount":{"type":"integer","description":"The maximum number of tasks to reserve. Can be fewer if queue is not full enough.","format":"int32"},"step":{"type":"string","description":"The step queue to reserve from","enum":["CleanAndSync","PoolSync","Clean"]}},"description":"Request object for reserving a number of tasks waiting in a step queue."}}},"required":true},"responses":{"200":{"description":"The reserved tasks with their business partner data to process.","content":{"application/json":{"schema":{"required":["reservedTasks","timeout"],"type":"object","properties":{"reservedTasks":{"type":"array","description":"The reserved tasks with their business partner data to process","items":{"required":["businessPartner","requestKey","taskId"],"type":"object","properties":{"taskId":{"type":"string","description":"The identifier of the reserved task"},"businessPartner":{"required":["legalEntity","nameParts","uncategorized"],"type":"object","properties":{"nameParts":{"type":"array","items":{"required":["name","type"],"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["LegalName","ShortName","LegalForm","SiteName","AddressName"]}}}},"owningCompany":{"type":"string"},"uncategorized":{"required":["identifiers","nameParts","states"],"type":"object","properties":{"nameParts":{"type":"array","items":{"type":"string"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"address":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}}}},"legalEntity":{"required":["bpnReference","confidenceCriteria","identifiers","legalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"legalName":{"type":"string"},"legalShortName":{"type":"string"},"legalForm":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean"},"hasChanged":{"type":"boolean"},"legalAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}}}},"site":{"required":["bpnReference","confidenceCriteria","siteMainIsLegalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"siteName":{"type":"string"},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"hasChanged":{"type":"boolean"},"siteMainAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}},"siteMainIsLegalAddress":{"type":"boolean"}}},"additionalAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}},"type":{"type":"string","enum":["LegalEntity","Site","Address"]}}},"requestKey":{"type":"string"}},"description":"Task reservation entry"}},"timeout":{"type":"string","description":"The timestamp until the reservation is valid and results are accepted","format":"date-time","deprecated":true}},"description":"Response object for giving a list of reserved tasks"}}}},"400":{"description":"On malformed task create requests or reaching upsert limit"}},"method":"post","path":"/v6/golden-record-tasks/step-reservations","servers":[{"url":"http://localhost:8085","description":"Generated server url"}],"jsonRequestBodyExample":{"amount":0,"step":"CleanAndSync"},"info":{"title":"Business Partner Data Management Orchestrator","description":"Orchestrator component acts as a passive component and offers for each processing steps individual endpoints","version":"6.0.0"},"postman":{"name":"Reserve the next golden record tasks waiting in the given step queue","description":{"content":"Reserve up to a given number of golden record tasks in the given step queue. The response entries contain the business partner data to process which consists of the generic and L/S/A data. The reservation has a time limit which is returned. For a single request, the maximum number of reservable tasks is limited to 100.","type":"text/plain"},"url":{"path":["v6","golden-record-tasks","step-reservations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/business-partner-data-management-orchestrator -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Reserve the next golden record tasks waiting in the given step queue - - - -Reserve up to a given number of golden record tasks in the given step queue. The response entries contain the business partner data to process which consists of the generic and L/S/A data. The reservation has a time limit which is returned. For a single request, the maximum number of reservable tasks is limited to 100. - -
Request Body required
- -The reserved tasks with their business partner data to process. - -
Schema
    reservedTasks object[]
    - -The reserved tasks with their business partner data to process - -
    businessPartner object
    nameParts object[]
    uncategorized object
    identifiers object[]
    states object[]
    address object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    physicalAddress object
    geographicCoordinates object
    street object
    alternativeAddress object
    geographicCoordinates object
    legalEntity object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    legalAddress object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    physicalAddress object
    geographicCoordinates object
    street object
    alternativeAddress object
    geographicCoordinates object
    site object
    bpnReference object
    states object[]
    confidenceCriteria object
    siteMainAddress object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    physicalAddress object
    geographicCoordinates object
    street object
    alternativeAddress object
    geographicCoordinates object
    additionalAddress object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    physicalAddress object
    geographicCoordinates object
    street object
    alternativeAddress object
    geographicCoordinates object
- -On malformed task create requests or reaching upsert limit - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Orchestrator Api/resolve-step-results.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Orchestrator Api/resolve-step-results.api.mdx deleted file mode 100644 index f2dd1a829fb..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Orchestrator Api/resolve-step-results.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: resolve-step-results -title: "Post step results for reserved golden record tasks in the given step queue" -description: "Post business partner step results for the given tasks in the given step queue. In order to post a result for a task it needs to be reserved first, has to currently be in the given step queue and the time limit is not exceeded. The number of results you can post at a time does not need to match the original number of reserved tasks. Results are accepted via strategy 'all or nothing'. For a single request, the maximum number of postable results is limited to 100." -sidebar_label: "Post step results for reserved golden record tasks in the given step queue" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Task Worker"],"description":"Post business partner step results for the given tasks in the given step queue. In order to post a result for a task it needs to be reserved first, has to currently be in the given step queue and the time limit is not exceeded. The number of results you can post at a time does not need to match the original number of reserved tasks. Results are accepted via strategy 'all or nothing'. For a single request, the maximum number of postable results is limited to 100.","operationId":"resolveStepResults","requestBody":{"content":{"application/json":{"schema":{"required":["results","step"],"type":"object","properties":{"step":{"type":"string","description":"The step queue containing the tasks for which results are posted","enum":["CleanAndSync","PoolSync","Clean"]},"results":{"type":"array","items":{"required":["businessPartner","errors","taskId"],"type":"object","properties":{"taskId":{"type":"string","description":"The identifier of the task for which this is a result"},"businessPartner":{"required":["legalEntity","nameParts","uncategorized"],"type":"object","properties":{"nameParts":{"type":"array","items":{"required":["name","type"],"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["LegalName","ShortName","LegalForm","SiteName","AddressName"]}}}},"owningCompany":{"type":"string"},"uncategorized":{"required":["identifiers","nameParts","states"],"type":"object","properties":{"nameParts":{"type":"array","items":{"type":"string"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"address":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}}}},"legalEntity":{"required":["bpnReference","confidenceCriteria","identifiers","legalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"legalName":{"type":"string"},"legalShortName":{"type":"string"},"legalForm":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean"},"hasChanged":{"type":"boolean"},"legalAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}}}},"site":{"required":["bpnReference","confidenceCriteria","siteMainIsLegalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"siteName":{"type":"string"},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"hasChanged":{"type":"boolean"},"siteMainAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}},"siteMainIsLegalAddress":{"type":"boolean"}}},"additionalAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}},"type":{"type":"string","enum":["LegalEntity","Site","Address"]}}},"errors":{"type":"array","description":"Errors that occurred during processing of this task","items":{"required":["description","type"],"type":"object","properties":{"type":{"type":"string","description":"The type of error that occurred","enum":["Timeout","Unspecified"]},"description":{"type":"string","description":"The free text, detailed description of the error"}},"description":"Describes an error that happened during processing of a task"}}},"description":"A step result for a golden record task"}}},"description":"Request object for posting step results of previously reserved tasks"}}},"required":true},"responses":{"204":{"description":"If the results could be processed"},"400":{"description":"On malformed requests, reaching upsert limit or posting results for tasks which are missing or in the wrong step queue"}},"method":"post","path":"/v6/golden-record-tasks/step-results","servers":[{"url":"http://localhost:8085","description":"Generated server url"}],"jsonRequestBodyExample":{"step":"CleanAndSync","results":[{"taskId":"string","businessPartner":{"nameParts":[{"name":"string","type":"LegalName"}],"owningCompany":"string","uncategorized":{"nameParts":["string"],"identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"address":{"bpnReference":{"referenceValue":"string","desiredBpn":"string","referenceType":"Bpn"},"addressName":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-05-15","nextConfidenceCheckAt":"2024-05-15","confidenceLevel":0},"physicalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativeAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"hasChanged":true}},"legalEntity":{"bpnReference":{"referenceValue":"string","desiredBpn":"string","referenceType":"Bpn"},"legalName":"string","legalShortName":"string","legalForm":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-05-15","nextConfidenceCheckAt":"2024-05-15","confidenceLevel":0},"isCatenaXMemberData":true,"hasChanged":true,"legalAddress":{"bpnReference":{"referenceValue":"string","desiredBpn":"string","referenceType":"Bpn"},"addressName":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-05-15","nextConfidenceCheckAt":"2024-05-15","confidenceLevel":0},"physicalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativeAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"hasChanged":true}},"site":{"bpnReference":{"referenceValue":"string","desiredBpn":"string","referenceType":"Bpn"},"siteName":"string","states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-05-15","nextConfidenceCheckAt":"2024-05-15","confidenceLevel":0},"hasChanged":true,"siteMainAddress":{"bpnReference":{"referenceValue":"string","desiredBpn":"string","referenceType":"Bpn"},"addressName":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-05-15","nextConfidenceCheckAt":"2024-05-15","confidenceLevel":0},"physicalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativeAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"hasChanged":true},"siteMainIsLegalAddress":true},"additionalAddress":{"bpnReference":{"referenceValue":"string","desiredBpn":"string","referenceType":"Bpn"},"addressName":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-05-15","nextConfidenceCheckAt":"2024-05-15","confidenceLevel":0},"physicalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativeAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"string","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"hasChanged":true},"type":"LegalEntity"},"errors":[{"type":"Timeout","description":"string"}]}]},"info":{"title":"Business Partner Data Management Orchestrator","description":"Orchestrator component acts as a passive component and offers for each processing steps individual endpoints","version":"6.0.0"},"postman":{"name":"Post step results for reserved golden record tasks in the given step queue","description":{"content":"Post business partner step results for the given tasks in the given step queue. In order to post a result for a task it needs to be reserved first, has to currently be in the given step queue and the time limit is not exceeded. The number of results you can post at a time does not need to match the original number of reserved tasks. Results are accepted via strategy 'all or nothing'. For a single request, the maximum number of postable results is limited to 100.","type":"text/plain"},"url":{"path":["v6","golden-record-tasks","step-results"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/business-partner-data-management-orchestrator -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Post step results for reserved golden record tasks in the given step queue - - - -Post business partner step results for the given tasks in the given step queue. In order to post a result for a task it needs to be reserved first, has to currently be in the given step queue and the time limit is not exceeded. The number of results you can post at a time does not need to match the original number of reserved tasks. Results are accepted via strategy 'all or nothing'. For a single request, the maximum number of postable results is limited to 100. - -
Request Body required
    results object[] required
    businessPartner object required
    nameParts object[] required
    uncategorized object required
    identifiers object[] required
    states object[] required
    address object
    bpnReference object required
    identifiers object[] required
    states object[] required
    confidenceCriteria object required
    physicalAddress object required
    geographicCoordinates object required
    street object required
    alternativeAddress object
    geographicCoordinates object required
    legalEntity object required
    bpnReference object required
    identifiers object[] required
    states object[] required
    confidenceCriteria object required
    legalAddress object required
    bpnReference object required
    identifiers object[] required
    states object[] required
    confidenceCriteria object required
    physicalAddress object required
    geographicCoordinates object required
    street object required
    alternativeAddress object
    geographicCoordinates object required
    site object
    bpnReference object required
    states object[] required
    confidenceCriteria object required
    siteMainAddress object
    bpnReference object required
    identifiers object[] required
    states object[] required
    confidenceCriteria object required
    physicalAddress object required
    geographicCoordinates object required
    street object required
    alternativeAddress object
    geographicCoordinates object required
    additionalAddress object
    bpnReference object required
    identifiers object[] required
    states object[] required
    confidenceCriteria object required
    physicalAddress object required
    geographicCoordinates object required
    street object required
    alternativeAddress object
    geographicCoordinates object required
    errors object[] required
    - -Errors that occurred during processing of this task - -
- -If the results could be processed - -
- -On malformed requests, reaching upsert limit or posting results for tasks which are missing or in the wrong step queue - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Orchestrator Api/search-task-states.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Orchestrator Api/search-task-states.api.mdx deleted file mode 100644 index 315cdfc7c63..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Orchestrator Api/search-task-states.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: search-task-states -title: "Search for the state of golden record tasks by task identifiers" -description: "Returns the state of golden record tasks based on the provided task identifiers. Unknown task identifiers are ignored." -sidebar_label: "Search for the state of golden record tasks by task identifiers" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Task Client"],"description":"Returns the state of golden record tasks based on the provided task identifiers. Unknown task identifiers are ignored.","operationId":"searchTaskStates","requestBody":{"content":{"application/json":{"schema":{"required":["taskIds"],"type":"object","properties":{"taskIds":{"type":"array","items":{"type":"string"}}},"description":"Request object for giving a list of task identifiers to search for the state of tasks"}}},"required":true},"responses":{"200":{"description":"The state of the tasks for the provided task identifiers.","content":{"application/json":{"schema":{"required":["tasks"],"type":"object","properties":{"tasks":{"type":"array","items":{"required":["businessPartnerResult","processingState","taskId"],"type":"object","properties":{"taskId":{"type":"string"},"businessPartnerResult":{"required":["legalEntity","nameParts","uncategorized"],"type":"object","properties":{"nameParts":{"type":"array","items":{"required":["name","type"],"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["LegalName","ShortName","LegalForm","SiteName","AddressName"]}}}},"owningCompany":{"type":"string"},"uncategorized":{"required":["identifiers","nameParts","states"],"type":"object","properties":{"nameParts":{"type":"array","items":{"type":"string"}},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"address":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}}}},"legalEntity":{"required":["bpnReference","confidenceCriteria","identifiers","legalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"legalName":{"type":"string"},"legalShortName":{"type":"string"},"legalForm":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean"},"hasChanged":{"type":"boolean"},"legalAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}}}},"site":{"required":["bpnReference","confidenceCriteria","siteMainIsLegalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"siteName":{"type":"string"},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"hasChanged":{"type":"boolean"},"siteMainAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}},"siteMainIsLegalAddress":{"type":"boolean"}}},"additionalAddress":{"required":["bpnReference","confidenceCriteria","identifiers","physicalAddress","states"],"type":"object","properties":{"bpnReference":{"type":"object","properties":{"referenceValue":{"type":"string"},"desiredBpn":{"type":"string"},"referenceType":{"type":"string","enum":["Bpn","BpnRequestIdentifier"]}}},"addressName":{"type":"string"},"identifiers":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"type":{"type":"string"},"issuingBody":{"type":"string"}}}},"states":{"type":"array","items":{"type":"object","properties":{"validFrom":{"type":"string","format":"date-time"},"validTo":{"type":"string","format":"date-time"},"type":{"type":"string","enum":["ACTIVE","INACTIVE"]}}}},"confidenceCriteria":{"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"physicalAddress":{"required":["geographicCoordinates","street"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"administrativeAreaLevel2":{"type":"string"},"administrativeAreaLevel3":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"street":{"type":"object","properties":{"name":{"type":"string"},"houseNumber":{"type":"string"},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string"},"direction":{"type":"string"},"namePrefix":{"type":"string"},"additionalNamePrefix":{"type":"string"},"nameSuffix":{"type":"string"},"additionalNameSuffix":{"type":"string"}}},"companyPostalCode":{"type":"string"},"industrialZone":{"type":"string"},"building":{"type":"string"},"floor":{"type":"string"},"door":{"type":"string"}}},"alternativeAddress":{"required":["geographicCoordinates"],"type":"object","properties":{"geographicCoordinates":{"type":"object","properties":{"longitude":{"type":"number","format":"float"},"latitude":{"type":"number","format":"float"},"altitude":{"type":"number","format":"float"}}},"country":{"type":"string"},"administrativeAreaLevel1":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"deliveryServiceType":{"type":"string","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string"},"deliveryServiceNumber":{"type":"string"}}},"hasChanged":{"type":"boolean"}}},"type":{"type":"string","enum":["LegalEntity","Site","Address"]}}},"processingState":{"required":["createdAt","errors","modifiedAt","resultState","step","stepState","timeout"],"type":"object","properties":{"resultState":{"type":"string","description":"The processing result of the task, can also still be pending","enum":["Pending","Success","Error"]},"step":{"type":"string","description":"The last step this task has entered","enum":["CleanAndSync","PoolSync","Clean"]},"stepState":{"type":"string","description":"Whether the task is queued or already reserved for the latest step","enum":["Queued","Reserved","Success","Error"]},"errors":{"type":"array","description":"The actual errors that happened during processing if the task has an error result state. The errors refer to the latest step.","items":{"required":["description","type"],"type":"object","properties":{"type":{"type":"string","description":"The type of error that occurred","enum":["Timeout","Unspecified"]},"description":{"type":"string","description":"The free text, detailed description of the error"}},"description":"Describes an error that happened during processing of a task"}},"createdAt":{"type":"string","description":"When the task has been created","format":"date-time"},"modifiedAt":{"type":"string","description":"When the task has last been modified","format":"date-time"}},"description":"Contains detailed information about the current processing state of a golden record task"}},"description":"The golden record task's processing state together with optional business partner data in case processing is done"}}},"description":"Response object for giving a list of task states"}}}},"400":{"description":"On malformed task search requests"}},"method":"post","path":"/v6/golden-record-tasks/state/search","servers":[{"url":"http://localhost:8085","description":"Generated server url"}],"jsonRequestBodyExample":{"taskIds":["string"]},"info":{"title":"Business Partner Data Management Orchestrator","description":"Orchestrator component acts as a passive component and offers for each processing steps individual endpoints","version":"6.0.0"},"postman":{"name":"Search for the state of golden record tasks by task identifiers","description":{"content":"Returns the state of golden record tasks based on the provided task identifiers. Unknown task identifiers are ignored.","type":"text/plain"},"url":{"path":["v6","golden-record-tasks","state","search"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Orchestrator Api/business-partner-data-management-orchestrator -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Search for the state of golden record tasks by task identifiers - - - -Returns the state of golden record tasks based on the provided task identifiers. Unknown task identifiers are ignored. - -
Request Body required
- -The state of the tasks for the provided task identifiers. - -
Schema
    tasks object[]
    businessPartnerResult object
    nameParts object[]
    uncategorized object
    identifiers object[]
    states object[]
    address object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    physicalAddress object
    geographicCoordinates object
    street object
    alternativeAddress object
    geographicCoordinates object
    legalEntity object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    legalAddress object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    physicalAddress object
    geographicCoordinates object
    street object
    alternativeAddress object
    geographicCoordinates object
    site object
    bpnReference object
    states object[]
    confidenceCriteria object
    siteMainAddress object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    physicalAddress object
    geographicCoordinates object
    street object
    alternativeAddress object
    geographicCoordinates object
    additionalAddress object
    bpnReference object
    identifiers object[]
    states object[]
    confidenceCriteria object
    physicalAddress object
    geographicCoordinates object
    street object
    alternativeAddress object
    geographicCoordinates object
    processingState object
    - -Contains detailed information about the current processing state of a golden record task - -
    errors object[]
    - -The actual errors that happened during processing if the task has an error result state. The errors refer to the latest step. - -
- -On malformed task search requests - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Orchestrator Api/sidebar.js b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Orchestrator Api/sidebar.js deleted file mode 100644 index 433446ffc5e..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Orchestrator Api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Orchestrator Api/business-partner-data-management-orchestrator"},{"type":"category","label":"Task Client","link":{"type":"generated-index","title":"Task Client","slug":"/category/kits/Business Partner Kit/Software Development View/Orchestrator Api/task-client"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Orchestrator Api/create-tasks","label":"Create new golden record tasks for given business partner data","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Orchestrator Api/search-task-states","label":"Search for the state of golden record tasks by task identifiers","className":"api-method post"}]},{"type":"category","label":"Task Worker","link":{"type":"generated-index","title":"Task Worker","slug":"/category/kits/Business Partner Kit/Software Development View/Orchestrator Api/task-worker"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Orchestrator Api/resolve-step-results","label":"Post step results for reserved golden record tasks in the given step queue","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Orchestrator Api/reserve-tasks-for-step","label":"Reserve the next golden record tasks waiting in the given step queue","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool.info.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool.info.mdx deleted file mode 100644 index 7347e3ab4e9..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: business-partner-data-management-pool -title: "Business Partner Data Management Pool" -description: "Service that manages and shares business partner data with other CatenaX services" -sidebar_label: Introduction -sidebar_position: 0 -hide_title: true -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiDemoPanel/Export"; - -Version: 6.0.0 - -# Business Partner Data Management Pool - - - -Service that manages and shares business partner data with other CatenaX services - - - \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/create-addresses.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/create-addresses.api.mdx deleted file mode 100644 index d2ca9c87e81..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/create-addresses.api.mdx +++ /dev/null @@ -1,118 +0,0 @@ ---- -id: create-addresses -title: "Creates a new address" -description: "Create new business partners of type address by specifying the BPN of the parent each address belongs to. A parent can be either a site or legal entity business partner. If the parent cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response." -sidebar_label: "Creates a new address" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Address Controller"],"description":"Create new business partners of type address by specifying the BPN of the parent each address belongs to. A parent can be either a site or legal entity business partner. If the parent cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response.","operationId":"createAddresses","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"required":["bpnParent","confidenceCriteria","identifiers","physicalPostalAddress","states"],"type":"object","properties":{"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"type":"string","description":"One of the state types: active, inactive.","enum":["ACTIVE","INACTIVE"]}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"type":"string","description":"The type of the identifier."}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"bpnParent":{"type":"string","description":"BPNL of the legal entity or BPNS of the site this address belongs to."},"index":{"type":"string","description":"User defined index to conveniently match this entry to the corresponding entry in the response."},"requestKey":{"type":"string"}},"description":"Request for creating new business partner record of type address. In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}}}},"required":true},"responses":{"200":{"description":"New business partner record successfully created, possible errors are returned","content":{"application/json":{"schema":{"required":["entities","entityCount","errorCount","errors"],"type":"object","properties":{"entities":{"type":"array","items":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]},"index":{"type":"string","description":"User defined index to conveniently match this entry to the corresponding entry in the response."}},"description":"Created business partner of type address. In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}},"errors":{"type":"array","items":{"title":"ErrorInfo","required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string","description":"AddressCreateError","enum":["BpnNotValid","SiteNotFound","LegalEntityNotFound","RegionNotFound","IdentifierNotFound","AddressDuplicateIdentifier"]},"message":{"type":"string","description":"Error message that explains the error"},"entityKey":{"type":"string","description":"Key of the entity that failed from the request object: index or BPN"}},"description":"Holds information about failures when creating or updating an entity"}},"entityCount":{"type":"integer","format":"int32"},"errorCount":{"type":"integer","format":"int32"}},"description":"Holds information about successfully and failed entities after the creating/updating of several objects"}}}},"400":{"description":"On malformed requests"}},"method":"post","path":"/v6/addresses","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":[{"name":"string","states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"identifiers":[{"value":"string","type":"string"}],"physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-05-15","nextConfidenceCheckAt":"2024-05-15","confidenceLevel":0},"bpnParent":"string","index":"string","requestKey":"string"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Creates a new address","description":{"content":"Create new business partners of type address by specifying the BPN of the parent each address belongs to. A parent can be either a site or legal entity business partner. If the parent cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response.","type":"text/plain"},"url":{"path":["v6","addresses"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Creates a new address - - - -Create new business partners of type address by specifying the BPN of the parent each address belongs to. A parent can be either a site or legal entity business partner. If the parent cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response. - -
Request Body array required
    states object[] required
    - -The list of (temporary) states of the address. - -
    identifiers object[] required
    - -The list of identifiers of the address. - -
    physicalPostalAddress object required
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    confidenceCriteria object required
- -New business partner record successfully created, possible errors are returned - -
Schema
    entities object[]
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
    errors object[]
- -On malformed requests - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/create-business-partners.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/create-business-partners.api.mdx deleted file mode 100644 index f7a88bf8d07..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/create-business-partners.api.mdx +++ /dev/null @@ -1,162 +0,0 @@ ---- -id: create-business-partners -title: "Creates a new legal entity" -description: "Create new business partners of type legal entity. The given additional identifiers of a record need to be unique, otherwise they are ignored. For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response." -sidebar_label: "Creates a new legal entity" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Legal Entity Controller"],"description":"Create new business partners of type legal entity. The given additional identifiers of a record need to be unique, otherwise they are ignored. For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response.","operationId":"createBusinessPartners","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"required":["confidenceCriteria","identifiers","isCatenaXMemberData","legalAddress","legalName","states"],"type":"object","properties":{"legalName":{"type":"string","description":"The name of the legal entity according to official registers."},"legalShortName":{"type":"string","description":"The abbreviated name of the legal entity."},"legalForm":{"type":"string","description":"The legal form of the legal entity."},"identifiers":{"type":"array","description":"The list of identifiers of the legal entity.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"DE123465789\"."},"type":{"type":"string","description":"The type of the identifier."},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister."}},"description":"A legal entity identifier (uniquely) identifies the legal entity, such as the German Handelsregisternummer, a VAT number, etc."}},"states":{"type":"array","description":"The list of (temporary) states of the legal entity.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"type":"string","description":"One of the state types: active, inactive.","enum":["ACTIVE","INACTIVE"]}},"description":"A legal entity state indicates if the legal entity is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the legal entity is still operating."}},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the legal entity is owned and thus provided by a Catena-X Member."},"legalAddress":{"required":["confidenceCriteria","identifiers","physicalPostalAddress","states"],"type":"object","properties":{"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"type":"string","description":"One of the state types: active, inactive.","enum":["ACTIVE","INACTIVE"]}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"type":"string","description":"The type of the identifier."}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."},"index":{"type":"string","description":"User defined index to conveniently match this entry to the corresponding entry in the response."},"requestKey":{"type":"string"}},"description":"Request for creating new business partner record of type legal entity. In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL."}}}},"required":true},"responses":{"200":{"description":"New legal entities request was processed successfully, possible errors are returned","content":{"application/json":{"schema":{"required":["entities","entityCount","errorCount","errors"],"type":"object","properties":{"entities":{"type":"array","items":{"required":["bpnl","confidenceCriteria","createdAt","currentness","identifiers","isCatenaXMemberData","legalAddress","legalName","relations","states","updatedAt"],"type":"object","properties":{"bpnl":{"type":"string","description":"A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number."},"legalName":{"type":"string","description":"The name of the legal entity according to official registers."},"legalShortName":{"type":"string","description":"The abbreviated name of the legal entity."},"legalForm":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"The technical identifier of the legal form according to ISO 20275."},"name":{"type":"string","description":"The name of legal form according to ISO 20275."},"abbreviation":{"type":"string","description":"The abbreviated name of the legal form, such as AG for German Aktiengesellschaft."}},"description":"A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities."},"identifiers":{"type":"array","description":"The list of identifiers of the legal entity.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"DE123465789\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister."}},"description":"A legal entity identifier (uniquely) identifies the legal entity, such as the German Handelsregisternummer, a VAT number, etc."}},"states":{"type":"array","description":"The list of (temporary) states of the legal entity.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A legal entity state indicates if the legal entity is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the legal entity is still operating."}},"relations":{"type":"array","description":"Relations to other business partners.","items":{"required":["endBpnl","startBpnl","type"],"type":"object","properties":{"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["CX_LEGAL_SUCCESSOR_OF","CX_LEGAL_PREDECESSOR_OF"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"startBpnl":{"type":"string","description":"BPN of partner which is the source of the relation"},"endBpnl":{"type":"string","description":"BPN of partner which is the target of the relation"},"validFrom":{"type":"string","description":"Time when the relation started","format":"date-time"},"validTo":{"type":"string","description":"Time when the relation ended","format":"date-time"}},"description":"Directed relation between two business partners"}},"currentness":{"type":"string","description":"The date the business partner data was last indicated to be still current.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the legal entity is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"legalAddress":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."},"index":{"type":"string","description":"User defined index to conveniently match this entry to the corresponding entry in the response."}},"description":"Created/updated business partner of type legal entity. In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL."}},"errors":{"type":"array","items":{"title":"ErrorInfo","required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string","description":"LegalEntityCreateError","enum":["LegalEntityDuplicateIdentifier","LegalFormNotFound","LegalEntityIdentifierNotFound","LegalAddressRegionNotFound","LegalAddressIdentifierNotFound","LegalAddressDuplicateIdentifier","LegalEntityErrorMapping"]},"message":{"type":"string","description":"Error message that explains the error"},"entityKey":{"type":"string","description":"Key of the entity that failed from the request object: index or BPN"}},"description":"Holds information about failures when creating or updating an entity"}},"entityCount":{"type":"integer","format":"int32"},"errorCount":{"type":"integer","format":"int32"}},"description":"Holds information about successfully and failed entities after the creating/updating of several objects"}}}},"400":{"description":"On malformed requests"}},"method":"post","path":"/v6/legal-entities","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":[{"legalName":"string","legalShortName":"string","legalForm":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-05-15","nextConfidenceCheckAt":"2024-05-15","confidenceLevel":0},"isCatenaXMemberData":true,"legalAddress":{"name":"string","states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"identifiers":[{"value":"string","type":"string"}],"physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-05-15","nextConfidenceCheckAt":"2024-05-15","confidenceLevel":0}},"index":"string","requestKey":"string"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Creates a new legal entity","description":{"content":"Create new business partners of type legal entity. The given additional identifiers of a record need to be unique, otherwise they are ignored. For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response.","type":"text/plain"},"url":{"path":["v6","legal-entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Creates a new legal entity - - - -Create new business partners of type legal entity. The given additional identifiers of a record need to be unique, otherwise they are ignored. For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response. - -
Request Body array required
    identifiers object[] required
    - -The list of identifiers of the legal entity. - -
    states object[] required
    - -The list of (temporary) states of the legal entity. - -
    confidenceCriteria object required
    legalAddress object required
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[] required
    - -The list of (temporary) states of the address. - -
    identifiers object[] required
    - -The list of identifiers of the address. - -
    physicalPostalAddress object required
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    confidenceCriteria object required
- -New legal entities request was processed successfully, possible errors are returned - -
Schema
    entities object[]
    legalForm object
    - -A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities. - -
    identifiers object[]
    - -The list of identifiers of the legal entity. - -
    type object
    - -Named type uniquely identified by its technical key - -
    states object[]
    - -The list of (temporary) states of the legal entity. - -
    type object
    - -Named type uniquely identified by its technical key - -
    relations object[]
    - -Relations to other business partners. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
    legalAddress object
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
    errors object[]
- -On malformed requests - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-type.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-type.api.mdx deleted file mode 100644 index 85918cdf9ff..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-type.api.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: create-identifier-type -title: "Creates a new identifier type" -description: "Create a new identifier type (including validity details) which can be referenced by business partner records. Identifier types such as BPN or VAT determine with which kind of values a business partner can be identified with. The actual name of the identifier type is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique for the businessPartnerType as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems." -sidebar_label: "Creates a new identifier type" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Metadata Controller"],"description":"Create a new identifier type (including validity details) which can be referenced by business partner records. Identifier types such as BPN or VAT determine with which kind of values a business partner can be identified with. The actual name of the identifier type is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique for the businessPartnerType as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems.","operationId":"createIdentifierType","requestBody":{"content":{"application/json":{"schema":{"required":["businessPartnerType","details","name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"The technical identifier (unique in combination with businessPartnerType)."},"businessPartnerType":{"type":"string","description":"Specifies if an identifier type is valid for legal entities (L) or addresses (A). Sites (S) are not supported.","enum":["LEGAL_ENTITY","ADDRESS"]},"name":{"type":"string","description":"The name of the identifier type."},"details":{"type":"array","description":"Validity details.","items":{"required":["mandatory"],"type":"object","properties":{"country":{"type":"string","description":"2-digit country code for which this identifier is valid; null for universal identifiers.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"mandatory":{"type":"boolean","description":"True if identifier is mandatory in this country."}},"description":"Information for which countries an identifier type is valid and mandatory."}}},"description":"An identifier type defines the name or category of an identifier, such as the German Handelsregisternummer, VAT number, Global Location Number (GLN), etc. The identifier type is valid for a business partner type."}}},"required":true},"responses":{"200":{"description":"New identifier type successfully created","content":{"application/json":{"schema":{"required":["businessPartnerType","details","name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"The technical identifier (unique in combination with businessPartnerType)."},"businessPartnerType":{"type":"string","description":"Specifies if an identifier type is valid for legal entities (L) or addresses (A). Sites (S) are not supported.","enum":["LEGAL_ENTITY","ADDRESS"]},"name":{"type":"string","description":"The name of the identifier type."},"details":{"type":"array","description":"Validity details.","items":{"required":["mandatory"],"type":"object","properties":{"country":{"type":"string","description":"2-digit country code for which this identifier is valid; null for universal identifiers.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"mandatory":{"type":"boolean","description":"True if identifier is mandatory in this country."}},"description":"Information for which countries an identifier type is valid and mandatory."}}},"description":"An identifier type defines the name or category of an identifier, such as the German Handelsregisternummer, VAT number, Global Location Number (GLN), etc. The identifier type is valid for a business partner type."}}}},"400":{"description":"On malformed request parameters"},"409":{"description":"Identifier type with specified technical key already exists"}},"method":"post","path":"/v6/identifier-types","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"technicalKey":"string","businessPartnerType":"LEGAL_ENTITY","name":"string","details":[{"country":"UNDEFINED","mandatory":true}]},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Creates a new identifier type","description":{"content":"Create a new identifier type (including validity details) which can be referenced by business partner records. Identifier types such as BPN or VAT determine with which kind of values a business partner can be identified with. The actual name of the identifier type is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique for the businessPartnerType as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems.","type":"text/plain"},"url":{"path":["v6","identifier-types"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Creates a new identifier type - - - -Create a new identifier type (including validity details) which can be referenced by business partner records. Identifier types such as BPN or VAT determine with which kind of values a business partner can be identified with. The actual name of the identifier type is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique for the businessPartnerType as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems. - -
Request Body required
    details object[] required
    - -Validity details. - -
- -New identifier type successfully created - -
Schema
    details object[]
    - -Validity details. - -
- -On malformed request parameters - -
- -Identifier type with specified technical key already exists - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/create-legal-form.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/create-legal-form.api.mdx deleted file mode 100644 index 8328fe2bb44..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/create-legal-form.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: create-legal-form -title: "Creates a new legal form" -description: "Create a new legal form which can be referenced by business partner records. The actual name of the legal form is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique for the businessPartnerType as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems." -sidebar_label: "Creates a new legal form" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Metadata Controller"],"description":"Create a new legal form which can be referenced by business partner records. The actual name of the legal form is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique for the businessPartnerType as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems.","operationId":"createLegalForm","requestBody":{"content":{"application/json":{"schema":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key to be used for reference"},"name":{"type":"string","description":"Full name of the legal form"},"abbreviation":{"type":"string","description":"Abbreviation of the legal form name"}},"description":"New legal form record to be referenced by business partners"}}},"required":true},"responses":{"200":{"description":"New legal form successfully created","content":{"application/json":{"schema":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"The technical identifier of the legal form according to ISO 20275."},"name":{"type":"string","description":"The name of legal form according to ISO 20275."},"abbreviation":{"type":"string","description":"The abbreviated name of the legal form, such as AG for German Aktiengesellschaft."}},"description":"A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities."}}}},"400":{"description":"On malformed request parameters"},"409":{"description":"Legal form with specified technical key already exists"}},"method":"post","path":"/v6/legal-forms","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"technicalKey":"string","name":"string","abbreviation":"string"},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Creates a new legal form","description":{"content":"Create a new legal form which can be referenced by business partner records. The actual name of the legal form is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique for the businessPartnerType as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems.","type":"text/plain"},"url":{"path":["v6","legal-forms"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Creates a new legal form - - - -Create a new legal form which can be referenced by business partner records. The actual name of the legal form is free to choose and doesn't need to be unique. The technical key can be freely chosen but needs to be unique for the businessPartnerType as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems. - -
Request Body required
- -New legal form successfully created - -
Schema
- -On malformed request parameters - -
- -Legal form with specified technical key already exists - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/create-site.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/create-site.api.mdx deleted file mode 100644 index 9485d3077f2..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/create-site.api.mdx +++ /dev/null @@ -1,138 +0,0 @@ ---- -id: create-site -title: "Creates a new site" -description: "Create new business partners of type site by specifying the BPNL of the legal entity each site belongs to. If the legal entitiy cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response." -sidebar_label: "Creates a new site" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Site Controller"],"description":"Create new business partners of type site by specifying the BPNL of the legal entity each site belongs to. If the legal entitiy cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response.","operationId":"createSite","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"required":["bpnlParent","confidenceCriteria","mainAddress","name","states"],"type":"object","properties":{"name":{"type":"string","description":"The name of the site. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","description":"The list of the (temporary) states of the site.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"type":"string","description":"One of the state types: active, inactive.","enum":["ACTIVE","INACTIVE"]}},"description":"A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating."}},"mainAddress":{"required":["confidenceCriteria","identifiers","physicalPostalAddress","states"],"type":"object","properties":{"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"type":"string","description":"One of the state types: active, inactive.","enum":["ACTIVE","INACTIVE"]}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"type":"string","description":"The type of the identifier."}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"bpnlParent":{"type":"string","description":"The BPNL of the legal entity owning the site."},"index":{"type":"string","description":"User defined index to conveniently match this entry to the corresponding entry in the response."},"requestKey":{"type":"string"}},"description":"Request for creating new business partner record of type site. In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS."}}}},"required":true},"responses":{"200":{"description":"New sites request was processed successfully, possible errors are returned","content":{"application/json":{"schema":{"required":["entities","entityCount","errorCount","errors"],"type":"object","properties":{"entities":{"type":"array","items":{"required":["bpnLegalEntity","bpns","confidenceCriteria","createdAt","isCatenaXMemberData","mainAddress","name","states","updatedAt"],"type":"object","properties":{"bpns":{"type":"string","description":"A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located."},"name":{"type":"string","description":"The name of the site. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","description":"The list of the (temporary) states of the site.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating."}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the site is owned and thus provided by a Catena-X Member."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the site."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"mainAddress":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."},"index":{"type":"string","description":"User defined index to conveniently match this entry to the corresponding entry in the response."}},"description":"Created/updated business partner of type site. In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS."}},"errors":{"type":"array","items":{"title":"ErrorInfo","required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string","description":"SiteCreateError","enum":["LegalEntityNotFound","MainAddressIdentifierNotFound","MainAddressRegionNotFound","MainAddressDuplicateIdentifier"]},"message":{"type":"string","description":"Error message that explains the error"},"entityKey":{"type":"string","description":"Key of the entity that failed from the request object: index or BPN"}},"description":"Holds information about failures when creating or updating an entity"}},"entityCount":{"type":"integer","format":"int32"},"errorCount":{"type":"integer","format":"int32"}},"description":"Holds information about successfully and failed entities after the creating/updating of several objects"}}}},"400":{"description":"On malformed requests"}},"method":"post","path":"/v6/sites","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":[{"name":"string","states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"mainAddress":{"name":"string","states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"identifiers":[{"value":"string","type":"string"}],"physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-05-15","nextConfidenceCheckAt":"2024-05-15","confidenceLevel":0}},"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-05-15","nextConfidenceCheckAt":"2024-05-15","confidenceLevel":0},"bpnlParent":"string","index":"string","requestKey":"string"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Creates a new site","description":{"content":"Create new business partners of type site by specifying the BPNL of the legal entity each site belongs to. If the legal entitiy cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response.","type":"text/plain"},"url":{"path":["v6","sites"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Creates a new site - - - -Create new business partners of type site by specifying the BPNL of the legal entity each site belongs to. If the legal entitiy cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response. - -
Request Body array required
    states object[] required
    - -The list of the (temporary) states of the site. - -
    mainAddress object required
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[] required
    - -The list of (temporary) states of the address. - -
    identifiers object[] required
    - -The list of identifiers of the address. - -
    physicalPostalAddress object required
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    confidenceCriteria object required
    confidenceCriteria object required
- -New sites request was processed successfully, possible errors are returned - -
Schema
    entities object[]
    states object[]
    - -The list of the (temporary) states of the site. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
    mainAddress object
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
    errors object[]
- -On malformed requests - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/find-bpns-by-identifiers.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/find-bpns-by-identifiers.api.mdx deleted file mode 100644 index d6d00be6d85..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/find-bpns-by-identifiers.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: find-bpns-by-identifiers -title: "Returns a list of identifier mappings of an identifier to a BPNL/A/S, specified by a business partner type, identifier type and identifier values" -description: "Find business partner numbers by identifiers. The response can contain less results than the number of identifier values that were requested, if some of the identifiers did not exist. For a single request, the maximum number of identifier values to search for is limited to ${bpdm.bpn.search-request-limit} entries." -sidebar_label: "Returns a list of identifier mappings of an identifier to a BPNL/A/S, specified by a business partner type, identifier type and identifier values" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Bpn Controller"],"description":"Find business partner numbers by identifiers. The response can contain less results than the number of identifier values that were requested, if some of the identifiers did not exist. For a single request, the maximum number of identifier values to search for is limited to ${bpdm.bpn.search-request-limit} entries.","operationId":"findBpnsByIdentifiers","requestBody":{"content":{"application/json":{"schema":{"required":["businessPartnerType","idType","idValues"],"type":"object","properties":{"businessPartnerType":{"type":"string","description":"Specifies if an identifier type is valid for legal entities (L) or addresses (A). Sites (S) are not supported.","enum":["LEGAL_ENTITY","ADDRESS"]},"idType":{"type":"string","description":"Technical key of the type to which the identifiers belongs to"},"idValues":{"type":"array","description":"Values of the identifiers","items":{"type":"string","description":"Values of the identifiers"}}},"description":"Contains identifiers to search legal entities by"}}},"required":true},"responses":{"200":{"description":"Found bpn to identifier value mappings","content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"required":["bpn","idValue"],"type":"object","properties":{"idValue":{"type":"string","description":"Value of the identifier"},"bpn":{"type":"string","description":"Business Partner Number"}},"description":"Mapping of Business Partner Number to identifier value"}}}}},"400":{"description":"On malformed request parameters or if number of requested bpns exceeds limit"},"404":{"description":"Specified identifier type not found"}},"method":"post","path":"/v6/bpn/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"businessPartnerType":"LEGAL_ENTITY","idType":"string","idValues":["string"]},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Returns a list of identifier mappings of an identifier to a BPNL/A/S, specified by a business partner type, identifier type and identifier values","description":{"content":"Find business partner numbers by identifiers. The response can contain less results than the number of identifier values that were requested, if some of the identifiers did not exist. For a single request, the maximum number of identifier values to search for is limited to ${bpdm.bpn.search-request-limit} entries.","type":"text/plain"},"url":{"path":["v6","bpn","search"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns a list of identifier mappings of an identifier to a BPNL/A/S, specified by a business partner type, identifier type and identifier values - - - -Find business partner numbers by identifiers. The response can contain less results than the number of identifier values that were requested, if some of the identifiers did not exist. For a single request, the maximum number of identifier values to search for is limited to ${bpdm.bpn.search-request-limit} entries. - -
Request Body required
- -Found bpn to identifier value mappings - -
Schema array
- -On malformed request parameters or if number of requested bpns exceeds limit - -
- -Specified identifier type not found - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-address.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-address.api.mdx deleted file mode 100644 index 88870732ff5..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-address.api.mdx +++ /dev/null @@ -1,94 +0,0 @@ ---- -id: get-address -title: "Returns an address by its BPNA" -description: "Get business partners of type address by BPNA ignoring case." -sidebar_label: "Returns an address by its BPNA" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Address Controller"],"description":"Get business partners of type address by BPNA ignoring case.","operationId":"getAddress","parameters":[{"name":"bpna","in":"path","description":"BPNA value","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Found address with specified BPNA","content":{"application/json":{"schema":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}}}},"400":{"description":"On malformed request parameters"},"404":{"description":"No address found under specified BPNA"}},"method":"get","path":"/v6/addresses/{bpna}","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Returns an address by its BPNA","description":{"content":"Get business partners of type address by BPNA ignoring case.","type":"text/plain"},"url":{"path":["v6","addresses",":bpna"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) BPNA value","type":"text/plain"},"type":"any","value":"","key":"bpna"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns an address by its BPNA - - - -Get business partners of type address by BPNA ignoring case. - -
Path Parameters
- -Found address with specified BPNA - -
Schema
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- -On malformed request parameters - -
- -No address found under specified BPNA - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-addresses-1.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-addresses-1.api.mdx deleted file mode 100644 index a698053d8e4..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-addresses-1.api.mdx +++ /dev/null @@ -1,94 +0,0 @@ ---- -id: get-addresses-1 -title: "Returns addresses by different search parameters" -description: "This endpoint tries to find matches among all existing business partners of type address, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score." -sidebar_label: "Returns addresses by different search parameters" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Address Controller"],"description":"This endpoint tries to find matches among all existing business partners of type address, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. ","operationId":"getAddresses_1","parameters":[{"name":"addressBpns","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"legalEntityBpns","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"siteBpns","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"name","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Page of addresses matching the search criteria, may be empty","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed search or pagination request"}},"method":"get","path":"/v6/addresses","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Returns addresses by different search parameters","description":{"content":"This endpoint tries to find matches among all existing business partners of type address, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. ","type":"text/plain"},"url":{"path":["v6","addresses"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"addressBpns","value":""},{"disabled":false,"key":"legalEntityBpns","value":""},{"disabled":false,"key":"siteBpns","value":""},{"disabled":false,"key":"name","value":""},{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns addresses by different search parameters - - - -This endpoint tries to find matches among all existing business partners of type address, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. - -
Query Parameters
- -Page of addresses matching the search criteria, may be empty - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- -On malformed search or pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-addresses.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-addresses.api.mdx deleted file mode 100644 index 6619c3b4f54..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-addresses.api.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -id: get-addresses -title: "Returns all addresses of a legal entity with a specific BPNL" -description: "Get business partners of type address belonging to a business partner of type legal entity, identified by the business partner's BPNL ignoring case." -sidebar_label: "Returns all addresses of a legal entity with a specific BPNL" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Legal Entity Controller"],"description":"Get business partners of type address belonging to a business partner of type legal entity, identified by the business partner's BPNL ignoring case.","operationId":"getAddresses","parameters":[{"name":"bpnl","in":"path","description":"BPNL value","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"The addresses for the specified BPNL","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"},"404":{"description":"No business partner found for specified BPNL"}},"method":"get","path":"/v6/legal-entities/{bpnl}/addresses","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Returns all addresses of a legal entity with a specific BPNL","description":{"content":"Get business partners of type address belonging to a business partner of type legal entity, identified by the business partner's BPNL ignoring case.","type":"text/plain"},"url":{"path":["v6","legal-entities",":bpnl","addresses"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) BPNL value","type":"text/plain"},"type":"any","value":"","key":"bpnl"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns all addresses of a legal entity with a specific BPNL - - - -Get business partners of type address belonging to a business partner of type legal entity, identified by the business partner's BPNL ignoring case. - -
Path Parameters
Query Parameters
- -The addresses for the specified BPNL - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- -On malformed pagination request - -
- -No business partner found for specified BPNL - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-admin-areas-level-1.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-admin-areas-level-1.api.mdx deleted file mode 100644 index b30d80e3e5d..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-admin-areas-level-1.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-admin-areas-level-1 -title: "Get page of country subdivisions suitable for the administrativeAreaLevel1 address property" -description: "Lists all currently known country subdivisions according to ISO 3166-2 in a paginated result" -sidebar_label: "Get page of country subdivisions suitable for the administrativeAreaLevel1 address property" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Metadata Controller"],"description":"Lists all currently known country subdivisions according to ISO 3166-2 in a paginated result","operationId":"getAdminAreasLevel1","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Page of existing country subdivisions, may be empty","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["code","countryCode","name"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"code":{"type":"string","description":"The country subdivision code according to ISO 3166-2"},"name":{"type":"string","description":"The name of the country subdivision according to ISO 3166-2"}},"description":"Country subdivision"}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed request parameters"}},"method":"get","path":"/v6/administrative-areas-level1","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Get page of country subdivisions suitable for the administrativeAreaLevel1 address property","description":{"content":"Lists all currently known country subdivisions according to ISO 3166-2 in a paginated result","type":"text/plain"},"url":{"path":["v6","administrative-areas-level1"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of country subdivisions suitable for the administrativeAreaLevel1 address property - - - -Lists all currently known country subdivisions according to ISO 3166-2 in a paginated result - -
Query Parameters
- -Page of existing country subdivisions, may be empty - -
Schema
    content object[]
    - -Collection of results in the page - -
- -On malformed request parameters - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-changelog-entries.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-changelog-entries.api.mdx deleted file mode 100644 index cea80e338ce..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-changelog-entries.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: get-changelog-entries -title: "Returns changelog entries as of a specified timestamp, optionally filtered by a list of BPNL/S/A, or business partner types" -description: "Returns changelog entries as of a specified timestamp, optionally filtered by a list of BPNL/S/A, or business partner types" -sidebar_label: "Returns changelog entries as of a specified timestamp, optionally filtered by a list of BPNL/S/A, or business partner types" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Changelog Controller"],"operationId":"getChangelogEntries","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"timestampAfter":{"type":"string","description":"Only changelog entries created after this time. Ignored if empty.","format":"date-time","example":"2023-03-20T10:23:28.194Z"},"bpns":{"uniqueItems":true,"type":"array","description":"Only for business partners with the given array of BPNL/S/A. Ignored if empty.","items":{"type":"string"}},"businessPartnerTypes":{"uniqueItems":true,"type":"array","description":"Only for business partners with the given array of business partner types. Ignored if empty.","items":{"type":"string","enum":["LEGAL_ENTITY","SITE","ADDRESS","GENERIC"]}}},"description":"Request for searching and filtering the business partner changelog"}}},"required":true},"responses":{"200":{"description":"The specified changelog entries","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpn","businessPartnerType","changelogType","timestamp"],"type":"object","properties":{"bpn":{"type":"string","description":"The business partner number for which the changelog entry was created. Can be either a BPNL, BPNS or BPNA."},"businessPartnerType":{"type":"string","description":"One of the types of business partners for which the changelog entry was created: legal entity, site, address.","enum":["LEGAL_ENTITY","SITE","ADDRESS","GENERIC"]},"timestamp":{"type":"string","description":"The date and time when the changelog entry was created.","format":"date-time"},"changelogType":{"type":"string","description":"One of the actions for which the changelog entry was created: create, update.","enum":["CREATE","UPDATE"]}},"description":"An entry of the changelog, which is created each time a business partner is modified and contains data about the change. The actual new state of the business partner is not included."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"},"404":{"description":"No business partner found for specified bpn"}},"description":"Returns changelog entries as of a specified timestamp, optionally filtered by a list of BPNL/S/A, or business partner types","method":"post","path":"/v6/business-partners/changelog/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"timestampAfter":"2023-03-20T10:23:28.194Z","bpns":["string"],"businessPartnerTypes":["LEGAL_ENTITY"]},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Returns changelog entries as of a specified timestamp, optionally filtered by a list of BPNL/S/A, or business partner types","description":{"type":"text/plain"},"url":{"path":["v6","business-partners","changelog","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns changelog entries as of a specified timestamp, optionally filtered by a list of BPNL/S/A, or business partner types - - - -Returns changelog entries as of a specified timestamp, optionally filtered by a list of BPNL/S/A, or business partner types - -
Query Parameters
Request Body required
- -The specified changelog entries - -
Schema
    content object[]
    - -Collection of results in the page - -
- -On malformed pagination request - -
- -No business partner found for specified bpn - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-field-quality-rules.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-field-quality-rules.api.mdx deleted file mode 100644 index bc6ac287256..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-field-quality-rules.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-field-quality-rules -title: "Get all field quality rules filtered by country (specified by its ISO 3166-1 alpha-2 country code)" -description: "List the country specific data rules for entity fields.All fields that are not in this list are considered to be forbidden." -sidebar_label: "Get all field quality rules filtered by country (specified by its ISO 3166-1 alpha-2 country code)" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Metadata Controller"],"description":"List the country specific data rules for entity fields.All fields that are not in this list are considered to be forbidden.","operationId":"getFieldQualityRules","parameters":[{"name":"country","in":"query","description":"ISO 3166-1 alpha-2 country code","required":true,"schema":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]}}],"responses":{"200":{"description":"List of the existing rules for the given country","content":{"application/json":{"schema":{"type":"array","items":{"required":["country","fieldPath","qualityLevel"],"type":"object","properties":{"fieldPath":{"type":"string","description":"Path to the field"},"schemaName":{"type":"string","description":"Schema name of the entity the field belongs to"},"country":{"type":"string","description":"Country for wich the rule is valid","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"qualityLevel":{"type":"string","description":"Defines the quality of an entity field.","enum":["MANDATORY","OPTIONAL","FORBIDDEN"]}},"description":"Rule for the quality level of an entity field "}}}}},"400":{"description":"On malformed request parameters"}},"method":"get","path":"/v6/field-quality-rules/","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Get all field quality rules filtered by country (specified by its ISO 3166-1 alpha-2 country code)","description":{"content":"List the country specific data rules for entity fields.All fields that are not in this list are considered to be forbidden.","type":"text/plain"},"url":{"path":["v6","field-quality-rules",""],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ISO 3166-1 alpha-2 country code","type":"text/plain"},"key":"country","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get all field quality rules filtered by country (specified by its ISO 3166-1 alpha-2 country code) - - - -List the country specific data rules for entity fields.All fields that are not in this list are considered to be forbidden. - -
Query Parameters
- -List of the existing rules for the given country - -
Schema array
- -On malformed request parameters - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-types.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-types.api.mdx deleted file mode 100644 index 7fd0466115b..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-types.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: get-identifier-types -title: "Returns all identifier types filtered by business partner type and country." -description: "Lists all matching identifier types including validity details in a paginated result" -sidebar_label: "Returns all identifier types filtered by business partner type and country." -hide_title: true -hide_table_of_contents: true -api: {"tags":["Metadata Controller"],"description":"Lists all matching identifier types including validity details in a paginated result","operationId":"getIdentifierTypes","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}},{"name":"businessPartnerType","in":"query","required":true,"schema":{"type":"string","description":"Specifies if an identifier type is valid for legal entities (L) or addresses (A). Sites (S) are not supported.","enum":["LEGAL_ENTITY","ADDRESS"]}},{"name":"country","in":"query","required":false,"schema":{"type":"string","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]}}],"responses":{"200":{"description":"Page of existing identifier types, may be empty","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["businessPartnerType","details","name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"The technical identifier (unique in combination with businessPartnerType)."},"businessPartnerType":{"type":"string","description":"Specifies if an identifier type is valid for legal entities (L) or addresses (A). Sites (S) are not supported.","enum":["LEGAL_ENTITY","ADDRESS"]},"name":{"type":"string","description":"The name of the identifier type."},"details":{"type":"array","description":"Validity details.","items":{"required":["mandatory"],"type":"object","properties":{"country":{"type":"string","description":"2-digit country code for which this identifier is valid; null for universal identifiers.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"mandatory":{"type":"boolean","description":"True if identifier is mandatory in this country."}},"description":"Information for which countries an identifier type is valid and mandatory."}}},"description":"An identifier type defines the name or category of an identifier, such as the German Handelsregisternummer, VAT number, Global Location Number (GLN), etc. The identifier type is valid for a business partner type."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed request parameters"}},"method":"get","path":"/v6/identifier-types","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Returns all identifier types filtered by business partner type and country.","description":{"content":"Lists all matching identifier types including validity details in a paginated result","type":"text/plain"},"url":{"path":["v6","identifier-types"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"businessPartnerType","value":""},{"disabled":false,"key":"country","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns all identifier types filtered by business partner type and country. - - - -Lists all matching identifier types including validity details in a paginated result - -
Query Parameters
- -Page of existing identifier types, may be empty - -
Schema
    content object[]
    - -Collection of results in the page - -
    details object[]
    - -Validity details. - -
- -On malformed request parameters - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entities.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entities.api.mdx deleted file mode 100644 index 021aeae677a..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entities.api.mdx +++ /dev/null @@ -1,126 +0,0 @@ ---- -id: get-legal-entities -title: "Returns legal entities by different search parameters" -description: "This endpoint tries to find matches among all existing business partners of type legal entity, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match." -sidebar_label: "Returns legal entities by different search parameters" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Legal Entity Controller"],"description":"This endpoint tries to find matches among all existing business partners of type legal entity, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. ","operationId":"getLegalEntities","parameters":[{"name":"bpnLs","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"legalName","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Page of business partners matching the search criteria, may be empty","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpnl","confidenceCriteria","createdAt","currentness","identifiers","isCatenaXMemberData","legalAddress","legalName","relations","states","updatedAt"],"type":"object","properties":{"bpnl":{"type":"string","description":"A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number."},"legalName":{"type":"string","description":"The name of the legal entity according to official registers."},"legalShortName":{"type":"string","description":"The abbreviated name of the legal entity."},"legalForm":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"The technical identifier of the legal form according to ISO 20275."},"name":{"type":"string","description":"The name of legal form according to ISO 20275."},"abbreviation":{"type":"string","description":"The abbreviated name of the legal form, such as AG for German Aktiengesellschaft."}},"description":"A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities."},"identifiers":{"type":"array","description":"The list of identifiers of the legal entity.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"DE123465789\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister."}},"description":"A legal entity identifier (uniquely) identifies the legal entity, such as the German Handelsregisternummer, a VAT number, etc."}},"states":{"type":"array","description":"The list of (temporary) states of the legal entity.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A legal entity state indicates if the legal entity is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the legal entity is still operating."}},"relations":{"type":"array","description":"Relations to other business partners.","items":{"required":["endBpnl","startBpnl","type"],"type":"object","properties":{"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["CX_LEGAL_SUCCESSOR_OF","CX_LEGAL_PREDECESSOR_OF"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"startBpnl":{"type":"string","description":"BPN of partner which is the source of the relation"},"endBpnl":{"type":"string","description":"BPN of partner which is the target of the relation"},"validFrom":{"type":"string","description":"Time when the relation started","format":"date-time"},"validTo":{"type":"string","description":"Time when the relation ended","format":"date-time"}},"description":"Directed relation between two business partners"}},"currentness":{"type":"string","description":"The date the business partner data was last indicated to be still current.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the legal entity is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"legalAddress":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}},"description":"In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed search or pagination request"}},"method":"get","path":"/v6/legal-entities","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Returns legal entities by different search parameters","description":{"content":"This endpoint tries to find matches among all existing business partners of type legal entity, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. ","type":"text/plain"},"url":{"path":["v6","legal-entities"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"bpnLs","value":""},{"disabled":false,"key":"legalName","value":""},{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns legal entities by different search parameters - - - -This endpoint tries to find matches among all existing business partners of type legal entity, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. - -
Query Parameters
- -Page of business partners matching the search criteria, may be empty - -
Schema
    content object[]
    - -Collection of results in the page - -
    legalForm object
    - -A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities. - -
    identifiers object[]
    - -The list of identifiers of the legal entity. - -
    type object
    - -Named type uniquely identified by its technical key - -
    states object[]
    - -The list of (temporary) states of the legal entity. - -
    type object
    - -Named type uniquely identified by its technical key - -
    relations object[]
    - -Relations to other business partners. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
    legalAddress object
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- -On malformed search or pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity.api.mdx deleted file mode 100644 index 7e598684920..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity.api.mdx +++ /dev/null @@ -1,126 +0,0 @@ ---- -id: get-legal-entity -title: "Returns a legal entity by identifier, like BPN, DUNS or EU VAT ID, specified by the identifier type" -description: "This endpoint tries to find a business partner by the specified identifier. The identifier value is case insensitively compared but needs to be given exactly. By default the value given is interpreted as a BPN. By specifying the technical key of another identifier typethe value is matched against the identifiers of that given type." -sidebar_label: "Returns a legal entity by identifier, like BPN, DUNS or EU VAT ID, specified by the identifier type" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Legal Entity Controller"],"description":"This endpoint tries to find a business partner by the specified identifier. The identifier value is case insensitively compared but needs to be given exactly. By default the value given is interpreted as a BPN. By specifying the technical key of another identifier typethe value is matched against the identifiers of that given type.","operationId":"getLegalEntity","parameters":[{"name":"idValue","in":"path","description":"Identifier value","required":true,"schema":{"type":"string"}},{"name":"idType","in":"query","description":"Type of identifier to use, defaults to BPN when omitted","required":false,"schema":{"type":"string","default":"BPN"}}],"responses":{"200":{"description":"Found business partner with specified identifier","content":{"application/json":{"schema":{"required":["bpnl","confidenceCriteria","createdAt","currentness","identifiers","isCatenaXMemberData","legalAddress","legalName","relations","states","updatedAt"],"type":"object","properties":{"bpnl":{"type":"string","description":"A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number."},"legalName":{"type":"string","description":"The name of the legal entity according to official registers."},"legalShortName":{"type":"string","description":"The abbreviated name of the legal entity."},"legalForm":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"The technical identifier of the legal form according to ISO 20275."},"name":{"type":"string","description":"The name of legal form according to ISO 20275."},"abbreviation":{"type":"string","description":"The abbreviated name of the legal form, such as AG for German Aktiengesellschaft."}},"description":"A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities."},"identifiers":{"type":"array","description":"The list of identifiers of the legal entity.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"DE123465789\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister."}},"description":"A legal entity identifier (uniquely) identifies the legal entity, such as the German Handelsregisternummer, a VAT number, etc."}},"states":{"type":"array","description":"The list of (temporary) states of the legal entity.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A legal entity state indicates if the legal entity is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the legal entity is still operating."}},"relations":{"type":"array","description":"Relations to other business partners.","items":{"required":["endBpnl","startBpnl","type"],"type":"object","properties":{"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["CX_LEGAL_SUCCESSOR_OF","CX_LEGAL_PREDECESSOR_OF"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"startBpnl":{"type":"string","description":"BPN of partner which is the source of the relation"},"endBpnl":{"type":"string","description":"BPN of partner which is the target of the relation"},"validFrom":{"type":"string","description":"Time when the relation started","format":"date-time"},"validTo":{"type":"string","description":"Time when the relation ended","format":"date-time"}},"description":"Directed relation between two business partners"}},"currentness":{"type":"string","description":"The date the business partner data was last indicated to be still current.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the legal entity is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"legalAddress":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}},"description":"In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL."}}}},"400":{"description":"On malformed request parameters"},"404":{"description":"No business partner found under specified identifier or specified identifier type not found"}},"method":"get","path":"/v6/legal-entities/{idValue}","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Returns a legal entity by identifier, like BPN, DUNS or EU VAT ID, specified by the identifier type","description":{"content":"This endpoint tries to find a business partner by the specified identifier. The identifier value is case insensitively compared but needs to be given exactly. By default the value given is interpreted as a BPN. By specifying the technical key of another identifier typethe value is matched against the identifiers of that given type.","type":"text/plain"},"url":{"path":["v6","legal-entities",":idValue"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Type of identifier to use, defaults to BPN when omitted","type":"text/plain"},"key":"idType","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Identifier value","type":"text/plain"},"type":"any","value":"","key":"idValue"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns a legal entity by identifier, like BPN, DUNS or EU VAT ID, specified by the identifier type - - - -This endpoint tries to find a business partner by the specified identifier. The identifier value is case insensitively compared but needs to be given exactly. By default the value given is interpreted as a BPN. By specifying the technical key of another identifier typethe value is matched against the identifiers of that given type. - -
Path Parameters
Query Parameters
- -Found business partner with specified identifier - -
Schema
    legalForm object
    - -A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities. - -
    identifiers object[]
    - -The list of identifiers of the legal entity. - -
    type object
    - -Named type uniquely identified by its technical key - -
    states object[]
    - -The list of (temporary) states of the legal entity. - -
    type object
    - -Named type uniquely identified by its technical key - -
    relations object[]
    - -Relations to other business partners. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
    legalAddress object
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- -On malformed request parameters - -
- -No business partner found under specified identifier or specified identifier type not found - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-forms.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-forms.api.mdx deleted file mode 100644 index 925cf8110cc..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-legal-forms.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-legal-forms -title: "Returns all legal forms" -description: "Lists all currently known legal forms in a paginated result" -sidebar_label: "Returns all legal forms" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Metadata Controller"],"description":"Lists all currently known legal forms in a paginated result","operationId":"getLegalForms","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Page of existing legal forms, may be empty","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"The technical identifier of the legal form according to ISO 20275."},"name":{"type":"string","description":"The name of legal form according to ISO 20275."},"abbreviation":{"type":"string","description":"The abbreviated name of the legal form, such as AG for German Aktiengesellschaft."}},"description":"A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed request parameters"}},"method":"get","path":"/v6/legal-forms","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Returns all legal forms","description":{"content":"Lists all currently known legal forms in a paginated result","type":"text/plain"},"url":{"path":["v6","legal-forms"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns all legal forms - - - -Lists all currently known legal forms in a paginated result - -
Query Parameters
- -Page of existing legal forms, may be empty - -
Schema
    content object[]
    - -Collection of results in the page - -
- -On malformed request parameters - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-site.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-site.api.mdx deleted file mode 100644 index f3303c5bdfe..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-site.api.mdx +++ /dev/null @@ -1,106 +0,0 @@ ---- -id: get-site -title: "Returns a site by its BPNS" -description: "Get business partners of type site by BPNS ignoring case." -sidebar_label: "Returns a site by its BPNS" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Site Controller"],"description":"Get business partners of type site by BPNS ignoring case.","operationId":"getSite","parameters":[{"name":"bpns","in":"path","description":"BPNS value","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Found site with specified BPNS","content":{"application/json":{"schema":{"required":["bpnLegalEntity","bpns","confidenceCriteria","createdAt","isCatenaXMemberData","mainAddress","name","states","updatedAt"],"type":"object","properties":{"bpns":{"type":"string","description":"A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located."},"name":{"type":"string","description":"The name of the site. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","description":"The list of the (temporary) states of the site.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating."}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the site is owned and thus provided by a Catena-X Member."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the site."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"mainAddress":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}},"description":"In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS."}}}},"400":{"description":"On malformed request parameters"},"404":{"description":"No site found under specified BPNS"}},"method":"get","path":"/v6/sites/{bpns}","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Returns a site by its BPNS","description":{"content":"Get business partners of type site by BPNS ignoring case.","type":"text/plain"},"url":{"path":["v6","sites",":bpns"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) BPNS value","type":"text/plain"},"type":"any","value":"","key":"bpns"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns a site by its BPNS - - - -Get business partners of type site by BPNS ignoring case. - -
Path Parameters
- -Found site with specified BPNS - -
Schema
    states object[]
    - -The list of the (temporary) states of the site. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
    mainAddress object
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- -On malformed request parameters - -
- -No site found under specified BPNS - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-sites-1.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-sites-1.api.mdx deleted file mode 100644 index 2c3503dd991..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-sites-1.api.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: get-sites-1 -title: "Returns all sites of a legal entity with a specific BPNL" -description: "Get business partners of type site belonging to a business partner of type legal entity, identified by the business partner's bpnl ignoring case." -sidebar_label: "Returns all sites of a legal entity with a specific BPNL" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Legal Entity Controller"],"description":"Get business partners of type site belonging to a business partner of type legal entity, identified by the business partner's bpnl ignoring case.","operationId":"getSites_1","parameters":[{"name":"bpnl","in":"path","description":"BPNL value","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"The sites for the specified bpnl","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpnLegalEntity","bpns","confidenceCriteria","createdAt","isCatenaXMemberData","name","states","updatedAt"],"type":"object","properties":{"bpns":{"type":"string","description":"A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located."},"name":{"type":"string","description":"The name of the site. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","description":"The list of the (temporary) states of the site.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating."}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the site is owned and thus provided by a Catena-X Member."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the site."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}}},"description":"In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"},"404":{"description":"No business partner found for specified bpnl"}},"method":"get","path":"/v6/legal-entities/{bpnl}/sites","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Returns all sites of a legal entity with a specific BPNL","description":{"content":"Get business partners of type site belonging to a business partner of type legal entity, identified by the business partner's bpnl ignoring case.","type":"text/plain"},"url":{"path":["v6","legal-entities",":bpnl","sites"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) BPNL value","type":"text/plain"},"type":"any","value":"","key":"bpnl"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns all sites of a legal entity with a specific BPNL - - - -Get business partners of type site belonging to a business partner of type legal entity, identified by the business partner's bpnl ignoring case. - -
Path Parameters
Query Parameters
- -The sites for the specified bpnl - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    - -The list of the (temporary) states of the site. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
- -On malformed pagination request - -
- -No business partner found for specified bpnl - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-sites.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-sites.api.mdx deleted file mode 100644 index cd788374eac..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/get-sites.api.mdx +++ /dev/null @@ -1,106 +0,0 @@ ---- -id: get-sites -title: "Get page of sites matching the pagination search criteria" -description: "This endpoint retrieves all existing business partners of type sites." -sidebar_label: "Get page of sites matching the pagination search criteria" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Site Controller"],"description":"This endpoint retrieves all existing business partners of type sites.","operationId":"getSites","parameters":[{"name":"siteBpns","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"legalEntityBpns","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"name","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"responses":{"200":{"description":"Page of business partners matching the search criteria, may be empty","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpnLegalEntity","bpns","confidenceCriteria","createdAt","isCatenaXMemberData","mainAddress","name","states","updatedAt"],"type":"object","properties":{"bpns":{"type":"string","description":"A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located."},"name":{"type":"string","description":"The name of the site. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","description":"The list of the (temporary) states of the site.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating."}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the site is owned and thus provided by a Catena-X Member."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the site."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"mainAddress":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}},"description":"In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"get","path":"/v6/sites","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Get page of sites matching the pagination search criteria","description":{"content":"This endpoint retrieves all existing business partners of type sites.","type":"text/plain"},"url":{"path":["v6","sites"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"siteBpns","value":""},{"disabled":false,"key":"legalEntityBpns","value":""},{"disabled":false,"key":"name","value":""},{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Get page of sites matching the pagination search criteria - - - -This endpoint retrieves all existing business partners of type sites. - -
Query Parameters
- -Page of business partners matching the search criteria, may be empty - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    - -The list of the (temporary) states of the site. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
    mainAddress object
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/post-legal-entity-search.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/post-legal-entity-search.api.mdx deleted file mode 100644 index 41d1d2e6c60..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/post-legal-entity-search.api.mdx +++ /dev/null @@ -1,126 +0,0 @@ ---- -id: post-legal-entity-search -title: "Returns legal entities by different search parameters" -description: "Search legal entity partners by their BPNLs. The response can contain less results than the number of BPNLs that were requested, if some of the BPNLs did not exist. For a single request, the maximum number of BPNLs to search for is limited to ${bpdm.bpn.search-request-limit} entries." -sidebar_label: "Returns legal entities by different search parameters" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Legal Entity Controller"],"description":"Search legal entity partners by their BPNLs. The response can contain less results than the number of BPNLs that were requested, if some of the BPNLs did not exist. For a single request, the maximum number of BPNLs to search for is limited to ${bpdm.bpn.search-request-limit} entries.","operationId":"postLegalEntitySearch","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["bpnLs"],"type":"object","properties":{"bpnLs":{"type":"array","items":{"type":"string"}},"legalName":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Found legal entites","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpnl","confidenceCriteria","createdAt","currentness","identifiers","isCatenaXMemberData","legalAddress","legalName","relations","states","updatedAt"],"type":"object","properties":{"bpnl":{"type":"string","description":"A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number."},"legalName":{"type":"string","description":"The name of the legal entity according to official registers."},"legalShortName":{"type":"string","description":"The abbreviated name of the legal entity."},"legalForm":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"The technical identifier of the legal form according to ISO 20275."},"name":{"type":"string","description":"The name of legal form according to ISO 20275."},"abbreviation":{"type":"string","description":"The abbreviated name of the legal form, such as AG for German Aktiengesellschaft."}},"description":"A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities."},"identifiers":{"type":"array","description":"The list of identifiers of the legal entity.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"DE123465789\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister."}},"description":"A legal entity identifier (uniquely) identifies the legal entity, such as the German Handelsregisternummer, a VAT number, etc."}},"states":{"type":"array","description":"The list of (temporary) states of the legal entity.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A legal entity state indicates if the legal entity is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the legal entity is still operating."}},"relations":{"type":"array","description":"Relations to other business partners.","items":{"required":["endBpnl","startBpnl","type"],"type":"object","properties":{"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["CX_LEGAL_SUCCESSOR_OF","CX_LEGAL_PREDECESSOR_OF"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"startBpnl":{"type":"string","description":"BPN of partner which is the source of the relation"},"endBpnl":{"type":"string","description":"BPN of partner which is the target of the relation"},"validFrom":{"type":"string","description":"Time when the relation started","format":"date-time"},"validTo":{"type":"string","description":"Time when the relation ended","format":"date-time"}},"description":"Directed relation between two business partners"}},"currentness":{"type":"string","description":"The date the business partner data was last indicated to be still current.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the legal entity is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"legalAddress":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}},"description":"In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed request parameters or if number of requested bpns exceeds limit"}},"method":"post","path":"/v6/legal-entities/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"bpnLs":["string"],"legalName":"string"},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Returns legal entities by different search parameters","description":{"content":"Search legal entity partners by their BPNLs. The response can contain less results than the number of BPNLs that were requested, if some of the BPNLs did not exist. For a single request, the maximum number of BPNLs to search for is limited to ${bpdm.bpn.search-request-limit} entries.","type":"text/plain"},"url":{"path":["v6","legal-entities","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns legal entities by different search parameters - - - -Search legal entity partners by their BPNLs. The response can contain less results than the number of BPNLs that were requested, if some of the BPNLs did not exist. For a single request, the maximum number of BPNLs to search for is limited to ${bpdm.bpn.search-request-limit} entries. - -
Query Parameters
Request Body required
- -Found legal entites - -
Schema
    content object[]
    - -Collection of results in the page - -
    legalForm object
    - -A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities. - -
    identifiers object[]
    - -The list of identifiers of the legal entity. - -
    type object
    - -Named type uniquely identified by its technical key - -
    states object[]
    - -The list of (temporary) states of the legal entity. - -
    type object
    - -Named type uniquely identified by its technical key - -
    relations object[]
    - -Relations to other business partners. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
    legalAddress object
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- -On malformed request parameters or if number of requested bpns exceeds limit - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/post-site-search-1.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/post-site-search-1.api.mdx deleted file mode 100644 index 01de7381490..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/post-site-search-1.api.mdx +++ /dev/null @@ -1,102 +0,0 @@ ---- -id: post-site-search-1 -title: "postSiteSearch_1" -description: "postSiteSearch_1" -sidebar_label: "postSiteSearch_1" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Site Controller"],"operationId":"postSiteSearch_1","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["legalEntityBpns","siteBpns"],"type":"object","properties":{"siteBpns":{"type":"array","items":{"type":"string"}},"legalEntityBpns":{"type":"array","items":{"type":"string"}},"name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpnLegalEntity","bpns","confidenceCriteria","createdAt","isCatenaXMemberData","mainAddress","name","states","updatedAt"],"type":"object","properties":{"bpns":{"type":"string","description":"A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located."},"name":{"type":"string","description":"The name of the site. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","description":"The list of the (temporary) states of the site.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating."}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the site is owned and thus provided by a Catena-X Member."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the site."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"mainAddress":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}},"description":"In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS."}}},"description":"Paginated collection of results"}}}}},"description":"postSiteSearch_1","method":"post","path":"/v6/members/sites/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"siteBpns":["string"],"legalEntityBpns":["string"],"name":"string"},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"post Site Search 1","description":{"type":"text/plain"},"url":{"path":["v6","members","sites","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## postSiteSearch_1 - - - -postSiteSearch_1 - -
Query Parameters
Request Body required
- -OK - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    - -The list of the (temporary) states of the site. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
    mainAddress object
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/post-site-search.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/post-site-search.api.mdx deleted file mode 100644 index aabfe790b34..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/post-site-search.api.mdx +++ /dev/null @@ -1,106 +0,0 @@ ---- -id: post-site-search -title: "Returns sites by an array of BPNS and/or an array of corresponding BPNL" -description: "Search business partners of type site by their BPNSs or by the BPNLs of their parent legal entities" -sidebar_label: "Returns sites by an array of BPNS and/or an array of corresponding BPNL" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Site Controller"],"description":"Search business partners of type site by their BPNSs or by the BPNLs of their parent legal entities","operationId":"postSiteSearch","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["legalEntityBpns","siteBpns"],"type":"object","properties":{"siteBpns":{"type":"array","items":{"type":"string"}},"legalEntityBpns":{"type":"array","items":{"type":"string"}},"name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Found sites that belong to specified legal entites","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpnLegalEntity","bpns","confidenceCriteria","createdAt","isCatenaXMemberData","mainAddress","name","states","updatedAt"],"type":"object","properties":{"bpns":{"type":"string","description":"A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located."},"name":{"type":"string","description":"The name of the site. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","description":"The list of the (temporary) states of the site.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating."}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the site is owned and thus provided by a Catena-X Member."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the site."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"mainAddress":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}},"description":"In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed request parameters"}},"method":"post","path":"/v6/sites/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"siteBpns":["string"],"legalEntityBpns":["string"],"name":"string"},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Returns sites by an array of BPNS and/or an array of corresponding BPNL","description":{"content":"Search business partners of type site by their BPNSs or by the BPNLs of their parent legal entities","type":"text/plain"},"url":{"path":["v6","sites","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns sites by an array of BPNS and/or an array of corresponding BPNL - - - -Search business partners of type site by their BPNSs or by the BPNLs of their parent legal entities - -
Query Parameters
Request Body required
- -Found sites that belong to specified legal entites - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    - -The list of the (temporary) states of the site. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
    mainAddress object
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- -On malformed request parameters - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/search-addresses-1.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/search-addresses-1.api.mdx deleted file mode 100644 index 0120b89f14e..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/search-addresses-1.api.mdx +++ /dev/null @@ -1,94 +0,0 @@ ---- -id: search-addresses-1 -title: "Returns addresses by an array of BPNA and/or an array of corresponding BPNS and/or an array of corresponding BPNL." -description: "Search business partners of type address by their BPNA or their parents' BPNL or BPNS." -sidebar_label: "Returns addresses by an array of BPNA and/or an array of corresponding BPNS and/or an array of corresponding BPNL." -hide_title: true -hide_table_of_contents: true -api: {"tags":["Address Controller"],"description":"Search business partners of type address by their BPNA or their parents' BPNL or BPNS.","operationId":"searchAddresses_1","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["addressBpns","legalEntityBpns","siteBpns"],"type":"object","properties":{"addressBpns":{"type":"array","items":{"type":"string"}},"legalEntityBpns":{"type":"array","items":{"type":"string"}},"siteBpns":{"type":"array","items":{"type":"string"}},"name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"Found sites for the specified sites and legal entities","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}}},"description":"Paginated collection of results"}}}},"400":{"description":"On malformed pagination request"}},"method":"post","path":"/v6/addresses/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"addressBpns":["string"],"legalEntityBpns":["string"],"siteBpns":["string"],"name":"string"},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Returns addresses by an array of BPNA and/or an array of corresponding BPNS and/or an array of corresponding BPNL.","description":{"content":"Search business partners of type address by their BPNA or their parents' BPNL or BPNS.","type":"text/plain"},"url":{"path":["v6","addresses","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns addresses by an array of BPNA and/or an array of corresponding BPNS and/or an array of corresponding BPNL. - - - -Search business partners of type address by their BPNA or their parents' BPNL or BPNS. - -
Query Parameters
Request Body required
- -Found sites for the specified sites and legal entities - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- -On malformed pagination request - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/search-addresses.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/search-addresses.api.mdx deleted file mode 100644 index 49c24fd70b7..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/search-addresses.api.mdx +++ /dev/null @@ -1,90 +0,0 @@ ---- -id: search-addresses -title: "searchAddresses" -description: "searchAddresses" -sidebar_label: "searchAddresses" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Address Controller"],"operationId":"searchAddresses","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["addressBpns","legalEntityBpns","siteBpns"],"type":"object","properties":{"addressBpns":{"type":"array","items":{"type":"string"}},"legalEntityBpns":{"type":"array","items":{"type":"string"}},"siteBpns":{"type":"array","items":{"type":"string"}},"name":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}}},"description":"Paginated collection of results"}}}}},"description":"searchAddresses","method":"post","path":"/v6/members/addresses/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"addressBpns":["string"],"legalEntityBpns":["string"],"siteBpns":["string"],"name":"string"},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"search Addresses","description":{"type":"text/plain"},"url":{"path":["v6","members","addresses","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## searchAddresses - - - -searchAddresses - -
Query Parameters
Request Body required
- -OK - -
Schema
    content object[]
    - -Collection of results in the page - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/search-changelog-entries.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/search-changelog-entries.api.mdx deleted file mode 100644 index 5289106fcd9..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/search-changelog-entries.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: search-changelog-entries -title: "searchChangelogEntries" -description: "searchChangelogEntries" -sidebar_label: "searchChangelogEntries" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Changelog Controller"],"operationId":"searchChangelogEntries","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"timestampAfter":{"type":"string","description":"Only changelog entries created after this time. Ignored if empty.","format":"date-time","example":"2023-03-20T10:23:28.194Z"},"bpns":{"uniqueItems":true,"type":"array","description":"Only for business partners with the given array of BPNL/S/A. Ignored if empty.","items":{"type":"string"}},"businessPartnerTypes":{"uniqueItems":true,"type":"array","description":"Only for business partners with the given array of business partner types. Ignored if empty.","items":{"type":"string","enum":["LEGAL_ENTITY","SITE","ADDRESS","GENERIC"]}}},"description":"Request for searching and filtering the business partner changelog"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpn","businessPartnerType","changelogType","timestamp"],"type":"object","properties":{"bpn":{"type":"string","description":"The business partner number for which the changelog entry was created. Can be either a BPNL, BPNS or BPNA."},"businessPartnerType":{"type":"string","description":"One of the types of business partners for which the changelog entry was created: legal entity, site, address.","enum":["LEGAL_ENTITY","SITE","ADDRESS","GENERIC"]},"timestamp":{"type":"string","description":"The date and time when the changelog entry was created.","format":"date-time"},"changelogType":{"type":"string","description":"One of the actions for which the changelog entry was created: create, update.","enum":["CREATE","UPDATE"]}},"description":"An entry of the changelog, which is created each time a business partner is modified and contains data about the change. The actual new state of the business partner is not included."}}},"description":"Paginated collection of results"}}}}},"description":"searchChangelogEntries","method":"post","path":"/v6/members/changelog/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"timestampAfter":"2023-03-20T10:23:28.194Z","bpns":["string"],"businessPartnerTypes":["LEGAL_ENTITY"]},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"search Changelog Entries","description":{"type":"text/plain"},"url":{"path":["v6","members","changelog","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## searchChangelogEntries - - - -searchChangelogEntries - -
Query Parameters
Request Body required
- -OK - -
Schema
    content object[]
    - -Collection of results in the page - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/search-legal-entities.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/search-legal-entities.api.mdx deleted file mode 100644 index b4ee34ff2ce..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/search-legal-entities.api.mdx +++ /dev/null @@ -1,122 +0,0 @@ ---- -id: search-legal-entities -title: "searchLegalEntities" -description: "searchLegalEntities" -sidebar_label: "searchLegalEntities" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Legal Entity Controller"],"operationId":"searchLegalEntities","parameters":[{"name":"page","in":"query","description":"Number of page to get results from","required":false,"schema":{"minimum":0,"type":"string","default":"0"}},{"name":"size","in":"query","description":"Size of each page","required":false,"schema":{"maximum":100,"minimum":0,"type":"string","default":"10"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["bpnLs"],"type":"object","properties":{"bpnLs":{"type":"array","items":{"type":"string"}},"legalName":{"type":"string"}}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"required":["content","contentSize","page","totalElements","totalPages"],"type":"object","properties":{"totalElements":{"type":"integer","description":"Total number of all results in all pages","format":"int64"},"totalPages":{"type":"integer","description":"Total number pages","format":"int32"},"page":{"type":"integer","description":"Current page number","format":"int32"},"contentSize":{"type":"integer","description":"Number of results in the page","format":"int32"},"content":{"type":"array","description":"Collection of results in the page","items":{"required":["bpnl","confidenceCriteria","createdAt","currentness","identifiers","isCatenaXMemberData","legalAddress","legalName","relations","states","updatedAt"],"type":"object","properties":{"bpnl":{"type":"string","description":"A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number."},"legalName":{"type":"string","description":"The name of the legal entity according to official registers."},"legalShortName":{"type":"string","description":"The abbreviated name of the legal entity."},"legalForm":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"The technical identifier of the legal form according to ISO 20275."},"name":{"type":"string","description":"The name of legal form according to ISO 20275."},"abbreviation":{"type":"string","description":"The abbreviated name of the legal form, such as AG for German Aktiengesellschaft."}},"description":"A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities."},"identifiers":{"type":"array","description":"The list of identifiers of the legal entity.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"DE123465789\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister."}},"description":"A legal entity identifier (uniquely) identifies the legal entity, such as the German Handelsregisternummer, a VAT number, etc."}},"states":{"type":"array","description":"The list of (temporary) states of the legal entity.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A legal entity state indicates if the legal entity is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the legal entity is still operating."}},"relations":{"type":"array","description":"Relations to other business partners.","items":{"required":["endBpnl","startBpnl","type"],"type":"object","properties":{"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["CX_LEGAL_SUCCESSOR_OF","CX_LEGAL_PREDECESSOR_OF"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"startBpnl":{"type":"string","description":"BPN of partner which is the source of the relation"},"endBpnl":{"type":"string","description":"BPN of partner which is the target of the relation"},"validFrom":{"type":"string","description":"Time when the relation started","format":"date-time"},"validTo":{"type":"string","description":"Time when the relation ended","format":"date-time"}},"description":"Directed relation between two business partners"}},"currentness":{"type":"string","description":"The date the business partner data was last indicated to be still current.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the legal entity is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"legalAddress":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}},"description":"In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL."}}},"description":"Paginated collection of results"}}}}},"description":"searchLegalEntities","method":"post","path":"/v6/members/legal-entities/search","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":{"bpnLs":["string"],"legalName":"string"},"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"search Legal Entities","description":{"type":"text/plain"},"url":{"path":["v6","members","legal-entities","search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of page to get results from","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"Size of each page","type":"text/plain"},"key":"size","value":""}],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## searchLegalEntities - - - -searchLegalEntities - -
Query Parameters
Request Body required
- -OK - -
Schema
    content object[]
    - -Collection of results in the page - -
    legalForm object
    - -A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities. - -
    identifiers object[]
    - -The list of identifiers of the legal entity. - -
    type object
    - -Named type uniquely identified by its technical key - -
    states object[]
    - -The list of (temporary) states of the legal entity. - -
    type object
    - -Named type uniquely identified by its technical key - -
    relations object[]
    - -Relations to other business partners. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
    legalAddress object
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/sidebar.js b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/sidebar.js deleted file mode 100644 index 9fdefa5596e..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool"},{"type":"category","label":"Changelog Controller","link":{"type":"generated-index","title":"Changelog Controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/changelog-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/search-changelog-entries","label":"searchChangelogEntries","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-changelog-entries","label":"Returns changelog entries as of a specified timestamp, optionally filtered by a list of BPNL/S/A, or business partner types","className":"api-method post"}]},{"type":"category","label":"Legal Entity Controller","link":{"type":"generated-index","title":"Legal Entity Controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/legal-entity-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entities","label":"Returns legal entities by different search parameters","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/update-business-partners","label":"Updates an existing legal entity","className":"api-method put"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/create-business-partners","label":"Creates a new legal entity","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/search-legal-entities","label":"searchLegalEntities","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/post-legal-entity-search","label":"Returns legal entities by different search parameters","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity","label":"Returns a legal entity by identifier, like BPN, DUNS or EU VAT ID, specified by the identifier type","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-sites-1","label":"Returns all sites of a legal entity with a specific BPNL","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-addresses","label":"Returns all addresses of a legal entity with a specific BPNL","className":"api-method get"}]},{"type":"category","label":"Metadata Controller","link":{"type":"generated-index","title":"Metadata Controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/metadata-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-legal-forms","label":"Returns all legal forms","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/create-legal-form","label":"Creates a new legal form","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-types","label":"Returns all identifier types filtered by business partner type and country.","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-type","label":"Creates a new identifier type","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-field-quality-rules","label":"Get all field quality rules filtered by country (specified by its ISO 3166-1 alpha-2 country code)","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-admin-areas-level-1","label":"Get page of country subdivisions suitable for the administrativeAreaLevel1 address property","className":"api-method get"}]},{"type":"category","label":"Site Controller","link":{"type":"generated-index","title":"Site Controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/site-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-sites","label":"Get page of sites matching the pagination search criteria","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/update-site","label":"Updates an existing site","className":"api-method put"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/create-site","label":"Creates a new site","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/post-site-search","label":"Returns sites by an array of BPNS and/or an array of corresponding BPNL","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/post-site-search-1","label":"postSiteSearch_1","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-site","label":"Returns a site by its BPNS","className":"api-method get"}]},{"type":"category","label":"Bpn Controller","link":{"type":"generated-index","title":"Bpn Controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/bpn-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/find-bpns-by-identifiers","label":"Returns a list of identifier mappings of an identifier to a BPNL/A/S, specified by a business partner type, identifier type and identifier values","className":"api-method post"}]},{"type":"category","label":"Address Controller","link":{"type":"generated-index","title":"Address Controller","slug":"/category/kits/Business Partner Kit/Software Development View/Pool Api/address-controller"},"items":[{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-addresses-1","label":"Returns addresses by different search parameters","className":"api-method get"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/update-addresses","label":"Updates an existing address","className":"api-method put"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/create-addresses","label":"Creates a new address","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/search-addresses","label":"searchAddresses","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/search-addresses-1","label":"Returns addresses by an array of BPNA and/or an array of corresponding BPNS and/or an array of corresponding BPNL.","className":"api-method post"},{"type":"doc","id":"kits/Business Partner Kit/Software Development View/Pool Api/get-address","label":"Returns an address by its BPNA","className":"api-method get"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/update-addresses.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/update-addresses.api.mdx deleted file mode 100644 index fd662e8886b..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/update-addresses.api.mdx +++ /dev/null @@ -1,118 +0,0 @@ ---- -id: update-addresses -title: "Updates an existing address" -description: "Update existing business partner records of type address referenced via BPNA. The endpoint expects to receive the full updated record, including values that didn't change." -sidebar_label: "Updates an existing address" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Address Controller"],"description":"Update existing business partner records of type address referenced via BPNA. The endpoint expects to receive the full updated record, including values that didn't change.","operationId":"updateAddresses","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"required":["bpna","confidenceCriteria","identifiers","physicalPostalAddress","requestKey","states"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"type":"string","description":"One of the state types: active, inactive.","enum":["ACTIVE","INACTIVE"]}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"type":"string","description":"The type of the identifier."}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"requestKey":{"type":"string"}},"description":"Request for updating a business partner record of type address. In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}}}},"required":true},"responses":{"200":{"description":"The successfully updated records, possible errors are returned","content":{"application/json":{"schema":{"required":["entities","entityCount","errorCount","errors"],"type":"object","properties":{"entities":{"type":"array","items":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."}},"errors":{"type":"array","items":{"title":"ErrorInfo","required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string","description":"AddressUpdateError","enum":["AddressNotFound","RegionNotFound","IdentifierNotFound","AddressDuplicateIdentifier"]},"message":{"type":"string","description":"Error message that explains the error"},"entityKey":{"type":"string","description":"Key of the entity that failed from the request object: index or BPN"}},"description":"Holds information about failures when creating or updating an entity"}},"entityCount":{"type":"integer","format":"int32"},"errorCount":{"type":"integer","format":"int32"}},"description":"Holds information about successfully and failed entities after the creating/updating of several objects"}}}},"400":{"description":"On malformed requests"}},"method":"put","path":"/v6/addresses","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":[{"bpna":"string","name":"string","states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"identifiers":[{"value":"string","type":"string"}],"physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-05-15","nextConfidenceCheckAt":"2024-05-15","confidenceLevel":0},"requestKey":"string"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Updates an existing address","description":{"content":"Update existing business partner records of type address referenced via BPNA. The endpoint expects to receive the full updated record, including values that didn't change.","type":"text/plain"},"url":{"path":["v6","addresses"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Updates an existing address - - - -Update existing business partner records of type address referenced via BPNA. The endpoint expects to receive the full updated record, including values that didn't change. - -
Request Body array required
    states object[] required
    - -The list of (temporary) states of the address. - -
    identifiers object[] required
    - -The list of identifiers of the address. - -
    physicalPostalAddress object required
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    confidenceCriteria object required
- -The successfully updated records, possible errors are returned - -
Schema
    entities object[]
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
    errors object[]
- -On malformed requests - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/update-business-partners.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/update-business-partners.api.mdx deleted file mode 100644 index 71840bb1070..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/update-business-partners.api.mdx +++ /dev/null @@ -1,162 +0,0 @@ ---- -id: update-business-partners -title: "Updates an existing legal entity" -description: "Update existing business partner records of type legal entity referenced via BPNL. The endpoint expects to receive the full updated record, including values that didn't change." -sidebar_label: "Updates an existing legal entity" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Legal Entity Controller"],"description":"Update existing business partner records of type legal entity referenced via BPNL. The endpoint expects to receive the full updated record, including values that didn't change.","operationId":"updateBusinessPartners","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"required":["bpnl","confidenceCriteria","identifiers","isCatenaXMemberData","legalAddress","legalName","requestKey","states"],"type":"object","properties":{"bpnl":{"type":"string","description":"A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number."},"legalName":{"type":"string","description":"The name of the legal entity according to official registers."},"legalShortName":{"type":"string","description":"The abbreviated name of the legal entity."},"legalForm":{"type":"string","description":"The legal form of the legal entity."},"identifiers":{"type":"array","description":"The list of identifiers of the legal entity.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"DE123465789\"."},"type":{"type":"string","description":"The type of the identifier."},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister."}},"description":"A legal entity identifier (uniquely) identifies the legal entity, such as the German Handelsregisternummer, a VAT number, etc."}},"states":{"type":"array","description":"The list of (temporary) states of the legal entity.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"type":"string","description":"One of the state types: active, inactive.","enum":["ACTIVE","INACTIVE"]}},"description":"A legal entity state indicates if the legal entity is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the legal entity is still operating."}},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the legal entity is owned and thus provided by a Catena-X Member."},"legalAddress":{"required":["confidenceCriteria","identifiers","physicalPostalAddress","states"],"type":"object","properties":{"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"type":"string","description":"One of the state types: active, inactive.","enum":["ACTIVE","INACTIVE"]}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"type":"string","description":"The type of the identifier."}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."},"requestKey":{"type":"string"}},"description":"Request for updating a business partner record of type legal entity. In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL."}}}},"required":true},"responses":{"200":{"description":"Update legal entities request was processed successfully, possible errors are returned","content":{"application/json":{"schema":{"required":["entities","entityCount","errorCount","errors"],"type":"object","properties":{"entities":{"type":"array","items":{"required":["bpnl","confidenceCriteria","createdAt","currentness","identifiers","isCatenaXMemberData","legalAddress","legalName","relations","states","updatedAt"],"type":"object","properties":{"bpnl":{"type":"string","description":"A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number."},"legalName":{"type":"string","description":"The name of the legal entity according to official registers."},"legalShortName":{"type":"string","description":"The abbreviated name of the legal entity."},"legalForm":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"The technical identifier of the legal form according to ISO 20275."},"name":{"type":"string","description":"The name of legal form according to ISO 20275."},"abbreviation":{"type":"string","description":"The abbreviated name of the legal form, such as AG for German Aktiengesellschaft."}},"description":"A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities."},"identifiers":{"type":"array","description":"The list of identifiers of the legal entity.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"DE123465789\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"issuingBody":{"type":"string","description":"The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister."}},"description":"A legal entity identifier (uniquely) identifies the legal entity, such as the German Handelsregisternummer, a VAT number, etc."}},"states":{"type":"array","description":"The list of (temporary) states of the legal entity.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A legal entity state indicates if the legal entity is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the legal entity is still operating."}},"relations":{"type":"array","description":"Relations to other business partners.","items":{"required":["endBpnl","startBpnl","type"],"type":"object","properties":{"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["CX_LEGAL_SUCCESSOR_OF","CX_LEGAL_PREDECESSOR_OF"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"startBpnl":{"type":"string","description":"BPN of partner which is the source of the relation"},"endBpnl":{"type":"string","description":"BPN of partner which is the target of the relation"},"validFrom":{"type":"string","description":"Time when the relation started","format":"date-time"},"validTo":{"type":"string","description":"Time when the relation ended","format":"date-time"}},"description":"Directed relation between two business partners"}},"currentness":{"type":"string","description":"The date the business partner data was last indicated to be still current.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the legal entity is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"legalAddress":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."},"index":{"type":"string","description":"User defined index to conveniently match this entry to the corresponding entry in the response."}},"description":"Created/updated business partner of type legal entity. In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL."}},"errors":{"type":"array","items":{"title":"ErrorInfo","required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string","description":"LegalEntityUpdateError","enum":["LegalEntityNotFound","LegalEntityDuplicateIdentifier","LegalFormNotFound","LegalEntityIdentifierNotFound","LegalAddressRegionNotFound","LegalAddressIdentifierNotFound","LegalAddressDuplicateIdentifier","LegalEntityErrorMapping"]},"message":{"type":"string","description":"Error message that explains the error"},"entityKey":{"type":"string","description":"Key of the entity that failed from the request object: index or BPN"}},"description":"Holds information about failures when creating or updating an entity"}},"entityCount":{"type":"integer","format":"int32"},"errorCount":{"type":"integer","format":"int32"}},"description":"Holds information about successfully and failed entities after the creating/updating of several objects"}}}},"400":{"description":"On malformed requests"}},"method":"put","path":"/v6/legal-entities","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":[{"bpnl":"string","legalName":"string","legalShortName":"string","legalForm":"string","identifiers":[{"value":"string","type":"string","issuingBody":"string"}],"states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-05-15","nextConfidenceCheckAt":"2024-05-15","confidenceLevel":0},"isCatenaXMemberData":true,"legalAddress":{"name":"string","states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"identifiers":[{"value":"string","type":"string"}],"physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-05-15","nextConfidenceCheckAt":"2024-05-15","confidenceLevel":0}},"requestKey":"string"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Updates an existing legal entity","description":{"content":"Update existing business partner records of type legal entity referenced via BPNL. The endpoint expects to receive the full updated record, including values that didn't change.","type":"text/plain"},"url":{"path":["v6","legal-entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Updates an existing legal entity - - - -Update existing business partner records of type legal entity referenced via BPNL. The endpoint expects to receive the full updated record, including values that didn't change. - -
Request Body array required
    identifiers object[] required
    - -The list of identifiers of the legal entity. - -
    states object[] required
    - -The list of (temporary) states of the legal entity. - -
    confidenceCriteria object required
    legalAddress object required
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[] required
    - -The list of (temporary) states of the address. - -
    identifiers object[] required
    - -The list of identifiers of the address. - -
    physicalPostalAddress object required
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    confidenceCriteria object required
- -Update legal entities request was processed successfully, possible errors are returned - -
Schema
    entities object[]
    legalForm object
    - -A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities. - -
    identifiers object[]
    - -The list of identifiers of the legal entity. - -
    type object
    - -Named type uniquely identified by its technical key - -
    states object[]
    - -The list of (temporary) states of the legal entity. - -
    type object
    - -Named type uniquely identified by its technical key - -
    relations object[]
    - -Relations to other business partners. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
    legalAddress object
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
    errors object[]
- -On malformed requests - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/update-site.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/update-site.api.mdx deleted file mode 100644 index 7ebcd175a12..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Pool Api/update-site.api.mdx +++ /dev/null @@ -1,138 +0,0 @@ ---- -id: update-site -title: "Updates an existing site" -description: "Update existing business partner records of type site referenced via BPNS. The endpoint expects to receive the full updated record, including values that didn't change." -sidebar_label: "Updates an existing site" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Site Controller"],"description":"Update existing business partner records of type site referenced via BPNS. The endpoint expects to receive the full updated record, including values that didn't change.","operationId":"updateSite","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"required":["bpns","confidenceCriteria","mainAddress","name","requestKey","states"],"type":"object","properties":{"bpns":{"type":"string","description":"A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located."},"name":{"type":"string","description":"The name of the site. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","description":"The list of the (temporary) states of the site.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"type":"string","description":"One of the state types: active, inactive.","enum":["ACTIVE","INACTIVE"]}},"description":"A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating."}},"mainAddress":{"required":["confidenceCriteria","identifiers","physicalPostalAddress","states"],"type":"object","properties":{"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"type":"string","description":"One of the state types: active, inactive.","enum":["ACTIVE","INACTIVE"]}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"type":"string","description":"The type of the identifier."}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"type":"string","description":"The 2-digit country code of the physical postal address according to ISO 3166-1.","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"administrativeAreaLevel1":{"type":"string","description":"The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"requestKey":{"type":"string"}},"description":"Request for updating a business partner record of type site. In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS."}}}},"required":true},"responses":{"200":{"description":"Update sites request was processed successfully, possible errors are returned","content":{"application/json":{"schema":{"required":["entities","entityCount","errorCount","errors"],"type":"object","properties":{"entities":{"type":"array","items":{"required":["bpnLegalEntity","bpns","confidenceCriteria","createdAt","isCatenaXMemberData","mainAddress","name","states","updatedAt"],"type":"object","properties":{"bpns":{"type":"string","description":"A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located."},"name":{"type":"string","description":"The name of the site. This is not according to official registers but according to the name the owner chooses."},"states":{"type":"array","description":"The list of the (temporary) states of the site.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating."}},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the site is owned and thus provided by a Catena-X Member."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the site."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"mainAddress":{"required":["bpna","confidenceCriteria","createdAt","identifiers","isCatenaXMemberData","physicalPostalAddress","states","updatedAt"],"type":"object","properties":{"bpna":{"type":"string","description":"A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity."},"name":{"type":"string","description":"The name of the address. This is not according to official registers but according to the name the sharing member chooses."},"states":{"type":"array","description":"The list of (temporary) states of the address.","items":{"required":["type"],"type":"object","properties":{"validFrom":{"type":"string","description":"The date from which the state is valid.","format":"date-time"},"validTo":{"type":"string","description":"The date until the state is valid.","format":"date-time"},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["ACTIVE","INACTIVE"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address."}},"identifiers":{"type":"array","description":"The list of identifiers of the address.","items":{"required":["type","value"],"type":"object","properties":{"value":{"type":"string","description":"The value of the identifier like \"0847976000005\"."},"type":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference"},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"}},"description":"An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)."}},"physicalPostalAddress":{"required":["city","country"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"administrativeAreaLevel2":{"type":"string","description":"The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country."},"administrativeAreaLevel3":{"type":"string","description":"The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country."},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"district":{"type":"string","description":"The name of the district of the physical postal address which divides the city in several smaller areas."},"street":{"type":"object","properties":{"name":{"type":"string","description":"The name of the street."},"houseNumber":{"type":"string","description":"The number representing the exact location of a building within the street."},"houseNumberSupplement":{"type":"string"},"milestone":{"type":"string","description":"The number representing the exact location of an addressed object within a street without house numbers, such as within long roads."},"direction":{"type":"string","description":"The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South."},"namePrefix":{"type":"string","description":"The street related information, which is usually printed before the official street name on an address label."},"additionalNamePrefix":{"type":"string","description":"The additional street related information, which is usually printed before the official street name on an address label."},"nameSuffix":{"type":"string","description":"The street related information, which is usually printed after the official street name on an address label."},"additionalNameSuffix":{"type":"string","description":"The additional street related information, which is usually printed after the official street name on an address label."}},"description":"The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway"},"companyPostalCode":{"type":"string","description":"The company postal code of the physical postal address, which is sometimes required for large companies."},"industrialZone":{"type":"string","description":"The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area."},"building":{"type":"string","description":"The alphanumeric identifier of the building addressed by the physical postal address."},"floor":{"type":"string","description":"The number of a floor in the building addressed by the physical postal address, synonym: level."},"door":{"type":"string","description":"The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite."}},"description":"A physical postal address describes the physical location of an office, warehouse, gate, etc."},"alternativePostalAddress":{"required":["city","country","deliveryServiceNumber","deliveryServiceType"],"type":"object","properties":{"geographicCoordinates":{"required":["latitude","longitude"],"type":"object","properties":{"longitude":{"type":"number","description":"Longitude coordinate","format":"float"},"latitude":{"type":"number","description":"Latitude coordinate","format":"float"},"altitude":{"type":"number","description":"Altitude, if applicable","format":"float"}},"description":"The exact location of the physical postal address in latitude, longitude, and altitude."},"country":{"required":["name","technicalKey"],"type":"object","properties":{"technicalKey":{"type":"string","description":"Unique key of this type for reference","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"name":{"type":"string","description":"Name or denotation of this type"}},"description":"Named type uniquely identified by its technical key"},"administrativeAreaLevel1":{"required":["countryCode","regionCode","regionName"],"type":"object","properties":{"countryCode":{"type":"string","description":"Country code","enum":["UNDEFINED","AC","AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BU","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CP","CR","CS","CU","CV","CW","CX","CY","CZ","DE","DG","DJ","DK","DM","DO","DZ","EA","EC","EE","EG","EH","ER","ES","ET","EU","EZ","FI","FJ","FK","FM","FO","FR","FX","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NT","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SF","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SU","SV","SX","SY","SZ","TA","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TP","TR","TT","TV","TW","TZ","UA","UG","UK","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XI","XU","XK","YE","YT","YU","ZA","ZM","ZR","ZW"]},"regionCode":{"type":"string","description":"Abbreviation or shorthand of the area"},"regionName":{"type":"string","description":"Describes the full name of the region within a country according to ISO 3166-214"}},"description":"Region within a country"},"postalCode":{"type":"string","description":"The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code."},"city":{"type":"string","description":"The name of the city of the physical postal address, synonyms: town, village, municipality."},"deliveryServiceType":{"type":"string","description":"One of the alternative postal address types: P.O. box, private bag, boite postale.","enum":["PO_BOX","PRIVATE_BAG","BOITE_POSTALE"]},"deliveryServiceQualifier":{"type":"string","description":"The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities."},"deliveryServiceNumber":{"type":"string","description":"The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number."}},"description":"An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else."},"bpnLegalEntity":{"type":"string","description":"The BPNL of the legal entity owning the address."},"bpnSite":{"type":"string","description":"The BPNS of the site the address belongs to."},"isCatenaXMemberData":{"type":"boolean","description":"Indicates whether the address is owned and thus provided by a Catena-X Member."},"createdAt":{"type":"string","description":"The date when the data record has been created.","format":"date-time"},"updatedAt":{"type":"string","description":"The date when the data record has been last updated.","format":"date-time"},"confidenceCriteria":{"required":["checkedByExternalDataSource","confidenceLevel","lastConfidenceCheckAt","nextConfidenceCheckAt","numberOfSharingMembers","sharedByOwner"],"type":"object","properties":{"sharedByOwner":{"type":"boolean"},"checkedByExternalDataSource":{"type":"boolean"},"numberOfSharingMembers":{"type":"integer","format":"int32"},"lastConfidenceCheckAt":{"type":"string","format":"date-time"},"nextConfidenceCheckAt":{"type":"string","format":"date-time"},"confidenceLevel":{"type":"integer","format":"int32"}}},"addressType":{"type":"string","description":"Indicates the address type, the legal address to a legal entity or the main address to a site, an additional address, or both legal and site address.The site main address is where typically the main entrance or the reception is located, or where the mail is delivered to.","enum":["LegalAndSiteMainAddress","LegalAddress","SiteMainAddress","AdditionalAddress"]}},"description":"In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA."},"index":{"type":"string","description":"User defined index to conveniently match this entry to the corresponding entry in the response."}},"description":"Created/updated business partner of type site. In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS."}},"errors":{"type":"array","items":{"title":"ErrorInfo","required":["errorCode","message"],"type":"object","properties":{"errorCode":{"type":"string","description":"SiteUpdateError","enum":["SiteNotFound","MainAddressIdentifierNotFound","MainAddressRegionNotFound","MainAddressDuplicateIdentifier"]},"message":{"type":"string","description":"Error message that explains the error"},"entityKey":{"type":"string","description":"Key of the entity that failed from the request object: index or BPN"}},"description":"Holds information about failures when creating or updating an entity"}},"entityCount":{"type":"integer","format":"int32"},"errorCount":{"type":"integer","format":"int32"}},"description":"Holds information about successfully and failed entities after the creating/updating of several objects"}}}},"400":{"description":"On malformed requests"}},"method":"put","path":"/v6/sites","servers":[{"url":"http://localhost:8080","description":"Generated server url"}],"jsonRequestBodyExample":[{"bpns":"string","name":"string","states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"mainAddress":{"name":"string","states":[{"validFrom":"2024-05-15","validTo":"2024-05-15","type":"ACTIVE"}],"identifiers":[{"value":"string","type":"string"}],"physicalPostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","administrativeAreaLevel2":"string","administrativeAreaLevel3":"string","postalCode":"string","city":"string","district":"string","street":{"name":"string","houseNumber":"string","houseNumberSupplement":"string","milestone":"string","direction":"string","namePrefix":"string","additionalNamePrefix":"string","nameSuffix":"string","additionalNameSuffix":"string"},"companyPostalCode":"string","industrialZone":"string","building":"string","floor":"string","door":"string"},"alternativePostalAddress":{"geographicCoordinates":{"longitude":0,"latitude":0,"altitude":0},"country":"UNDEFINED","administrativeAreaLevel1":"string","postalCode":"string","city":"string","deliveryServiceType":"PO_BOX","deliveryServiceQualifier":"string","deliveryServiceNumber":"string"},"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-05-15","nextConfidenceCheckAt":"2024-05-15","confidenceLevel":0}},"confidenceCriteria":{"sharedByOwner":true,"checkedByExternalDataSource":true,"numberOfSharingMembers":0,"lastConfidenceCheckAt":"2024-05-15","nextConfidenceCheckAt":"2024-05-15","confidenceLevel":0},"requestKey":"string"}],"info":{"title":"Business Partner Data Management Pool","description":"Service that manages and shares business partner data with other CatenaX services","version":"6.0.0"},"postman":{"name":"Updates an existing site","description":{"content":"Update existing business partner records of type site referenced via BPNS. The endpoint expects to receive the full updated record, including values that didn't change.","type":"text/plain"},"url":{"path":["v6","sites"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Updates an existing site - - - -Update existing business partner records of type site referenced via BPNS. The endpoint expects to receive the full updated record, including values that didn't change. - -
Request Body array required
    states object[] required
    - -The list of the (temporary) states of the site. - -
    mainAddress object required
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[] required
    - -The list of (temporary) states of the address. - -
    identifiers object[] required
    - -The list of identifiers of the address. - -
    physicalPostalAddress object required
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    confidenceCriteria object required
    confidenceCriteria object required
- -Update sites request was processed successfully, possible errors are returned - -
Schema
    entities object[]
    states object[]
    - -The list of the (temporary) states of the site. - -
    type object
    - -Named type uniquely identified by its technical key - -
    confidenceCriteria object
    mainAddress object
    - -In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. - -
    states object[]
    - -The list of (temporary) states of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    identifiers object[]
    - -The list of identifiers of the address. - -
    type object
    - -Named type uniquely identified by its technical key - -
    physicalPostalAddress object
    - -A physical postal address describes the physical location of an office, warehouse, gate, etc. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    street object
    - -The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway - -
    alternativePostalAddress object
    - -An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. - -
    geographicCoordinates object
    - -The exact location of the physical postal address in latitude, longitude, and altitude. - -
    country object
    - -Named type uniquely identified by its technical key - -
    administrativeAreaLevel1 object
    - -Region within a country - -
    confidenceCriteria object
    errors object[]
- -On malformed requests - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/page_software-operation-view.md b/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/page_software-operation-view.md deleted file mode 100644 index cfdf08071df..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/page_software-operation-view.md +++ /dev/null @@ -1,584 +0,0 @@ ---- -id: Operation View -title: Operation View -description: 'Business Partner Kit' -sidebar_position: 3 ---- - -![Business partner kit banner](/img/kit-icons/bp-kit-icon.svg) - -### Business Partner KIT - -## Local Deployment - -BPDM is an acronym for business partner data management. This project provides core services for querying, adding and changing business partner base information in the Eclipse Tractus-X landscape. BPDM project is SpringBoot Kotlin software project managed by Maven and consists of three microservices. This section contains information on how to configure and run the BPDM application. - -This local deployment is an easy installation with helm. This setup is built to run on a kubernetes cluster. - -| Step | Action | Description | -|----------------------------------------------------------------------------------|-------------------------------------|-------------------------------------------------------------------------| -|![arrow down](@site/static/img/arrow_down.png)| **[Install the prerequisites](#step-1-prerequisites)**| Install all necessary tools for this setup | -|![vector](@site/static/img/vector.png) | **[Check out the Code](#step-2-check-out-the-code)** | Get all necessary code to deploy the service and dependencies to the kuberneetes cluster| -|![check](@site/static/img/check.png) | **[Installing the Service](#step-3-installing-the-services)**|Start cluster and interact with Services | - -### Step 1: Prerequisites - -1. [Docker](https://docs.docker.com/get-docker/) is installed and the Docker deamon is running with at least 8GB of memory -2. [helm](https://helm.sh/docs/intro/install/) is installed -3. [Minikube](https://minikube.sigs.k8s.io/docs/start/) is installed and running. - You can also use any other local Kubernetes cluster, this guide is just using Minikube as a reference. - - ```bash - minikube start --memory 8192 --cpus 2 - ``` - - _Optional_: enable minikube metrics - - ```bash - minikube addons enable metrics-server - ``` - -4. [kubectl](https://kubernetes.io/docs/tasks/tools/) is installed -5. [psql](https://www.compose.com/articles/postgresql-tips-installing-the-postgresql-client/) client is installed - -### Step 2: Check out the code - -Check out the project [BPDM](https://github.com/eclipse-tractusx/bpdm) or download a [released version](https://github.com/eclipse-tractusx/bpdm/releases) of the project. - -### Step 3: Installing the services - -#### 1. Start the cluster - -To deploy the services on kubernetes using helm charts, run - -```bash -cd local/bpdm -helm install your_namespace ./charts/bpdm/ -``` - -If postgresql is not available in your cluster then you might get following error. - -```bash -Error: INSTALLATION FAILED: An error occurred while checking for chart dependencies. You may need to run `helm dependency build` to fetch missing dependencies: found in Chart.yaml, but missing in charts/ directory: opensearch, postgresql -``` - -You can resolve it by adding dependancy to the build - -```bash -helm dependency build ./charts/bpdm/ -``` - -This can take up to **5 minutes**. - -When the deployment is finished you can expect that 3 deployments can be seen in the minikube dashboard: - -* bpdm-bridge-dummy -* bpdm-gate -* bpdm-pool -* bpdm-cleaning-dummy -* bpdm-orchestrator - -Also in total 5 Pods are up and running. - -##### 1.1 Get the status of the deployment - -The minikube dashboard will give you feedback on how the status of the deployment currently is: - -```bash - minikube dashboard -``` - -Make sure you select the namespace **your_namespace**: - -![expected status](@site/static/img/minikube-bpdm-dashboard-overview.png) - -#### 2. Forward ports - -When the deployment has been finished, you can for port forwarding using k9s. Also, if k9s tool is not installed the you can use [installer](https://k9scli.io/topics/install/) - -```bash - -``` - -or port forwarding can also be achived kubernetes command - -```bash -kubectl port-forward : -``` - -After that you can access the: - -* **bpdm-bridge-dummy:** [http://localhost:8083](http://localhost:8083) -* **bpdm-gate:** [http://localhost:8081](http://localhost:8081) -* **bpdm-pool:** [http://localhost:8080](http://localhost:8080) - -## Deploy Individual Service - -### 1. BPDM Pool - -The [prerequisites](#step-1-prerequisites) for running this service. In an existing Kubernetes cluster the application can be deployed with the following command: - -```bash -helm install release_name ./charts/bpdm/bpdm-pool --namespace your_namespace -``` - -This will install a new release of the BPDM Pool in the given namespace.On default values this release deploys the latest image tagged as `main` from the repository's GitHub Container Registry. The application is run on default profile (without authorization). -Additionally, the Helm deployment contains a PostgreSQL database and Opensearch instance which the BPDM Pool connects to. - -On the default values deployment no further action is needed to make the BPDM Pool deployment run. -However, per default, ingress as well as authentication for endpoints are disabled. - -By giving your own values file you can configure the Helm deployment of the BPDM Pool freely: - -```bash -helm install release_name ./charts/bpdm/bpdm-pool --namespace your_namespace -f ./path/to/your/values.yaml -``` - -In the following sections you can have a look at the most important configuration options. - -#### Image Tag - -Per default, the Helm deployment references a certain BPDM Pool release version where the newest Helm release points to the newest Pool version. -This is a stable tag pointing to a fixed release version of the BPDM Pool. -For your deployment you might want to follow the latest application releases instead. - -In your values file you can overwrite the default tag: - -```yaml -image: - tag: "latest" -``` - -#### Profiles - -You can also activate Spring profiles in which the BPDM Pool should be run. -In case you want to run the Pool with authorization enabled you can write the following: - -```yaml -springProfiles: - - auth -``` - -#### Ingress - -You can specify your own ingress configuration for the Helm deployment to make the BPDM Pool available over Ingress. -Note that you need to have the appropriate Ingress controller installed in your cluster first. -For example, consider a Kubernetes cluster with an [Ingress-Nginx](https://kubernetes.github.io/ingress-nginx/) installed. -An Ingress configuration for the Pool deployment could look like this: - -```yaml -ingress: - enabled: true - annotations: - kubernetes.io/ingress.class: nginx - nginx.ingress.kubernetes.io/backend-protocol: "HTTP" - hosts: - - host: business-partners.your-domain.net - paths: - - path: /pool - pathType: Prefix -``` - -#### Pool Configuration - -The Helm deployment comes with the ability to configure the BPDM Pool application directly over the values file. -This way you are able to overwrite any configuration property of the `application.properties` and `application-auth.properties` files. -Consider that you would need to turn on `auth` profile first before overwriting any property in the corresponding properties file could take effect. -Overwriting configuration properties can be useful to connect to a remote service: - -```yaml -applicationConfig: - bpdm: - security: - auth-server-url: https://remote.keycloak.domain.com - realm: CUSTOM_REALM - client-id: POOL_CLIENT -``` - -In this example above a Pool with authenticated activated connects to a remote Keycloak instance and uses its custom realm and resource. - -Entries in the "applicationConfig" value are written directly to a configMap that is part of the Helm deployment. -This can be a problem if you want to overwrite configuration properties with secrets. -Therefore, you can specify secret configuration values in a different Helm value `applicationSecrets`. -Content of this value is written in a Kubernetes secret instead. -If you want to specify a custom database password for example: - -```yaml -applicationSecrets: - spring: - datasource: - password: your_database_secret -``` - -#### Helm Dependencies - -On default, the Helm deployment also contains a PostgreSQL and Opensearch deployment. -You can configure these deployments in your value file as well. -For this, consider the documentation of the correspondent dependency [PostgreSQL](https://artifacthub.io/packages/helm/bitnami/postgresql/11.9.13) -or [Opensearch](https://opensearch.org/docs/latest/dashboards/install/helm/). -In case you want to use an already deployed database or Opensearch instance you can also disable the respective dependency and overwrite the default host -address in the `applicationConfig`: - -```yaml -applicationConfig: - spring: - datasource: - url: jdbc:postgresql://remote.host.net:5432/bpdm -postgres: - enabled: false -``` - -### 2. BPDM Gate - -The [prerequisites](#step-1-prerequisites) for running this service is same except this service need running BPDM Pool instance. - -In an existing Kubernetes cluster the application can be deployed with the following command: - -```bash -helm install release_name ./charts/bpdm/bpdm-gate --namespace your_namespace -f /path/to/my_release-values.yaml -``` - -This will install a new release of the BPDM Gate in the given namespace. -On default values this release deploys the latest image tagged as `main` from the repository's GitHub Container Registry. -The application is run on default profile (without authorization for its own endpoints or BPDM Pool endpoints). -This deployment requires a BPDM Pool deployment to be reachable under host name `bpdm-pool` on port `8080`. - -By giving your own values file you can configure the Helm deployment of the BPDM Gate freely. -In the following sections you can have a look at the most important configuration options. - -#### Image Tag - -Per default, the Helm deployment references the latest BPDM gate release tagged as `main`. -This tag follows the latest version of the Gate and contains the newest features and bug fixes. -You might want to switch to a more stable release tag instead for your deployment. -In your values file you can overwrite the default tag: - -```yaml -image: - tag: "latest" -``` - -#### Profiles - -You can also activate Spring profiles in which the BPDM Gate should be run. -In case you want to run the Gate with authorization and oAuth Pool client enabled you can write the following: - -```yaml -springProfiles: - - auth - - pool-auth -``` - -#### Ingress - -You can specify your own ingress configuration for the Helm deployment to make the BPDM Gate available over Ingress. -Note that you need to have the appropriate Ingress controller installed in your cluster first. -For example, consider a Kubernetes cluster with an [Ingress-Nginx](https://kubernetes.github.io/ingress-nginx/) installed. -An Ingress configuration for the Gate deployment could look like this: - -```yaml -ingress: - enabled: true - annotations: - kubernetes.io/ingress.class: nginx - nginx.ingress.kubernetes.io/backend-protocol: "HTTP" - hosts: - - host: business-partners.your-domain.net - paths: - - path: /companies/test-company - pathType: Prefix -``` - -#### Gate Configuration - -For the default deployment you already need to overwrite the configuration properties of the application. -The Helm deployment comes with the ability to configure the BPDM Gate application directly over the values file. -This way you are able to overwrite any configuration property of the `application.properties`, `application-auth.properties` -and `application-pool-auth.properties` files. -Consider that you would need to turn on `auth` and `pool-auth` profile first before overwriting any property in the corresponding properties file could take -effect. -Overwriting configuration properties can be useful for connecting to a remotely hosted BPDM Pool instance: - -```yaml -applicationConfig: - bpdm: - pool: - base-url: http://remote.domain.net/api/catena -``` - -Entries in the "applicationConfig" value are written directly to a configMap that is part of the Helm deployment. -This can be a problem if you want to overwrite configuration properties with secrets. -Therefore, you can specify secret configuration values in a different Helm value `applicationSecrets`. -Content of this value is written in a Kubernetes secret instead. -If you want to specify a keycloak client secret for example: - -```yaml -applicationSecrets: - bpdm: - security: - credentials: - secret: your_client_secret -``` - -### 3. BPDM Bridge Dummy - -The [prerequisites](#step-1-prerequisites) for running this service is same. In an existing Kubernetes cluster the application can be deployed with the following command: - -```bash -helm install release_name ./charts/bpdm/bpdm-bridge-dummy --namespace your_namespace -f /path/to/my_release-values.yaml -``` - -This will install a new release of the BPDM Bridge Dummy in the given namespace. -On default values this release deploys the latest image tagged as `main` from the repository's GitHub Container Registry. - -By giving your own values file you can configure the Helm deployment of the BPDM Bridge Dummy freely. -In the following sections you can have a look at the most important configuration options. - -#### Image Tag - -Per default, the Helm deployment references the latest BPDM Bridge Dummy release tagged as `main`. -This tag follows the latest version of the Bridge Dummy and contains the newest features and bug fixes. -You might want to switch to a more stable release tag instead for your deployment. -In your values file you can overwrite the default tag: - -```yaml -image: - tag: "latest" -``` - -#### Profiles - -You can also activate Spring profiles in which the BPDM Bridge Dummy should be run. -In case you want to run the Bridge Dummy with authorization enabled you can write the following: - -```yaml -springProfiles: - - auth -``` - -#### Ingress - -You can specify your own ingress configuration for the Helm deployment to make the BPDM Bridge Dummy available over Ingress. -Note that you need to have the appropriate Ingress controller installed in your cluster first. -For example, consider a Kubernetes cluster with an [Ingress-Nginx](https://kubernetes.github.io/ingress-nginx/) installed. -An Ingress configuration for the Bridge Dummy deployment could somehow look like this: - -```yaml -ingress: - enabled: true - annotations: - kubernetes.io/ingress.class: nginx - nginx.ingress.kubernetes.io/backend-protocol: "HTTP" - hosts: - - host: business-partners.your-domain.net - paths: - - path: /bridge - pathType: Prefix -``` - -#### Bridge Dummy Configuration - -For the default deployment you already need to overwrite the configuration properties of the application. -The Helm deployment comes with the ability to configure the BPDM Bridge Dummy application directly over the values file. -This way you are able to overwrite any configuration property of the `application.properties` and `application-auth.properties` files. -Consider that you would need to turn on `auth` profile first before overwriting any property in the corresponding properties file could take -effect. -Overwriting configuration properties can be useful for connecting to a remotely hosted BPDM Gate and Pool instance: - -```yaml -applicationConfig: - bpdm: - pool: - base-url: http://remote.domain.net/api/catena - gate: - base-url: http://remote.domain.net/api/catena -``` - -Entries in the "applicationConfig" value are written directly to a configMap that is part of the Helm deployment. -This can be a problem if you want to overwrite configuration properties with secrets. -Therefore, you can specify secret configuration values in a different Helm value `applicationSecrets`. -Content of this value is written in a Kubernetes secret instead. -If you want to specify a keycloak client secret for example: - -```yaml -applicationSecrets: - bpdm: - security: - credentials: - secret: your_client_secret -``` - -### 4. BPDM Cleaning Dummy - -The [prerequisites](#step-1-prerequisites) for running this service is same. In an existing Kubernetes cluster the application can be deployed with the following command: - -```bash -helm install release_name ./charts/bpdm/bpdm-cleaning-service-dummy --namespace your_namespace -f /path/to/my_release-values.yaml -``` - -This will install a new release of the BPDM Cleaning Dummy in the given namespace. -On default values this release deploys the latest image tagged as `main` from the repository's GitHub Container Registry. - -By giving your own values file you can configure the Helm deployment of the BPDM Cleaning Dummy freely. -In the following sections you can have a look at the most important configuration options. - -#### Image Tag - -Per default, the Helm deployment references the latest BPDM Cleaning Dummy release tagged as `main`. -This tag follows the latest version of the Cleaning Dummy and contains the newest features and bug fixes. -You might want to switch to a more stable release tag instead for your deployment. -In your values file you can overwrite the default tag: - -```yaml -image: - tag: "latest" -``` - -#### Profiles - -You can also activate Spring profiles in which the BPDM Cleaning Dummy should be run. -In case you want to run the Cleaning Dummy with authorization enabled you can write the following: - -```yaml -springProfiles: - - auth -``` - -#### Ingress - -You can specify your own ingress configuration for the Helm deployment to make the BPDM Cleaning Dummy available over Ingress. -Note that you need to have the appropriate Ingress controller installed in your cluster first. -For example, consider a Kubernetes cluster with an [Ingress-Nginx](https://kubernetes.github.io/ingress-nginx/) installed. -An Ingress configuration for the Cleaning Dummy deployment could somehow look like this: - -```yaml -ingress: - enabled: true - annotations: - kubernetes.io/ingress.class: nginx - nginx.ingress.kubernetes.io/backend-protocol: "HTTP" - hosts: - - host: business-partners.your-domain.net - paths: - - path: /cleaning - pathType: Prefix -``` - -#### Cleaning Dummy Configuration - -For the default deployment you already need to overwrite the configuration properties of the application. -The Helm deployment comes with the ability to configure the BPDM Cleaning Dummy application directly over the values file. -This way you are able to overwrite any configuration property of the `application.properties` and `application-auth.properties` files. -Consider that you would need to turn on `auth` profile first before overwriting any property in the corresponding properties file could take effect. - -Entries in the "applicationConfig" value are written directly to a configMap that is part of the Helm deployment. -This can be a problem if you want to overwrite configuration properties with secrets. -Therefore, you can specify secret configuration values in a different Helm value `applicationSecrets`. -Content of this value is written in a Kubernetes secret instead. -If you want to specify a keycloak client secret for example: - -```yaml -applicationSecrets: - bpdm: - security: - credentials: - secret: your_client_secret -``` - -### 5. BPDM Orchestrator - -The [prerequisites](#step-1-prerequisites) for running this service is same. In an existing Kubernetes cluster the application can be deployed with the following command: - -```bash -helm install release_name ./charts/bpdm/bpdm-orchestrator --namespace your_namespace -f /path/to/my_release-values.yaml -``` - -This will install a new release of the BPDM Orchestrator in the given namespace. -On default values this release deploys the latest image tagged as `main` from the repository's GitHub Container Registry. - -By giving your own values file you can configure the Helm deployment of the BPDM Orchestrator freely. -In the following sections you can have a look at the most important configuration options. - -#### Image Tag - -Per default, the Helm deployment references the latest BPDM Orchestrator release tagged as `main`. -This tag follows the latest version of the Orchestrator and contains the newest features and bug fixes. -You might want to switch to a more stable release tag instead for your deployment. -In your values file you can overwrite the default tag: - -```yaml -image: - tag: "latest" -``` - -#### Profiles - -You can also activate Spring profiles in which the BPDM Orchestrator should be run. -In case you want to run the Orchestrator with authorization enabled you can write the following: - -```yaml -springProfiles: - - auth -``` - -#### Ingress - -You can specify your own ingress configuration for the Helm deployment to make the BPDM Orchestrator available over Ingress. -Note that you need to have the appropriate Ingress controller installed in your cluster first. -For example, consider a Kubernetes cluster with an [Ingress-Nginx](https://kubernetes.github.io/ingress-nginx/) installed. -An Ingress configuration for the Orchestrator deployment could somehow look like this: - -```yaml -ingress: - enabled: true - annotations: - kubernetes.io/ingress.class: nginx - nginx.ingress.kubernetes.io/backend-protocol: "HTTP" - hosts: - - host: business-partners.your-domain.net - paths: - - path: /cleaning - pathType: Prefix -``` - -#### Orchestrator Configuration - -For the default deployment you already need to overwrite the configuration properties of the application. -The Helm deployment comes with the ability to configure the BPDM Orchestrator application directly over the values file. -This way you are able to overwrite any configuration property of the `application.properties` and `application-auth.properties` files. -Consider that you would need to turn on `auth` profile first before overwriting any property in the corresponding properties file could take effect. - -Entries in the "applicationConfig" value are written directly to a configMap that is part of the Helm deployment. -This can be a problem if you want to overwrite configuration properties with secrets. -Therefore, you can specify secret configuration values in a different Helm value `applicationSecrets`. -Content of this value is written in a Kubernetes secret instead. -If you want to specify a keycloak client secret for example: - -```yaml -applicationSecrets: - bpdm: - security: - credentials: - secret: your_client_secret -``` - -## Stopping the cluster - -1. stop minikube - - ```bash - minikube stop - ``` - -2. stop the processes used for port forwarding and minikube dashboard -3. shut down the Docker daemon - -## How to debug an application in the cluster - -If you want to connect your IDE to one of the applications in the cluster, you need to enable debug mode for that application by overriding the entrypoint (using the `command` and `args` fields in the deployment resource). How to do this depends on the application. For the BPDM, as it is based on Spring Boot and Kotlin, you would need to add this flag to the start command: - -```bash --agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=8000 -``` - -Then you can forward the port 8000 for the BPDM deployment to your host machine and connect your IDE to that port. diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/page-glossary.md b/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/page-glossary.md deleted file mode 100644 index a56b7fb6b53..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/page-glossary.md +++ /dev/null @@ -1,289 +0,0 @@ ---- -title: Glossary ---- - - -| Term | Definition | Source | -| ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Allocation | Partitioning the input or output flows of a process or a product system between the product system under study and one or more other product systems | DIN EN ISO 14040 | -| Attributable process | Those processes that consists of all service, material and energy flows that become, make and carry a product throughout its life cycle. | WBCSD Pathfinder | -| Bio-based Materials | Material of biological origin (biomass excluding material embededded in geological formations and / or fossilised) | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172132, P. 9 | -| Bio-based products | wholly or partly derived from materials of biological origin, excluding materials embedded in geological formations and/or fossilised. | | -| Biomass | Material of biological origin, excluding material embedded in geological formations or transformed material of biological origin, excluding material embedded in geological formations or transformed to fossilized material and excluding peat | DIN ISO 14021 | -| By-Product | Substance or object, resulting from a production process, the primary aim of which is not the production of that item, and does not constitute waste (as defined in Directive 2008/98/E on waste) | Art. 5 No. 1 WFD (Waste framework directive 2008/98/EC) | -| Biodiversity | Biological diversity means the variability among living organisms from all sources including, inter alia, terrestrial, marine and other aquatic ecosystems and the ecological complexes of which they are part: diversity in species, between species and of ecosystems. | Art. 2 UN Convention on biological diversity; ESRS E4 (COM(2023) 5303 final | -| Carbon offsetting | Mechanism for compensatingfor a full PCF or a partial PCF through the prevention of the release of,reduction in, or removal of an amount of GHG emissions in a process outside the product system under study | DIN EN ISO 14067 | -| CAS Number | a unique numerical identifier assigned by the Chemical Abstracts Service (CAS) to every chemical substance described in the open scientific literature. / Except for a small selection of most common substances released under CCBY-NC license the CAS numbers are a proprietary identification scheme to be licensed from CAS (USA) | [CAS REGISTRY / CAS](https://www.cas.org/cas-data/cas-registry) | -| Certificate of Decstruction | An official document issued in accordance with the minimum requirements set out by the European Commission's Decision of February 19, 2002. It confirms the proper disposal of an end-of-life vehicle and is required for vehicle deregistration. | 2000/53/EC | -| Chain-of-Custody approach | A process by which inputs and outputs and associated information are transferred, monitored and controlled as they move through each step in the relevant supply chain. See Mass Balance for details | ISO 22095 | -| Chemical Recycling | Chemical or feedstock recycling refers to the conversion of plastic polymers into their monomers or chemical building blocks or basic chemicals, i. e. depolymerisation by means of thermochemical or chemical processes, although there is currently no uniform, legally binding definition. | Background Paper pn Chemical Recycling - German Environmental Agency, Dec 2020 | -| Circular Econamy | See chapter 3.1; but also “An ec economic system that uses a systemic approach to maintain a circular flow of resources, by recovering, retaining or adding to their value, while contributing to sustainable development | ISO/DIS 59004:2023(E) | -| Circular Economy Principles | The Circular Economy is based on three principles, driven by design: (i) eliminate waste and pollution; (ii) circulate products and materials at their highest value; and (iii) regenerate nature. | EFRAG-Draft ESRS (11/2022) | -| Carbon offsetting | Mechanism for compensatingfor a full PCF or a partial PCF through the prevention of the release of,reduction in, or removal of an amount of GHG emissions in a process outside the product system under study | DIN EN ISO 14067, Feb. 2019, p. 18 | -| Closed-loop recycling | In a closed loop, the secondary material from one product system is either reused in the same product system (real closed-loop) or used in another product system without changing the inherent technical properties of the material (quasi closed-loop). | | -| CO2e (carbon dioxide equivalent) | Unit for comparing the radiative forcing of a greenhouse gas to that of carbon dioxide | DIN EN ISO 14067, Feb. 2019, p.20 | -| component | part or small assembly of parts used as part of a larger assembly | Artikel 2 Begriffsbestimmungen 200053EG | -| Compostable | characteristic of a product, packaging or associated component that allows it to biodegrade, generating a relatively homogeneous and stable humus-like substance. | DIN ISO 14021 | -| Consumer | Any natural person who, in contracts covered by this Directive, is acting for purposes which are outside his trade, business, craft or profession | 2011/83/EU on conusmer rights | -| Co-product | Any of two or more products comning from the same unit process or product system | DIN EN ISO 14067, Feb. 2019, p.22 | -| Cradle-to-gate PCF | Part of a product’s full lifecycle, covering all emissions allocated to a product upstream of a company plus all emissions resulting from processes within the company until the product leaves the suppliers' gate | WBCSD Pathfinder | -| Cut-off criteria | Specification of the amount of material or energy flow or the level of significance of GHG emissions associated with unit processor the product system, to be excluded from a PCF study | DIN EN ISO 14067, Feb. 2019 p.24 | -| Declared unit | Quantity of a product for use as a reference unit in the quantification of a Cradle-to-Gate PCF | adapted from DIN EN iso 14067 | -| Degradable | A characteristic of a product or packaging that, with respect to specific conditions, allows it to break down to a specific extent within a given time. | DIN ISO 14021 | -| Digital Twin | The Digital Twin is a virtual representation of assets and adheres to the following characteristics: The DT has at least one Catena-X-wide unique ID. Digital Twins are organized by a set of Aspects. The set can be extended over lifetime. An Aspect of a DT includes both structural as well as behavioral data and models (including operations and simulation models). The semantics of an Aspect can be described via semantic models A single Aspect can be connected to different heterogenous data sources (including behavioural models) The DT can represent asset types (e.g. virtual prototype of a car) and asset instances (e.g. real car) A DT can cover the whole asset lifecycle including (e.g. planning phase, production, sales, use and decommissioning phase). However, in practice there may be more than one twin with different IDs representing different lifecycle phases (e.g. a twin for types and multiple twins for instances). An asset can have more than one DT The DT represents current available information about an asset (synchronized at a specified frequency and fidelity) which can be leveraged for simulation and business process integration By using aspects the DT can reference other DT to express "part of" or "consists of" relations | Catena-X definition | -| Direct emissions | GHG emissions from the processes that are owned or controlled by the reporting company | WBCSD Pathfinder | -| Downstream emissions | Indirect GHG emissions that occur in the value chain following the processes owned or controlled by the reporting company | WBCSD PAthfinder | -| Durability | The ability of a product, component or material to remain functional and relevant when used as intended. | EFRAG - Draft ESRS (11/2022) | -| ecological assessment | compilation and evoluation of the inputs, outputs, and potential environmental impacts of a product system throughout its life cycle | Artikel 2 Begriffsbestimmungen 200053EG | -| end-of-life | the point at which a product or component is taken out of use | Artikel 2 Begriffsbestimmungen 200053EG | -| end-of-life vehicle | vehicles that are considered waste under Article 1 letter a) of Directive 75/442/EC | Artikel 2 Begriffsbestimmungen 200053EG | -| End-of-waste | The end-of-waste state for waste in Europe is reached when the material is no longer considered waste under the national implementation of the Waste Framework Directive. | EN 15804 | -| Functional unit | Quantified benefit of a product system for use as a comparison unit | | -| Fossile Materials | Fossil raw materials are all raw materials derived from organic material. They incldude coal, crude oil and natural gas. | Bundesverband Geothermie | -| Global warming potential (GWP) | Index, based on radiative properties of GHGs, measuring the radiative forcing following a pulse emission of a unit mass of a given GHG in the present-day atmosphere integrated over a chosen time horizon, relative to that of carbon dioxide (CO2) | DIN EN ISO 14067, Feb. 2019, p. 21 | -| Greenhouse gases (GHGs) | Gaseous constitient of the atmosphere, both natural and anthropogenic, that absorbs and emits radiation at specific wavelengths within the spectrum of infrared radiation emitted by the Earth´s surface, the atmosphere, and clouds | DIN ISO 14067, Feb. 2019, p. 19 | -| ILCD Format | International Life Cycle Data Format | | -| intermediate product | output from a unit process that is input to other unit processes that require further transformation within the system | | -| input | product, material, or energy flow that enters a unit process. Products and materials include raw materials, intermediate products, and coproducts. | WBCSD Pathfinder | -| Land use | Human use or management of land within the relevant boundary | DIN EN ISO 14067, Feb. 2019 p. 30 | -| life cycle | consecutive and interlinked stages to a product, from raw material acquisition or generation from natural resources to final disposal. | DIN EN ISO 14067, Feb. 2019 p. 25 | -| Life cycle assesment (LCA) | Compilation and evaluation of the inputs, outputs and potential environmental impacts of a product system throughout its life cycle | DIN EN ISO 14067, Feb. 2019, p. 25 | -| Life cycle emissions | The sum of GHG emissions resulting from all stages of the life cycle of a product and within the specified boundaries of the product | WBCSD Pathfinder | -| Life cycle inventory (LCI) | The phase of life cycle assessment involving the compilation and quantification of inputs and outputs for a product throughout its life cycle (such as a product´s GHG emissions and sources) | DIN EN ISO 14067, Feb. 2019, p. 25 | -| Life cycle inventory results | GHG impact of the studied product per unit of analysis | WBCSD Pathfinder | -| Mass | In physics, mass is not the same as weight. Mass is both a property of a physical body and a measure of its resistance to acceleration. For disambiguation see definition of "Weight" below | | -| Mass Balance | Mass balance is one of several well-known chain of custody approaches that can be used to track the flow of materials through the value chain. The total quantity of the content in question is tracked through the production system and the allocation of this content is made to the end products based on verifiable accounting. The goal of this method is to ensure proper accounting and to confirm a link between the incoming content (e.g., "sustainable," "recycled," or "organic" according to some definition) and the eventual outgoing product. | [https://www.basf.com/global/documents/de/sustainability/we-source-responsibly/Mass-Balance-White-Paper-2020.pdf](https://www.basf.com/global/documents/de/sustainability/we-source-responsibly/Mass-Balance-White-Paper-2020.pdf) | -| Material | Physical good used as input for production processes of goods or services, or physical good suppliedto a customer as output | adapted from WBCSD Pathfinder | -| Material / Raw Material | Materials are composed of basic substances, (1) either one or more chemical element(s) (like iron, copper) (2) or one or more chemical compound(s) (like acrylic resin, zinc oxide) (3) or one or more materials (like polyamide and glas fibre). Therefore, a material definition is only valid if a definition of (see chemical composition) is given alongside it. | Catena-X Definition, IMDS | -| Material Composition | see chemical composition | Own Catena-X definition | -| Material Declaration | Material declaration (MD) is the process mandated to meet the obligations placed on (automobile) manufacturers, and thus on their suppliers, by national and international standards, laws and regulations. | IMDS Information Pages - Home - IMDS Public Pages (mdsystem.com) | -| Material Details | Collection of material information defined by given context in an information model | Catena-X Definition | -| Material Identifier | Material Identifier is a alphanumerical identifier that serves programmatic functions (e.g., as data ID) but also satisfies chemical regulation (see material declaration) under national and international law. | Catena-X definition | -| Material Name | Trivial name (often name of a chemical group) used to denote some material in everyday speech or jargon. Entirely dependent on specific context. | Catena-X definition | -| Material Type | Groups of materials defined by convention (e.g., IMDS) or ISO Standard (e.g., ISO 62474) in order to simplify communication of relevance of material information (in search or filtering) | [https://std.iec.ch/iec62474/iec62474.nsf/Index?open&q=180013](https://www.basf.com/global/documents/de/sustainability/we-source-responsibly/Mass-Balance-White-Paper-2020) | -| Mechanical Recycling | End-of-life materials can be processed via collecting, sorting, shredding, melting and transforming it into secondary raw materials for a new application. This form of recycling involves processes in which e.g. the polymer structure is not significantly changed and the plastic is preserved as a material. Thus, in terms of its complexity, mechanical recycling takes place at a lower technical level than chemical recycling. | [Mechanical recycling (basf.com)](https://www.basf.com/global/en/who-we-are/sustainability/we-drive-sustainable-solutions/circular-economy/mechanical-recycling.html) [Glossar und Methoden / Statistikportal.de](https://www.statistikportal.de/de/ugrdl/glossar-und-methoden#P) | -| Multi-input-output unit process | Operation or process with multiple inputs, such as materials and energy, and multiple outputs, such as co-products and waste | WBCSD Pathfinder | -| Negative emissions | Removal of greenhouse gases (GHGs) from the atmosphere by deliberate human activities, i.e., in addition to the removal that would occur via natural carbon cycle processes | IPCC glossary | -| Net negative emissions | A situation of net negative emissions is achieved when,as the result of human activities, more greenhouse gases are removed from the atmosphere than are emitted into it. Where multiple greenhouse gases are involved, the quantification of negative emissions depends on the climate metric chosen to compare emissions of different gases (such as global warming potential, global temperature change potential, and others, as well as the chosen time horizon). | IPCC glossary | -| Net zero CO2 emissions | Net zero carbon dioxide (CO2) emissions are achieved when anthropogenic CO2 emissions are balanced globally by anthropogenic CO2 removals over a specified period. Net zero CO2 emissions are also referred to as carbon neutrality. | IPCC glossary | -| Net zero emissions | Net zero emissions are achieved when anthropogenic emissions of greenhouse gases into the atmosphere are balanced by anthropogenic removals over a specified period. Where multiple greenhouse gases are involved, the quantification of net zero emissions depends on the climate metric chosen to compare emissions of different gases (such as global warming potential, global temperature change potential, and others, as well as the chosen time horizon). | IPCC glossary | -| Open-loop recycling | In open-loop recycling, the material is reused in other productsystems and its inherent properties are changed (e.g., recycled material may have a different chemical composition, a different structure or a higher concentration of dissolved impurities compared to primary material). | | -| output | product, material, or energy flow that leaves a unit process. Products and material include raw materials, intermediate products, co-products, and releases. | WBCSD Pathfinder | -| Partial PCF | Sum of GHG emissions and GHG removals of one or more selected process(es) in a product system, expressed as carbon dioxide equivalents and based on the selected stages or processes within the life cycle. | DIN EN ISO 14067, Feb. 2019, p. 16 | -| Post-consumer Recyclate | Post-Consumer (PCR) recycled content represents the total proportion, by mass, of post-consumer input materials incorporated in the process. | SP-Recycled-Content-Definition-Final-09102021-1.pdf | -| Post-consumer material | Material generated by households or by commercial, industrial and institutional facilities in their role as end-users of the product which can no longer be used for its intended purpose. This includes returns of material from the distribution chain. Post-consumer material can be used in the form of recovered or recycled material as a substitute for primary material. | DIN ISO 14021 | -| Pre-consumer Material | Material diverted from the waste stream during a manufacturing process. Excluded is reutilization of materials such as rework, regrind or scrap generated in a process and capable of being reclaimed within the same process that generated it. Pre-consumer material can be used in the form of recovered or recycled material as a substitute for primary material. | DIN ISO 14021 | -| Primary data | Data pertaining to a specific product or activity within a company’s value chain. Such data may take the form of activity data, emissions, or emission factors. Primary data is site-specific, company-specific (if there are multiple sites for the same product) or supply chain–specific. | WBCSD Pathfinder | -| Primary Material | Raw material coming from the environment, as well as materials of differing stages of processing (Raw materials, semi- and finished goods), which are used in the production process for the first time. | | -| Process | Set of interrelated or interacting activities that transforms inputs into outputs. | DIN EN ISO 14067, feb. 2019, p. 23 | -| prevention | measures to reduce the quantity and environmental harm of end-of-life vehicles, their materials, and substances. | | -| producer / Manufacturer | the vehicle manufacturer or the commercial importer of a vehicle into a EU Member State | | -| product | a product refers to any goods or service, which can be categorized as services (e.g. transport), software (e.g. computer program, dictionary), hardware (e.g. engine mechanical part), and processed materials (e.g. lubricant). Services have both tangible and intangible elements. The provision of a service can involve activities such as repairing a customer-supplied tangible product (e.g. an automobile) or working on a customer-supplied intangible product (e.g. preparing a tax return using an income statement). | | -| Product carbon footprint (PCF) | Total GHG emissions generated during the life cycle of a product, measured in CO2e. Within the boundary of the CX-PCF Rulebook, emissions related to the product use and end-of-life stages are excluded from the PCF. | WBCSD Pathfinder | -| Product category | Group of products that can fulfill equivalent functions. | WBCSD Pathfinder | -| Product category rules (PCR) | A set of specific rules, requirements, and guidelines for calculating PCFs (among other things) and developing environmental declarations for one or more product categories according to EN ISO 14040:2006. | WBCSD Pathfinder | -| Production | Process of combining various inputs, both material (such as metal, wood, glass, or plastics) and immaterial (such as plans, or knowledge) in order to create output. | | -| product system | collection of unit processes with elementary and product flows, performing one or more defined functions, and which models the life cycle of a product | DIN EN ISO 14067, Feb. 2019, p. 22 | -| Production waste | Waste generated in different industries in connection with production and the opposite to consumption waste, which primarily comprise municipal waste and waste comparable to it. | [Production waste/Concepts/Statistics Finland](https://www.stat.fi/meta/kas/tuotantojate_en.html) | -| R-Strategies | Various approaches to implement circular economy, known as R-strategies, have been developed to achieve less resource and material consumption in product chains and make the economy more circular. | Potting, J., et al. "Circular economy: measuring innovation in the product chain." Planbureau voor de Leefomgeving 2544 (2017). | -| raw materials | primary or secondary material that is used to produce a product. Secondary material includes recycled material. | | -| Recovery | Any operation the principal result of which is waste serving a useful purpose by replacing other materials which would otherwise have been used to fulfill a particular function, or waste being prepared to fulfill that function, in the plant or in the wider economy. | Art. 3 (15) of directive 2008/98 EC | -| Recovered Material | Material that would have otherwise been disposed of as waste or used for energy recovery, but has instead been collected and recovered [reclaimed] as a material input, in lieu of new primary material, for a recycling or a manufacturing process. | DIN ISO 14021 | -| Recyclate | Secondary raw materials that have been generated by means of the recovery of waste or are generated in the disposal of waste and are suitable for the production of products. | | -| Recycled Content | Proportion, by mass, of recycled material in a product or packaging. The recycled content is the sum of pre-consumer material and post-consumer material. | DIN ISO 14021 | -| Recycled Material | Material, that has been reprocessed from (reclaimed) material by means of a manufacturing process and made into a final product or into a component for incorporation into a product. | DIN ISO 1402 | -| Recycling | Any recovery operation by which waste materials are reprocessed into products, materials or substances whether for the original or other purposes. It includes the reprocessing of organic material but does not include energy recovery and the reprocessing into materials that are to be used as fuels or for backfilling operations. ‘recycling’ means the reprocessing in a production process of the waste materials for the original purpose or for other purposes but excluding energy recovery. Energy recovery means the use of combustible waste as a means to generate energy through direct incineration with or without other waste but with recovery of the heat; | EFRAG – Draft ESRS (11/2022) | -| Reduce | Increase efficiency in product manufacture or use by consuming fewer natural resources and materials | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172131, p. 7 | -| Reference flow | Measure of the inputs to or outputs from processes in a given product system required to fulfil the function expressed by the functional unit. | DIN EN ISO 14067, Feb. 2019, p. 24 | -| Refurbish | Restore an old product and bring it up to date (to specified quality level) | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172131, p. 7 | -| Refuse | Make product redundant by abandoning its function or by offering the same function by a radically different (e.g. digital) product or service | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172131, p. 7 | -| Releases | tbd. | | -| Remanufacture | Remanufacturing is a standardized industrial process by which a used product or part are returned to same-as-new, or better, condition and performance. The process is in line with specific technical specifications, including engineering, quality and testing standards. The process yields fully warranted products. Collecting discarded products or materials that can be refinished and sanitised to serve their original functions | CLEPA, European Environmental Agency - Eionet report ETC/WMGE 2021/10, P. 3 | -| Renewable Energy | Energy from renewable sources’ or ‘renewable energy’ means energy from renewable non-fossil sources, namely wind, solar (solar thermal and solar photovoltaic) and geothermal energy, ambient energy, tide, wave and other ocean energy, hydropower, biomass, landfill gas, sewage treatment plant gas, and biogas. | Renewable Energy Directive (2018/2001) | -| Renewable materials | Material that is derived from resources that are quickly replenished by ecological cycles or agricultural processes, so that the services provided by these and other linked resources are not endangered and remain available for the next generation. | EFRAG – Draft ESRS (11/2022) | -| Repair | Repair and maintenance of defective product so it can be used with its original function | [Link, ESPR Draft](https://op.europa.eu/en/publication-detail/-/publication/ca9846a8-6289-11ea-b735-01aa75ed71a1/language-en/format-PDF/source-120460723) | -| Repurpose | Use a redundant product or its parts in a new product with different function | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172131, p. 7 | -| Rethink | Make product use more intensive (e.g. through product-as-a-service, reuse and sharing models or by putting multi-functional products on the market) | European Commission, Categorisation System for the Circular Economy Circular Economy, doi: 10.2777 / 172131, p. 7 | -| Reuse | Reuse of a product which is still in good condition and fulfils its original function (and is not waste) for the same purpose for which it was conceived | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172131, p. 7 | -| Reutilization | Reutilization of materials such as rework, regrind, or scrap materials generated within the process and capable of being reused within the same process that generated it. Any operation by which products or components that are not waste are used again for the same purpose for which they were originally intended. Reutilization allows waste to be reduced and materials can be kept in cycle. | Adapted from ISO 14021 | -| Representative product | The representative product can be a real or an averaged (non-existing) product. The averaged product should be calculated based on sales-weighted characteristics of all technologies/materials used in the company’s production system. | | -| Resource inflow | Resource that enters the organisation's infrastructure. | EFRAG – Draft ESRS (11/2022) | -| Resource outflow | Resource that leaves the organisation's infrastructure. | EFRAG – Draft ESRS (11/2022) | -| Reuse | Any operation by which products and components that are not waste are used again for the same purpose for which they were conceived. This may involve cleaning or small adjustments so it is ready for the next use without significant definition. | Art. 3 (13) of the Directive 2008/98/EC & EFRAG-Draft ESRS (11/2022) | -| Risk management | Plans, actions, strategies, or policies to reduce the likelihood and/or consequences of risks or to respond to consequences. | IPCC Glossary, p. 45 | -| Secondary data | Secondary data can include data from databases and published literature, default emission factors from national inventories, calculated data estimates or other representative data, validated by competent authorities. | DIN EN ISO 14067, Feb. 2019, p. 28 | -| Secondary Material | Secondary materials are any materials that are not the primary products from manufacturing and other industrial sectors. These materials can include scrap and residuals from production processes and products that have been recovered at the end of their useful life. | [United States Environmental Protection Agency](https://www.epa.gov/smm/sustainable-management-industrial-non-hazardous-secondary-materials) | -| Secondary Material Framework | Secondary Material Quota = on vehicle level, Secondary Material Content = on component level | | -| Secondary Material Quota (on vehicle level) | not found | | -| Secondary Raw Material | Material that serves as a substitute for primary material and is kept in cycle. | | -| Secondary Raw Material Content | The content of materials that serve as substitutes for primary materials and are kept in cycle. The secondary raw material content is calculated in proportion of secondary material and product weight. | | -| Supplier gate | Supplier's production site or supplier's distribution site. | | -| Supply chain | Those involved, through upstream and downstream linkages, in process and activities relating to the provision of products to the user. | DIN EN ISO 14067, Feb. 2019, p. 28 | -| Sustainability | A dynamic process that guarantees the persistence of natural and human systems in an equitable manner. | IPCC Glossary, p. 49 | -| System boundary | Boundary based on a set of criteria representing which unit processes are a part of the system under study. | DIN EN ISO 14040, Feb. 2021, p. 13 | -| Treatment | Activities carried out after the end-of-life vehicle is handed over to a facility for the elimination of pollutants, dismantling, coarse crushing, shredding, recycling or preparation for disposal of shredder waste, as well as other activities related to the recycling and/or disposal of end-of-life vehicles and end-of-life vehicle components. | | -| Unit process | Smallest element considered in the life cycle inventory analysis for which input and output data are quantified. | DIN EN ISO 14067, Feb. 2019, p. 23 | -| Upstream emissions | Indirect GHG emissions that occur in the value chain prior to the processes owned or controlled by the reporting company. All upstream transportation emissions are also included as part of upstream emissions. | WBCSD Pathfinder | -| Use stage | That part of the life cycle of a product that occurs between the transfer of the product to the consumer and the end-of-life of the product. | Adapted from WBCSD Pathfinder | -| Value chain | All the upstream and downstream activities associated with the operations of a company. | WBCSD Pathfinder | -| Vehicle | Vehicles of classes M1 or N1 according to Annex II Section A of Directive 70/156/EC and three-wheeled vehicles according to Directive 92/61/EC, however excluding three-wheeled motorcycles. | | -| VIN | vehicle identification number | ISO 3779:2009-10 | -| Waste | Materials, co-products, products, or emissions without economic value that the holder intends or is required to dispose of. | DIN EN ISO 14067, Feb. 2019, p. 26; WBCSD Pathfinder | -| Waste | Any substance or object which the holder discards or intends or is required to discard. | Art. 3(1) of the Directive 2008/98/EC | -| Waste hierarchy | The waste hierarchy is the following priority order in waste prevention and management: (a) prevention; (b) preparing for re-use; (c) recycling; (d) other recovery, e.g., energy recovery; and (e) disposal. | Art. 4 (1) of the Directive 2008/98/EC | -| Waste Prevention | Waste prevention is any measure taken to ensure that a substance, material or article does not become a waste. It is used to reduce the amount of waste, the harmful effects of the waste on people and the environment, or the content of harmful substances in materials and articles. | Kreislaufwirtschaftsgesetz | -| Term | Definition | Source | -| - | - | - | -| Allocation | Partitioning the input or output flows of a process or a product system between the product system under study and one or more other product systems | DIN EN ISO 14040 | -| Attributable process | Those processes that consists of all service, material and energy flows that become, make and carry a product throughout its life cycle. | WBCSD Pathfinder | -| Bio-based Materials | Material of biological origin (biomass excluding material embededded in geological formations and / or fossilised) | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172132, P. 9 | -| Bio-based products | wholly or partly derived from materials of biological origin, excluding materials embedded in geological formations and/or fossilised. | | -| Biomass | Material of biological origin, excluding material embedded in geological formations or transformed material of biological origin, excluding material embedded in geological formations or transformed to fossilized material and excluding peat | DIN ISO 14021 | -| By-Product | Substance or object, resulting from a production process, the primary aim of which is not the production of that item, and does not constitute waste (as defined in Directive 2008/98/E on waste) | Art. 5 No. 1 WFD (Waste framework directive 2008/98/EC) | -| Biodiversity | Biological diversity means the variability among living organisms from all sources including, inter alia, terrestrial, marine and other aquatic ecosystems and the ecological complexes of which they are part: diversity in species, between species and of ecosystems. | Art. 2 UN Convention on biological diversity; ESRS E4 (COM(2023) 5303 final | -| Carbon offsetting | Mechanism for compensatingfor a full PCF or a partial PCF through the prevention of the release of,reduction in, or removal of an amount of GHG emissions in a process outside the product system under study | DIN EN ISO 14067 | -| CAS Number | a unique numerical identifier assigned by the Chemical Abstracts Service (CAS) to every chemical substance described in the open scientific literature. / Except for a small selection of most common substances released under CCBY-NC license the CAS numbers are a proprietary identification scheme to be licensed from CAS (USA) | [CAS REGISTRY / CAS](https://www.cas.org/cas-data/cas-registry) | -| Certificate of Decstruction | An official document issued in accordance with the minimum requirements set out by the European Commission's Decision of February 19, 2002. It confirms the proper disposal of an end-of-life vehicle and is required for vehicle deregistration. | 2000/53/EC | -| Chain-of-Custody approach | A process by which inputs and outputs and associated information are transferred, monitored and controlled as they move through each step in the relevant supply chain. See Mass Balance for details | ISO 22095 | -| Chemical Recycling | Chemical or feedstock recycling refers to the conversion of plastic polymers into their monomers or chemical building blocks or basic chemicals, i. e. depolymerisation by means of thermochemical or chemical processes, although there is currently no uniform, legally binding definition. | Background Paper pn Chemical Recycling - German Environmental Agency, Dec 2020 | -| Circular Econamy | See chapter 3.1; but also “An ec economic system that uses a systemic approach to maintain a circular flow of resources, by recovering, retaining or adding to their value, while contributing to sustainable development | ISO/DIS 59004:2023(E) | -| Circular Economy Principles | The Circular Economy is based on three principles, driven by design: (i) eliminate waste and pollution; (ii) circulate products and materials at their highest value; and (iii) regenerate nature. | EFRAG-Draft ESRS (11/2022) | -| Carbon offsetting | Mechanism for compensatingfor a full PCF or a partial PCF through the prevention of the release of,reduction in, or removal of an amount of GHG emissions in a process outside the product system under study | DIN EN ISO 14067, Feb. 2019, p. 18 | -| Closed-loop recycling | In a closed loop, the secondary material from one product system is either reused in the same product system (real closed-loop) or used in another product system without changing the inherent technical properties of the material (quasi closed-loop). | | -| CO2e (carbon dioxide equivalent) | Unit for comparing the radiative forcing of a greenhouse gas to that of carbon dioxide | DIN EN ISO 14067, Feb. 2019, p.20 | -| component | part or small assembly of parts used as part of a larger assembly | Artikel 2 Begriffsbestimmungen 200053EG | -| Compostable | characteristic of a product, packaging or associated component that allows it to biodegrade, generating a relatively homogeneous and stable humus-like substance. | DIN ISO 14021 | -| Consumer | Any natural person who, in contracts covered by this Directive, is acting for purposes which are outside his trade, business, craft or profession | 2011/83/EU on conusmer rights | -| Co-product | Any of two or more products comning from the same unit process or product system | DIN EN ISO 14067, Feb. 2019, p.22 | -| Cradle-to-gate PCF | Part of a product’s full lifecycle, covering all emissions allocated to a product upstream of a company plus all emissions resulting from processes within the company until the product leaves the suppliers' gate | WBCSD Pathfinder | -| Cut-off criteria | Specification of the amount of material or energy flow or the level of significance of GHG emissions associated with unit processor the product system, to be excluded from a PCF study | DIN EN ISO 14067, Feb. 2019 p.24 | -| Declared unit | Quantity of a product for use as a reference unit in the quantification of a Cradle-to-Gate PCF | adapted from DIN EN iso 14067 | -| Degradable | A characteristic of a product or packaging that, with respect to specific conditions, allows it to break down to a specific extent within a given time. | DIN ISO 14021 | -| Digital Twin | The Digital Twin is a virtual representation of assets and adheres to the following characteristics: The DT has at least one Catena-X-wide unique ID. Digital Twins are organized by a set of Aspects. The set can be extended over lifetime. An Aspect of a DT includes both structural as well as behavioral data and models (including operations and simulation models). The semantics of an Aspect can be described via semantic models A single Aspect can be connected to different heterogenous data sources (including behavioural models) The DT can represent asset types (e.g. virtual prototype of a car) and asset instances (e.g. real car) A DT can cover the whole asset lifecycle including (e.g. planning phase, production, sales, use and decommissioning phase). However, in practice there may be more than one twin with different IDs representing different lifecycle phases (e.g. a twin for types and multiple twins for instances). An asset can have more than one DT The DT represents current available information about an asset (synchronized at a specified frequency and fidelity) which can be leveraged for simulation and business process integration By using aspects the DT can reference other DT to express "part of" or "consists of" relations | Catena-X definition | -| Direct emissions | GHG emissions from the processes that are owned or controlled by the reporting company | WBCSD Pathfinder | -| Downstream emissions | Indirect GHG emissions that occur in the value chain following the processes owned or controlled by the reporting company | WBCSD PAthfinder | -| Durability | The ability of a product, component or material to remain functional and relevant when used as intended. | EFRAG - Draft ESRS (11/2022) | -| ecological assessment | compilation and evoluation of the inputs, outputs, and potential environmental impacts of a product system throughout its life cycle | Artikel 2 Begriffsbestimmungen 200053EG | -| end-of-life | the point at which a product or component is taken out of use | Artikel 2 Begriffsbestimmungen 200053EG | -| end-of-life vehicle | vehicles that are considered waste under Article 1 letter a) of Directive 75/442/EC | Artikel 2 Begriffsbestimmungen 200053EG | -| End-of-waste | The end-of-waste state for waste in Europe is reached when the material is no longer considered waste under the national implementation of the Waste Framework Directive. | EN 15804 | -| Functional unit | Quantified benefit of a product system for use as a comparison unit | | -| Fossile Materials | Fossil raw materials are all raw materials derived from organic material. They incldude coal, crude oil and natural gas. | Bundesverband Geothermie | -| Global warming potential (GWP) | Index, based on radiative properties of GHGs, measuring the radiative forcing following a pulse emission of a unit mass of a given GHG in the present-day atmosphere integrated over a chosen time horizon, relative to that of carbon dioxide (CO2) | DIN EN ISO 14067, Feb. 2019, p. 21 | -| Greenhouse gases (GHGs) | Gaseous constitient of the atmosphere, both natural and anthropogenic, that absorbs and emits radiation at specific wavelengths within the spectrum of infrared radiation emitted by the Earth´s surface, the atmosphere, and clouds | DIN ISO 14067, Feb. 2019, p. 19 | -| ILCD Format | International Life Cycle Data Format | | -| intermediate product | output from a unit process that is input to other unit processes that require further transformation within the system | | -| input | product, material, or energy flow that enters a unit process. Products and materials include raw materials, intermediate products, and coproducts. | WBCSD Pathfinder | -| Land use | Human use or management of land within the relevant boundary | DIN EN ISO 14067, Feb. 2019 p. 30 | -| life cycle | consecutive and interlinked stages to a product, from raw material acquisition or generation from natural resources to final disposal. | DIN EN ISO 14067, Feb. 2019 p. 25 | -| Life cycle assesment (LCA) | Compilation and evaluation of the inputs, outputs and potential environmental impacts of a product system throughout its life cycle | DIN EN ISO 14067, Feb. 2019, p. 25 | -| Life cycle emissions | The sum of GHG emissions resulting from all stages of the life cycle of a product and within the specified boundaries of the product | WBCSD Pathfinder | -| Life cycle inventory (LCI) | The phase of life cycle assessment involving the compilation and quantification of inputs and outputs for a product throughout its life cycle (such as a product´s GHG emissions and sources) | DIN EN ISO 14067, Feb. 2019, p. 25 | -| Life cycle inventory results | GHG impact of the studied product per unit of analysis | WBCSD Pathfinder | -| Mass | In physics, mass is not the same as weight. Mass is both a property of a physical body and a measure of its resistance to acceleration. For disambiguation see definition of "Weight" below | | -| Mass Balance | Mass balance is one of several well-known chain of custody approaches that can be used to track the flow of materials through the value chain. The total quantity of the content in question is tracked through the production system and the allocation of this content is made to the end products based on verifiable accounting. The goal of this method is to ensure proper accounting and to confirm a link between the incoming content (e.g., "sustainable," "recycled," or "organic" according to some definition) and the eventual outgoing product. | [https://www.basf.com/global/documents/de/sustainability/we-source-responsibly/Mass-Balance-White-Paper-2020.pdf](https://www.basf.com/global/documents/de/sustainability/we-source-responsibly/Mass-Balance-White-Paper-2020.pdf) | -| Material | Physical good used as input for production processes of goods or services, or physical good suppliedto a customer as output | adapted from WBCSD Pathfinder | -| Material / Raw Material | Materials are composed of basic substances, (1) either one or more chemical element(s) (like iron, copper) (2) or one or more chemical compound(s) (like acrylic resin, zinc oxide) (3) or one or more materials (like polyamide and glas fibre). Therefore, a material definition is only valid if a definition of (see chemical composition) is given alongside it. | Catena-X Definition, IMDS | -| Material Composition | see chemical composition | Own Catena-X definition | -| Material Declaration | Material declaration (MD) is the process mandated to meet the obligations placed on (automobile) manufacturers, and thus on their suppliers, by national and international standards, laws and regulations. | IMDS Information Pages - Home - IMDS Public Pages (mdsystem.com) | -| Material Details | Collection of material information defined by given context in an information model | Catena-X Definition | -| Material Identifier | Material Identifier is a alphanumerical identifier that serves programmatic functions (e.g., as data ID) but also satisfies chemical regulation (see material declaration) under national and international law. | Catena-X definition | -| Material Name | Trivial name (often name of a chemical group) used to denote some material in everyday speech or jargon. Entirely dependent on specific context. | Catena-X definition | -| Material Type | Groups of materials defined by convention (e.g., IMDS) or ISO Standard (e.g., ISO 62474) in order to simplify communication of relevance of material information (in search or filtering) | [https://std.iec.ch/iec62474/iec62474.nsf/Index?open&q=180013](https://std.iec.ch/iec62474/iec62474.nsf/Index?open&q=180013) | -| Mechanical Recycling | End-of-life materials can be processed via collecting, sorting, shredding, melting and transforming it into secondary raw materials for a new application. This form of recycling involves processes in which e.g. the polymer structure is not significantly changed and the plastic is preserved as a material. Thus, in terms of its complexity, mechanical recycling takes place at a lower technical level than chemical recycling. | [Mechanical recycling (basf.com)](https://www.basf.com/global/en/who-we-are/sustainability/we-drive-sustainable-solutions/circular-economy/mechanical-recycling.html) [Glossar und Methoden/Statistikportal.de](https://www.statistikportal.de/de/ugrdl/glossar-und-methoden#P) | -| Multi-input-output unit process | Operation or process with multiple inputs, such as materials and energy, and multiple outputs, such as co-products and waste | WBCSD Pathfinder | -| Negative emissions | Removal of greenhouse gases (GHGs) from the atmosphere by deliberate human activities, i.e., in addition to the removal that would occur via natural carbon cycle processes | IPCC glossary | -| Net negative emissions | A situation of net negative emissions is achieved when,as the result of human activities, more greenhouse gases are removed from the atmosphere than are emitted into it. Where multiple greenhouse gases are involved, the quantification of negative emissions depends on the climate metric chosen to compare emissions of different gases (such as global warming potential, global temperature change potential, and others, as well as the chosen time horizon). | IPCC glossary | -| Net zero CO2 emissions | Net zero carbon dioxide (CO2) emissions are achieved when anthropogenic CO2 emissions are balanced globally by anthropogenic CO2 removals over a specified period. Net zero CO2 emissions are also referred to as carbon neutrality. | IPCC glossary | -| Net zero emissions | Net zero emissions are achieved when anthropogenic emissions of greenhouse gases into the atmosphere are balanced by anthropogenic removals over a specified period. Where multiple greenhouse gases are involved, the quantification of net zero emissions depends on the climate metric chosen to compare emissions of different gases (such as global warming potential, global temperature change potential, and others, as well as the chosen time horizon). | IPCC glossary | -| Open-loop recycling | In open-loop recycling, the material is reused in other productsystems and its inherent properties are changed (e.g., recycled material may have a different chemical composition, a different structure or a higher concentration of dissolved impurities compared to primary material). | | -| output | product, material, or energy flow that leaves a unit process. Products and material include raw materials, intermediate products, co-products, and releases. | WBCSD Pathfinder | -| Partial PCF | Sum of GHG emissions and GHG removals of one or more selected process(es) in a product system, expressed as carbon dioxide equivalents and based on the selected stages or processes within the life cycle. | DIN EN ISO 14067, Feb. 2019, p. 16 | -| Post-consumer Recyclate | Post-Consumer (PCR) recycled content represents the total proportion, by mass, of post-consumer input materials incorporated in the process. | SP-Recycled-Content-Definition-Final-09102021-1.pdf | -| Post-consumer material | Material generated by households or by commercial, industrial and institutional facilities in their role as end-users of the product which can no longer be used for its intended purpose. This includes returns of material from the distribution chain. Post-consumer material can be used in the form of recovered or recycled material as a substitute for primary material. | DIN ISO 14021 | -| Pre-consumer Material | Material diverted from the waste stream during a manufacturing process. Excluded is reutilization of materials such as rework, regrind or scrap generated in a process and capable of being reclaimed within the same process that generated it. Pre-consumer material can be used in the form of recovered or recycled material as a substitute for primary material. | DIN ISO 14021 | -| Primary data | Data pertaining to a specific product or activity within a company’s value chain. Such data may take the form of activity data, emissions, or emission factors. Primary data is site-specific, company-specific (if there are multiple sites for the same product) or supply chain–specific. | WBCSD Pathfinder | -| Primary Material | Raw material coming from the environment, as well as materials of differing stages of processing (Raw materials, semi- and finished goods), which are used in the production process for the first time. | | -| Process | Set of interrelated or interacting activities that transforms inputs into outputs. | DIN EN ISO 14067, feb. 2019, p. 23 | -| prevention | measures to reduce the quantity and environmental harm of end-of-life vehicles, their materials, and substances. | | -| producer / Manufacturer | the vehicle manufacturer or the commercial importer of a vehicle into a EU Member State | | -| product | a product refers to any goods or service, which can be categorized as services (e.g. transport), software (e.g. computer program, dictionary), hardware (e.g. engine mechanical part), and processed materials (e.g. lubricant). Services have both tangible and intangible elements. The provision of a service can involve activities such as repairing a customer-supplied tangible product (e.g. an automobile) or working on a customer-supplied intangible product (e.g. preparing a tax return using an income statement). | | -| Product carbon footprint (PCF) | Total GHG emissions generated during the life cycle of a product, measured in CO2e. Within the boundary of the CX-PCF Rulebook, emissions related to the product use and end-of-life stages are excluded from the PCF. | WBCSD Pathfinder | -| Product category | Group of products that can fulfill equivalent functions. | WBCSD Pathfinder | -| Product category rules (PCR) | A set of specific rules, requirements, and guidelines for calculating PCFs (among other things) and developing environmental declarations for one or more product categories according to EN ISO 14040:2006. | WBCSD Pathfinder | -| Production | Process of combining various inputs, both material (such as metal, wood, glass, or plastics) and immaterial (such as plans, or knowledge) in order to create output. | | -| product system | collection of unit processes with elementary and product flows, performing one or more defined functions, and which models the life cycle of a product | DIN EN ISO 14067, Feb. 2019, p. 22 | -| Production waste | Waste generated in different industries in connection with production and the opposite to consumption waste, which primarily comprise municipal waste and waste comparable to it. | [Production waste / Concepts / Statistics Finland](https://www.stat.fi/meta/kas/tuotantojate_en.html) | -| R-Strategies | Various approaches to implement circular economy, known as R-strategies, have been developed to achieve less resource and material consumption in product chains and make the economy more circular. | Potting, J., et al. "Circular economy: measuring innovation in the product chain." Planbureau voor de Leefomgeving 2544 (2017). | -| raw materials | primary or secondary material that is used to produce a product. Secondary material includes recycled material. | | -| Recovery | Any operation the principal result of which is waste serving a useful purpose by replacing other materials which would otherwise have been used to fulfill a particular function, or waste being prepared to fulfill that function, in the plant or in the wider economy. | Art. 3 (15) of directive 2008/98 EC | -| Recovered Material | Material that would have otherwise been disposed of as waste or used for energy recovery, but has instead been collected and recovered [reclaimed] as a material input, in lieu of new primary material, for a recycling or a manufacturing process. | DIN ISO 14021 | -| Recyclate | Secondary raw materials that have been generated by means of the recovery of waste or are generated in the disposal of waste and are suitable for the production of products. | | -| Recycled Content | Proportion, by mass, of recycled material in a product or packaging. The recycled content is the sum of pre-consumer material and post-consumer material. | DIN ISO 14021 | -| Recycled Material | Material, that has been reprocessed from (reclaimed) material by means of a manufacturing process and made into a final product or into a component for incorporation into a product. | DIN ISO 1402 | -| Recycling | Any recovery operation by which waste materials are reprocessed into products, materials or substances whether for the original or other purposes. It includes the reprocessing of organic material but does not include energy recovery and the reprocessing into materials that are to be used as fuels or for backfilling operations. ‘recycling’ means the reprocessing in a production process of the waste materials for the original purpose or for other purposes but excluding energy recovery. Energy recovery means the use of combustible waste as a means to generate energy through direct incineration with or without other waste but with recovery of the heat; | EFRAG – Draft ESRS (11/2022) | -| Reduce | Increase efficiency in product manufacture or use by consuming fewer natural resources and materials | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172131, p. 7 | -| Reference flow | Measure of the inputs to or outputs from processes in a given product system required to fulfil the function expressed by the functional unit. | DIN EN ISO 14067, Feb. 2019, p. 24 | -| Refurbish | Restore an old product and bring it up to date (to specified quality level) | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172131, p. 7 | -| Refuse | Make product redundant by abandoning its function or by offering the same function by a radically different (e.g. digital) product or service | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172131, p. 7 | -| Releases | tbd. | | -| Remanufacture | Remanufacturing is a standardized industrial process by which a used product or part are returned to same-as-new, or better, condition and performance. The process is in line with specific technical specifications, including engineering, quality and testing standards. The process yields fully warranted products. Collecting discarded products or materials that can be refinished and sanitised to serve their original functions | CLEPA, European Environmental Agency - Eionet report ETC/WMGE 2021/10, P. 3 | -| Renewable Energy | Energy from renewable sources’ or ‘renewable energy’ means energy from renewable non-fossil sources, namely wind, solar (solar thermal and solar photovoltaic) and geothermal energy, ambient energy, tide, wave and other ocean energy, hydropower, biomass, landfill gas, sewage treatment plant gas, and biogas. | Renewable Energy Directive (2018/2001) | -| Renewable materials | Material that is derived from resources that are quickly replenished by ecological cycles or agricultural processes, so that the services provided by these and other linked resources are not endangered and remain available for the next generation. | EFRAG – Draft ESRS (11/2022) | -| Repair | Repair and maintenance of defective product so it can be used with its original function | [Link, ESPR Draft](https://op.europa.eu/en/publication-detail/-/publication/ca9846a8-6289-11ea-b735-01aa75ed71a1/language-en/format-PDF/source-120460723) | -| Repurpose | Use a redundant product or its parts in a new product with different function | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172131, p. 7 | -| Rethink | Make product use more intensive (e.g. through product-as-a-service, reuse and sharing models or by putting multi-functional products on the market) | European Commission, Categorisation System for the Circular Economy Circular Economy, doi: 10.2777 / 172131, p. 7 | -| Reuse | Reuse of a product which is still in good condition and fulfils its original function (and is not waste) for the same purpose for which it was conceived | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172131, p. 7 | -| Reutilization | Reutilization of materials such as rework, regrind, or scrap materials generated within the process and capable of being reused within the same process that generated it. Any operation by which products or components that are not waste are used again for the same purpose for which they were originally intended. Reutilization allows waste to be reduced and materials can be kept in cycle. | Adapted from ISO 14021 | -| Representative product | The representative product can be a real or an averaged (non-existing) product. The averaged product should be calculated based on sales-weighted characteristics of all technologies/materials used in the company’s production system. | | -| Resource inflow | Resource that enters the organisation's infrastructure. | EFRAG – Draft ESRS (11/2022) | -| Resource outflow | Resource that leaves the organisation's infrastructure. | EFRAG – Draft ESRS (11/2022) | -| Reuse | Any operation by which products and components that are not waste are used again for the same purpose for which they were conceived. This may involve cleaning or small adjustments so it is ready for the next use without significant definition. | Art. 3 (13) of the Directive 2008/98/EC & EFRAG-Draft ESRS (11/2022) | -| Risk management | Plans, actions, strategies, or policies to reduce the likelihood and/or consequences of risks or to respond to consequences. | IPCC Glossary, p. 45 | -| Secondary data | Secondary data can include data from databases and published literature, default emission factors from national inventories, calculated data estimates or other representative data, validated by competent authorities. | DIN EN ISO 14067, Feb. 2019, p. 28 | -| Secondary Material | Secondary materials are any materials that are not the primary products from manufacturing and other industrial sectors. These materials can include scrap and residuals from production processes and products that have been recovered at the end of their useful life. | [United States Environmental Protection Agency](https://www.epa.gov/smm/sustainable-management-industrial-non-hazardous-secondary-materials) | -| Secondary Material Framework | Secondary Material Quota = on vehicle level, Secondary Material Content = on component level | | -| Secondary Material Quota (on vehicle level) | not found | | -| Secondary Raw Material | Material that serves as a substitute for primary material and is kept in cycle. | | -| Secondary Raw Material Content | The content of materials that serve as substitutes for primary materials and are kept in cycle. The secondary raw material content is calculated in proportion of secondary material and product weight. | | -| Supplier gate | Supplier's production site or supplier's distribution site. | | -| Supply chain | Those involved, through upstream and downstream linkages, in process and activities relating to the provision of products to the user. | DIN EN ISO 14067, Feb. 2019, p. 28 | -| Sustainability | A dynamic process that guarantees the persistence of natural and human systems in an equitable manner. | IPCC Glossary, p. 49 | -| System boundary | Boundary based on a set of criteria representing which unit processes are a part of the system under study. | DIN EN ISO 14040, Feb. 2021, p. 13 | -| Treatment | Activities carried out after the end-of-life vehicle is handed over to a facility for the elimination of pollutants, dismantling, coarse crushing, shredding, recycling or preparation for disposal of shredder waste, as well as other activities related to the recycling and/or disposal of end-of-life vehicles and end-of-life vehicle components. | | -| Unit process | Smallest element considered in the life cycle inventory analysis for which input and output data are quantified. | DIN EN ISO 14067, Feb. 2019, p. 23 | -| Upstream emissions | Indirect GHG emissions that occur in the value chain prior to the processes owned or controlled by the reporting company. All upstream transportation emissions are also included as part of upstream emissions. | WBCSD Pathfinder | -| Use stage | That part of the life cycle of a product that occurs between the transfer of the product to the consumer and the end-of-life of the product. | Adapted from WBCSD Pathfinder | -| Value chain | All the upstream and downstream activities associated with the operations of a company. | WBCSD Pathfinder | -| Vehicle | Vehicles of classes M1 or N1 according to Annex II Section A of Directive 70/156/EC and three-wheeled vehicles according to Directive 92/61/EC, however excluding three-wheeled motorcycles. | | -| VIN | vehicle identification number | ISO 3779:2009-10 | -| Waste | Materials, co-products, products, or emissions without economic value that the holder intends or is required to dispose of. | DIN EN ISO 14067, Feb. 2019, p. 26; WBCSD Pathfinder | -| Waste | Any substance or object which the holder discards or intends or is required to discard. | Art. 3(1) of the Directive 2008/98/EC | -| Waste hierarchy | The waste hierarchy is the following priority order in waste prevention and management: (a) prevention; (b) preparing for re-use; (c) recycling; (d) other recovery, e.g., energy recovery; and (e) disposal. | Art. 4 (1) of the Directive 2008/98/EC | -| Waste Prevention | Waste prevention is any measure taken to ensure that a substance, material or article does not become a waste. It is used to reduce the amount of waste, the harmful effects of the waste on people and the environment, or the content of harmful substances in materials and articles. | Kreislaufwirtschaftsgesetz | - -## NOTICE - -This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - -- Copyright (c) 2023,2024 BMW AG -- Copyright (c) 2023,2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) -- Copyright (c) 2023,2024 BASF SE -- Copyright (c) 2023,2024 SAP Deutschland SE & Co.KG -- Copyright (c) 2023,2024 T-Systems International GmbH -- Copyright (c) 2023,2024 LRP Auto-Recycling Leipzig GmbH -- Copyright (c) 2023,2024 Robert Bosch GmbH -- Copyright (c) 2023,2024 tec4U-Ingenieurgesellschaft mbH -- Copyright (c) 2023,2024 Contributors to the Eclipse Foundation# NOTICE - -This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - -- Copyright (c) 2023,2024 BMW AG -- Copyright (c) 2023,2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) -- Copyright (c) 2023,2024 BASF SE -- Copyright (c) 2023,2024 SAP Deutschland SE & Co.KG -- Copyright (c) 2023,2024 T-Systems International GmbH -- Copyright (c) 2023,2024 LRP Auto-Recycling Leipzig GmbH -- Copyright (c) 2023,2024 Robert Bosch GmbH -- Copyright (c) 2023,2024 tec4U-Ingenieurgesellschaft mbH -- Copyright (c) 2023,2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/communication_architecture.svg.license b/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/communication_architecture.svg.license deleted file mode 100644 index f493e6d5bf0..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/communication_architecture.svg.license +++ /dev/null @@ -1,13 +0,0 @@ -## NOTICE - -This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - -- Copyright (c) 2024 BMW AG -- Copyright (c) 2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) -- Copyright (c) 2024 BASF SE -- Copyright (c) 2024 SAP Deutschland SE & Co.KG -- Copyright (c) 2024 T-Systems International GmbH -- Copyright (c) 2024 LRP Auto-Recycling Leipzig GmbH -- Copyright (c) 2024 Robert Bosch GmbH -- Copyright (c) 2024 tec4U-Ingenieurgesellschaft mbH -- Copyright (c) 2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.05/kits/Demand and Capacity Management Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-24.05/kits/Demand and Capacity Management Kit/page_adoption-view.md deleted file mode 100644 index 83e74e2d88e..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Demand and Capacity Management Kit/page_adoption-view.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -id: adoption-view -title: Adoption View -description: 'A first impression' -sidebar_position: 2 -toc_min_heading_level: 2 -toc_max_heading_level: 2 ---- - -![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) - -## Vision & Mission - -The Catena-X-Standards for Demand- and Capacity-Management enable participants of the automotive supply chain to become more resilient and to increase the degree of collaboration aimed at avoiding or solving production bottlenecks as well as surplus situations in a tactical horizon of 1-2 years. - -Thereby the standards empower participants to share data in a secure and sovereign way while ensuring the interoperability of the different applications involved in the process. - -## Status Quo - -### Today's challenge for automotive companies - -Resilience has become imperative within Supply Chain Management, especially over the past years. With the growing complexity of supply chains and a rising number of global and local crises, small and medium enterprises (SMEs) as well as large enterprises (LEs) are facing an increased risk of serious disruptions in their supply chains, bullwhip effects and in the worst case even temporary production shutdowns with a high effort and costs of replanning. - -Inside the volatile and highly complex surroundings of the automotive industry nowadays, mostly tailor-made, proprietary and often fully manual IT solutions support the demand and capacity management processes along the value chain. On the one side there is no common understanding of these processes among the participants. On the other side, different data formats as well as application programming interfaces are used, which is increasing the complexity in the data exchange and which is leading to transfer problems, inconsistencies, or even loss of data. - -## Business Value - -### Why DCM KIT? - -The purpose and focus of Demand and Capacity Management (DCM) KIT is twofold: - -- Define a common understanding of the DCM process thus paving the way for more proactive and efficient collaboration. -- Establish process and application interoperability with the help of common semantics and unified interfaces for data exchange while ensuring the data sovereignty of data providers. - -Implementing the DCM standards will add the following core capabilities to business applications: - -- Provisioning and consumption of material demands data in a sovereign manner. -- Provisioning and consumption of capacity data in a sovereign manner. -- Discovery of bottlenecks and surplus capacity situations by employing a unified calculation logic. - -## Standards - -The DCM standard consists of three main elements: - -- **Core Business logic** – to focus on a **common understanding** of the **DCM processes** among the participants. **Version 2.0.0** (Release 24.05) [CX-0128 Demand and Capacity Management Data Exchange](https://catena-x.net/de/standard-library) -- **Data model** – to align the structure of the shared data and enable the adoption of the core business logic without misinterpretation. **Version 2.0.0** (Release 24.05) [CX-0128 Demand and Capacity Management Data Exchange](https://catena-x.net/de/standard-library) -- **APIs** – to make sure that data are transmitted and consumed properly as well as are identically interpreted across companies. **Version 2.0.0** (Release 24.05) [CX-0128 Demand and Capacity Management Data Exchange](https://catena-x.net/de/standard-library) - -### POWER of STANDARD - -Standards create trust. Customer and Supplier can form new partnerships confidently. Knowing that integration in the network will be dramatically simplified. Standardization can help reduce costs by eliminating redundancies and streamlining processes. By adopting a common set of practices and technologies, businesses can avoid the need to develop their own proprietary systems, which can be expensive and time-consuming. - -### DATA SOVEREIGNTY in FOCUS - -DCM KIT keeps up with Catena X commitment to data sovereignty. This KIT has the goal to always comply with the data sovereignty principle implemented by the Eclipse Dataspace Connector. That enables all participants in the supply chain to always stay in full control of their own data. - -This is how sharing data is fun. - -### INTEROPERABILITY at its BEST - -Application and Service Provider can reduce investments to integrate DCM data models/API specification from DCM KIT. - -The Kit enables the offering of value-add services and innovation based on process description of the core business logic and how a collaborative approach is a win-win-situation for customer and supplier. - -### COLLABORATION is KEY - -The DCM KIT enables better and faster issue resolution. We believe that collaboration is the key to creating and maintaining strong partnerships between customers and suppliers and, at the same time, enhancing problem solving to reach a more balanced and efficient supply and demand management. - -Of course, by realizing efficiency through improved collaboration all involved partners will gain competitive advantage over those that do not collaborate. - -## Semantic Models - -| Semantic Model | Link to GitHub Repository | -| ------------- | ------------- | -| WeekBasedCapacityGroup | | -| WeekBasedMaterialDemand | | -| IdBasedRequestForUpdate | | -| IdBasedComment | | - -## Notice - -This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) - -- SPDX-License-Identifier: CC-BY-4.0 -- SPDX-FileCopyrightText: 2023,2024 ZF Friedrichshafen AG -- SPDX-FileCopyrightText: 2023,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -- SPDX-FileCopyrightText: 2023,2024 SAP SE -- SPDX-FileCopyrightText: 2023,2024 Volkswagen AG -- SPDX-FileCopyrightText: 2023,2024 Mercedes Benz Group AG -- SPDX-FileCopyrightText: 2023,2024 BASF SE -- SPDX-FileCopyrightText: 2023,2024 SupplyOn AG -- SPDX-FileCopyrightText: 2023,2024 Henkel AG & Co.KGaA -- SPDX-FileCopyrightText: 2023,2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) -- SPDX-FileCopyrightText: 2023,2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.05/kits/Demand and Capacity Management Kit/page_architecture-view.md b/docs-kits_versioned_docs/version-24.05/kits/Demand and Capacity Management Kit/page_architecture-view.md deleted file mode 100644 index 1aafa036d4b..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Demand and Capacity Management Kit/page_architecture-view.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -id: architecture-view -title: Architecture View -description: The view from above -sidebar_position: 4 ---- - -![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) - -## Why​ - -This page is relevant for you, if one of the following cases applies: - -1. You want to participate in the demand and capacity usecase as either a customer or a supplier and intend to adapt your existing custom application landscape to Catena-X DCM. -2. You want to offer business solutions to the aforementioned customers and suppliers by adapting your commercial software product for Catena-X DCM. - -If none of this applies to you or you are unsure, please refer to [Operation View](page_operation-view.md) first. - -> Note: If you purchase commercial software from a software vendor, the vendor needs to adopt their software for you. Please refer your vendor to this page. - -## Prerequisites - -In order to participate in the Catena-X network an Eclipse Dataspace Connector (EDC), or a similar connector fulfilling the Dataspace Protocol, is required, as the endpoints must not be called directly but only through a Data Asset/Contract Offer. - -In addition use case participants need to be boarded onto the Catena-X network. - -Participants intending to act as a customer require at least one BPNL for their company as well as one BPNS for every site they intend to integrate into the Catena-X network. - -Participants intending to act as a supplier require at least one BPNL for their company. - -## How - -If you want to adapt your custom or commercial applications to work with the Catena-X DCM usecase you will have to - -1. Modify the source code of your application -2. Enable your software to offer multiple REST API endpoints in order to receive data -3. Enable your software to call multiple REST API endpoints in order to send data -4. Enable your software to communicate through an Eclipse Dataspace Connector (EDC), or a similar solution, which is to be setup separately - -For details, please refer to the Catena-X DCM standard [CX-0128](https://catena-x.net/de/standard-library). This page provides a non-normative overview only. - -## Solution Overview - -For the exchange of the demand and capacity information required by the process, five REST APIs are used: - -- WeekBasedMaterialDemand API - used for the exchange of demand information -- WeekBasedCapacityGroup API - used for the exchange of capacity information -- RequestForUpdate API - used for requesting an update of WeekBasedMaterialDemand or WeekBasedCapacityGroup -- IdBasedComment API - used for the exchange of additional comments regarding WeekBasedMaterialDemand or WeekBasedCapacityGroup -- Asset Administration Shell (AAS) API - used when using DCM in combination with a Digital Twin Registry - -All those APIs are REST-based APIs. - -Implementing all endpoints is mandatory, except the AAS API endpoint, which is optional. - -Note that the software solutions used as well as the business process should be enabled in order to receive WeekBasedMaterialDemand information from customers and send WeekBasedCapacityGroup information back to those customers. Also, it needs to be possible to send the own WeekBasedMaterialDemand information to the suppliers and receive their WeekBasedCapacityGroup information in return. Therefore, the software tools used need to be able to send/receive these information and the users need to be able to work with the information in the planning processes. - -When implementing the API endpoints, it is important to follow the DCM standard closely in order to ensure compatibility with other solutions. This is not limited to technical aspects, but also extends to the business definition of demand and capacity. - -### Architecture Constraints - -| Constraint ID | Constraint | -| ------------- | ------------- | -| C-1 | Software and third party software must be compliant to the Catena-X and Eclipse Foundation Guidelines/Policies [eclipse_foundation](https://www.eclipse.org/projects/dev_process/) | -| C-2 | [Eclipse Dataspace Connector](https://github.com/eclipse-tractusx/tractusx-edc/tree/main) (EDC), or a similar solution, must be used for data transfer between different legal entities; e.g. the API endpoints listed above may only be called through a Data Asset/Contract Offer | - -## Sequence Diagram - -The overall interaction between partners is illustrated by the following sequence diagram: - -```mermaid -sequenceDiagram - box rgb(80,80,80) Customer - participant Customer - participant CustomerApp as Customer App - participant CustomerConnector as Customer connector - end - box rgb(80,80,80) Core Services - participant CoreBpnlDiscovery as Core BPNL Discovery - participant CoreEdcDiscovery as Core EDC discovery - end - box rgb(80,80,80) Supplier - participant SupplierConnector as Supplier connector - participant SupplierApp as Supplier App - participant Supplier - end - - Customer ->> CustomerApp: Create MaterialDemand - activate CustomerApp - CustomerApp -->> Customer: MaterialDemand created - deactivate CustomerApp - Customer ->> CustomerApp: Finalize MaterialDemand - activate CustomerApp - CustomerApp ->> CoreBpnlDiscovery: Resolve Supplier Base Data into BPNL - activate CoreBpnlDiscovery - CoreBpnlDiscovery -->> CustomerApp: Supplier BPNL - deactivate CoreBpnlDiscovery - CustomerApp ->> CoreEdcDiscovery: Resolve Supplier BPNL into connector URL catalogue - activate CoreEdcDiscovery - CoreEdcDiscovery -->> CustomerApp: Connector URL catalogue - deactivate CoreEdcDiscovery - CustomerApp ->> CustomerApp: Find correct connector via URL catalogue inspection - CustomerApp ->> CustomerConnector: Transmit MaterialDemand - activate CustomerConnector - CustomerConnector ->> SupplierConnector: Resolve connector Endpoint and connector service catalogue into MaterialDemand API URL - activate SupplierConnector - SupplierConnector ->> CustomerConnector: Framework & Contract Negotiation - CustomerConnector -->> SupplierConnector: Framework & Contract Negotiation - SupplierConnector -->> CustomerConnector: MaterialDemand API URL - CustomerConnector ->> SupplierConnector: Transmit MaterialDemand - SupplierConnector ->> SupplierApp: Transmit MaterialDemand - activate SupplierApp - SupplierApp ->> Supplier: Transmit MaterialDemand - Supplier -->> SupplierApp: MaterialDemand received - SupplierApp -->> SupplierConnector: MaterialDemand received - deactivate SupplierApp - SupplierConnector -->> CustomerConnector: MaterialDemand received - deactivate SupplierConnector - CustomerConnector -->> CustomerApp: MaterialDemand received - deactivate CustomerConnector - CustomerApp -->> Customer: MaterialDemand finalized & synchronized - deactivate CustomerApp - - Supplier ->> SupplierApp: Create CapacityGroup - activate SupplierApp - SupplierApp -->> Supplier: CapacityGroup created - deactivate SupplierApp - Supplier ->> SupplierApp: Link Demands to CapacityGroup - activate SupplierApp - SupplierApp -->> Supplier: Demands Linked - deactivate SupplierApp - Supplier ->> SupplierApp: Finalize CapacityGroup - activate SupplierApp - SupplierApp ->> CoreBpnlDiscovery: Resolve Customer Base Data into BPNL - activate CoreBpnlDiscovery - CoreBpnlDiscovery -->> SupplierApp: Customer BPNL - deactivate CoreBpnlDiscovery - SupplierApp ->> CoreEdcDiscovery: Resolve Customer BPNL into connector URL catalogue - activate CoreEdcDiscovery - CoreEdcDiscovery -->> SupplierApp: connector URL catalogue - deactivate CoreEdcDiscovery - SupplierApp ->> SupplierApp: Find correct connector via URL catalogue inspection - SupplierApp ->> SupplierConnector: Transmit CapacityGroup - activate SupplierConnector - SupplierConnector ->> CustomerConnector: Resolve connector Endpoint and connector service catalogue into CapacityGroup API URL - activate CustomerConnector - CustomerConnector ->> SupplierConnector: Framework & Contract Negotiation - SupplierConnector -->> CustomerConnector: Framework & Contract Negotiation - CustomerConnector -->> SupplierConnector: CapacityGroup API Endpoint - SupplierConnector ->> CustomerConnector: Transmit CapacityGroup - CustomerConnector ->> CustomerApp: Transmit CapacityGroup - activate CustomerApp - CustomerApp ->> Customer: Transmit CapacityGroup - Customer -->> CustomerApp: CapacityGroup received - CustomerApp -->> CustomerConnector: CapacityGroup received - deactivate CustomerApp - CustomerConnector -->> SupplierConnector: CapacityGroup received - deactivate CustomerConnector - SupplierConnector -->> SupplierApp: CapacityGroup received - deactivate SupplierConnector - SupplierApp -->> Supplier: CapacityGroupfinalized & synchronized - deactivate SupplierApp -``` - -Note that the supplier does not need to immediately reply with capacity group after receiving demand information, although a timely reply is appreciated, there can be a considerable time in between instead. - -Digital Twins can also be used to reference parts, but are not shown in the sequence diagram for simplicity. diff --git a/docs-kits_versioned_docs/version-24.05/kits/Demand and Capacity Management Kit/page_changelog.md b/docs-kits_versioned_docs/version-24.05/kits/Demand and Capacity Management Kit/page_changelog.md deleted file mode 100644 index b79dff6535c..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Demand and Capacity Management Kit/page_changelog.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -id: changelog -title: Changelog -description: 'What has changed recently?' -sidebar_position: 1 -toc_min_heading_level: 2 -toc_max_heading_level: 2 ---- - -![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) - -## DCM KIT Changelog - -All notable changes to this Kit will be documented in this file. - -## [1.0.0] - unreleased - -### Added - -- Added [DCM Operation View](page_operation-view.md) - -### Changed - -- Changed banner image file location and converted .png image to .svg -- Updated aspect models in [Adoption View](page_adoption-view.md) to new versions -- Updated aspect models and API definitions in [Development View](page_development-view.md) to new versions -- Updated WeekBasedMaterialDemand data model and API chapters to new data model (Replaced MaterialDemand with WeekBasedMaterialDemand aspect model) -- Updated choice of words and writing pattern throughout the documentation - -### Removed - -- ./. - -## [0.2.0] - 2024-03-08 - -### Added - -- Added Architecture View -- Added IdBasedRequestForUpdate data model reference to Adoption View -- Added IdBasedComment data model reference to Adoption View -- Added IdBasedRequestForUpdate data model chapter to Development View -- Added IdBasedComment data model chapter to Development View -- Added IdBasedRequestForUpdate API chapter to Development View -- Added IdBasedComment API chapter to Development View - -### Changed - -- Updated DCM standard references in Adoption View (Merged CX-0046, CX-0047 and CX-0048 into CX-0128) -- Updated data model references in Adoption View -- Updated MaterialDemand data model chapter to new data models and versions (Replaced WeekBasedMaterialDemand with MaterialDemand aspect model) -- Updated WeekBasedCapacityGroup data model chapter to new data models and versions -- Updated MaterialDemand API chapter to new API definitions -- Updated WeekBasedCapacityGroup API chapter to new API definitions - -### Removed - -n/a - -## [0.1.0] - 2023-03-01 - -### Added - -- Adoption View -- Development View - -### Changed - -n/a - -### Removed - -n/a diff --git a/docs-kits_versioned_docs/version-24.05/kits/Demand and Capacity Management Kit/page_development-view.md b/docs-kits_versioned_docs/version-24.05/kits/Demand and Capacity Management Kit/page_development-view.md deleted file mode 100644 index c975e6dae99..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Demand and Capacity Management Kit/page_development-view.md +++ /dev/null @@ -1,1284 +0,0 @@ ---- -id: development-view -title: Development View -description: 'What do I have to implement?' -sidebar_position: 3 ---- - -![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) - -This page describes the most important parts for the software implementation of the DCM standards. For the full -technical specification, please refer to the -standard [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. - -## Introduction - -This document describes the `WeekBasedMaterialDemand`, `WeekBasedCapacityGroup`, `IdBasedRequestForUpdate` and `IdBasedComment` -semantic models and the API definitions used in the DCM Catena-X network. - -## Aspect Models - -### Aspect Model "WeekBasedMaterialDemand" - -For the exchange of material demand information, customers MUST provide data to suppliers. The data format specified in [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary] MUST be conformed to. - -Customers and suppliers MUST implement the `WeekBasedMaterialDemand` data model. - -Suppliers MUST be able to consume and process material demand information. - -Customers MUST be able to provide and process material demand information. - -Data providers of `WeekBasedMaterialDemand` data MUST ensure that it aligns with the semantic model specified in [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. - -The unique identifier for the semantic model, as specified in [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary], MUST be used to define the meaning of the data being transferred. - -Business applications utilizing `WeekBasedMaterialDemand` data MUST consume this data, conforming to the semantic model specified in [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. - -Within the Catena-X data space `WeekBasedMaterialDemand` data MUST be requested and exchanged using a connector, conforming to the standards [CX-0018][StandardLibrary] and [CX-0002][StandardLibrary]. - -The JSON Payload provided by data providers MUST comply with the JSON schema as specified in [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. - -The characteristics BPNL and BPNS MUST be used, conforming with [CX-0010][StandardLibrary]. - -#### Sample Data - -```json -{ - "unitOfMeasureIsOmitted" : false, - "unitOfMeasure" : "unit:piece", - "materialDescriptionCustomer" : "Spark Plug", - "materialGlobalAssetId" : "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df", - "materialDemandId" : "0157ba42-d2a8-4e28-8565-7b07830c1110", - "materialNumberSupplier" : "MNR-8101-ID146955.001", - "supplier" : "{{CATENAX-SUPPLIER-BPNL}}", - "changedAt" : "2023-11-05T08:15:30.123-05:00", - "demandSeries" : [ { - "expectedSupplierLocation" : "{{CATENAX-SUPPLIER-BPNS}}", - "demands" : [ { - "demand" : 1000, - "pointInTime" : "2023-10-09" - } ], - "customerLocation" : "{{CATENAX-CUSTOMER-BPNS}}", - "demandCategory" : { - "demandCategoryCode" : "0001" - } - } ], - "materialDemandIsInactive" : true, - "materialNumberCustomer" : "MNR-7307-AU340474.002", - "customer" : "{{CATENAX-CUSTOMER-BPNL}}" -} -``` - -The semantic model has the unique identifier - -```text -urn:samm:io.catenax.week_based_material_demand:3.0.0 -``` - -Data providers MUST use this identifier to clearly define the semantics of the data they are transferring. - -All other file format and serializations are derived from a RDF turtle file. It is the source for the Semantic Aspect Meta Model. You can access the RDF turtle file at the following URL: - -```text -https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.week_based_material_demand/3.0.0/WeekBasedMaterialDemand.ttl -``` - -The open source command line tool of the Eclipse Semantic Modeling Framework is used to generate other file formats such as JSON schema, AASX for Asset Administration Shell Submodel template or HTML documentation. - -### Aspect Model "WeekBasedCapacityGroup" - -For the exchange of capacity group information, suppliers MUST provide data to customers. The data format specified in [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary] MUST be conformed to. - -Customers and suppliers MUST implement the `WeekBasedCapacityGroup` data model. - -Suppliers MUST be able to provide and process capacity group information. - -Customers MUST be able to consume and process capacity group information. - -Data providers of `WeekBasedCapacityGroup` data MUST ensure that it aligns with the semantic model specified in [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. - -The unique identifier for the semantic model, as specified in [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary], MUST be used to define the meaning of the data being transferred. - -Business applications utilizing `WeekBasedCapacityGroup` data MUST consume this data, conforming to the semantic model specified in [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. - -Within the Catena-X data space `WeekBasedCapacityGroup` data MUST be requested and exchanged using a connector, conforming to the standards [CX-0018][StandardLibrary] and [CX-0002][StandardLibrary]. - -The JSON Payload provided by data providers MUST comply with the JSON schema as specified in [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. - -The characteristics BPNL and BPNS MUST be used, conforming with [CX-0010][StandardLibrary]. - -#### Sample Data - -```json -{ - "unitOfMeasure" : "unit:piece", - "linkedDemandSeries" : [ { - "loadFactor" : 3.5, - "materialNumberCustomer" : "MNR-7307-AU340474.002", - "materialNumberSupplier" : "MNR-8101-ID146955.001", - "customerLocation" : "{{CATENAX-CUSTOMER-BPNS}}", - "demandCategory" : { - "demandCategoryCode" : "0001" - } - } ], - "linkedCapacityGroups" : [ "be4d8470-2de6-43d2-b5f8-2e5d3eebf3fd" ], - "unitOfMeasureIsOmitted" : false, - "capacityGroupIsInactive" : true, - "demandVolatilityParameters" : { - "rollingHorizonAlertThresholds" : [ { - "sequenceNumber" : 1, - "absoluteNegativeDeviation" : 100.0, - "subhorizonLength" : 4, - "relativeNegativeDeviation" : 0.3, - "absolutePositiveDeviation" : 100.0, - "relativePositiveDeviation" : 0.2 - } ], - "measurementInterval" : 4, - "startReferenceDateTime" : "2024-01-10T12:00:00.320Z" - }, - "supplier" : "{{CATENAX-SUPPLIER-BPNL}}", - "name" : "Spark Plugs on drilling machine for car model XYZ", - "supplierLocations" : [ "{{CATENAX-SUPPLIER-BPNS}}" ], - "capacities" : [ { - "pointInTime" : "2022-08-01", - "agreedCapacity" : 1800, - "actualCapacity" : 1000, - "maximumCapacity" : 2000, - "deltaProductionResult" : 400 - } ], - "changedAt" : "2023-03-10T12:27:11.320Z", - "capacityGroupId" : "0157ba42-d2a8-4e28-8565-7b07830c1110", - "customer" : "{{CATENAX-CUSTOMER-BPNL}}" -} -``` - -The semantic model has the unique identifier - -```text -urn:samm:io.catenax.week_based_capacity_group:3.0.0 -``` - -Data providers MUST use this identifier to clearly define the semantics of the data they are transferring. - -All other file format and serializations are derived from a RDF turtle file. It is the source for the Semantic Aspect Meta Model. You can access the RDF turtle file at the following URL: - -```text -https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.week_based_capacity_group/3.0.0/WeekBasedCapacityGroup.ttl -``` - -The open source command line tool of the Eclipse Semantic Modeling Framework is used to generate other file formats such as JSON schema, AASX for Asset Administration Shell Submodel template or HTML documentation. - -### Aspect Model "IdBasedRequestForUpdate" - -`IdBasedRequestForUpdate` can be exchanged between customer and supplier conforming to the API standard described in [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. The data format specified in this standard MUST be conformed to. - -Customers and suppliers MUST implement the `IdBasedRequestForUpdate` data model. - -Customers and suppliers MUST be able to consume and process a request for update. - -Providing an `IdBasedRequestForUpdate` is OPTIONAL. It is RECOMMENDED to be both capable of providing and consuming a request for update. - -Providers of an `IdBasedRequestForUpdate` MUST ensure that it aligns with the semantic model specified in [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. - -The unique identifier for the semantic model, as specified in [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary], MUST be used to define the meaning of the data being transferred. - -Business applications utilizing `IdBasedRequestForUpdate` data MUST consume this data, conforming to the semantic model specified in [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. - -Within the Catena-X data space `IdBasedRequestForUpdate` data MUST be requested and exchanged using a connector, conforming to the standards [CX-0018][StandardLibrary] and [CX-0002][StandardLibrary]. - -The JSON Payload provided by data providers MUST comply with the JSON schema as specified in [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. - -#### Sample Data - -```json -{ - "weekBasedMaterialDemand" : [ { - "materialDemandId" : "0157ba42-d2a8-4e28-8565-7b07830c3456", - "changedAt" : "2023-03-10T12:27:11.320Z" - } ], - "weekBasedCapacityGroup" : [ { - "capacityGroupId" : "0157ba42-d2a8-4e28-8565-7b07830c1110", - "changedAt" : "2023-03-10T12:27:11.320Z" - } ] -} -``` - -The semantic model has the unique identifier - -```text -urn:samm:io.catenax.id_based_request_for_update:3.0.0 -``` - -Data providers MUST use this identifier to clearly define the semantics of the data they are transferring. - -All other file format and serializations are derived from a RDF turtle file. It is the source for the Semantic Aspect Meta Model. You can access the RDF turtle file at the following URL: - -```text -https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.id_based_request_for_update/3.0.0/IdBasedRequestForUpdate.ttl -``` - -The open source command line tool of the Eclipse Semantic Modeling Framework is used to generate other file formats such as JSON schema, AASX for Asset Administration Shell Submodel template or HTML documentation. - -### Aspect Model "IdBasedComment" - -An `IdBasedComment` can refer to a `WeekBasedCapacityGroup`, its weekly capacities, a `WeekBasedMaterialDemand`, or its weekly demand series. This comment can be exchanged between customer and supplier conforming to the API standard described [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. The data format specified in this standard MUST be conformed to. - -Customers and suppliers MUST implement the `IdBasedComment` data model. - -Customers and suppliers MUST be able to provide and process an `IdBasedComment`. - -Customers and suppliers MUST be able to consume and process an `IdBasedComment`. - -Data providers of `IdBasedComment` data MUST ensure that it aligns with the semantic model specified in [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. - -The unique identifier for the semantic model, as specified in [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary], MUST be used to define the meaning of the data being transferred. - -Business applications utilizing `IdBasedComment` data MUST consume this data, conforming to the semantic model specified in [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. - -Data consumers and data providers MUST comply with the license of the semantic model specified in [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. - -Within the Catena-X data space `IdBasedComment` data MUST be requested and exchanged using a connector, conforming to the standards [CX-0018][StandardLibrary] and [CX-0002][StandardLibrary]. - -The JSON Payload provided by data providers MUST comply with the JSON schema as specified in [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. - -The characteristics BPNL and BPNS MUST be used, conforming with [CX-0010][StandardLibrary]. - -#### Sample Data - -```json -{ - "postedAt" : "2023-03-10T12:27:11.320Z", - "listOfReferenceDates" : [ "2023-11-05" ], - "author" : "someone@company.com", - "supplier" : "{{CATENAX-SUPPLIER-BPNL}}", - "commentType" : "information", - "commentId" : "f5c151e4-30b5-4456-94fd-2a7b559b6121", - "changedAt" : "2023-03-10T12:27:11.320Z", - "commentText" : "Hello, this is a comment!", - "requestDelete" : true, - "objectId" : "dfeb1334-497e-4dab-97c1-4e6f4e1c0320", - "objectType" : "urn:samm:io.catenax.week_based_capacity_group", - "customer" : "{{CATENAX-CUSTOMER-BPNL}}" -} -``` - -The semantic model has the unique identifier - -```text -urn:samm:io.catenax.id_based_comment:1.0.0 -``` - -Data providers MUST use this identifier to clearly define the semantics of the data they are transferring. - -All other file format and serializations are derived from a RDF turtle file. It is the source for the Semantic Aspect Meta Model. You can access the RDF turtle file at the following URL: - -```text -https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.id_based_comment/1.0.0/IdBasedComment.ttl -``` - -The open source command line tool of the Eclipse Semantic Modeling Framework is used to generate other file formats such as JSON schema, AASX for Asset Administration Shell Submodel template or HTML documentation. - -## Application Programming Interfaces - -### Header - -When exchanging data with a DCM partner, the POST request payload MUST be structured as follows: - -```json -{ - "messageHeader": - , - - "content":{ - "informationObject":[ - , - - ] - } -} -``` - -This format ensures that the header, which contains metadata about the message, is kept separate from the content, which includes the actual data being exchanged. The content section can hold multiple `informationObject` entries. These objects can be one of the following types: `WeekBasedMaterialDemand`, `WeekBasedCapacityGroup`, `IdBasedComment`, or `IdBasedRequestForUpdate`. - -The master reference for generating additional file formats and serializations is the RDF turtle file, which is an instance of the Semantic Aspect Meta Model. The RDF turtle file for the `messageHeaderObject` is defined in a centralized shared aspect model and can be accessed at the following URL: - -```text -https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.shared.message_header/3.0.0/MessageHeaderAspect.ttl -``` - -Within the RDF turtle file, you will find detailed descriptions for how to use the message header. - -### WeekBasedMaterialDemand API - -The `WeekBasedMaterialDemand` object is used to provide material demand information from customer to supplier. - -Customers MUST be able to provide `WeekBasedMaterialDemand`. - -Suppliers MUST be able to consume and process `WeekBasedMaterialDemand`. - -The `WeekBasedMaterialDemand` API MUST be published towards the network using a Data Asset/Contract Offer, which is in line with the Dataspace Protocol as specified by the International Data Spaces Association (IDSA) and MUST conform with the Catena-X standard [CX-0001][StandardLibrary]. - -#### Data Exchange - -Customers MUST provide suppliers with `WeekBasedMaterialDemand` data via HTTP POST request. The data MUST conform to the format specified in this standard and it MUST NOT exceed 15 MiB in size. It MUST be a valid JSON string and MUST include all mandatory properties. The data model with all its properties MUST conform to the respective aspect model and the definitions above. Properties marked as "optional" MAY be included in the data. -When consuming a payload, that contains unknown properties not described within the data model but is otherwise correct, those properties MUST be ignored. - -Attributes that are strings MUST be formatted correctly. For example, `expectedSupplierLocation` MUST be formatted as a BPNS. The `pointInTime` property MUST represent the week's Monday in the format YYYY-MM-DD as described in ISO8601. - -The `demandCategory` property MUST be set to one of the predefined values from [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. - -The `unitOfMeasure` property MUST be set to one of the predefined values from [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. If no unit of measure is to be provided, the customer MUST omit the property and set the `unitOfMeasureIsOmitted` flag to true. - -Multiple `WeekBasedMaterialDemand` aspects MAY be provided in one transfer as a JSON list. If only one `WeekBasedMaterialDemand` aspect is provided, it MUST be as list with one entry. - -The current week is denominated as N=0, the next week as N=1, the week after the next week as N=2 and so on. -The data series in the `WeekBasedMaterialDemand` SHOULD start from week N=2. The dataset MUST include at least one week, where N>1 and MUST NOT contain duplicate weeks. Weeks N=0 and N=1 MAY be included. If demand changes, the entire dataset MUST be provided again, avoiding inconsistent or incomplete data. The new dataset might contain additional data or less data then the previous version of the same dataset. This includes the possibility that a `demandSeries` might have been removed entirely. Each `WeekBasedMaterialDemand` object MUST be unique for a given `supplier`, `customer` and `materialNumberCustomer` combination. This means that customers need to aggregate demands from all their factories before providing them to suppliers as a single `WeekBasedMaterialDemand`. - -If a week's demand is zero (value = `0`), it MUST be explicitly stated and included in the `WeekBasedMaterialDemand`, unknown demands (value = `null`) SHOULD be omitted. - -The customer MAY define a `WeekBasedMaterialDemand` as inactive by setting and transferring the `materialDemandIsInactive` flag to the supplier. The inactive `WeekBasedMaterialDemand` and their related `demandSeries` data MUST be ignored during the demand-capacity matching over the whole horizon, i.e. must be considered in the same way as not existing data for the demand-capacity matching. Inactivating a `WeekBasedMaterialDemand` may trigger their archiving or deletion in the local DCM application of the business partner. -Once a `WeekBasedMaterialDemand` has been set as inactive, this MAY be undone by the customer by reverting the `materialDemandIsInactive` flag. In this case, the `WeekBasedMaterialDemand` MUST again be considered during the demand-capacity matching. The reverting of the inactive flag of a `WeekBasedMaterialDemand` may correspond to a newly created and initially transferred or to an updated `WeekBasedMaterialDemand`. - -#### UUID generation and handling - -UUIDv4 is REQUIRED for exchanging demand data to ensure uniqueness and security. The UUID MUST be generated conforming to [RFC4122][RFC4122] and MUST be treated as unique within the supplier-customer relationship. - -#### Data asset structure - -The HTTP POST endpoint introduced above MUST NOT be called from a supply chain partner directly. Rather, it MUST be called via connector conformant to [CX-0018][StandardLibrary]. Therefore, the endpoint MUST be offered as a Data Asset. The latter MUST have a property `https://purl.org/dc/terms/type` with the ID `https://w3id.org/catenax/taxonomy#DcmWeekBasedMaterialDemand`. It can be abbreviated if the namespaces of key and value are part of the json-ld @context object (see example below). This property SHOULD be used to identify the asset when searching the assets catalog of a supplier. Because the asset reflects the contractual relationship between a supplier and its customers, only one asset with the aforementioned property for one version MUST be visible to the customer at any time to avoid ambiguity. - -The API version described MUST be published in the property `https://w3id.org/catenax/ontology/common#version` as version 2.0 in the asset. The requester of an asset MUST be able to handle multiple assets for this endpoint, being differentiated only by the version. The requester SHOULD choose the asset with the highest compatible version number implemented by themselves. If the requester cannot find a compatible version with their own, the requester MUST terminate the data transfer. - -Each supplier MUST ensure that only their customers have access to the asset by using access and usage policies and respective contract definitions. - -An example Data Asset definition is shown below. - -> Note: Expressions in double curly braces {{}} MUST be substituted with a corresponding value. -> -> Asset definition example for Management API v3 (non-normative) - -```json -{ - "@context": { - "edc": "https://w3id.org/edc/v0.0.1/ns/", - "cx-common": "https://w3id.org/catenax/ontology/common#", - "cx-taxo": "https://w3id.org/catenax/taxonomy#", - "dct": "https://purl.org/dc/terms/" - }, - "@id": "{{ ASSET_ID }}", - "properties": { - "dct:type": { - "@id": "cx-taxo:DcmWeekBasedMaterialDemand" - }, - "description": "Endpoint for providing Material Demands", - "cx-common:version": "2.0" - }, - "dataAddress": { - "@type": "DataAddress", - "type": "HttpData", - "baseUrl": "{{ URL-BACKEND-APPLICATION-WEEKBASEDMATERIALDEMAND-ENDPOINT }}", - "method": "POST", - "proxyBody": "true", - "contentType": "application/json" - } -} -``` - -#### Error handling - -Every API endpoint defined above MUST respond to incoming requests with HTTP status codes as described in [RFC9110][RFC9110]. All of the following HTTP status codes, except for codes `200` and `201`, MUST be interpreted as failures. Therefore, it may be sufficient for a business application to simply check if the status code is `200` or `201` or not. If not, the request failed. - -| HTTP Status Code | HTTP Status Message | Description | -|:-----------------|:--------------------|:-------------| -| 200 | OK | The request has succeeded. The `WeekBasedMaterialDemand` has been successfully processed in the backend system. | -| 201 | Created | The request has succeeded and has led to the creation of a new `WeekBasedMaterialDemand` in the backend system. | -| 400 | Bad request | The server cannot or will not process the request due to something that is perceived to be a client error (e.g. malformed request syntax, invalid request message framing, or deceptive request routing). | -| 401 | Unauthorized | The client request has not been completed because it lacks valid authentication credentials for the requested resource. | -| 403 | Forbidden | The `WeekBasedMaterialDemand` in question is not available for the client (e.g. it belongs to a different company). | -| 405 | Method not allowed | The method used to request the data was not POST. | -| 422 | Unprocessable Entity | The request was well-formed but was unable to be followed due to semantic errors, e.g. the JSON payload could not be parsed. | -| 503 | Service Unavailable | The server is not ready to handle the request. | - -If one `WeekBasedMaterialDemand` aspect is provided in one HTTP request, the return codes MUST be used as stated in the table above. - -If a list of multiple `WeekBasedMaterialDemand` aspects is provided in one HTTP request, the status code `400` MUST be used if at least one `WeekBasedMaterialDemand` in the list cannot be processed. Applications MAY choose to process valid entries from a list which also contains invalid entries. If a list of multiple `WeekBasedMaterialDemand` aspects is provided in one HTTP request and all of them can be processed successfully, the status code `200` MUST be used. - -The return codes `401`, `405`, `422` and `503` in the table above MAY also be applicable to a list of multiple `WeekBasedMaterialDemand` aspects. - -#### Validating payload - -The following tables are supposed to answer questions regarding what business logic MUST be executed when consuming a `WeekBasedMaterialDemand` which has been formed in a specific way. - -The order of rules is indicated by the 'Number' row. The rules MUST be executed in exactly this order, starting from the lowest number. - -The first rule that matches MUST be executed. All other rules MUST be ignored. - -'value' indicates the actual value written in quotation marks and without any specific formatting (e.g. italic). - -_Valid value_ indicates that the value is valid according to aspect model, API and process. - -_Invalid value_ indicates that the value is invalid according to aspect model, API and process. - -_Any value_ indicates that the value can be anything, valid or not. - -A whitespace or an empty cell indicates that for this specific rule that row is not applicable. - -| **Number** | 1 | | -|---|---|---| -| **Properties** | | | -| **Meta Properties** | Any property | _invalid value_ | -| | All other properties | _Any value_ | -| **Actions** | Business Logic | Ignore consumed values | -| | Return Code | 400 - Bad Request | - -| **Number** | 2 | | -|---|---|---| -| **Properties** | customer | Customer BPNL does not match the providing connectors registered BPNL | -| **Meta Properties** | Any property | | -| | All other properties | _Valid value_ | -| **Actions** | Business Logic | Ignore consumed values | -| | Return Code | 400 - Bad Request | - -| **Number** | 3 | | -|---|---|---| -| **Properties** | customer | Supplier does not match any Supplier BPNL that I am responsible for | -| **Meta Properties** | Any property | | -| | All other properties | _Valid value_ | -| **Actions** | Business Logic | Ignore consumed values | -| | Return Code | 400 - Bad Request | - -| **Number** | 4 | | -|---|---|---| -| **Properties** | materialDemandID | _Known value_ | -| | changedAt | More recent than all previously consumed `WeekBasedMaterialDemand` with the same materialDemandID | -| **Meta Properties** | Any property | | -| | All other properties | _Valid value_ | -| **Actions** | Business Logic | Overwrite all existing values | -| | Return Code | 200 - OK | - -| **Number** | 5 | | -|---|---|---| -| **Properties** | materialDemandID | _Unknown value_, but there exists another UUID for the exact same combination of supplier, customer and materialNumberCustomer | -| | customer | _Known value_ | -| | supplier | _Known value_ | -| | materialNumberCustomer | _Known value_ | -| **Meta Properties** | Any property | | -| | All other properties | _Valid value_ | -| **Actions** | Business Logic | Ignore consumed values | -| | Return Code | 400 - Bad Request | - -| **Number** | 6 | | -|---|---|---| -| **Properties** | materialDemandID | _Unknown value_ | -| **Meta Properties** | Any property | | -| | All other properties | _Valid value_ | -| **Actions** | Business Logic | Save as new material demand with consumed values | -| | Return Code | 201 - Created | - -| **Number** | 7 | | -|---|---|---| -| **Properties** | materialDemandID | _Known value_ | -| | changedAt | Older than any previously consumed `WeekBasedMaterialDemand` with the same materialDemandID | -| **Meta Properties** | Any property | | -| | All other properties | _Any value_ | -| **Actions** | Business Logic | Ignore consumed values | -| | Return Code | 400 - Bad Request | - -| **Number** | 8 | | -|---|---|---| -| **Properties** | materialDemandID | _Known value_ | -| | changedAt | Identical to the most recent of all previously consumed `WeekBasedMaterialDemand` with the same materialDemandID | -| **Meta Properties** | Any property | | -| | All other properties | _Any value_ | -| **Actions** | Business Logic | Overwrite all existing values with consumed values | -| | Return Code | 200 - OK | - -### WeekBasedCapacityGroup API - -The `WeekBasedCapacityGroup` object is used to provide capacity group information from supplier to customer. - -Suppliers MUST be able to provide `WeekBasedCapacityGroup` - -Customers MUST be able to consume and process `WeekBasedCapacityGroup` - -The `WeekBasedCapacityGroup` API MUST be published towards the network using a Data Asset/Contract Offer, which is in line with the Dataspace Protocol as specified by IDSA and MUST conform with the Catena-X standard [CX-0001][StandardLibrary]. - -#### Data Exchange - -Suppliers MUST provide customers with `WeekBasedCapacityGroup` data via HTTP POST request. The data MUST conform to the format specified in this standard and it MUST NOT exceed 15 MiB in size. It MUST be a valid JSON string and MUST include all mandatory properties. The data model with all its properties MUST conform to the respective aspect model and the definitions above. Properties marked as "optional" MAY be included in the data. -When consuming a payload, that contains unknown properties not described within the data model but is otherwise correct, those properties MUST be ignored. - -Attributes that are strings MUST be formatted correctly. For example, `customer` MUST be formatted as a BPNL. The `pointInTime` property MUST represent the week's Monday in the format YYYY-MM-DD as described in ISO8601. - -The `demandCategory` property MUST be set to one of the predefined values from [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. - -The `unitOfMeasure` property MUST be set to one of the predefined values from [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. If no unit of measure is to be provided, the customer MUST omit the property and set the `unitOfMeasureIsOmitted` flag to true. - -Multiple `WeekBasedCapacityGroup` aspects MAY be provided in one transfer as a JSON list. If only one `WeekBasedCapacityGroup` aspect is provided, it MUST be as a list with one entry. - -The current week is denominated as N=0, the next week as N=1, the week after the next week as N=2 and so on. -The data series in the `WeekBasedCapacityGroup` SHOULD start from N=2. The dataset MUST include at least one week, where N>1 and MUST NOT contain duplicate weeks. Weeks N=0 and N=1 MAY be included. If capacity changes, the entire dataset MUST be provided again, avoiding inconsistent or incomplete data. A single combination of `demandCategory`, `customerLocation` and `materialNumberCustomer` MAY be referenced across multiple `WeekBasedCapacityGroup` objects. This means that one `materialNumberCustomer` MAY appear in the `linkedDemandSeries` of several distinct `WeekBasedCapacityGroup` objects. - -If a week's demand is zero (value = `0`), it MUST be explicitly stated and included in the `WeekBasedMaterialDemand`, unknown demands (value = `null`) SHOULD be omitted. - -The `linkedDemandSeries` property specifies which particular `WeekBasedMaterialDemand` a `WeekBasedCapacityGroup` is referencing. To clarify the `linkedDemandSeries` points to a demand with a specific trio: `demandCategory`, `customerLocation` and `materialNumberCustomer`. - -The customer MAY define a `WeekBasedCapacityGroup` as inactive by setting and transferring the `capacityGroupIsInactive` flag to the supplier. The inactive `WeekBasedCapacityGroup` MUST be ignored during the demand-capacity matching over the whole horizon, i.e. must be considered in the same way as not existing data for the demand-capacity matching. Inactivating data may trigger their archiving or deletion in the local DCM application of the business partner. The inactive flag of a `WeekBasedCapacityGroup` MUST NOT affect linked `WeekBasedMaterialDemand` objects or other linked `WeekBasedCapacityGroup`. The inactivation of a `WeekBasedCapacityGroup` MAY result in the situation that its linked active `WeekBasedMaterialDemand` objects have to be newly linked to other active `WeekBasedCapacityGroup`. Once a `WeekBasedCapacityGroup` has been set as inactive, this MAY be undone by reverting the `capacityGroupIsInactive` flag. In this case, the `WeekBasedCapacityGroup` MUST again be considered during the demand-capacity matching. The reverting of the inactive flag of a `WeekBasedCapacityGroup` may correspond to a newly created and initially transferred or to an updated `WeekBasedCapacityGroup`. - -Suppliers MAY use demand volatility metrics, including the optional entity `demandVolatilityParameters` within the JSON payload. - -The following properties are used by demand volatility metrics: - -- demandVolatilityParameters - - startReferenceDateTime - - measurementInterval - - rollingHorizonAlertThresholds - - sequenceNumber - - subhorizonLength - - absolutePositiveDeviation - - absoluteNegativeDeviation - - relativePositiveDeviation - - relativeNegativeDeviation - -Suppliers use `startReferenceDateTime` to define the start of the demand volatility metric calculation, it is also marks the start of the first measurement interval. Its value MUST be chosen, so that transfer times are considered, allowing the customer to consume the data while `startReferenceDateTime` is still larger than the customer´s system time. It is RECOMMENDED to allow for a grace period of at least 24 hours. - -In order to get the start of any subsequent measurement intervals the value of `measurementInterval` needs to be converted from integer to weeks and added to `startReferenceDateTime`. - -Once demand volatility metric calculation has been initialized `startReferenceDateTime` MUST maintain its value. - -If the value of `startReferenceDateTime` or `measurementInterval` changes this is considered another initialization. - -The sequence of entries within the `linkedDemandSeries` of a `WeekBasedCapacityGroup` does not follow any particular order and MUST be treated as non-sequential or random. - -#### UUID generation and handling - -UUIDv4 is REQUIRED for exchanging capacity data to ensure uniqueness and security. The UUID MUST be generated conforming to [RFC4122][RFC4122] and MUST be treated as unique within the supplier-customer relationship. - -#### Data asset structure - -The HTTP POST endpoint introduced above MUST NOT be called from a supply chain partner directly. Rather, it MUST be called via a connector conformant to [CX-0018][StandardLibrary]. Therefore, the endpoint MUST be offered as a Data Asset. The latter MUST have a property `https://purl.org/dc/terms/type` with the ID `https://w3id.org/catenax/taxonomy#DcmWeekBasedCapacityGroup`. It can be abbreviated if the namespaces of key and value are part of the json-ld @context object (see example below). This property SHOULD be used to identify the asset when searching the assets catalog of a customer. Because the asset reflects the contractual relationship between a customer and its suppliers, only one asset with the aforementioned property for one version MUST be visible to the supplier at any time to avoid ambiguity. - -The API version described in this standard MUST be published in the property `https://w3id.org/catenax/ontology/common#version` as version 2.0 in the asset. The requester of an asset MUST be able to handle multiple assets for this endpoint, being differentiated only by the version. The requester SHOULD choose the asset with the highest compatible version number implemented by themselves. If the requester cannot find a compatible version with their own, the requester MUST terminate the data transfer. - -Each customer MUST ensure that only their suppliers have access to the asset by using access and usage policies and respective contract definitions. - -An example Data Asset definition is shown below. - -> Note: Expressions in double curly braces {{}} MUST be substituted with a corresponding value. -> -> Asset definition example for management API v3 (non-normative) - -```json -{ - "@context": { - "edc": "https://w3id.org/edc/v0.0.1/ns/", - "cx-common": "https://w3id.org/catenax/ontology/common#", - "cx-taxo": "https://w3id.org/catenax/taxonomy#", - "dct": "https://purl.org/dc/terms/" - }, - "@id": "{{ ASSET_ID }}", - "properties": { - "dct:type": { - "@id": "cx-taxo:DcmWeekBasedCapacityGroup" - }, - "description": "Endpoint for providing Week Based Capacity Groups", - "cx-common:version": "2.0" - }, - "dataAddress": { - "@type": "DataAddress", - "type": "HttpData", - "baseUrl": "{{ URL-BACKEND-APPLICATION-WEEKBASEDCAPACITYGROUP-ENDPOINT }}", - "method": "POST", - "proxyBody": "true", - "contentType": "application/json" - } -} -``` - -#### Error handling - -Every API endpoint defined above MUST respond to incoming requests with HTTP status codes as described in [RFC9110][RFC9110]. All of the following HTTP status codes, except for codes `200` and `201`, MUST be interpreted as failures. Therefore, it may be sufficient for a business application to simply check if the status code is `200` or `201` or not. If not, the request failed. - -| HTTP Status Code | HTTP Status Message | Description | -|:-----------------|:--------------------|:-------------| -| 200 | OK | The request has succeeded. The `WeekBasedCapacityGroup` has been successfully processed in the backend system. | -| 201 | Created | The request has succeeded and has led to the creation of a new `WeekBasedCapacityGroup` in the backend system. | -| 400 | Bad request | The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). | -| 401 | Unauthorized | The client request has not been completed because it lacks valid authentication credentials for the requested resource. | -| 403 | Forbidden | The `WeekBasedCapacityGroup` in question is not available for the client (e.g. it belongs to a different company). | -| 405 | Method not allowed | The method used to request the data was not POST. | -| 422 | Unprocessable Entity | The request was well-formed but was unable to be followed due to semantic errors, e.g. the JSON payload could not be parsed. | -| 503 | Service Unavailable | The client request has not been completed because it lacks valid authentication credentials for the requested resource. | - -If one `WeekBasedCapacityGroup` aspect is provided in one HTTP request, the return codes MUST be used as stated in the table above. - -If a list of multiple `WeekBasedCapacityGroup` aspects is provided in one HTTP request, the status code `400` MUST be used if at least one `WeekBasedCapacityGroup` in the list cannot be processed. Applications MAY choose to process valid entries from a list which also contains invalid entries. If a list of multiple `WeekBasedCapacityGroup` aspects is provided in one HTTP request and all of them can be processed successfully, the status code `200` MUST be used. - -The return codes `401`, `405`, `422` and `503` in the table above MAY also be applicable to a list of multiple `WeekBasedCapacityGroup` aspects. - -#### Validating payload - -The following tables are supposed to answer questions regarding what business logic MUST be executed when consuming a `WeekBasedCapacityGroup` which has been formed in a specific way. - -The order of rules is indicated by the 'Number' row. - -The first rule that matches MUST be executed. All other rules MUST be ignored. - -'value' indicates the actual value written in quotation marks and without any specific formatting (e.g. italic). - -_Valid value_ indicates that the value is valid according to aspect model, API and process. - -_Invalid value_ indicates that the value is invalid according to to aspect model, API and process. - -_Any value_ indicates that the value can by anything, valid or not. - -A whitespace or an empty cell indicates that for this specific rule that row is not applicable. - -| **Number** | 1 | | -|---|---|---| -| **Properties** | | | -| **Meta Properties** | Any property | _invalid value_ | -| | All other properties | _Any value_ | -| **Actions** | Business Logic | Ignore consumed values | -| | Return Code | 400 - Bad Request | - -| **Number** | 2 | | -|---|---|---| -| **Properties** | customer | Supplier BPNL does not match the providing connectors registered BPNL | -| **Meta Properties** | Any property | | -| | All other properties | _Valid value_ | -| **Actions** | Business Logic | Ignore consumed values | -| | Return Code | 400 - Bad Request | - -| **Number** | 3 | | -|---|---|---| -| **Properties** | customer | Customer does not match any Supplier BPNL that I am responsible for | -| **Meta Properties** | Any property | | -| | All other properties | _Valid value_ | -| **Actions** | Business Logic | Ignore consumed values | -| | Return Code | 400 - Bad Request | - -| **Number** | 4 | | -|---|---|---| -| **Properties** | linkedCapacityGroups | Either both `linkedCapacityGroups` and `linkedDemandSeries` contain _Any value_ or do not contain a value. | -| | linkedDemandSeries | Either both `linkedCapacityGroups` and `linkedDemandSeries` contain _Any value_ or do not contain a value. | -| **Meta Properties** | Any property | | -| | All other properties | _Valid value_ | -| **Actions** | Business Logic | Ignore consumed values | -| | Return Code | 400 - Bad Request | - -| **Number** | 5 | | -|---|---|---| -| **Properties** | startReferenceDateTime | _value_ < _system time_ AND _value_ <> _current value_ of `startReferenceDateTime` | -| **Meta Properties** | Any property | | -| | All other properties | _Valid value_ | -| **Actions** | Business Logic | Ignore consumed values. | -| | Return Code | 400 - Bad Request | - -| **Number** | 6 | | -|---|---|---| -| **Properties** | capacityGroupID | _Known value_ | -| | changedAt | More recent than all previously consumed `WeekBasedCapacityGroup` with the same capacityGroupID | -| **Meta Properties** | Any property | | -| | All other properties | _Valid value_ | -| **Actions** | Business Logic | Overwrite all existing values | -| | Return Code | 200 - OK | - -| **Number** | 7 | | -|---|---|---| -| **Properties** | capacityGroupID | _Unknown value_ | -| **Meta Properties** | Any property | | -| | All other properties | _Valid value_ | -| **Actions** | Business Logic | Save as new capacity group with consumed values | -| | Return Code | 201 - Created | - -| **Number** | 8 | | -|---|---|---| -| **Properties** | capacityGroupID | _Known value_ | -| | changedAt | Older than any previously consumed `WeekBasedCapacityGroup` with the same capacityGroupID | -| **Meta Properties** | Any property | | -| | All other properties | _Any value_ | -| **Actions** | Business Logic | Ignore consumed values | -| | Return Code | 400 - Bad Request | - -| **Number** | 9 | | -|---|---|---| -| **Properties** | capacityGroupID | _Known value_ | -| | changedAt | Identical to the most recent of all previously consumed `WeekBasedCapacityGroup` with the same capacityGroupID | -| **Meta Properties** | Any property | | -| | All other properties | _Any value_ | -| **Actions** | Business Logic | Overwrite all existing values with consumed values | -| | Return Code | 200 - OK | - -### RequestForUpdate API - -The `IdBasedRequestForUpdate` object (RfU) is used to request updates of some or even all `WeekBasedMaterialDemand` or `WeekBasedCapacityGroup` objects. - -Customers and Supplier MUST be able to consume and process a RfU. Being able to provide a RfU is RECOMMENDED. - -To properly process a RfU, the following steps MUST be executed: - -1. Response: Answering with the appropriate HTTP status code -2. Action: If that status code is `200 OK`: Providing the requested material demands and capacity groups via `WeekBasedMaterialDemand` API or `WeekBasedCapacityGroup` API respectively. - -It is RECOMMENDED that this functionality SHOULD NOT be an end-user functionality which can be executed in an user interface. - -The `IdBasedRequestForUpdate` API MUST be published towards the network using a Data Asset/Contract Offer, which is in line with the Dataspace Protocol as specified by IDSA and MUST conform with the Catena-X standard [CX-0001][StandardLibrary]. - -#### Data Exchange - -The `IdBasedRequestForUpdate` data MUST be provided by the customer to the supplier or vice versa via HTTP POST request. The data MUST conform to the format specified in this standard and it MUST NOT exceed 15 MiB in size. -When consuming a payload, that contains unknown properties not described within this standard but is otherwise correct, those properties MUST be ignored. - -An empty RfU payload requests all data within the specific customer-supplier relationship. - -A RfU payload MAY specify that only `WeekBasedMaterialDemand` or `WeekBasedCapacityGroup` objects are requested within the specific customer-supplier relationship. - -A RfU payload MAY specify that only certain data objects, identified by their respective UUID, are requested within the specific customer-supplier relationship. - -A RfU payload MAY specify that only certain data objects, that have been updated, identified by their respective UUID and `changedAt` value, are requested within the specific customer-supplier relationship. - -The following example payloads are intended to illustrate the different possible payloads of an `IdBasedRequestForUpdate`: - -RfU: Provide Everything - -```json -{ -} -``` - -RfU: Provide only Material Demands - -```json -{ - "weekBasedMaterialDemand": [ - ] -} -``` - -RfU: Provide only Capacity Groups - -```json -{ - "weekBasedCapacityGroup": [ - ] -} -``` - -RfU: Provide only certain Objects - -```json -{ - "weekBasedMaterialDemand": [ - { - "materialDemandId":"278e333d-f06b-4b59-8e95-22862f69807f"}, - { - "materialDemandId":"46adfa5d-36b7-4a9b-9ac6-508dac500dd2"} - ] -}, -{ - "weekBasedCapacityGroup": [ - { - "capacityGroupId":"a2fc69ac-ede7-48d3-bee5-04de665d49f0"}, - { - "capacityGroupId":"34238729-990a-4b61-b0c6-336da7b71675"} - ] -} -``` - -RfU: Provide only certain Objects and only if my version is not up to date - -```json -{ - "weekBasedMaterialDemand": [ - { - "materialDemandId":"278e333d-f06b-4b59-8e95-22862f69807f"}, - { - "materialDemandId":"46adfa5d-36b7-4a9b-9ac6-508dac500dd2"} - ] -}, -{ - "weekBasedCapacityGroup": [ - { - "capacityGroupId":"a2fc69ac-ede7-48d3-bee5-04de665d49f0"}, - { - "capacityGroupId":"34238729-990a-4b61-b0c6-336da7b71675", - "changedAt": "2023-03-08T11:44:27.701+01:00"} - ] -} -``` - -#### Data asset structure - -The HTTP POST endpoint introduced above MUST NOT be called from a supply chain partner directly. Rather, it MUST be called via a connector conformant to [CX-0018][StandardLibrary]. Therefore, the endpoint MUST be offered as a Data Asset. The latter MUST have a property `https://purl.org/dc/terms/type` with the ID `https://w3id.org/catenax/taxonomy#DcmIdBasedRequestForUpdate`. It can be abbreviated if the namespaces of key and value are part of the json-ld @context object (see example below). This property SHOULD be used to identify the asset when searching the assets catalog of a partner. Because the asset reflects the contractual relationship between two DCM partners, only one asset with the aforementioned property for one version MUST be visible to the partner at any time to avoid ambiguity. - -The API version described in this standard MUST be published in the property `https://w3id.org/catenax/ontology/common#version` as version 2.0 in the asset. The requester of an asset MUST be able to handle multiple assets for this endpoint, being differentiated only by the version. The requester SHOULD choose the asset with the highest compatible version number implemented by themselves. If the requester cannot find a compatible version with their own, the requester MUST terminate the data transfer. - -Each DCM participant MUST ensure that only their business partners have access to the asset by using access and usage policies and respective contract definitions. - -An example Data Asset definition is shown below. - -> Note: Expressions in double curly braces {{}} MUST be substituted with a corresponding value. -> -> Asset definition example for management API v3 (non-normative) - -```json -{ - "@context": { - "edc": "https://w3id.org/edc/v0.0.1/ns/", - "cx-common": "https://w3id.org/catenax/ontology/common#", - "cx-taxo": "https://w3id.org/catenax/taxonomy#", - "dct": "https://purl.org/dc/terms/" - }, - "@id": "{{ ASSET_ID }}", - "properties": { - "dct:type": { - "@id": "cx-taxo:DcmIdBasedRequestForUpdate" - }, - "description": "Endpoint for requesting updates", - "cx-common:version": "2.0" - }, - "dataAddress": { - "@type": "DataAddress", - "type": "HttpData", - "baseUrl": "{{ URL-BACKEND-APPLICATION-IDBASEDREQUESTFORUPDATE-ENDPOINT }}", - "method": "POST", - "proxyBody": "true", - "contentType": "application/json" - } -} -``` - -#### Error handling - -Every API endpoint defined above MUST respond to incoming requests with HTTP status codes as described in [RFC9110][RFC9110]. All of the following HTTP status codes, except for code `200` , MUST be interpreted as failures. Therefore, it may be sufficient for a business application to simply check if the status code is `200` or not. If not, the request failed. - -| HTTP Status Code | HTTP Status Message | Description | -|:-----------------|:--------------------|:-------------| -| 200 | OK | The request has succeeded. The `IdBasedRequestForUpdate` has been successfully processed in the backend system. | -| 400 | Bad request | The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). | -| 401 | Unauthorized | The client request has not been completed because it lacks valid authentication credentials for the requested resource. | -| 403 | Forbidden | The `IdBasedRequestForUpdate` functionality is not available for the client. | -| 405 | Method not allowed | The method used to request the data was not POST. | -| 422 | Unprocessable Entity | The request was well-formed but was unable to be followed due to semantic errors, e.g. the JSON payload could not be parsed. | -| 503 | Service Unavailable | The client request has not been completed because it lacks valid authentication credentials for the requested resource. | - -Because multiple material demands and capacity groups can be requested at the same time HTTP status code `200` only means that the `IdBasedRequestForUpdate` was processed successfully and that the data objects will be provided in due time. - -The requested data objects SHOULD be provided within five minutes, but definitely they MUST be provided within 24 hours. - -If only a single data object is requested it MUST be provided within 10 seconds. - -#### Validating payload - -Payload validation only applies to the formal layer. If a payload is correctly formed and thusly can be processed HTTP `200` is the correct response code. Even if a material demand (identified by its UUID) has been requested that does not exists within that supplier-customer relationship, HTTP `200` is the correct response code. - -### IdBasedComment API - -The `IdBasedComment` object is used to exchange comments, referencing a `WeekBasedCapacityGroup` or a `WeekBasedMaterialDemand` between customer and supplier. - -Customers and suppliers MUST be able to provide, consume and process `IdBasedComment`. - -The `IdBasedComment` API MUST be published towards the network using a Data Asset/Contract Offer, which is in line with the Dataspace Protocol as specified by IDSA and MUST conform with the Catena-X standard [CX-0001][StandardLibrary]. - -#### Data Exchange - -The `IdBasedComment` data MUST be provided by the customer to the supplier or vice versa via HTTP POST request. The data MUST conform to the format specified in this standard and it MUST NOT exceed 15 MiB in size. It MUST be a valid JSON string and MUST include all mandatory properties. The data model with all its properties MUST conform to the respective aspect model and the definitions above. -When consuming a payload, that contains unknown properties not described within the data model but is otherwise correct, those properties MUST be ignored. - -Attributes that are strings MUST be formatted correctly. For example, `expectedSupplierLocation` MUST be formatted as a BPNS. The `listOfReferenceDates` collection MUST represent the calendar week's Mondays in the format YYYY-MM-DD as described in ISO8601. - -Certain properties, such as `author`, `objectId`, `listOfReferenceDates` and `objectType`, have specific requirements for their values. `author` MUST contain a valid email address or BPNL if anonymity is preferred. `objectId`, MUST be the UUID of either the `WeekBasedMaterialDemand` or `WeekBasedCapacityGroup` the comments is referencing. `objectType` MUST be as a Catena-X aspect model unique identifier without a version. - -Multiple `IdBasedComment` aspects MAY be provided in one transfer as a JSON list. If only one `IdBasedComment` aspect is provided, it MUST be as a list with one entry. - -A comment MAY reference more than one calendar week utilizing the `listOfReferenceDates` property. Every entry in `listOfReferenceDates` MUST be set to a Monday, MUST conform to ISO8601 and MUST use the format YYYY-MM-DD (for example 2023-02-13). - -Applications that consume a `IdBasedComment` with the property `requestDelete` set to `true` MUST delete the comment in compliance with General Data Protection Regulation (GDPR). Deletion is final and MUST NOT be reversed. - -Applications SHOULD remember which comments they originated in order to prevent unauthorized deletion. - -An `IdBasedComment` SHOULD always be provided with as much information as is available, so that the consuming application can better decide how to process the comment. - -The table below MUST be considered in addition to the data model itself and describes which properties MUST be treated as mandatory so that applications can execute certain actions on an `IdBasedComment`. - -| Property \ Action | Create | Update | Delete | -|---|---|---|---| -| **commentId** | MUST | MUST | MUST | -| **objectId** | MUST | MUST | MUST | -| **objectType** | MUST | MUST | MUST | -| **supplier** | MUST | MUST | MUST | -| **customer** | MUST | MUST | MUST | -| commentType | SHOULD - if not, consumer can use value `default` | SHOULD - if not, consumer can use value `default` | MAY | -| author | SHOULD - if not, consumer can use sender BPNL from connector | SHOULD - if not, consumer can use sender BPNL from connector | MAY | -| postedAt | SHOULD - if not, consumer can set timestamp of receipt | SHOULD - MUST NOT differ from time of creation | MAY | -| listOfReferenceDates | MAY | MAY | MAY | -| changedAt | MAY | SHOULD - if not consumer can set timestamp of receipt | MAY | -| commentText | SHOULD | SHOULD | MAY | -| requestDelete | MUST NOT | MUST NOT | MUST | - -#### UUID generation and handling - -UUIDv4 is REQUIRED for exchanging comment data to ensure uniqueness and security. The UUID MUST be generated conforming to [RFC4122][RFC4122] and MUST be treated as unique within the supplier-customer relationship. - -#### Data asset structure - -The HTTP POST endpoint introduced above MUST NOT be called from a supply chain partner directly. Rather, it MUST be called via a connector conformant to [CX-0018][StandardLibrary]. Therefore, the endpoint MUST be offered as a Data Asset. The latter MUST have a property `https://purl.org/dc/terms/type` with the ID `https://w3id.org/catenax/taxonomy#DcmIdBasedComment`. It can be abbreviated if the namespaces of key and value are part of the json-ld @context object (see example below). This property SHOULD be used to identify the asset when searching the assets catalog of a partner. Because the asset reflects the contractual relationship between two DCM partners, only one asset with the aforementioned property for one version MUST be visible to the partner at any time to avoid ambiguity. - -The API version described in this standard MUST be published in the property `https://w3id.org/catenax/ontology/common#version` as version 2.0 in the asset. The requester of an asset MUST be able to handle multiple assets for this endpoint, being differentiated only by the version. The requester SHOULD choose the asset with the highest compatible version number implemented by themselves. If the requester cannot find a compatible version with their own, the requester MUST terminate the data transfer. - -Each DCM participant MUST ensure that only their business partners have access to the asset by using access and usage policies and respective contract definitions. - -An example Data Asset definition is shown below. - -> Note: Expressions in double curly braces {{}} MUST be substituted with a corresponding value. -> -> Asset definition example for management API v3 (non-normative) - -```json -{ - "@context": { - "edc": "https://w3id.org/edc/v0.0.1/ns/", - "cx-common": "https://w3id.org/catenax/ontology/common#", - "cx-taxo": "https://w3id.org/catenax/taxonomy#", - "dct": "https://purl.org/dc/terms/" - }, - "@id": "{{ ASSET_ID }}", - "properties": { - "dct:type": { - "@id": "cx-taxo:DcmIdBasedComment" - }, - "description": "Endpoint for providing comments", - "cx-common:version": "2.0" - }, - "dataAddress": { - "@type": "DataAddress", - "type": "HttpData", - "baseUrl": "{{ URL-BACKEND-APPLICATION-IDBASEDCOMMENT-ENDPOINT }}", - "method": "POST", - "proxyBody": "true", - "contentType": "application/json" - } -} -``` - -#### Error handling - -Every API endpoint defined above MUST respond to incoming requests with HTTP status codes as described in [RFC9110][RFC9110]. All of the following HTTP status codes, except for codes `200` and `201`, MUST be interpreted as failures. Therefore, it may be sufficient for a business application to simply check if the status code is `200` or `202` or not. If not, the request failed. - -| HTTP Status Code | HTTP Status Message | Description | -|:-----------------|:--------------------|:-------------| -| 200 | OK | The request has succeeded. The `IdBasedComment` has been successfully processed in the backend system. | -| 201 | Created | The request has succeeded and has led to the creation of a new `IdBasedComment` in the backend system. | -| 400 | Bad request | The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). | -| 401 | Unauthorized | The client request has not been completed because it lacks valid authentication credentials for the requested resource. | -| 403 | Forbidden | The `IdBasedComment` in question is not available for the client (e.g. it belongs to a different company). | -| 405 | Method not allowed | The method used to request the data was not POST. | -| 422 | Unprocessable Entity | The request was well-formed but was unable to be followed due to semantic errors, e.g. the JSON payload could not be parsed. | -| 501 | Not Implemented | The `IdBasedComment` is not accepted since the feature is not implemented. | -| 503 | Service Unavailable | The client request has not been completed because it lacks valid authentication credentials for the requested resource. | - -If one `IdBasedComment` aspect is provided in one HTTP request, the return codes MUST be used as stated in the table above. - -If a list of multiple `IdBasedComment` aspects is provided in one HTTP request, the status code `400` MUST be used if at least one `IdBasedComment` in the list cannot be processed. Applications MAY choose to process valid entries from a list which also contains invalid entries. If a list of multiple `IdBasedComment` aspects is provided in one HTTP request and all of them can be processed successfully, the status code 200 MUST be used. - -The return codes `401`, `405`, `422` and `503` in the table above MAY also be applicable to a list of multiple `IdBasedComment` aspects. - -#### Validating payload - -The following tables are supposed to answer questions regarding what business logic MUST be executed when consuming a `IdBasedComment` which has been formed in a specific way. - -The order of rules is indicated by the 'Number' row. - -The first rule that matches MUST be executed. All other rules MUST be ignored. - -'value' indicates the actual value written in quotation marks and without any specific formatting (e.g. italic). - -_Valid value_ indicates that the value is valid according to data model, API and process. - -_Invalid value_ indicates that the value is invalid according to data model, API and process. - -_Any value_ indicates that the value can by anything, valid or not. - -A whitespace or an empty cell indicates that for this specific rule that row is not applicable. - -| **Number** | 1 | | -|---|---|---| -| **Properties** | | | -| **Meta Properties** | Any property | _invalid value_ | -| | All other properties | _Any value_ | -| **Actions** | Business Logic | Ignore consumed values | -| | Return Code | 400 - Bad Request | - -| **Number** | 2 | | -|---|---|---| -| **Properties** | messageHeader.header.senderBpn | Supplier BPNL does not match the sending connectors registered BPNL | -| **Meta Properties** | Any property | | -| | All other properties | _Valid value_ | -| **Actions** | Business Logic | Ignore consumed values | -| | Return Code | 400 - Bad Request | - -| **Number** | 3 | | -|---|---|---| -| **Properties** | messageHeader.header.senderBpn | Consumer does not match any Partners BPNL that I am in a relation with | -| **Meta Properties** | Any property | | -| | All other properties | _Valid value_ | -| **Actions** | Business Logic | Ignore consumed values | -| | Return Code | 400 - Bad Request | - -| **Number** | 4 | | -|---|---|---| -| **Properties** | objectId | Does not match a UUID (`WeekBasedMaterialDemand` or `WeekBasedCapacityGroup`) the consumer exchanged with the provider before | -| **Meta Properties** | Any property | | -| | All other properties | _Valid value_ | -| **Actions** | Business Logic | Ignore consumed values | -| | Return Code | 403 - Forbidden | - -| **Number** | 5 | | -|---|---|---| -| **Properties** | objectType | Matches the identifier of the `WeekBasedMaterialDemand` (`urn:samm:io.catenax.week_based_material_demand`), but the endpoint does not process an `IdBasedComment` linked to a `WeekBasedMaterialDemand` | -| **Meta Properties** | Any property | | -| | All other properties | _Any value_ | -| **Actions** | Business Logic | Ignore consumed values | -| | Return Code | 501 - Not Implemented | - -| **Number** | 6 | | -|---|---|---| -| **Properties** | commentId | _Known value_ | -| | requestDelete | `true` | -| Meta Properties | Any property | | -| | All other properties | _Any value_ | -| **Actions** | Business Logic | Delete comment incl. all of its history from consumers application(s) | -| | Return Code | 200 - OK | - -| **Number** | 7 | | -|---|---|---| -| **Properties** | commentId | _Known value_ | -| | changedAt | More recent than all previously consumed `IdBasedComment` with the same commentId | -| **Meta Properties** | Any property | | -| | All other properties | _Valid value_ | -| **Actions** | Business Logic | Overwrite all existing values | -| | Return Code | 200 - OK | - -| **Number** | 8 | | -|---|---|---| -| **Properties** | commentId | _Unknown value_ | -| Meta Properties | Any property | | -| | All other properties | _Valid value_ | -| **Actions** | Business Logic | Save as new comment with consumed values | -| | Return Code | 201 - Created | - -| **Number** | 9 | | -|---|---|---| -| **Properties** | commentId | _Known value_ | -| | changedAt | Older than any previously consumed `IdBasedComment` with the same commentId | -| **Meta Properties** | Any property | | -| | All other properties | _Any value_ | -| **Actions** | Business Logic | Ignore consumed values | -| | Return Code | 400 - Bad Request | - -### DCM Asset Administration Shell API (AAS API) - -Data providers MAY adopt the DCM AAS API. If they choose otherwise, none of the obligations of this section apply. - -The `WeekBasedMaterialDemand` contains the demand information which is provided from the customer to the supplier. The supplier maintains a set of Submodels (one for each `WeekBasedMaterialDemand`) and registers them in their Digital Twin Registry. Both conform to the definitions of [CX-0002][StandardLibrary]. - -The `WeekBasedCapacityGroup` contains the capacity information which is provided from the supplier to the customer. The customer maintains a set of Submodels (one for each `WeekBasedCapacityGroup`) and registers them in their Digital Twin Registry. Both conform to the definitions of [CX-0002][StandardLibrary]. - -Suppliers MUST be able to host and correctly expose the `WeekBasedMaterialDemand`-Submodel and update the customer-hosted `WeekBasedCapacityGroup`-Submodel. - -Customers MUST be able to host and correctly expose the `WeekBasedCapacityGroup`-Submodel and update the supplier-hosted `WeekBasedMaterialDemand`-Submodel. - -#### API Specification - -##### API Endpoints & Resources - -Exchanging Data via the DCM AAS API requires customers and suppliers to both act in the roles of data provider and data consumer. The API is a superset of [CX-0002][StandardLibrary] with the following specializations: - -- A supplier MUST host and expose a Submodel `WeekBasedMaterialDemand` via the Submodel-API as defined in [CX-0002][StandardLibrary] -- A customer MUST host and expose a Submodel `WeekBasedCapacityGroup` via the Submodel-API as defined in [CX-0002][StandardLibrary] -- Additionally, suppliers and customers MUST offer the PatchSubmodel-Operation with the content-modifier `$value` on all Submodels as defined in [AAS Pt.2][AAS] - - A supplier MUST client-side be capable to update the `WeekBasedCapacityGroup`-Submodel hosted by the customer - - A customer MUST client-side be capable to update the `WeekBasedMaterialDemand`-Submodel hosted by the supplier - -##### Data Exchange - -Restrictions on the exchanged data can be retrieved from the data models. Additionally, the definitions from the API definitions above apply. - -##### UUID generation and handling - -UUIDv4 is REQUIRED for exchanging demand and capacity data to ensure uniqueness and security. The UUID MUST be generated conforming to [RFC4122][RFC4122] and MUST be treated as unique within the supplier-customer relationship. - -##### Available Data Types - -The API MUST use JSON formatted data transmitted over HTTPS. - -##### DTR Registration - -As mandated by [CX-0002][StandardLibrary], all Data-Providers MUST provide a Digital Twin Registry and use it to link their Submodels to identified assets. Assets in the DTR are identified via `specificAssetIds`. - -When registering Submodels with semanticId `WeekBasedMaterialDemand`, the data provider (supplier) MUST reuse the IDs mandated in [CX-0126][StandardLibrary], section 2.3.1. - -When registering Submodels with semanticId `WeekBasedCapacityGroup`, the data provider (customer) MUST create a single `specificAssetId` with name `creationEntityId` and a UUIDv4 as value. - -All other properties are standardized in [CX-0002][StandardLibrary] or [AAS Pt.2][AAS] respectively. - -Example: - -```json -{ - "id": "{{id of the AAS}}", - "idShort": "{{short name of your AAS}}", - "specificAssetIds": [ - { - "name": "creationEntityId", - "value": "{{someUuidV4}}", - "externalSubjectId": { - "type": "ExternalReference", - "keys": [ - { - "type": "GlobalReference", - "value": "*" - } - ] - } - } - ], - "submodelDescriptors": [ - { - "id": "{{someSubmodelId}}", - "semanticId": { - "type": "ExternalReference", - "keys": [ - { - "type": "GlobalReference", - "value": "urn:samm:io.catenax.week_based_capacity_group:2.0.0#WeekBasedCapacityGroup" - } - ] - }, - "endpoints": [ - { - "interface": "SUBMODEL-3.0", - "protocolInformation": { - "href": "{{dataplane baseurl extended with the appropriate path ending on /submodel}}", - "endpointProtocol": "HTTP", - "endpointProtocolVersion": [ - "1.1" - ], - "subprotocol": "DSP", - "subprotocolBody": "id={{ID of the connector asset the submodel is living behind}};dspEndpoint={{controlPlaneEndpoint}}", - "subprotocolBodyEncoding": "plain", - "securityAttributes": [ - { - "type": "NONE", - "key": "NONE", - "value": "NONE" - } - ] - } - } - ] - } - ] -} -``` - -##### Registration - -Obligations for the Asset Definition of the Digital Twin Registry are adopted from [CX-0002][StandardLibrary]. - -Obligations for the Asset Definition of a Submodel are adopted from [CX-0002][StandardLibrary]. Of the example below, only the "properties"- section is defined as normative there. Please note that the example below only signifies a single registered Submodel. While bundling several Submodels into a single Asset, there are no normative requirements for Asset properties. - -##### Data Asset - -There are no normative statements on the section `dataAddress` for the Asset. - -```json -{ - "@context": { - "cx-common": "https://w3id.org/catenax/ontology/common#", - "ctx": "https://w3id.org/catenax/taxonomy#", - "aas-semantics": "https://admin-shell.io/aas/3/0/HasSemantics/" - }, - "@id": "{{ID for the Asset}}", - "properties": { - "dct:type": { - "@id": "ctx:Submodel" - }, - "cx-common:version": "3.0", - "aas-semantics:semanticId": "{{URN of WeekBasedMaterialDemand or WeekBasedCapacityGroup Submodel}}" - }, - "dataAddress": { - "@type": "DataAddress", - "type": "HttpData", - "proxyPath": "true", - "proxyBody": "true", - "proxyMethod": "true", - "proxyQueryParams": "true", - "baseUrl": "{{Submodel endpoint ending before /submodel}}" - } -} -``` - -##### Policy Definition - -This policy is an example to let a single business partner pass. It could be used as (part of) either an accessPolicy or contractPolicy. - -```json -{ - "@context": { - "@vocab": "https://w3id.org/edc/v0.0.1/ns/", - "odrl": "http://www.w3.org/ns/odrl/2/" - }, - "@type": "PolicyDefinition", - "@id": "{{POLICY-DEFINITION-ID}}", - "policy": { - "odrl:permission": [ - { - "odrl:action": "USE", - "odrl:constraint": [ - { - "odrl:leftOperand": "{{BPN attribute in Data Consumer VC}}", - "odrl:operator": "=", - "odrl:rightOperand": "{{hard-coded BPN of privileged consumer}}" - } - ] - } - ], - "odrl:prohibition": [], - "odrl:obligation": [] - } -} -``` - -##### Contract Definition - -This example for a contract definition connects the defined policy to the defined asset. - -```json -{ - "@context": { - "@vocab": "https://w3id.org/edc/v0.0.1/ns/" - }, - "@type": "ContractDefinition", - "@id": "contract-definition-id", - "accessPolicyId": "{{POLICY-DEFINITION-ID}}", - "contractPolicyId": "{{POLICY-DEFINITION-ID}}", - "assetsSelector": [ - { - "operandLeft": "https://w3id.org/edc/v0.0.1/ns/id", - "operator": "=", - "operandRight": "{{ID for the Asset}}" - } - ] -} -``` - -##### Error Handling - -Error handling is specified by [CX-0002][StandardLibrary] and [AAS Pt.2][AAS]. - -[StandardLibrary]: https://catena-x.net/de/standard-library -[RFC4122]: https://www.rfc-editor.org/rfc/rfc4122 -[RFC9110]: https://www.rfc-editor.org/rfc/rfc9110 -[AAS]: https://www.plattform-i40.de/IP/Redaktion/EN/Downloads/Publikation/Details_of_the_Asset_Administration_Shell_Part2_V1.html diff --git a/docs-kits_versioned_docs/version-24.05/kits/Demand and Capacity Management Kit/page_operation-view.md b/docs-kits_versioned_docs/version-24.05/kits/Demand and Capacity Management Kit/page_operation-view.md deleted file mode 100644 index b271933a4d9..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Demand and Capacity Management Kit/page_operation-view.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -id: operation-view -title: Operation View -description: Your first steps -sidebar_position: 5 ---- - -![DCM kit banner](@site/static/img/DCMKitLogoIcon-min.png) - -> Purpose of this page: -> -> On this page we will document the steps required to adopt a DCM solution and pre-requisites to start activities with DCM partners. -> -> For more detailed technical information, please refer to: [Architecture View](page_architecture-view.md). - -## Audience & Scope - -This guideline is relevant for companies acting as: - -1. a data provider or data consumer that want to enable your custom software for Catena-X DCM -2. a Business Application Provider and want to enable your commercial software for Catena-X DCM - -## Pre-requisites - -You can participate in the Catena-X data ecosystem in various roles. Become acquainted with the foundational building blocks of Catena-X and how all participants collaborate within a global ecosystem by reading the [Whitepaper describing the Catena-X operating model](https://catena-x.net/fileadmin/_online_media_/CX_Operating_Modelv2.1_final.pdf). - -Actors willing to use the Catena-X DCM standard, and start a collaboration with other supply chain partners enabled by an interoperable solution, can prepare asking the IT colleagues to check the following [End-to-End Adopter Journey](https://eclipse-tractusx.github.io/docs/tutorials/e2e/). - -## Onboarding steps for Data Providers / Data Consumers - -Data providers or data consumers that want to enable your custom software for Catena-X DCM need to: - -1. register for the Catena-X Ecosystem -2. be technically onboarded in the Catena-X Network and take care of an organizational onboarding within your Company -3. setup the necessary IT parts for the go-live -4. receive a Business Partner Number (BPN) -5. accept the DCM Framework Agreement/Use Case Policy -6. sign necessary contract(s), e.g. the Data Exchange Contract(s) with your partner(s) - -Additional information: - -- For the steps 1 to 4 please refer to the documentation on the [Catena-X website](https://catena-x.net/en/participate), choosing the approach that best fits your role. After these steps, you will be able to see which other companies have been onboarded and are technically able to connect with you for the DCM use case -- For step 5, please accept the [Use Case Policy published on the Catena-X website](https://catena-x.net/en/catena-x-introduce-implement/governance-framework-for-data-space-operations). In addition, please refer to the document [CX-0050-FrameworkAgreementCredential](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_September23/CX-0050-FrameworkAgreementCredential-v.1.0.0.pdf) chapter 2.4.5 -- For step 6, please check with your DCM counterparts, if it is required to sign a separate document or if this has already been covered within the contract between you and your partners - -## Adoption Strategies for Data Providers / Data Consumers - -A company interested in operating the Catena-X DCM standard can decide to go for one of the following **implementation strategies**: - -Strategy 1 - -- purchase a Catena-X DCM certified Commercial Off-The-Shelf (COTS) solution - - adopting a certified solution ensures that it has been developed and conformed to the DCM standard, as these have been approved by the Catena-X Association -- in this case, the next step is to purchase a commercial solution - - to do so, access the marketplace of an operating company (e.g. Cofinity-X), and choose the solution that best fits you - - alternatively, get in touch with commercial vendors directly - -Strategy 2 - -- adopt and deploy an existing Free and Open Source Solution (FOSS) - - adopting a certified solution ensures that it has been developed and conformed to the DCM standard, as these have been approved by the Catena-X Association - -Strategy 3 - -- adopt and integrate the business logic, API and data models according to the Catena-X DCM standard into an existing software solution (e.g. self-developed software) - - here you then need to make sure that the application developed is conform to the DCM standard. -- in this case, refer to the document DCM [Architecture View](page_architecture-view.md) for further technical details related to your next steps - -Please refer to the [Catena-X Library](https://catena-x.net/de/standard-library) for the newest version of the DCM as well as other standards. - -## Step overview - -1. Join the [Catena-X network](https://catena-x.net/en/catena-x-introduce-implement/onboarding) -2. Follow the onboarding process -3. Get a DCM App. There are now three different options: - 1. Buy a certified commercial DCM App. See the Catena-X market place for offers. - 2. Use a open source solution for DCM. - 3. Modify or develop your own software to work with Catena-X. See DCM [Architecture View](page_architecture-view.md) for details. -4. Start exchanging data with your partner companies - -## Onboarding steps for Business Application Providers - -Business Application Providers that want to enable their commercial software for Catena-X DCM need to register for the Catena-X Ecosystem following the specific information described in [Offering a Catena-X Solution](https://catena-x.net/en/catena-x-introduce-implement/offering-a-catena-x-solution) (including next steps & contacts). - -Please refer to the [Catena-X Library](https://catena-x.net/de/standard-library) for the newest version of the DCM as well as other standards. diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Discovery/dotaas-part-2-http-rest-discovery-service-specification.info.mdx b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Discovery/dotaas-part-2-http-rest-discovery-service-specification.info.mdx deleted file mode 100644 index 08dea9e47f6..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Discovery/dotaas-part-2-http-rest-discovery-service-specification.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: dotaas-part-2-http-rest-discovery-service-specification -title: "DotAAS Part 2 | HTTP/REST | Discovery Service Specification" -description: "The entire Full Profile of the Discovery Service Specification as part of Details of the Asset Administration Shell Part 2. Publisher: Industrial Digital Twin Association (IDTA) 2023" -sidebar_label: Introduction -sidebar_position: 0 -hide_title: true -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiDemoPanel/Export"; - -Version: V3.0_SSP-001 - -# DotAAS Part 2 | HTTP/REST | Discovery Service Specification - - - -The entire Full Profile of the Discovery Service Specification as part of Details of the Asset Administration Shell Part 2. Publisher: Industrial Digital Twin Association (IDTA) 2023 - -

Contact

Industrial Digital Twin Association (IDTA): info@idtwin.org

License

CC BY 4.0
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Discovery/get-all-asset-administration-shell-ids-by-asset-link.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Discovery/get-all-asset-administration-shell-ids-by-asset-link.api.mdx deleted file mode 100644 index 47b373a2912..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Discovery/get-all-asset-administration-shell-ids-by-asset-link.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-all-asset-administration-shell-ids-by-asset-link -title: "Returns a list of Asset Administration Shell ids linked to specific Asset identifiers" -description: "Returns a list of Asset Administration Shell ids linked to specific Asset identifiers" -sidebar_label: "Returns a list of Asset Administration Shell ids linked to specific Asset identifiers" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Asset Administration Shell Basic Discovery API"],"operationId":"GetAllAssetAdministrationShellIdsByAssetLink","parameters":[{"name":"assetIds","in":"query","description":"A list of specific Asset identifiers","required":false,"style":"form","explode":true,"schema":{"type":"array","example":"[ { \"name\": \"some-asset-id\", \"value\": \"http://example-company.com/myAsset\", \"externalSubjectId\": { \"keys\": [ { \"type\": \"GlobalReference\", \"value\": \"http://example-company.com/example-companys-asset-keys\" } ], \"type\": \"GlobalReference\" } }, { \"name\": \"some-other-asset-id\", \"value\": \"12345ABC\", \"externalSubjectId\": { \"keys\": [ { \"type\": \"GlobalReference\", \"value\": \"http://my-own-company.com/keys\" } ], \"type\": \"GlobalReference\" } } ]","items":{"allOf":[{"type":"object","properties":{"semanticId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"supplementalSemanticIds":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}},{"required":["name","value"],"properties":{"name":{"maxLength":64,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"externalSubjectId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}]}}},{"name":"limit","in":"query","description":"The maximum number of elements in the response array","required":false,"schema":{"minimum":1,"type":"integer"}},{"name":"cursor","in":"query","description":"A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Requested Asset Administration Shell ids","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"default":{"description":"Default error handling for unmentioned status codes","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}}},"x-semanticIds":["https://admin-shell.io/aas/API/GetAllAssetAdministrationShellIdsByAssetLink/3/0"],"description":"Returns a list of Asset Administration Shell ids linked to specific Asset identifiers","method":"get","path":"/lookup/shells","servers":[{"url":"{protocol}://{host_name}:{port}/api/{version_prefix}","variables":{"protocol":{"description":"Allows access through http and https (recommended)","default":"https","enum":["http","https"]},"host_name":{"description":"Hostname of server hosting the api","default":"admin-shell.io"},"port":{"description":"80 is default for http, 443 for https","default":"443","enum":["80","443"]},"version_prefix":{"default":"v3.0","enum":["v3.0"]}}}],"info":{"title":"DotAAS Part 2 | HTTP/REST | Discovery Service Specification","description":"The entire Full Profile of the Discovery Service Specification as part of Details of the Asset Administration Shell Part 2. Publisher: Industrial Digital Twin Association (IDTA) 2023","contact":{"name":"Industrial Digital Twin Association (IDTA)","email":"info@idtwin.org"},"license":{"name":"CC BY 4.0","url":"https://creativecommons.org/licenses/by/4.0/"},"version":"V3.0_SSP-001"},"postman":{"name":"Returns a list of Asset Administration Shell ids linked to specific Asset identifiers","description":{"type":"text/plain"},"url":{"path":["lookup","shells"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"A list of specific Asset identifiers","type":"text/plain"},"key":"assetIds","value":""},{"disabled":false,"description":{"content":"The maximum number of elements in the response array","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/AAS Discovery//dotaas-part-2-http-rest-discovery-service-specification -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns a list of Asset Administration Shell ids linked to specific Asset identifiers - - - -Returns a list of Asset Administration Shell ids linked to specific Asset identifiers - -
Query Parameters
- -Requested Asset Administration Shell ids - -
Schema array
  • string
- -Default error handling for unmentioned status codes - -
Schema
    messages object[]
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Discovery/get-all-asset-links-by-id.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Discovery/get-all-asset-links-by-id.api.mdx deleted file mode 100644 index 4f31609fee2..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Discovery/get-all-asset-links-by-id.api.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -id: get-all-asset-links-by-id -title: "Returns a list of specific Asset identifiers based on an Asset Administration Shell id to edit discoverable content" -description: "Returns a list of specific Asset identifiers based on an Asset Administration Shell id to edit discoverable content" -sidebar_label: "Returns a list of specific Asset identifiers based on an Asset Administration Shell id to edit discoverable content" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Asset Administration Shell Basic Discovery API"],"operationId":"GetAllAssetLinksById","parameters":[{"name":"aasIdentifier","in":"path","description":"The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"byte"}}],"responses":{"200":{"description":"Requested specific Asset identifiers","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"type":"object","properties":{"semanticId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"supplementalSemanticIds":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}},{"required":["name","value"],"properties":{"name":{"maxLength":64,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"externalSubjectId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}]}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"default":{"description":"Default error handling for unmentioned status codes","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}}},"x-semanticIds":["https://admin-shell.io/aas/API/GetAllAssetLinksById/3/0"],"description":"Returns a list of specific Asset identifiers based on an Asset Administration Shell id to edit discoverable content","method":"get","path":"/lookup/shells/{aasIdentifier}","servers":[{"url":"{protocol}://{host_name}:{port}/api/{version_prefix}","variables":{"protocol":{"description":"Allows access through http and https (recommended)","default":"https","enum":["http","https"]},"host_name":{"description":"Hostname of server hosting the api","default":"admin-shell.io"},"port":{"description":"80 is default for http, 443 for https","default":"443","enum":["80","443"]},"version_prefix":{"default":"v3.0","enum":["v3.0"]}}}],"info":{"title":"DotAAS Part 2 | HTTP/REST | Discovery Service Specification","description":"The entire Full Profile of the Discovery Service Specification as part of Details of the Asset Administration Shell Part 2. Publisher: Industrial Digital Twin Association (IDTA) 2023","contact":{"name":"Industrial Digital Twin Association (IDTA)","email":"info@idtwin.org"},"license":{"name":"CC BY 4.0","url":"https://creativecommons.org/licenses/by/4.0/"},"version":"V3.0_SSP-001"},"postman":{"name":"Returns a list of specific Asset identifiers based on an Asset Administration Shell id to edit discoverable content","description":{"type":"text/plain"},"url":{"path":["lookup","shells",":aasIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)","type":"text/plain"},"type":"any","value":"","key":"aasIdentifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/AAS Discovery//dotaas-part-2-http-rest-discovery-service-specification -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns a list of specific Asset identifiers based on an Asset Administration Shell id to edit discoverable content - - - -Returns a list of specific Asset identifiers based on an Asset Administration Shell id to edit discoverable content - -
Path Parameters
- -Requested specific Asset identifiers - -
Schema array
    semanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    supplementalSemanticIds undefined[]
    - -**Possible values:** `>= 1` - -
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    externalSubjectId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
- -Not Found - -
Schema
    messages object[]
- -Default error handling for unmentioned status codes - -
Schema
    messages object[]
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Discovery/get-description.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Discovery/get-description.api.mdx deleted file mode 100644 index 521f8f82b01..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Discovery/get-description.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: get-description -title: "Returns the self-describing information of a network resource (ServiceDescription)" -description: "Returns the self-describing information of a network resource (ServiceDescription)" -sidebar_label: "Returns the self-describing information of a network resource (ServiceDescription)" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Description API"],"operationId":"GetDescription","responses":{"200":{"description":"Requested Description","content":{"application/json":{"schema":{"type":"object","properties":{"profiles":{"minItems":1,"type":"array","items":{"type":"string","enum":["AssetAdministrationShellServiceSpecification/V3.0","AssetAdministrationShellServiceSpecification/V3.0-MinimalProfile","SubmodelServiceSpecification/V3.0","SubmodelServiceSpecification/V3.0-ValueProfile","SubmodelServiceSpecification/V3.0-MinimalProfile","AasxFileServerServiceSpecification/V3.0","RegistryServiceSpecification/V3.0","RegistryServiceSpecification/V3.0- AssetAdministrationShellRegistry","RegistryServiceSpecification/V3.0-SubmodelRegistry","RepositoryServiceSpecification/V3.0","RepositoryServiceSpecification/V3.0-MinimalProfile","AssetAdministrationShellRepositoryServiceSpecification/V3.0","AssetAdministrationShellRepositoryServiceSpecification/V3.0-MinimalProfile","SubmodelRepositoryServiceSpecification/V3.0","SubmodelRepositoryServiceSpecification/V3.0-MinimalProfile","RegistryAndDiscoveryServiceSpecification/V3.0"]}}},"description":"The Description object enables servers to present their capabilities to the clients, in particular which profiles they implement. At least one defined profile is required. Additional, proprietary attributes might be included. Nevertheless, the server must not expect that a regular client understands them.","example":"{\n \"profiles\": [\n \"RepositoryServiceSpecification/V3.0-MinimalProfile\",\n \"RegistryServiceSpecification/V3.0\"\n ]\n}"}}}},"default":{"description":"Default error handling for unmentioned status codes","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}}},"x-semanticIds":["https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0"],"description":"Returns the self-describing information of a network resource (ServiceDescription)","method":"get","path":"/description","servers":[{"url":"{protocol}://{host_name}:{port}/api/{version_prefix}","variables":{"protocol":{"description":"Allows access through http and https (recommended)","default":"https","enum":["http","https"]},"host_name":{"description":"Hostname of server hosting the api","default":"admin-shell.io"},"port":{"description":"80 is default for http, 443 for https","default":"443","enum":["80","443"]},"version_prefix":{"default":"v3.0","enum":["v3.0"]}}}],"info":{"title":"DotAAS Part 2 | HTTP/REST | Discovery Service Specification","description":"The entire Full Profile of the Discovery Service Specification as part of Details of the Asset Administration Shell Part 2. Publisher: Industrial Digital Twin Association (IDTA) 2023","contact":{"name":"Industrial Digital Twin Association (IDTA)","email":"info@idtwin.org"},"license":{"name":"CC BY 4.0","url":"https://creativecommons.org/licenses/by/4.0/"},"version":"V3.0_SSP-001"},"postman":{"name":"Returns the self-describing information of a network resource (ServiceDescription)","description":{"type":"text/plain"},"url":{"path":["description"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/AAS Discovery//dotaas-part-2-http-rest-discovery-service-specification -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns the self-describing information of a network resource (ServiceDescription) - - - -Returns the self-describing information of a network resource (ServiceDescription) - -
- -Requested Description - -
Schema
    = 1`"} defaultValue={undefined}>
- -Default error handling for unmentioned status codes - -
Schema
    messages object[]
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Discovery/sidebar.js b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Discovery/sidebar.js deleted file mode 100644 index 7db655518ea..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Discovery/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/AAS Discovery//dotaas-part-2-http-rest-discovery-service-specification"},{"type":"category","label":"Asset Administration Shell Basic Discovery API","link":{"type":"generated-index","title":"Asset Administration Shell Basic Discovery API","slug":"/category/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/AAS Discovery/asset-administration-shell-basic-discovery-api"},"items":[{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/AAS Discovery//get-all-asset-administration-shell-ids-by-asset-link","label":"Returns a list of Asset Administration Shell ids linked to specific Asset identifiers","className":"api-method get"},{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/AAS Discovery//get-all-asset-links-by-id","label":"Returns a list of specific Asset identifiers based on an Asset Administration Shell id to edit discoverable content","className":"api-method get"}]},{"type":"category","label":"Description API","link":{"type":"generated-index","title":"Description API","slug":"/category/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/AAS Discovery/description-api"},"items":[{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/AAS Discovery//get-description","label":"Returns the self-describing information of a network resource (ServiceDescription)","className":"api-method get"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Registry/dotaas-part-2-http-rest-registry-service-specification.info.mdx b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Registry/dotaas-part-2-http-rest-registry-service-specification.info.mdx deleted file mode 100644 index 3b413b7c2bb..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Registry/dotaas-part-2-http-rest-registry-service-specification.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: dotaas-part-2-http-rest-registry-service-specification -title: "DotAAS Part 2 | HTTP/REST | Registry Service Specification" -description: "The Read Profile of the Asset Administration Shell Registry Service Specification as part of the Specification of the Asset Administration Shell: Part 2. Publisher: Industrial Digital Twin Association (IDTA) April 2023" -sidebar_label: Introduction -sidebar_position: 0 -hide_title: true -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiDemoPanel/Export"; - -Version: V3.0_SSP-002 - -# DotAAS Part 2 | HTTP/REST | Registry Service Specification - - - -The Read Profile of the Asset Administration Shell Registry Service Specification as part of the Specification of the Asset Administration Shell: Part 2. Publisher: Industrial Digital Twin Association (IDTA) April 2023 - -

Contact

Industrial Digital Twin Association (IDTA): info@idtwin.org

License

CC BY 4.0
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Registry/get-all-asset-administration-shell-descriptors.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Registry/get-all-asset-administration-shell-descriptors.api.mdx deleted file mode 100644 index 750e2627547..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Registry/get-all-asset-administration-shell-descriptors.api.mdx +++ /dev/null @@ -1,290 +0,0 @@ ---- -id: get-all-asset-administration-shell-descriptors -title: "Returns all Asset Administration Shell Descriptors" -description: "Returns all Asset Administration Shell Descriptors" -sidebar_label: "Returns all Asset Administration Shell Descriptors" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Asset Administration Shell Registry API"],"operationId":"GetAllAssetAdministrationShellDescriptors","parameters":[{"name":"limit","in":"query","description":"The maximum number of elements in the response array","required":false,"schema":{"minimum":1,"type":"integer"}},{"name":"cursor","in":"query","description":"A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue","required":false,"schema":{"type":"string"}},{"name":"assetKind","in":"query","description":"The Asset's kind (Instance or Type)","required":false,"schema":{"type":"string","enum":["Instance","NotApplicable","Type"]}},{"name":"assetType","in":"query","description":"The Asset's type (UTF8-BASE64-URL-encoded)","required":false,"schema":{"maxLength":2000,"minLength":1,"pattern":"^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$","type":"string"}}],"responses":{"200":{"description":"Requested Asset Administration Shell Descriptors","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"paging_metadata":{"type":"object","properties":{"cursor":{"type":"string","example":"wJlCDLIl6KTWypN7T6vc6nWEmEYe99Hjf1XY1xmqV-M=#"}}}}},{"type":"object","properties":{"result":{"type":"array","items":{"required":["id"],"type":"object","example":"{ \"id\": \"https://example.org/aas/motor\", \"endpoints\": [ { \"protocolInformation\": { \"endpointAddress\": \"https://localhost:1234\", \"endpointProtocolVersion\": \"1.1\" }, \"interface\": \"AAS-1.0\" }, { \"protocolInformation\": { \"endpointAddress\": \"opc.tcp://localhost:4840\" }, \"interface\": \"AAS-1.0\" }, { \"protocolInformation\": { \"endpointAddress\": \"https://localhost:5678\", \"endpointProtocolVersion\": \"1.1\", \"subprotocol\": \"OPC UA Basic SOAP\", \"subprotocolBody\": \"ns=2;s=MyAAS\", \"subprotocolBodyEncoding\": \"application/soap+xml\" }, \"interface\": \"AAS-1.0\" } ] }","allOf":[{"type":"object","properties":{"description":{"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":1023}}}]}},"displayName":{"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":128}}}]}},"extensions":{"minItems":1,"type":"array","items":{"allOf":[{"type":"object","properties":{"semanticId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"supplementalSemanticIds":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}},{"required":["name"],"properties":{"name":{"maxLength":128,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueType":{"type":"string","enum":["xs:anyURI","xs:base64Binary","xs:boolean","xs:byte","xs:date","xs:dateTime","xs:decimal","xs:double","xs:duration","xs:float","xs:gDay","xs:gMonth","xs:gMonthDay","xs:gYear","xs:gYearMonth","xs:hexBinary","xs:int","xs:integer","xs:long","xs:negativeInteger","xs:nonNegativeInteger","xs:nonPositiveInteger","xs:positiveInteger","xs:short","xs:string","xs:time","xs:unsignedByte","xs:unsignedInt","xs:unsignedLong","xs:unsignedShort"]},"value":{"type":"string"},"refersTo":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}}]}}},"example":"{ \"endpoints\": [ { \"protocolInformation\": { \"endpointAddress\": \"https://localhost:1234\", \"endpointProtocolVersion\": \"1.1\" }, \"interface\": \"AAS-1.0\" }, { \"protocolInformation\": { \"endpointAddress\": \"opc.tcp://localhost:4840\" }, \"interface\": \"AAS-1.0\" }, { \"protocolInformation\": { \"endpointAddress\": \"https://localhost:5678\", \"endpointProtocolVersion\": \"1.1\", \"subprotocol\": \"OPC UA Basic SOAP\", \"subprotocolBody\": \"ns=2;s=MyAAS\", \"subprotocolBodyEncoding\": \"application/soap+xml\" }, \"interface\": \"AAS-1.0\" } ] }"},{"properties":{"administration":{"allOf":[{"type":"object","properties":{"embeddedDataSpecifications":{"minItems":1,"type":"array","items":{"required":["dataSpecification","dataSpecificationContent"],"type":"object","properties":{"dataSpecification":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"dataSpecificationContent":{"oneOf":[{"allOf":[{"required":["modelType"],"type":"object","properties":{"modelType":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataSpecificationIec61360","Entity","File","MultiLanguageProperty","Operation","Property","Range","ReferenceElement","RelationshipElement","Submodel","SubmodelElementCollection","SubmodelElementList"]}}},{"required":["preferredName"],"properties":{"preferredName":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":255}}}]}},"shortName":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":18}}}]}},"unit":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"unitId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"sourceOfDefinition":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"symbol":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"dataType":{"type":"string","enum":["BLOB","BOOLEAN","DATE","FILE","HTML","INTEGER_COUNT","INTEGER_CURRENCY","INTEGER_MEASURE","IRDI","IRI","RATIONAL","RATIONAL_MEASURE","REAL_COUNT","REAL_CURRENCY","REAL_MEASURE","STRING","STRING_TRANSLATABLE","TIME","TIMESTAMP"]},"definition":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":1023}}}]}},"valueFormat":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueList":{"required":["valueReferencePairs"],"type":"object","properties":{"valueReferencePairs":{"minItems":1,"type":"array","items":{"required":["value","valueId"],"type":"object","properties":{"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}}}},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"levelType":{"required":["max","min","nom","typ"],"type":"object","properties":{"min":{"type":"boolean"},"nom":{"type":"boolean"},"typ":{"type":"boolean"},"max":{"type":"boolean"}}},"modelType":{"pattern":"DataSpecificationIec61360","type":"string"}}}]}]}}}}}},{"properties":{"version":{"type":"string","allOf":[{"maxLength":4,"minLength":1},{"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"},{"pattern":"^(0|[1-9][0-9]*)$"}]},"revision":{"type":"string","allOf":[{"maxLength":4,"minLength":1},{"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"},{"pattern":"^(0|[1-9][0-9]*)$"}]},"creator":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"templateId":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}]},"assetKind":{"type":"string","enum":["Instance","NotApplicable","Type"]},"assetType":{"maxLength":2000,"minLength":1,"pattern":"^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$","type":"string"},"endpoints":{"minItems":1,"type":"array","items":{"required":["interface","protocolInformation"],"type":"object","properties":{"interface":{"maxLength":128,"type":"string"},"protocolInformation":{"required":["href"],"type":"object","properties":{"href":{"maxLength":2048,"type":"string"},"endpointProtocol":{"maxLength":128,"type":"string"},"endpointProtocolVersion":{"type":"array","items":{"maxLength":128,"type":"string"}},"subprotocol":{"maxLength":128,"type":"string"},"subprotocolBody":{"maxLength":128,"type":"string"},"subprotocolBodyEncoding":{"maxLength":128,"type":"string"},"securityAttributes":{"minItems":1,"type":"array","items":{"required":["key","type","value"],"type":"object","properties":{"type":{"type":"string","enum":["NONE","RFC_TLSA","W3C_DID"]},"key":{"type":"string"},"value":{"type":"string"}}}}}}}}},"globalAssetId":{"maxLength":2000,"minLength":1,"pattern":"^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$","type":"string"},"idShort":{"maxLength":128,"type":"string"},"id":{"maxLength":2000,"minLength":1,"pattern":"^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$","type":"string"},"specificAssetIds":{"type":"array","items":{"allOf":[{"type":"object","properties":{"semanticId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"supplementalSemanticIds":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}},{"required":["name","value"],"properties":{"name":{"maxLength":64,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"externalSubjectId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}]}},"submodelDescriptors":{"type":"array","items":{"required":["endpoints","id"],"type":"object","properties":{"administration":{"allOf":[{"type":"object","properties":{"embeddedDataSpecifications":{"minItems":1,"type":"array","items":{"required":["dataSpecification","dataSpecificationContent"],"type":"object","properties":{"dataSpecification":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"dataSpecificationContent":{"oneOf":[{"allOf":[{"required":["modelType"],"type":"object","properties":{"modelType":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataSpecificationIec61360","Entity","File","MultiLanguageProperty","Operation","Property","Range","ReferenceElement","RelationshipElement","Submodel","SubmodelElementCollection","SubmodelElementList"]}}},{"required":["preferredName"],"properties":{"preferredName":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":255}}}]}},"shortName":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":18}}}]}},"unit":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"unitId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"sourceOfDefinition":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"symbol":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"dataType":{"type":"string","enum":["BLOB","BOOLEAN","DATE","FILE","HTML","INTEGER_COUNT","INTEGER_CURRENCY","INTEGER_MEASURE","IRDI","IRI","RATIONAL","RATIONAL_MEASURE","REAL_COUNT","REAL_CURRENCY","REAL_MEASURE","STRING","STRING_TRANSLATABLE","TIME","TIMESTAMP"]},"definition":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":1023}}}]}},"valueFormat":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueList":{"required":["valueReferencePairs"],"type":"object","properties":{"valueReferencePairs":{"minItems":1,"type":"array","items":{"required":["value","valueId"],"type":"object","properties":{"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}}}},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"levelType":{"required":["max","min","nom","typ"],"type":"object","properties":{"min":{"type":"boolean"},"nom":{"type":"boolean"},"typ":{"type":"boolean"},"max":{"type":"boolean"}}},"modelType":{"pattern":"DataSpecificationIec61360","type":"string"}}}]}]}}}}}},{"properties":{"version":{"type":"string","allOf":[{"maxLength":4,"minLength":1},{"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"},{"pattern":"^(0|[1-9][0-9]*)$"}]},"revision":{"type":"string","allOf":[{"maxLength":4,"minLength":1},{"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"},{"pattern":"^(0|[1-9][0-9]*)$"}]},"creator":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"templateId":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}]},"endpoints":{"minItems":1,"type":"array","items":{"required":["interface","protocolInformation"],"type":"object","properties":{"interface":{"maxLength":128,"type":"string"},"protocolInformation":{"required":["href"],"type":"object","properties":{"href":{"maxLength":2048,"type":"string"},"endpointProtocol":{"maxLength":128,"type":"string"},"endpointProtocolVersion":{"type":"array","items":{"maxLength":128,"type":"string"}},"subprotocol":{"maxLength":128,"type":"string"},"subprotocolBody":{"maxLength":128,"type":"string"},"subprotocolBodyEncoding":{"maxLength":128,"type":"string"},"securityAttributes":{"minItems":1,"type":"array","items":{"required":["key","type","value"],"type":"object","properties":{"type":{"type":"string","enum":["NONE","RFC_TLSA","W3C_DID"]},"key":{"type":"string"},"value":{"type":"string"}}}}}}}}},"idShort":{"maxLength":128,"type":"string"},"id":{"maxLength":2000,"minLength":1,"pattern":"^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$","type":"string"},"semanticId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"supplementalSemanticId":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}},"example":"{ \"id\": \"https://admin-shell.io/zvei/nameplate/1/0/Nameplate\", \"endpoints\": [ { \"protocolInformation\": { \"endpointAddress\": \"https://localhost:1234\", \"endpointProtocolVersion\": \"1.1\" }, \"interface\": \"AAS-1.0\" }, { \"protocolInformation\": { \"endpointAddress\": \"opc.tcp://localhost:4840\" }, \"interface\": \"AAS-1.0\" }, { \"protocolInformation\": { \"endpointAddress\": \"https://localhost:5678\", \"endpointProtocolVersion\": \"1.1\", \"subprotocol\": \"OPC UA Basic SOAP\", \"subprotocolBody\": \"ns=2;s=MyAAS\", \"subprotocolBodyEncoding\": \"application/soap+xml\" }, \"interface\": \"AAS-1.0\" } ] }","allOf":[{"type":"object","properties":{"description":{"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":1023}}}]}},"displayName":{"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":128}}}]}},"extensions":{"minItems":1,"type":"array","items":{"allOf":[{"type":"object","properties":{"semanticId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"supplementalSemanticIds":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}},{"required":["name"],"properties":{"name":{"maxLength":128,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueType":{"type":"string","enum":["xs:anyURI","xs:base64Binary","xs:boolean","xs:byte","xs:date","xs:dateTime","xs:decimal","xs:double","xs:duration","xs:float","xs:gDay","xs:gMonth","xs:gMonthDay","xs:gYear","xs:gYearMonth","xs:hexBinary","xs:int","xs:integer","xs:long","xs:negativeInteger","xs:nonNegativeInteger","xs:nonPositiveInteger","xs:positiveInteger","xs:short","xs:string","xs:time","xs:unsignedByte","xs:unsignedInt","xs:unsignedLong","xs:unsignedShort"]},"value":{"type":"string"},"refersTo":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}}]}}},"example":"{ \"endpoints\": [ { \"protocolInformation\": { \"endpointAddress\": \"https://localhost:1234\", \"endpointProtocolVersion\": \"1.1\" }, \"interface\": \"AAS-1.0\" }, { \"protocolInformation\": { \"endpointAddress\": \"opc.tcp://localhost:4840\" }, \"interface\": \"AAS-1.0\" }, { \"protocolInformation\": { \"endpointAddress\": \"https://localhost:5678\", \"endpointProtocolVersion\": \"1.1\", \"subprotocol\": \"OPC UA Basic SOAP\", \"subprotocolBody\": \"ns=2;s=MyAAS\", \"subprotocolBodyEncoding\": \"application/soap+xml\" }, \"interface\": \"AAS-1.0\" } ] }"}]}}}}]}}}}]}}}},"400":{"description":"Bad Request, e.g. the request parameters of the format of the request body is wrong.","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"default":{"description":"Default error handling for unmentioned status codes","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}}},"x-semanticIds":["https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptors/3/0","https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptorsByAssetKind/3/0","https://admin-shell.io/aas/API/GetAllAssetAdministrationShellDescriptorsByAssetType/3/0"],"description":"Returns all Asset Administration Shell Descriptors","method":"get","path":"/shell-descriptors","servers":[{"url":"{protocol}://{host_name}:{port}/api/{version_prefix}","variables":{"protocol":{"description":"Allows access through http and https (recommended)","default":"https","enum":["http","https"]},"host_name":{"description":"Hostname of server hosting the api","default":"admin-shell.io"},"port":{"description":"80 is default for http, 443 for https","default":"443","enum":["80","443"]},"version_prefix":{"default":"v3.0","enum":["v3.0"]}}}],"info":{"title":"DotAAS Part 2 | HTTP/REST | Registry Service Specification","description":"The Read Profile of the Asset Administration Shell Registry Service Specification as part of the Specification of the Asset Administration Shell: Part 2. Publisher: Industrial Digital Twin Association (IDTA) April 2023","contact":{"name":"Industrial Digital Twin Association (IDTA)","email":"info@idtwin.org"},"license":{"name":"CC BY 4.0","url":"https://creativecommons.org/licenses/by/4.0/"},"version":"V3.0_SSP-002"},"postman":{"name":"Returns all Asset Administration Shell Descriptors","description":{"type":"text/plain"},"url":{"path":["shell-descriptors"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The maximum number of elements in the response array","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"The Asset's kind (Instance or Type)","type":"text/plain"},"key":"assetKind","value":""},{"disabled":false,"description":{"content":"The Asset's type (UTF8-BASE64-URL-encoded)","type":"text/plain"},"key":"assetType","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/AAS Registry//dotaas-part-2-http-rest-registry-service-specification -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns all Asset Administration Shell Descriptors - - - -Returns all Asset Administration Shell Descriptors - -
Query Parameters
- -Requested Asset Administration Shell Descriptors - -
Schema
    paging_metadata object
    result object[]
    description object[]
    displayName object[]
    extensions object[]
    - -**Possible values:** `>= 1` - -
    semanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    supplementalSemanticIds undefined[]
    - -**Possible values:** `>= 1` - -
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    refersTo undefined[]
    - -**Possible values:** `>= 1` - -
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    administration object
    embeddedDataSpecifications object[]
    - -**Possible values:** `>= 1` - -
    dataSpecification
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    dataSpecificationContent object
    oneOf
    preferredName object[]
    - -**Possible values:** `>= 1` - -
    shortName object[]
    - -**Possible values:** `>= 1` - -
    unitId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    definition object[]
    - -**Possible values:** `>= 1` - -
    valueList object
    valueReferencePairs object[]
    - -**Possible values:** `>= 1` - -
    valueId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    levelType object
    creator
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    endpoints object[]
    - -**Possible values:** `>= 1` - -
    protocolInformation object
    securityAttributes object[]
    - -**Possible values:** `>= 1` - -
    specificAssetIds object[]
    semanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    supplementalSemanticIds undefined[]
    - -**Possible values:** `>= 1` - -
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    externalSubjectId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    submodelDescriptors object[]
    administration object
    embeddedDataSpecifications object[]
    - -**Possible values:** `>= 1` - -
    dataSpecification
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    dataSpecificationContent object
    oneOf
    preferredName object[]
    - -**Possible values:** `>= 1` - -
    shortName object[]
    - -**Possible values:** `>= 1` - -
    unitId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    definition object[]
    - -**Possible values:** `>= 1` - -
    valueList object
    valueReferencePairs object[]
    - -**Possible values:** `>= 1` - -
    valueId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    levelType object
    creator
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    endpoints object[]
    - -**Possible values:** `>= 1` - -
    protocolInformation object
    securityAttributes object[]
    - -**Possible values:** `>= 1` - -
    semanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    supplementalSemanticId undefined[]
    - -**Possible values:** `>= 1` - -
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    description object[]
    displayName object[]
    extensions object[]
    - -**Possible values:** `>= 1` - -
    semanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    supplementalSemanticIds undefined[]
    - -**Possible values:** `>= 1` - -
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    refersTo undefined[]
    - -**Possible values:** `>= 1` - -
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
- -Bad Request, e.g. the request parameters of the format of the request body is wrong. - -
Schema
    messages object[]
- -Forbidden - -
Schema
    messages object[]
- -Internal Server Error - -
Schema
    messages object[]
- -Default error handling for unmentioned status codes - -
Schema
    messages object[]
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Registry/get-all-submodel-descriptors-through-superpath.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Registry/get-all-submodel-descriptors-through-superpath.api.mdx deleted file mode 100644 index bc3b042b01a..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Registry/get-all-submodel-descriptors-through-superpath.api.mdx +++ /dev/null @@ -1,170 +0,0 @@ ---- -id: get-all-submodel-descriptors-through-superpath -title: "Returns all Submodel Descriptors" -description: "Returns all Submodel Descriptors" -sidebar_label: "Returns all Submodel Descriptors" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Asset Administration Shell Registry API"],"operationId":"GetAllSubmodelDescriptorsThroughSuperpath","parameters":[{"name":"aasIdentifier","in":"path","description":"The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"byte"}},{"name":"limit","in":"query","description":"The maximum number of elements in the response array","required":false,"schema":{"minimum":1,"type":"integer"}},{"name":"cursor","in":"query","description":"A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Requested Submodel Descriptors","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"paging_metadata":{"type":"object","properties":{"cursor":{"type":"string","example":"wJlCDLIl6KTWypN7T6vc6nWEmEYe99Hjf1XY1xmqV-M=#"}}}}},{"type":"object","properties":{"result":{"type":"array","items":{"required":["endpoints","id"],"type":"object","properties":{"administration":{"allOf":[{"type":"object","properties":{"embeddedDataSpecifications":{"minItems":1,"type":"array","items":{"required":["dataSpecification","dataSpecificationContent"],"type":"object","properties":{"dataSpecification":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"dataSpecificationContent":{"oneOf":[{"allOf":[{"required":["modelType"],"type":"object","properties":{"modelType":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataSpecificationIec61360","Entity","File","MultiLanguageProperty","Operation","Property","Range","ReferenceElement","RelationshipElement","Submodel","SubmodelElementCollection","SubmodelElementList"]}}},{"required":["preferredName"],"properties":{"preferredName":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":255}}}]}},"shortName":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":18}}}]}},"unit":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"unitId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"sourceOfDefinition":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"symbol":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"dataType":{"type":"string","enum":["BLOB","BOOLEAN","DATE","FILE","HTML","INTEGER_COUNT","INTEGER_CURRENCY","INTEGER_MEASURE","IRDI","IRI","RATIONAL","RATIONAL_MEASURE","REAL_COUNT","REAL_CURRENCY","REAL_MEASURE","STRING","STRING_TRANSLATABLE","TIME","TIMESTAMP"]},"definition":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":1023}}}]}},"valueFormat":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueList":{"required":["valueReferencePairs"],"type":"object","properties":{"valueReferencePairs":{"minItems":1,"type":"array","items":{"required":["value","valueId"],"type":"object","properties":{"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}}}},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"levelType":{"required":["max","min","nom","typ"],"type":"object","properties":{"min":{"type":"boolean"},"nom":{"type":"boolean"},"typ":{"type":"boolean"},"max":{"type":"boolean"}}},"modelType":{"pattern":"DataSpecificationIec61360","type":"string"}}}]}]}}}}}},{"properties":{"version":{"type":"string","allOf":[{"maxLength":4,"minLength":1},{"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"},{"pattern":"^(0|[1-9][0-9]*)$"}]},"revision":{"type":"string","allOf":[{"maxLength":4,"minLength":1},{"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"},{"pattern":"^(0|[1-9][0-9]*)$"}]},"creator":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"templateId":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}]},"endpoints":{"minItems":1,"type":"array","items":{"required":["interface","protocolInformation"],"type":"object","properties":{"interface":{"maxLength":128,"type":"string"},"protocolInformation":{"required":["href"],"type":"object","properties":{"href":{"maxLength":2048,"type":"string"},"endpointProtocol":{"maxLength":128,"type":"string"},"endpointProtocolVersion":{"type":"array","items":{"maxLength":128,"type":"string"}},"subprotocol":{"maxLength":128,"type":"string"},"subprotocolBody":{"maxLength":128,"type":"string"},"subprotocolBodyEncoding":{"maxLength":128,"type":"string"},"securityAttributes":{"minItems":1,"type":"array","items":{"required":["key","type","value"],"type":"object","properties":{"type":{"type":"string","enum":["NONE","RFC_TLSA","W3C_DID"]},"key":{"type":"string"},"value":{"type":"string"}}}}}}}}},"idShort":{"maxLength":128,"type":"string"},"id":{"maxLength":2000,"minLength":1,"pattern":"^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$","type":"string"},"semanticId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"supplementalSemanticId":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}},"example":"{ \"id\": \"https://admin-shell.io/zvei/nameplate/1/0/Nameplate\", \"endpoints\": [ { \"protocolInformation\": { \"endpointAddress\": \"https://localhost:1234\", \"endpointProtocolVersion\": \"1.1\" }, \"interface\": \"AAS-1.0\" }, { \"protocolInformation\": { \"endpointAddress\": \"opc.tcp://localhost:4840\" }, \"interface\": \"AAS-1.0\" }, { \"protocolInformation\": { \"endpointAddress\": \"https://localhost:5678\", \"endpointProtocolVersion\": \"1.1\", \"subprotocol\": \"OPC UA Basic SOAP\", \"subprotocolBody\": \"ns=2;s=MyAAS\", \"subprotocolBodyEncoding\": \"application/soap+xml\" }, \"interface\": \"AAS-1.0\" } ] }","allOf":[{"type":"object","properties":{"description":{"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":1023}}}]}},"displayName":{"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":128}}}]}},"extensions":{"minItems":1,"type":"array","items":{"allOf":[{"type":"object","properties":{"semanticId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"supplementalSemanticIds":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}},{"required":["name"],"properties":{"name":{"maxLength":128,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueType":{"type":"string","enum":["xs:anyURI","xs:base64Binary","xs:boolean","xs:byte","xs:date","xs:dateTime","xs:decimal","xs:double","xs:duration","xs:float","xs:gDay","xs:gMonth","xs:gMonthDay","xs:gYear","xs:gYearMonth","xs:hexBinary","xs:int","xs:integer","xs:long","xs:negativeInteger","xs:nonNegativeInteger","xs:nonPositiveInteger","xs:positiveInteger","xs:short","xs:string","xs:time","xs:unsignedByte","xs:unsignedInt","xs:unsignedLong","xs:unsignedShort"]},"value":{"type":"string"},"refersTo":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}}]}}},"example":"{ \"endpoints\": [ { \"protocolInformation\": { \"endpointAddress\": \"https://localhost:1234\", \"endpointProtocolVersion\": \"1.1\" }, \"interface\": \"AAS-1.0\" }, { \"protocolInformation\": { \"endpointAddress\": \"opc.tcp://localhost:4840\" }, \"interface\": \"AAS-1.0\" }, { \"protocolInformation\": { \"endpointAddress\": \"https://localhost:5678\", \"endpointProtocolVersion\": \"1.1\", \"subprotocol\": \"OPC UA Basic SOAP\", \"subprotocolBody\": \"ns=2;s=MyAAS\", \"subprotocolBodyEncoding\": \"application/soap+xml\" }, \"interface\": \"AAS-1.0\" } ] }"}]}}}}]}}}},"400":{"description":"Bad Request, e.g. the request parameters of the format of the request body is wrong.","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"default":{"description":"Default error handling for unmentioned status codes","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}}},"x-semanticIds":["https://admin-shell.io/aas/API/GetAllSubmodelDescriptors/3/0"],"description":"Returns all Submodel Descriptors","method":"get","path":"/shell-descriptors/{aasIdentifier}/submodel-descriptors","servers":[{"url":"{protocol}://{host_name}:{port}/api/{version_prefix}","variables":{"protocol":{"description":"Allows access through http and https (recommended)","default":"https","enum":["http","https"]},"host_name":{"description":"Hostname of server hosting the api","default":"admin-shell.io"},"port":{"description":"80 is default for http, 443 for https","default":"443","enum":["80","443"]},"version_prefix":{"default":"v3.0","enum":["v3.0"]}}}],"info":{"title":"DotAAS Part 2 | HTTP/REST | Registry Service Specification","description":"The Read Profile of the Asset Administration Shell Registry Service Specification as part of the Specification of the Asset Administration Shell: Part 2. Publisher: Industrial Digital Twin Association (IDTA) April 2023","contact":{"name":"Industrial Digital Twin Association (IDTA)","email":"info@idtwin.org"},"license":{"name":"CC BY 4.0","url":"https://creativecommons.org/licenses/by/4.0/"},"version":"V3.0_SSP-002"},"postman":{"name":"Returns all Submodel Descriptors","description":{"type":"text/plain"},"url":{"path":["shell-descriptors",":aasIdentifier","submodel-descriptors"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The maximum number of elements in the response array","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue","type":"text/plain"},"key":"cursor","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)","type":"text/plain"},"type":"any","value":"","key":"aasIdentifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/AAS Registry//dotaas-part-2-http-rest-registry-service-specification -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns all Submodel Descriptors - - - -Returns all Submodel Descriptors - -
Path Parameters
Query Parameters
- -Requested Submodel Descriptors - -
Schema
    paging_metadata object
    result object[]
    administration object
    embeddedDataSpecifications object[]
    - -**Possible values:** `>= 1` - -
    dataSpecification
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    dataSpecificationContent object
    oneOf
    preferredName object[]
    - -**Possible values:** `>= 1` - -
    shortName object[]
    - -**Possible values:** `>= 1` - -
    unitId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    definition object[]
    - -**Possible values:** `>= 1` - -
    valueList object
    valueReferencePairs object[]
    - -**Possible values:** `>= 1` - -
    valueId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    levelType object
    creator
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    endpoints object[]
    - -**Possible values:** `>= 1` - -
    protocolInformation object
    securityAttributes object[]
    - -**Possible values:** `>= 1` - -
    semanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    supplementalSemanticId undefined[]
    - -**Possible values:** `>= 1` - -
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    description object[]
    displayName object[]
    extensions object[]
    - -**Possible values:** `>= 1` - -
    semanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    supplementalSemanticIds undefined[]
    - -**Possible values:** `>= 1` - -
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    refersTo undefined[]
    - -**Possible values:** `>= 1` - -
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
- -Bad Request, e.g. the request parameters of the format of the request body is wrong. - -
Schema
    messages object[]
- -Forbidden - -
Schema
    messages object[]
- -Not Found - -
Schema
    messages object[]
- -Internal Server Error - -
Schema
    messages object[]
- -Default error handling for unmentioned status codes - -
Schema
    messages object[]
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Registry/get-asset-administration-shell-descriptor-by-id.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Registry/get-asset-administration-shell-descriptor-by-id.api.mdx deleted file mode 100644 index c6b4f1342c4..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Registry/get-asset-administration-shell-descriptor-by-id.api.mdx +++ /dev/null @@ -1,294 +0,0 @@ ---- -id: get-asset-administration-shell-descriptor-by-id -title: "Returns a specific Asset Administration Shell Descriptor" -description: "Returns a specific Asset Administration Shell Descriptor" -sidebar_label: "Returns a specific Asset Administration Shell Descriptor" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Asset Administration Shell Registry API"],"operationId":"GetAssetAdministrationShellDescriptorById","parameters":[{"name":"aasIdentifier","in":"path","description":"The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"byte"}}],"responses":{"200":{"description":"Requested Asset Administration Shell Descriptor","content":{"application/json":{"schema":{"required":["id"],"type":"object","example":"{ \"id\": \"https://example.org/aas/motor\", \"endpoints\": [ { \"protocolInformation\": { \"endpointAddress\": \"https://localhost:1234\", \"endpointProtocolVersion\": \"1.1\" }, \"interface\": \"AAS-1.0\" }, { \"protocolInformation\": { \"endpointAddress\": \"opc.tcp://localhost:4840\" }, \"interface\": \"AAS-1.0\" }, { \"protocolInformation\": { \"endpointAddress\": \"https://localhost:5678\", \"endpointProtocolVersion\": \"1.1\", \"subprotocol\": \"OPC UA Basic SOAP\", \"subprotocolBody\": \"ns=2;s=MyAAS\", \"subprotocolBodyEncoding\": \"application/soap+xml\" }, \"interface\": \"AAS-1.0\" } ] }","allOf":[{"type":"object","properties":{"description":{"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":1023}}}]}},"displayName":{"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":128}}}]}},"extensions":{"minItems":1,"type":"array","items":{"allOf":[{"type":"object","properties":{"semanticId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"supplementalSemanticIds":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}},{"required":["name"],"properties":{"name":{"maxLength":128,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueType":{"type":"string","enum":["xs:anyURI","xs:base64Binary","xs:boolean","xs:byte","xs:date","xs:dateTime","xs:decimal","xs:double","xs:duration","xs:float","xs:gDay","xs:gMonth","xs:gMonthDay","xs:gYear","xs:gYearMonth","xs:hexBinary","xs:int","xs:integer","xs:long","xs:negativeInteger","xs:nonNegativeInteger","xs:nonPositiveInteger","xs:positiveInteger","xs:short","xs:string","xs:time","xs:unsignedByte","xs:unsignedInt","xs:unsignedLong","xs:unsignedShort"]},"value":{"type":"string"},"refersTo":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}}]}}},"example":"{ \"endpoints\": [ { \"protocolInformation\": { \"endpointAddress\": \"https://localhost:1234\", \"endpointProtocolVersion\": \"1.1\" }, \"interface\": \"AAS-1.0\" }, { \"protocolInformation\": { \"endpointAddress\": \"opc.tcp://localhost:4840\" }, \"interface\": \"AAS-1.0\" }, { \"protocolInformation\": { \"endpointAddress\": \"https://localhost:5678\", \"endpointProtocolVersion\": \"1.1\", \"subprotocol\": \"OPC UA Basic SOAP\", \"subprotocolBody\": \"ns=2;s=MyAAS\", \"subprotocolBodyEncoding\": \"application/soap+xml\" }, \"interface\": \"AAS-1.0\" } ] }"},{"properties":{"administration":{"allOf":[{"type":"object","properties":{"embeddedDataSpecifications":{"minItems":1,"type":"array","items":{"required":["dataSpecification","dataSpecificationContent"],"type":"object","properties":{"dataSpecification":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"dataSpecificationContent":{"oneOf":[{"allOf":[{"required":["modelType"],"type":"object","properties":{"modelType":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataSpecificationIec61360","Entity","File","MultiLanguageProperty","Operation","Property","Range","ReferenceElement","RelationshipElement","Submodel","SubmodelElementCollection","SubmodelElementList"]}}},{"required":["preferredName"],"properties":{"preferredName":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":255}}}]}},"shortName":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":18}}}]}},"unit":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"unitId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"sourceOfDefinition":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"symbol":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"dataType":{"type":"string","enum":["BLOB","BOOLEAN","DATE","FILE","HTML","INTEGER_COUNT","INTEGER_CURRENCY","INTEGER_MEASURE","IRDI","IRI","RATIONAL","RATIONAL_MEASURE","REAL_COUNT","REAL_CURRENCY","REAL_MEASURE","STRING","STRING_TRANSLATABLE","TIME","TIMESTAMP"]},"definition":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":1023}}}]}},"valueFormat":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueList":{"required":["valueReferencePairs"],"type":"object","properties":{"valueReferencePairs":{"minItems":1,"type":"array","items":{"required":["value","valueId"],"type":"object","properties":{"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}}}},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"levelType":{"required":["max","min","nom","typ"],"type":"object","properties":{"min":{"type":"boolean"},"nom":{"type":"boolean"},"typ":{"type":"boolean"},"max":{"type":"boolean"}}},"modelType":{"pattern":"DataSpecificationIec61360","type":"string"}}}]}]}}}}}},{"properties":{"version":{"type":"string","allOf":[{"maxLength":4,"minLength":1},{"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"},{"pattern":"^(0|[1-9][0-9]*)$"}]},"revision":{"type":"string","allOf":[{"maxLength":4,"minLength":1},{"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"},{"pattern":"^(0|[1-9][0-9]*)$"}]},"creator":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"templateId":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}]},"assetKind":{"type":"string","enum":["Instance","NotApplicable","Type"]},"assetType":{"maxLength":2000,"minLength":1,"pattern":"^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$","type":"string"},"endpoints":{"minItems":1,"type":"array","items":{"required":["interface","protocolInformation"],"type":"object","properties":{"interface":{"maxLength":128,"type":"string"},"protocolInformation":{"required":["href"],"type":"object","properties":{"href":{"maxLength":2048,"type":"string"},"endpointProtocol":{"maxLength":128,"type":"string"},"endpointProtocolVersion":{"type":"array","items":{"maxLength":128,"type":"string"}},"subprotocol":{"maxLength":128,"type":"string"},"subprotocolBody":{"maxLength":128,"type":"string"},"subprotocolBodyEncoding":{"maxLength":128,"type":"string"},"securityAttributes":{"minItems":1,"type":"array","items":{"required":["key","type","value"],"type":"object","properties":{"type":{"type":"string","enum":["NONE","RFC_TLSA","W3C_DID"]},"key":{"type":"string"},"value":{"type":"string"}}}}}}}}},"globalAssetId":{"maxLength":2000,"minLength":1,"pattern":"^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$","type":"string"},"idShort":{"maxLength":128,"type":"string"},"id":{"maxLength":2000,"minLength":1,"pattern":"^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$","type":"string"},"specificAssetIds":{"type":"array","items":{"allOf":[{"type":"object","properties":{"semanticId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"supplementalSemanticIds":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}},{"required":["name","value"],"properties":{"name":{"maxLength":64,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"externalSubjectId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}]}},"submodelDescriptors":{"type":"array","items":{"required":["endpoints","id"],"type":"object","properties":{"administration":{"allOf":[{"type":"object","properties":{"embeddedDataSpecifications":{"minItems":1,"type":"array","items":{"required":["dataSpecification","dataSpecificationContent"],"type":"object","properties":{"dataSpecification":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"dataSpecificationContent":{"oneOf":[{"allOf":[{"required":["modelType"],"type":"object","properties":{"modelType":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataSpecificationIec61360","Entity","File","MultiLanguageProperty","Operation","Property","Range","ReferenceElement","RelationshipElement","Submodel","SubmodelElementCollection","SubmodelElementList"]}}},{"required":["preferredName"],"properties":{"preferredName":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":255}}}]}},"shortName":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":18}}}]}},"unit":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"unitId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"sourceOfDefinition":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"symbol":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"dataType":{"type":"string","enum":["BLOB","BOOLEAN","DATE","FILE","HTML","INTEGER_COUNT","INTEGER_CURRENCY","INTEGER_MEASURE","IRDI","IRI","RATIONAL","RATIONAL_MEASURE","REAL_COUNT","REAL_CURRENCY","REAL_MEASURE","STRING","STRING_TRANSLATABLE","TIME","TIMESTAMP"]},"definition":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":1023}}}]}},"valueFormat":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueList":{"required":["valueReferencePairs"],"type":"object","properties":{"valueReferencePairs":{"minItems":1,"type":"array","items":{"required":["value","valueId"],"type":"object","properties":{"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}}}},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"levelType":{"required":["max","min","nom","typ"],"type":"object","properties":{"min":{"type":"boolean"},"nom":{"type":"boolean"},"typ":{"type":"boolean"},"max":{"type":"boolean"}}},"modelType":{"pattern":"DataSpecificationIec61360","type":"string"}}}]}]}}}}}},{"properties":{"version":{"type":"string","allOf":[{"maxLength":4,"minLength":1},{"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"},{"pattern":"^(0|[1-9][0-9]*)$"}]},"revision":{"type":"string","allOf":[{"maxLength":4,"minLength":1},{"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"},{"pattern":"^(0|[1-9][0-9]*)$"}]},"creator":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"templateId":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}]},"endpoints":{"minItems":1,"type":"array","items":{"required":["interface","protocolInformation"],"type":"object","properties":{"interface":{"maxLength":128,"type":"string"},"protocolInformation":{"required":["href"],"type":"object","properties":{"href":{"maxLength":2048,"type":"string"},"endpointProtocol":{"maxLength":128,"type":"string"},"endpointProtocolVersion":{"type":"array","items":{"maxLength":128,"type":"string"}},"subprotocol":{"maxLength":128,"type":"string"},"subprotocolBody":{"maxLength":128,"type":"string"},"subprotocolBodyEncoding":{"maxLength":128,"type":"string"},"securityAttributes":{"minItems":1,"type":"array","items":{"required":["key","type","value"],"type":"object","properties":{"type":{"type":"string","enum":["NONE","RFC_TLSA","W3C_DID"]},"key":{"type":"string"},"value":{"type":"string"}}}}}}}}},"idShort":{"maxLength":128,"type":"string"},"id":{"maxLength":2000,"minLength":1,"pattern":"^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$","type":"string"},"semanticId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"supplementalSemanticId":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}},"example":"{ \"id\": \"https://admin-shell.io/zvei/nameplate/1/0/Nameplate\", \"endpoints\": [ { \"protocolInformation\": { \"endpointAddress\": \"https://localhost:1234\", \"endpointProtocolVersion\": \"1.1\" }, \"interface\": \"AAS-1.0\" }, { \"protocolInformation\": { \"endpointAddress\": \"opc.tcp://localhost:4840\" }, \"interface\": \"AAS-1.0\" }, { \"protocolInformation\": { \"endpointAddress\": \"https://localhost:5678\", \"endpointProtocolVersion\": \"1.1\", \"subprotocol\": \"OPC UA Basic SOAP\", \"subprotocolBody\": \"ns=2;s=MyAAS\", \"subprotocolBodyEncoding\": \"application/soap+xml\" }, \"interface\": \"AAS-1.0\" } ] }","allOf":[{"type":"object","properties":{"description":{"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":1023}}}]}},"displayName":{"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":128}}}]}},"extensions":{"minItems":1,"type":"array","items":{"allOf":[{"type":"object","properties":{"semanticId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"supplementalSemanticIds":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}},{"required":["name"],"properties":{"name":{"maxLength":128,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueType":{"type":"string","enum":["xs:anyURI","xs:base64Binary","xs:boolean","xs:byte","xs:date","xs:dateTime","xs:decimal","xs:double","xs:duration","xs:float","xs:gDay","xs:gMonth","xs:gMonthDay","xs:gYear","xs:gYearMonth","xs:hexBinary","xs:int","xs:integer","xs:long","xs:negativeInteger","xs:nonNegativeInteger","xs:nonPositiveInteger","xs:positiveInteger","xs:short","xs:string","xs:time","xs:unsignedByte","xs:unsignedInt","xs:unsignedLong","xs:unsignedShort"]},"value":{"type":"string"},"refersTo":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}}]}}},"example":"{ \"endpoints\": [ { \"protocolInformation\": { \"endpointAddress\": \"https://localhost:1234\", \"endpointProtocolVersion\": \"1.1\" }, \"interface\": \"AAS-1.0\" }, { \"protocolInformation\": { \"endpointAddress\": \"opc.tcp://localhost:4840\" }, \"interface\": \"AAS-1.0\" }, { \"protocolInformation\": { \"endpointAddress\": \"https://localhost:5678\", \"endpointProtocolVersion\": \"1.1\", \"subprotocol\": \"OPC UA Basic SOAP\", \"subprotocolBody\": \"ns=2;s=MyAAS\", \"subprotocolBodyEncoding\": \"application/soap+xml\" }, \"interface\": \"AAS-1.0\" } ] }"}]}}}}]}}}},"400":{"description":"Bad Request, e.g. the request parameters of the format of the request body is wrong.","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"default":{"description":"Default error handling for unmentioned status codes","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}}},"x-semanticIds":["https://admin-shell.io/aas/API/GetAssetAdministrationShellDescriptorById/3/0"],"description":"Returns a specific Asset Administration Shell Descriptor","method":"get","path":"/shell-descriptors/{aasIdentifier}","servers":[{"url":"{protocol}://{host_name}:{port}/api/{version_prefix}","variables":{"protocol":{"description":"Allows access through http and https (recommended)","default":"https","enum":["http","https"]},"host_name":{"description":"Hostname of server hosting the api","default":"admin-shell.io"},"port":{"description":"80 is default for http, 443 for https","default":"443","enum":["80","443"]},"version_prefix":{"default":"v3.0","enum":["v3.0"]}}}],"info":{"title":"DotAAS Part 2 | HTTP/REST | Registry Service Specification","description":"The Read Profile of the Asset Administration Shell Registry Service Specification as part of the Specification of the Asset Administration Shell: Part 2. Publisher: Industrial Digital Twin Association (IDTA) April 2023","contact":{"name":"Industrial Digital Twin Association (IDTA)","email":"info@idtwin.org"},"license":{"name":"CC BY 4.0","url":"https://creativecommons.org/licenses/by/4.0/"},"version":"V3.0_SSP-002"},"postman":{"name":"Returns a specific Asset Administration Shell Descriptor","description":{"type":"text/plain"},"url":{"path":["shell-descriptors",":aasIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)","type":"text/plain"},"type":"any","value":"","key":"aasIdentifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/AAS Registry//dotaas-part-2-http-rest-registry-service-specification -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns a specific Asset Administration Shell Descriptor - - - -Returns a specific Asset Administration Shell Descriptor - -
Path Parameters
- -Requested Asset Administration Shell Descriptor - -
Schema
    description object[]
    displayName object[]
    extensions object[]
    - -**Possible values:** `>= 1` - -
    semanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    supplementalSemanticIds undefined[]
    - -**Possible values:** `>= 1` - -
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    refersTo undefined[]
    - -**Possible values:** `>= 1` - -
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    administration object
    embeddedDataSpecifications object[]
    - -**Possible values:** `>= 1` - -
    dataSpecification
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    dataSpecificationContent object
    oneOf
    preferredName object[]
    - -**Possible values:** `>= 1` - -
    shortName object[]
    - -**Possible values:** `>= 1` - -
    unitId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    definition object[]
    - -**Possible values:** `>= 1` - -
    valueList object
    valueReferencePairs object[]
    - -**Possible values:** `>= 1` - -
    valueId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    levelType object
    creator
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    endpoints object[]
    - -**Possible values:** `>= 1` - -
    protocolInformation object
    securityAttributes object[]
    - -**Possible values:** `>= 1` - -
    specificAssetIds object[]
    semanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    supplementalSemanticIds undefined[]
    - -**Possible values:** `>= 1` - -
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    externalSubjectId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    submodelDescriptors object[]
    administration object
    embeddedDataSpecifications object[]
    - -**Possible values:** `>= 1` - -
    dataSpecification
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    dataSpecificationContent object
    oneOf
    preferredName object[]
    - -**Possible values:** `>= 1` - -
    shortName object[]
    - -**Possible values:** `>= 1` - -
    unitId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    definition object[]
    - -**Possible values:** `>= 1` - -
    valueList object
    valueReferencePairs object[]
    - -**Possible values:** `>= 1` - -
    valueId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    levelType object
    creator
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    endpoints object[]
    - -**Possible values:** `>= 1` - -
    protocolInformation object
    securityAttributes object[]
    - -**Possible values:** `>= 1` - -
    semanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    supplementalSemanticId undefined[]
    - -**Possible values:** `>= 1` - -
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    description object[]
    displayName object[]
    extensions object[]
    - -**Possible values:** `>= 1` - -
    semanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    supplementalSemanticIds undefined[]
    - -**Possible values:** `>= 1` - -
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    refersTo undefined[]
    - -**Possible values:** `>= 1` - -
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
- -Bad Request, e.g. the request parameters of the format of the request body is wrong. - -
Schema
    messages object[]
- -Forbidden - -
Schema
    messages object[]
- -Not Found - -
Schema
    messages object[]
- -Internal Server Error - -
Schema
    messages object[]
- -Default error handling for unmentioned status codes - -
Schema
    messages object[]
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Registry/get-description.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Registry/get-description.api.mdx deleted file mode 100644 index 119c5524882..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Registry/get-description.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-description -title: "Returns the self-describing information of a network resource (ServiceDescription)" -description: "Returns the self-describing information of a network resource (ServiceDescription)" -sidebar_label: "Returns the self-describing information of a network resource (ServiceDescription)" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Description API"],"operationId":"GetDescription","responses":{"200":{"description":"Requested Description","content":{"application/json":{"schema":{"type":"object","properties":{"profiles":{"minItems":1,"type":"array","items":{"type":"string","enum":["AssetAdministrationShellServiceSpecification/V3.0","AssetAdministrationShellServiceSpecification/V3.0-MinimalProfile","SubmodelServiceSpecification/V3.0","SubmodelServiceSpecification/V3.0-ValueProfile","SubmodelServiceSpecification/V3.0-MinimalProfile","AasxFileServerServiceSpecification/V3.0","RegistryServiceSpecification/V3.0","RegistryServiceSpecification/V3.0- AssetAdministrationShellRegistry","RegistryServiceSpecification/V3.0-SubmodelRegistry","RepositoryServiceSpecification/V3.0","RepositoryServiceSpecification/V3.0-MinimalProfile","AssetAdministrationShellRepositoryServiceSpecification/V3.0","AssetAdministrationShellRepositoryServiceSpecification/V3.0-MinimalProfile","SubmodelRepositoryServiceSpecification/V3.0","SubmodelRepositoryServiceSpecification/V3.0-MinimalProfile","RegistryAndDiscoveryServiceSpecification/V3.0"]}}},"description":"The Description object enables servers to present their capabilities to the clients, in particular which profiles they implement. At least one defined profile is required. Additional, proprietary attributes might be included. Nevertheless, the server must not expect that a regular client understands them.","example":"{\n \"profiles\": [\n \"RepositoryServiceSpecification/V3.0-MinimalProfile\",\n \"RegistryServiceSpecification/V3.0\"\n ]\n}"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"default":{"description":"Default error handling for unmentioned status codes","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}}},"x-semanticIds":["https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0"],"description":"Returns the self-describing information of a network resource (ServiceDescription)","method":"get","path":"/description","servers":[{"url":"{protocol}://{host_name}:{port}/api/{version_prefix}","variables":{"protocol":{"description":"Allows access through http and https (recommended)","default":"https","enum":["http","https"]},"host_name":{"description":"Hostname of server hosting the api","default":"admin-shell.io"},"port":{"description":"80 is default for http, 443 for https","default":"443","enum":["80","443"]},"version_prefix":{"default":"v3.0","enum":["v3.0"]}}}],"info":{"title":"DotAAS Part 2 | HTTP/REST | Registry Service Specification","description":"The Read Profile of the Asset Administration Shell Registry Service Specification as part of the Specification of the Asset Administration Shell: Part 2. Publisher: Industrial Digital Twin Association (IDTA) April 2023","contact":{"name":"Industrial Digital Twin Association (IDTA)","email":"info@idtwin.org"},"license":{"name":"CC BY 4.0","url":"https://creativecommons.org/licenses/by/4.0/"},"version":"V3.0_SSP-002"},"postman":{"name":"Returns the self-describing information of a network resource (ServiceDescription)","description":{"type":"text/plain"},"url":{"path":["description"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/AAS Registry//dotaas-part-2-http-rest-registry-service-specification -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns the self-describing information of a network resource (ServiceDescription) - - - -Returns the self-describing information of a network resource (ServiceDescription) - -
- -Requested Description - -
Schema
    = 1`"} defaultValue={undefined}>
- -Forbidden - -
Schema
    messages object[]
- -Default error handling for unmentioned status codes - -
Schema
    messages object[]
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Registry/get-submodel-descriptor-by-id-through-superpath.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Registry/get-submodel-descriptor-by-id-through-superpath.api.mdx deleted file mode 100644 index 031655498f5..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Registry/get-submodel-descriptor-by-id-through-superpath.api.mdx +++ /dev/null @@ -1,90 +0,0 @@ ---- -id: get-submodel-descriptor-by-id-through-superpath -title: "Returns a specific Submodel Descriptor" -description: "Returns a specific Submodel Descriptor" -sidebar_label: "Returns a specific Submodel Descriptor" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Asset Administration Shell Registry API"],"operationId":"GetSubmodelDescriptorByIdThroughSuperpath","parameters":[{"name":"aasIdentifier","in":"path","description":"The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"byte"}},{"name":"submodelIdentifier","in":"path","description":"The Submodel’s unique id (UTF8-BASE64-URL-encoded)","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"byte"}}],"responses":{"200":{"description":"Requested Submodel Descriptor","content":{"application/json":{"schema":{"required":["endpoints","id"],"type":"object","properties":{"administration":{"allOf":[{"type":"object","properties":{"embeddedDataSpecifications":{"minItems":1,"type":"array","items":{"required":["dataSpecification","dataSpecificationContent"],"type":"object","properties":{"dataSpecification":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"dataSpecificationContent":{"oneOf":[{"allOf":[{"required":["modelType"],"type":"object","properties":{"modelType":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataSpecificationIec61360","Entity","File","MultiLanguageProperty","Operation","Property","Range","ReferenceElement","RelationshipElement","Submodel","SubmodelElementCollection","SubmodelElementList"]}}},{"required":["preferredName"],"properties":{"preferredName":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":255}}}]}},"shortName":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":18}}}]}},"unit":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"unitId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"sourceOfDefinition":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"symbol":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"dataType":{"type":"string","enum":["BLOB","BOOLEAN","DATE","FILE","HTML","INTEGER_COUNT","INTEGER_CURRENCY","INTEGER_MEASURE","IRDI","IRI","RATIONAL","RATIONAL_MEASURE","REAL_COUNT","REAL_CURRENCY","REAL_MEASURE","STRING","STRING_TRANSLATABLE","TIME","TIMESTAMP"]},"definition":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":1023}}}]}},"valueFormat":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueList":{"required":["valueReferencePairs"],"type":"object","properties":{"valueReferencePairs":{"minItems":1,"type":"array","items":{"required":["value","valueId"],"type":"object","properties":{"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}}}},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"levelType":{"required":["max","min","nom","typ"],"type":"object","properties":{"min":{"type":"boolean"},"nom":{"type":"boolean"},"typ":{"type":"boolean"},"max":{"type":"boolean"}}},"modelType":{"pattern":"DataSpecificationIec61360","type":"string"}}}]}]}}}}}},{"properties":{"version":{"type":"string","allOf":[{"maxLength":4,"minLength":1},{"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"},{"pattern":"^(0|[1-9][0-9]*)$"}]},"revision":{"type":"string","allOf":[{"maxLength":4,"minLength":1},{"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"},{"pattern":"^(0|[1-9][0-9]*)$"}]},"creator":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"templateId":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}]},"endpoints":{"minItems":1,"type":"array","items":{"required":["interface","protocolInformation"],"type":"object","properties":{"interface":{"maxLength":128,"type":"string"},"protocolInformation":{"required":["href"],"type":"object","properties":{"href":{"maxLength":2048,"type":"string"},"endpointProtocol":{"maxLength":128,"type":"string"},"endpointProtocolVersion":{"type":"array","items":{"maxLength":128,"type":"string"}},"subprotocol":{"maxLength":128,"type":"string"},"subprotocolBody":{"maxLength":128,"type":"string"},"subprotocolBodyEncoding":{"maxLength":128,"type":"string"},"securityAttributes":{"minItems":1,"type":"array","items":{"required":["key","type","value"],"type":"object","properties":{"type":{"type":"string","enum":["NONE","RFC_TLSA","W3C_DID"]},"key":{"type":"string"},"value":{"type":"string"}}}}}}}}},"idShort":{"maxLength":128,"type":"string"},"id":{"maxLength":2000,"minLength":1,"pattern":"^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$","type":"string"},"semanticId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"supplementalSemanticId":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}},"example":"{ \"id\": \"https://admin-shell.io/zvei/nameplate/1/0/Nameplate\", \"endpoints\": [ { \"protocolInformation\": { \"endpointAddress\": \"https://localhost:1234\", \"endpointProtocolVersion\": \"1.1\" }, \"interface\": \"AAS-1.0\" }, { \"protocolInformation\": { \"endpointAddress\": \"opc.tcp://localhost:4840\" }, \"interface\": \"AAS-1.0\" }, { \"protocolInformation\": { \"endpointAddress\": \"https://localhost:5678\", \"endpointProtocolVersion\": \"1.1\", \"subprotocol\": \"OPC UA Basic SOAP\", \"subprotocolBody\": \"ns=2;s=MyAAS\", \"subprotocolBodyEncoding\": \"application/soap+xml\" }, \"interface\": \"AAS-1.0\" } ] }","allOf":[{"type":"object","properties":{"description":{"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":1023}}}]}},"displayName":{"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":128}}}]}},"extensions":{"minItems":1,"type":"array","items":{"allOf":[{"type":"object","properties":{"semanticId":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"supplementalSemanticIds":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}},{"required":["name"],"properties":{"name":{"maxLength":128,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueType":{"type":"string","enum":["xs:anyURI","xs:base64Binary","xs:boolean","xs:byte","xs:date","xs:dateTime","xs:decimal","xs:double","xs:duration","xs:float","xs:gDay","xs:gMonth","xs:gMonthDay","xs:gYear","xs:gYearMonth","xs:hexBinary","xs:int","xs:integer","xs:long","xs:negativeInteger","xs:nonNegativeInteger","xs:nonPositiveInteger","xs:positiveInteger","xs:short","xs:string","xs:time","xs:unsignedByte","xs:unsignedInt","xs:unsignedLong","xs:unsignedShort"]},"value":{"type":"string"},"refersTo":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}}]}}},"example":"{ \"endpoints\": [ { \"protocolInformation\": { \"endpointAddress\": \"https://localhost:1234\", \"endpointProtocolVersion\": \"1.1\" }, \"interface\": \"AAS-1.0\" }, { \"protocolInformation\": { \"endpointAddress\": \"opc.tcp://localhost:4840\" }, \"interface\": \"AAS-1.0\" }, { \"protocolInformation\": { \"endpointAddress\": \"https://localhost:5678\", \"endpointProtocolVersion\": \"1.1\", \"subprotocol\": \"OPC UA Basic SOAP\", \"subprotocolBody\": \"ns=2;s=MyAAS\", \"subprotocolBodyEncoding\": \"application/soap+xml\" }, \"interface\": \"AAS-1.0\" } ] }"}]}}}},"400":{"description":"Bad Request, e.g. the request parameters of the format of the request body is wrong.","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"default":{"description":"Default error handling for unmentioned status codes","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}}},"x-semanticIds":["https://admin-shell.io/aas/API/GetSubmodelDescriptorById/3/0"],"description":"Returns a specific Submodel Descriptor","method":"get","path":"/shell-descriptors/{aasIdentifier}/submodel-descriptors/{submodelIdentifier}","servers":[{"url":"{protocol}://{host_name}:{port}/api/{version_prefix}","variables":{"protocol":{"description":"Allows access through http and https (recommended)","default":"https","enum":["http","https"]},"host_name":{"description":"Hostname of server hosting the api","default":"admin-shell.io"},"port":{"description":"80 is default for http, 443 for https","default":"443","enum":["80","443"]},"version_prefix":{"default":"v3.0","enum":["v3.0"]}}}],"info":{"title":"DotAAS Part 2 | HTTP/REST | Registry Service Specification","description":"The Read Profile of the Asset Administration Shell Registry Service Specification as part of the Specification of the Asset Administration Shell: Part 2. Publisher: Industrial Digital Twin Association (IDTA) April 2023","contact":{"name":"Industrial Digital Twin Association (IDTA)","email":"info@idtwin.org"},"license":{"name":"CC BY 4.0","url":"https://creativecommons.org/licenses/by/4.0/"},"version":"V3.0_SSP-002"},"postman":{"name":"Returns a specific Submodel Descriptor","description":{"type":"text/plain"},"url":{"path":["shell-descriptors",":aasIdentifier","submodel-descriptors",":submodelIdentifier"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)","type":"text/plain"},"type":"any","value":"","key":"aasIdentifier"},{"disabled":false,"description":{"content":"(Required) The Submodel’s unique id (UTF8-BASE64-URL-encoded)","type":"text/plain"},"type":"any","value":"","key":"submodelIdentifier"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/AAS Registry//dotaas-part-2-http-rest-registry-service-specification -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns a specific Submodel Descriptor - - - -Returns a specific Submodel Descriptor - -
Path Parameters
- -Requested Submodel Descriptor - -
Schema
    description object[]
    displayName object[]
    extensions object[]
    - -**Possible values:** `>= 1` - -
    semanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    supplementalSemanticIds undefined[]
    - -**Possible values:** `>= 1` - -
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
    refersTo undefined[]
    - -**Possible values:** `>= 1` - -
    keys object[]
    - -**Possible values:** `>= 1` - -
    referredSemanticId
    keys object[]
    - -**Possible values:** `>= 1` - -
- -Bad Request, e.g. the request parameters of the format of the request body is wrong. - -
Schema
    messages object[]
- -Forbidden - -
Schema
    messages object[]
- -Not Found - -
Schema
    messages object[]
- -Internal Server Error - -
Schema
    messages object[]
- -Default error handling for unmentioned status codes - -
Schema
    messages object[]
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Registry/sidebar.js b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Registry/sidebar.js deleted file mode 100644 index 21de37e94ab..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API AAS Registry/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/AAS Registry//dotaas-part-2-http-rest-registry-service-specification"},{"type":"category","label":"Asset Administration Shell Registry API","link":{"type":"generated-index","title":"Asset Administration Shell Registry API","slug":"/category/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/AAS Registry/asset-administration-shell-registry-api"},"items":[{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/AAS Registry//get-all-asset-administration-shell-descriptors","label":"Returns all Asset Administration Shell Descriptors","className":"api-method get"},{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/AAS Registry//get-asset-administration-shell-descriptor-by-id","label":"Returns a specific Asset Administration Shell Descriptor","className":"api-method get"},{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/AAS Registry//get-all-submodel-descriptors-through-superpath","label":"Returns all Submodel Descriptors","className":"api-method get"},{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/AAS Registry//get-submodel-descriptor-by-id-through-superpath","label":"Returns a specific Submodel Descriptor","className":"api-method get"}]},{"type":"category","label":"Description API","link":{"type":"generated-index","title":"Description API","slug":"/category/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/AAS Registry/description-api"},"items":[{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/AAS Registry//get-description","label":"Returns the self-describing information of a network resource (ServiceDescription)","className":"api-method get"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API BPN Discovery/bpn-discovery-service.info.mdx b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API BPN Discovery/bpn-discovery-service.info.mdx deleted file mode 100644 index 5e953cfe130..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API BPN Discovery/bpn-discovery-service.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: bpn-discovery-service -title: "BPN Discovery Service" -description: "BPN Discovery Service to find BPN based on a local identifier." -sidebar_label: Introduction -sidebar_position: 0 -hide_title: true -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiDemoPanel/Export"; - -Version: 0.0.1 - -# BPN Discovery Service - - - -BPN Discovery Service to find BPN based on a local identifier. - -

Authentication

Contact

SLDT Team:
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API BPN Discovery/delete-bpn-discovery-by-id.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API BPN Discovery/delete-bpn-discovery-by-id.api.mdx deleted file mode 100644 index 24d787cc423..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API BPN Discovery/delete-bpn-discovery-by-id.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: delete-bpn-discovery-by-id -title: "Delete numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as single entry." -description: "Delete numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as single entry." -sidebar_label: "Delete numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as single entry." -hide_title: true -hide_table_of_contents: true -api: {"tags":["Discovery"],"operationId":"DeleteBpnDiscoveryById","parameters":[{"name":"resourceId","in":"path","description":"The IdentifierKeyValue unique id (BASE64-URL-encoded)","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"BPN Identifier Key-Value deleted successfully"}},"description":"Delete numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as single entry.","method":"delete","path":"/api/administration/connectors/bpnDiscovery/{resourceId}","security":[{"CatenaXOpenId":["profile"]}],"securitySchemes":{"CatenaXOpenId":{"type":"openIdConnect","openIdConnectUrl":"../.well-known/openid-configuration"}},"info":{"title":"BPN Discovery Service","description":"BPN Discovery Service to find BPN based on a local identifier.","contact":{"name":"SLDT Team"},"version":"0.0.1"},"postman":{"name":"Delete numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as single entry.","description":{"type":"text/plain"},"url":{"path":["api","administration","connectors","bpnDiscovery",":resourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The IdentifierKeyValue unique id (BASE64-URL-encoded)","type":"text/plain"},"type":"any","value":"","key":"resourceId"}]},"method":"DELETE"}} -sidebar_class_name: "delete api-method" -info_path: docs-kits/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/BPN Discovery//bpn-discovery-service -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Delete numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as single entry. - - - -Delete numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as single entry. - -
Path Parameters
- -BPN Identifier Key-Value deleted successfully - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API BPN Discovery/get-bpn-discoveries.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API BPN Discovery/get-bpn-discoveries.api.mdx deleted file mode 100644 index bc86018cb5d..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API BPN Discovery/get-bpn-discoveries.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-bpn-discoveries -title: "Find BPN endpoints corresponding to numbers (e.g. OEN, batteryID, etc.)" -description: "Find BPN endpoints corresponding to numbers (e.g. OEN, batteryID, etc.)" -sidebar_label: "Find BPN endpoints corresponding to numbers (e.g. OEN, batteryID, etc.)" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Discovery"],"operationId":"GetBpnDiscoveries","requestBody":{"description":"the request body is expecting a list of key (type, e.g. OEN, batteryID, etc.) - value (explicit number) pairs, where this service will respond with the corresponding BPN. Please add minimum one key-value pair.","content":{"application/json":{"schema":{"title":"SearchRequest","properties":{"searchFilter":{"title":"searchFilter","type":"array","maxItems":10000,"items":{"title":"SearchIdentifierTypeKeyPair","properties":{"type":{"type":"string","minLength":1,"maxLength":200},"keys":{"type":"array","maxItems":10000,"items":{"type":"string"}}}}}}},"examples":{"complete":{"value":{"searchFilter":[{"type":"oen","keys":["oen-1243","oen-11"]},{"type":"bpid","keys":["bpid-1243","bpid-11"]}]}}}}},"required":true},"responses":{"200":{"description":"key value for BPN created successfully","content":{"application/json":{"schema":{"title":"BpnCollection","properties":{"bpns":{"title":"bpns","type":"array","items":{"title":"Bpn","required":["type","key","value","resourceId"],"properties":{"type":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"resourceId":{"type":"string"}}}}}},"examples":{"complete":{"value":{"bpns":[{"type":"oen","key":"oen-1243","value":"bpn-123","resourceId":"1ca6f9b5-8e1d-422a-8541-9bb2cf5fe485"},{"type":"oen","key":"oen-11","value":"bpn-123","resourceId":"972262d7-7e05-4578-936f-de236d7feb94"},{"type":"bpid","key":"bpid-1243","value":"bpn-444","resourceId":"1b754aeb-c753-4adf-ae6d-52842f5a38b7"},{"type":"bpid","key":"oen-11","value":"bpn-444","resourceId":"e43f9cf8-f0d4-4c51-b7fe-b68ea4aeea7c"}]}}}}}}},"description":"Find BPN endpoints corresponding to numbers (e.g. OEN, batteryID, etc.)","method":"post","path":"/api/administration/connectors/bpnDiscovery/search","security":[{"CatenaXOpenId":["profile"]}],"securitySchemes":{"CatenaXOpenId":{"type":"openIdConnect","openIdConnectUrl":"../.well-known/openid-configuration"}},"jsonRequestBodyExample":{"searchFilter":[{"type":"string","keys":["string"]}]},"info":{"title":"BPN Discovery Service","description":"BPN Discovery Service to find BPN based on a local identifier.","contact":{"name":"SLDT Team"},"version":"0.0.1"},"postman":{"name":"Find BPN endpoints corresponding to numbers (e.g. OEN, batteryID, etc.)","description":{"type":"text/plain"},"url":{"path":["api","administration","connectors","bpnDiscovery","search"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/BPN Discovery//bpn-discovery-service -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Find BPN endpoints corresponding to numbers (e.g. OEN, batteryID, etc.) - - - -Find BPN endpoints corresponding to numbers (e.g. OEN, batteryID, etc.) - -
Request Body required
- -the request body is expecting a list of key (type, e.g. OEN, batteryID, etc.) - value (explicit number) pairs, where this service will respond with the corresponding BPN. Please add minimum one key-value pair. - -
    searchFilter SearchIdentifierTypeKeyPair[]
    - -**Possible values:** `<= 10000` - -
- -key value for BPN created successfully - -
Schema
    bpns Bpn[]
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API BPN Discovery/post-batch-bpn-discovery.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API BPN Discovery/post-batch-bpn-discovery.api.mdx deleted file mode 100644 index c3cc42171f9..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API BPN Discovery/post-batch-bpn-discovery.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: post-batch-bpn-discovery -title: "Create new numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as batch." -description: "Create new numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as batch." -sidebar_label: "Create new numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as batch." -hide_title: true -hide_table_of_contents: true -api: {"tags":["Discovery"],"operationId":"PostBatchBpnDiscovery","requestBody":{"description":"The request body is expecting a list of key (type, e.g. OEN, batteryID, etc.) - value (explicit number) pairs, where this service will respond with success/error message on persistance of this key-value-pairs. The BPN is hand-over by the authentication/authorization (→ token). Only the owner of a BPN can link any number (e.g. OEN, batteryID, etc.) to his BPN.","content":{"application/json":{"schema":{"type":"array","maxItems":10000,"items":{"title":"IdentifierTypeKeyPair","required":["type","key"],"properties":{"type":{"type":"string","minLength":1,"maxLength":200},"key":{"type":"string","minLength":1,"maxLength":200}}}},"examples":{"complete":{"value":[{"type":"oenId","key":"oenId-123"},{"type":"oen","key":"oen-4444"},{"type":"bpid","key":"bpid-123"}]}}}},"required":true},"responses":{"201":{"description":"key value for BPN in batch created successfully","content":{"application/json":{"schema":{"type":"array","maxItems":10000,"items":{"type":"object","required":["message","key","status"],"properties":{"message":{"type":"string","description":"The detailed message for the creation."},"details":{"type":"object","additionalProperties":{"type":"object"},"description":"An object with key/value pairs containing additional information exception."},"key":{"type":"string","description":"The created key."},"status":{"type":"integer","description":"The status code"}}}},"examples":{"complete":{"value":[{"message":"Validation failed.","details":{"type":"type oenId is not allowed."},"key":"oenId-123","status":400},{"message":"BpnDiscovery successfully created","details":null,"key":"oen-4444","status":200},{"message":"BpnDiscovery successfully created","details":null,"key":"bpid-123","status":200}]}}}}}},"description":"Create new numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as batch.","method":"post","path":"/api/administration/connectors/bpnDiscovery/batch","security":[{"CatenaXOpenId":["profile"]}],"securitySchemes":{"CatenaXOpenId":{"type":"openIdConnect","openIdConnectUrl":"../.well-known/openid-configuration"}},"jsonRequestBodyExample":[{"type":"string","key":"string"}],"info":{"title":"BPN Discovery Service","description":"BPN Discovery Service to find BPN based on a local identifier.","contact":{"name":"SLDT Team"},"version":"0.0.1"},"postman":{"name":"Create new numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as batch.","description":{"type":"text/plain"},"url":{"path":["api","administration","connectors","bpnDiscovery","batch"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/BPN Discovery//bpn-discovery-service -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create new numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as batch. - - - -Create new numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as batch. - -
Request Body array required
- -The request body is expecting a list of key (type, e.g. OEN, batteryID, etc.) - value (explicit number) pairs, where this service will respond with success/error message on persistance of this key-value-pairs. The BPN is hand-over by the authentication/authorization (→ token). Only the owner of a BPN can link any number (e.g. OEN, batteryID, etc.) to his BPN. - -
- -key value for BPN in batch created successfully - -
Schema array
    details object
    - -An object with key/value pairs containing additional information exception. - -
  • property name* object
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API BPN Discovery/post-bpn-discovery.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API BPN Discovery/post-bpn-discovery.api.mdx deleted file mode 100644 index e2f76bd636c..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API BPN Discovery/post-bpn-discovery.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: post-bpn-discovery -title: "Create new numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as single entry." -description: "Create new numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as single entry." -sidebar_label: "Create new numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as single entry." -hide_title: true -hide_table_of_contents: true -api: {"tags":["Discovery"],"operationId":"PostBpnDiscovery","requestBody":{"description":"the request body is expecting a key (type, e.g. OEN, batteryID, etc.) - value (explicit number) pair, where this service will respond with success/error message on persistance of this key-value-pair. The BPN is hand-over by the authentication/authorization (→ token). Only the owner of a BPN can link any number (e.g. OEN, batteryID, etc.) to his BPN.","content":{"application/json":{"schema":{"title":"IdentifierTypeKeyPair","required":["type","key"],"properties":{"type":{"type":"string","minLength":1,"maxLength":200},"key":{"type":"string","minLength":1,"maxLength":200}}},"examples":{"complete":{"value":{"type":"oen","key":"oen-123"}}}}},"required":true},"responses":{"201":{"description":"key value for BPN created successfully","content":{"application/json":{"schema":{"title":"Bpn","required":["type","key","value","resourceId"],"properties":{"type":{"type":"string"},"key":{"type":"string"},"value":{"type":"string"},"resourceId":{"type":"string"}}},"examples":{"complete":{"value":{"type":"oen","key":"oen-1243","value":"bpn-123","resourceId":"1ca6f9b5-8e1d-422a-8541-9bb2cf5fe485"}}}}}}},"description":"Create new numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as single entry.","method":"post","path":"/api/administration/connectors/bpnDiscovery","security":[{"CatenaXOpenId":["profile"]}],"securitySchemes":{"CatenaXOpenId":{"type":"openIdConnect","openIdConnectUrl":"../.well-known/openid-configuration"}},"jsonRequestBodyExample":{"type":"string","key":"string"},"info":{"title":"BPN Discovery Service","description":"BPN Discovery Service to find BPN based on a local identifier.","contact":{"name":"SLDT Team"},"version":"0.0.1"},"postman":{"name":"Create new numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as single entry.","description":{"type":"text/plain"},"url":{"path":["api","administration","connectors","bpnDiscovery"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/BPN Discovery//bpn-discovery-service -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Create new numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as single entry. - - - -Create new numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as single entry. - -
Request Body required
- -the request body is expecting a key (type, e.g. OEN, batteryID, etc.) - value (explicit number) pair, where this service will respond with success/error message on persistance of this key-value-pair. The BPN is hand-over by the authentication/authorization (→ token). Only the owner of a BPN can link any number (e.g. OEN, batteryID, etc.) to his BPN. - -
- -key value for BPN created successfully - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API BPN Discovery/sidebar.js b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API BPN Discovery/sidebar.js deleted file mode 100644 index b1dd8251cad..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API BPN Discovery/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/BPN Discovery//bpn-discovery-service"},{"type":"category","label":"Discovery","link":{"type":"generated-index","title":"Discovery","slug":"/category/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/BPN Discovery/discovery"},"items":[{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/BPN Discovery//post-bpn-discovery","label":"Create new numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as single entry.","className":"api-method post"},{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/BPN Discovery//post-batch-bpn-discovery","label":"Create new numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as batch.","className":"api-method post"},{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/BPN Discovery//get-bpn-discoveries","label":"Find BPN endpoints corresponding to numbers (e.g. OEN, batteryID, etc.)","className":"api-method post"},{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/BPN Discovery//delete-bpn-discovery-by-id","label":"Delete numbers (e.g. OEN, batteryID, etc.) corresponding to BPN endpoints as single entry.","className":"api-method delete"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Discovery Finder/delete-discovery-endpoint-by-resource-id.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Discovery Finder/delete-discovery-endpoint-by-resource-id.api.mdx deleted file mode 100644 index 2a0a08b5a3a..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Discovery Finder/delete-discovery-endpoint-by-resource-id.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: delete-discovery-endpoint-by-resource-id -title: "Delete the endpoint to BPN discovery services and the EDC discovery service." -description: "Delete the endpoint to BPN discovery services and the EDC discovery service." -sidebar_label: "Delete the endpoint to BPN discovery services and the EDC discovery service." -hide_title: true -hide_table_of_contents: true -api: {"tags":["Finder"],"operationId":"DeleteDiscoveryEndpointByResourceId","parameters":[{"name":"resourceId","in":"path","description":"The IdentifierKeyValue unique id (BASE64-URL-encoded)","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Discovery Endpoint deleted successfully"}},"description":"Delete the endpoint to BPN discovery services and the EDC discovery service.","method":"delete","path":"/api/administration/connectors/discovery/{resourceId}","security":[{"CatenaXOpenId":["profile"]}],"securitySchemes":{"CatenaXOpenId":{"type":"openIdConnect","openIdConnectUrl":"../.well-known/openid-configuration"}},"info":{"title":"Discovery Finder","description":"Discovery Finder to find endpoint of the BPN/EDC Discovery.","contact":{"name":"SLDT Team"},"version":"0.0.1"},"postman":{"name":"Delete the endpoint to BPN discovery services and the EDC discovery service.","description":{"type":"text/plain"},"url":{"path":["api","administration","connectors","discovery",":resourceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The IdentifierKeyValue unique id (BASE64-URL-encoded)","type":"text/plain"},"type":"any","value":"","key":"resourceId"}]},"method":"DELETE"}} -sidebar_class_name: "delete api-method" -info_path: docs-kits/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/Discovery Finder//discovery-finder -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Delete the endpoint to BPN discovery services and the EDC discovery service. - - - -Delete the endpoint to BPN discovery services and the EDC discovery service. - -
Path Parameters
- -Discovery Endpoint deleted successfully - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Discovery Finder/discovery-finder.info.mdx b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Discovery Finder/discovery-finder.info.mdx deleted file mode 100644 index 408672cb3a9..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Discovery Finder/discovery-finder.info.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -id: discovery-finder -title: "Discovery Finder" -description: "Discovery Finder to find endpoint of the BPN/EDC Discovery." -sidebar_label: Introduction -sidebar_position: 0 -hide_title: true -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiDemoPanel/Export"; - -Version: 0.0.1 - -# Discovery Finder - - - -Discovery Finder to find endpoint of the BPN/EDC Discovery. - -

Authentication

Contact

SLDT Team:
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Discovery Finder/get-discovery-endpoints.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Discovery Finder/get-discovery-endpoints.api.mdx deleted file mode 100644 index d0fd6660cb5..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Discovery Finder/get-discovery-endpoints.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-discovery-endpoints -title: "Find the endpoints to BPN discovery services and the EDC discovery service." -description: "Find the endpoints to BPN discovery services and the EDC discovery service." -sidebar_label: "Find the endpoints to BPN discovery services and the EDC discovery service." -hide_title: true -hide_table_of_contents: true -api: {"tags":["Finder"],"operationId":"GetDiscoveryEndpoints","requestBody":{"description":"The request body is expecting a list of types ( e.g. oen, bpid, etc.) to return available discovery endpoints.","content":{"application/json":{"schema":{"title":"SearchRequest","required":["types"],"properties":{"types":{"title":"types","type":"array","maxItems":10000,"items":{"type":"string"}}}},"examples":{"complete":{"value":{"types":["oen","bpid","bpn"]}}}}},"required":true},"responses":{"200":{"description":"Returns discovery endpoints based on search filter.","content":{"application/json":{"schema":{"title":"DiscoveryEndpointCollection","properties":{"endpoints":{"title":"endpoints","type":"array","maxItems":10000,"items":{"title":"DiscoveryEndpoint","required":["type","description","endpointAddress"],"properties":{"type":{"type":"string","minLength":1,"maxLength":200},"description":{"type":"string","minLength":1,"maxLength":500},"endpointAddress":{"type":"string","minLength":1,"maxLength":300},"documentation":{"type":"string","minLength":1,"maxLength":500},"resourceId":{"type":"string"}}}}}},"examples":{"complete":{"value":{"endpoints":[{"type":"oen","description":"Service to discover BPN to a particular OEN","endpointAddress":"http://...","documentation":"http://.../swagger/index.html","resourceId":"ec6f407b-4296-418c-9e4e-fb739fe72a67"},{"type":"bpid","description":"Service to discover BPN to a particular Battery Pass ID","endpointAddress":"http://...","documentation":"http://.../swagger/index.html","resourceId":"08702529-3714-4c4f-b022-346b9b4fbbe2"},{"type":"bpn","description":"Service to discover EDC to a particular BPN","endpointAddress":"http://...","documentation":"http://.../swagger/index.html","resourceId":"316417cd-0fb5-4daf-8dfa-8f68125923f1"}]}}}}}}},"description":"Find the endpoints to BPN discovery services and the EDC discovery service.","method":"post","path":"/api/administration/connectors/discovery/search","security":[{"CatenaXOpenId":["profile"]}],"securitySchemes":{"CatenaXOpenId":{"type":"openIdConnect","openIdConnectUrl":"../.well-known/openid-configuration"}},"jsonRequestBodyExample":{"types":["string"]},"info":{"title":"Discovery Finder","description":"Discovery Finder to find endpoint of the BPN/EDC Discovery.","contact":{"name":"SLDT Team"},"version":"0.0.1"},"postman":{"name":"Find the endpoints to BPN discovery services and the EDC discovery service.","description":{"type":"text/plain"},"url":{"path":["api","administration","connectors","discovery","search"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/Discovery Finder//discovery-finder -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Find the endpoints to BPN discovery services and the EDC discovery service. - - - -Find the endpoints to BPN discovery services and the EDC discovery service. - -
Request Body required
- -The request body is expecting a list of types ( e.g. oen, bpid, etc.) to return available discovery endpoints. - -
- -Returns discovery endpoints based on search filter. - -
Schema
    endpoints DiscoveryEndpoint[]
    - -**Possible values:** `<= 10000` - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Discovery Finder/post-discovery-endpoint.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Discovery Finder/post-discovery-endpoint.api.mdx deleted file mode 100644 index 94ae9a6ca45..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Discovery Finder/post-discovery-endpoint.api.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: post-discovery-endpoint -title: "Define the endpoint to BPN discovery services and the EDC discovery service." -description: "Define the endpoint to BPN discovery services and the EDC discovery service." -sidebar_label: "Define the endpoint to BPN discovery services and the EDC discovery service." -hide_title: true -hide_table_of_contents: true -api: {"tags":["Finder"],"operationId":"PostDiscoveryEndpoint","requestBody":{"description":"Create new endpoint for bpn discovery service / edc discovery service. The type is uniqued. This service is allowed to administrators only","content":{"application/json":{"schema":{"title":"DiscoveryEndpoint","required":["type","description","endpointAddress"],"properties":{"type":{"type":"string","minLength":1,"maxLength":200},"description":{"type":"string","minLength":1,"maxLength":500},"endpointAddress":{"type":"string","minLength":1,"maxLength":300},"documentation":{"type":"string","minLength":1,"maxLength":500},"resourceId":{"type":"string"}}},"examples":{"complete":{"value":{"type":"oen","description":"Service to discover BPN to a particular OEN","endpointAddress":"http://...","documentation":"http://.../swagger/index.html"}}}}},"required":true},"responses":{"201":{"description":"Discovery Endpoint created successfully","content":{"application/json":{"schema":{"title":"DiscoveryEndpoint","required":["type","description","endpointAddress"],"properties":{"type":{"type":"string","minLength":1,"maxLength":200},"description":{"type":"string","minLength":1,"maxLength":500},"endpointAddress":{"type":"string","minLength":1,"maxLength":300},"documentation":{"type":"string","minLength":1,"maxLength":500},"resourceId":{"type":"string"}}},"examples":{"complete":{"value":{"type":"oen","description":"Service to discover BPN to a particular OEN","endpointAddress":"http://...","documentation":"http://.../swagger/index.html","resourceId":"ec6f407b-4296-418c-9e4e-fb739fe72a67"}}}}}}},"description":"Define the endpoint to BPN discovery services and the EDC discovery service.","method":"post","path":"/api/administration/connectors/discovery","security":[{"CatenaXOpenId":["profile"]}],"securitySchemes":{"CatenaXOpenId":{"type":"openIdConnect","openIdConnectUrl":"../.well-known/openid-configuration"}},"jsonRequestBodyExample":{"type":"string","description":"string","endpointAddress":"string","documentation":"string","resourceId":"string"},"info":{"title":"Discovery Finder","description":"Discovery Finder to find endpoint of the BPN/EDC Discovery.","contact":{"name":"SLDT Team"},"version":"0.0.1"},"postman":{"name":"Define the endpoint to BPN discovery services and the EDC discovery service.","description":{"type":"text/plain"},"url":{"path":["api","administration","connectors","discovery"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/Discovery Finder//discovery-finder -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Define the endpoint to BPN discovery services and the EDC discovery service. - - - -Define the endpoint to BPN discovery services and the EDC discovery service. - -
Request Body required
- -Create new endpoint for bpn discovery service / edc discovery service. The type is uniqued. This service is allowed to administrators only - -
- -Discovery Endpoint created successfully - -
Schema
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Discovery Finder/sidebar.js b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Discovery Finder/sidebar.js deleted file mode 100644 index d69d5fb8a55..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Discovery Finder/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/Discovery Finder//discovery-finder"},{"type":"category","label":"Finder","link":{"type":"generated-index","title":"Finder","slug":"/category/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/Discovery Finder/finder"},"items":[{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/Discovery Finder//post-discovery-endpoint","label":"Define the endpoint to BPN discovery services and the EDC discovery service.","className":"api-method post"},{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/Discovery Finder//get-discovery-endpoints","label":"Find the endpoints to BPN discovery services and the EDC discovery service.","className":"api-method post"},{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/Discovery Finder//delete-discovery-endpoint-by-resource-id","label":"Delete the endpoint to BPN discovery services and the EDC discovery service.","className":"api-method delete"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API EDC Discovery/post-list-of-bpns-to-retrieve-available-company-connector.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API EDC Discovery/post-list-of-bpns-to-retrieve-available-company-connector.api.mdx deleted file mode 100644 index c6414300ef6..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API EDC Discovery/post-list-of-bpns-to-retrieve-available-company-connector.api.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: post-list-of-bpns-or-an-empty-array-to-retrieve-available-company-connector-authorization-required-roles-view-connectors -title: "post list of bpns or an empty array to retrieve available company connector. (Authorization required - Roles: view_connectors)" -description: "Example: POST: /api/administration/connectors/discovery" -sidebar_label: "post list of bpns or an empty array to retrieve available company connector. (Authorization required - Roles: view_connectors)" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Connectors"],"description":"Example: POST: /api/administration/connectors/discovery","requestBody":{"description":"Single or List of Business Partner Number of the company.","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}},"text/json":{"schema":{"type":"array","items":{"type":"string"}}},"application/*+json":{"schema":{"type":"array","items":{"type":"string"}}}}},"responses":{"200":{"description":"Returns company connector per bpn.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"bpn":{"type":"string","description":"","nullable":true},"connectorEndpoint":{"type":"array","items":{"type":"string"},"description":"","nullable":true}},"additionalProperties":false,"description":""}}}}},"401":{"description":"The User is unauthorized"},"500":{"description":"Internal Server Error"}},"method":"post","path":"/api/administration/Connectors/discovery","security":[{"Bearer":[]}],"securitySchemes":{"Bearer":{"type":"apiKey","description":"JWT Authorization header using the Bearer scheme. \r\n\r\n Enter 'Bearer' [space] and then your token in the text input below.\r\n\r\nExample: \"Bearer 12345abcdef\"","name":"Authorization","in":"header"}},"jsonRequestBodyExample":["string"],"info":{"title":"Org.Eclipse.TractusX.Portal.Backend.Administration.Service","version":"v2"},"postman":{"name":"post list of bpns or an empty array to retrieve available company connector. (Authorization required - Roles: view_connectors)","description":{"content":"Example: POST: /api/administration/connectors/discovery","type":"text/plain"},"url":{"path":["api","administration","Connectors","discovery"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/Digital Twin Kit/Software Development View/API EDC Discovery//org-eclipse-tractusx-portal-backend-administration-service -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## post list of bpns or an empty array to retrieve available company connector. (Authorization required - Roles: view_connectors) - - - -Example: POST: /api/administration/connectors/discovery - -
Request Body array
- -Single or List of Business Partner Number of the company. - -
  • string
Request Body array
- -Single or List of Business Partner Number of the company. - -
  • string
Request Body array
- -Single or List of Business Partner Number of the company. - -
  • string
- -Returns company connector per bpn. - -
Schema array
- -The User is unauthorized - -
- -Internal Server Error - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API EDC Discovery/sidebar.js b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API EDC Discovery/sidebar.js deleted file mode 100644 index fbd8cfacb8a..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API EDC Discovery/sidebar.js +++ /dev/null @@ -1,10 +0,0 @@ -module.exports = [ -{ - "type":"category","label":"Connectors","link": - { - "type":"generated-index","title":"Connectors","slug":"/category/kits/Digital Twin Kit/Software Development View/API EDC Discovery/connectors" - }, - "items": - [{ - "type":"doc","id":"kits/Digital Twin Kit/Software Development View/API EDC Discovery//post-list-of-bpns-or-an-empty-array-to-retrieve-available-company-connector-authorization-required-roles-view-connectors","label":"post list of bpns or an empty array to retrieve available company connector. (Authorization required - Roles: view_connectors)","className":"api-method post" - }]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Submodel/dotaas-part-2-http-rest-submodel-service-specification.info.mdx b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Submodel/dotaas-part-2-http-rest-submodel-service-specification.info.mdx deleted file mode 100644 index 5da2065f6c9..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Submodel/dotaas-part-2-http-rest-submodel-service-specification.info.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: dotaas-part-2-http-rest-submodel-service-specification -title: "DotAAS Part 2 | HTTP/REST | Submodel Service Specification" -description: "The Value Profile of the Submodel Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](http://industrialdigitaltwin.org/en/content-hub)." -sidebar_label: Introduction -sidebar_position: 0 -hide_title: true -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiDemoPanel/Export"; - -Version: V3.0.1_SSP-003 - -# DotAAS Part 2 | HTTP/REST | Submodel Service Specification - - - -The Value Profile of the Submodel Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](http://industrialdigitaltwin.org/en/content-hub). -Publisher: Industrial Digital Twin Association (IDTA) April 2023 - -

Contact

Industrial Digital Twin Association (IDTA): info@idtwin.org

License

CC BY 4.0
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Submodel/get-description.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Submodel/get-description.api.mdx deleted file mode 100644 index 340110b9c46..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Submodel/get-description.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-description -title: "Returns the self-describing information of a network resource (ServiceDescription)" -description: "Returns the self-describing information of a network resource (ServiceDescription)" -sidebar_label: "Returns the self-describing information of a network resource (ServiceDescription)" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Description API"],"operationId":"GetDescription","responses":{"200":{"description":"Requested Description","content":{"application/json":{"schema":{"type":"object","properties":{"profiles":{"minItems":1,"type":"array","items":{"type":"string","enum":["https://admin-shell.io/aas/API/3/0/AssetAdministrationShellServiceSpecification/SSP-001","https://admin-shell.io/aas/API/3/0/AssetAdministrationShellServiceSpecification/SSP-002","https://admin-shell.io/aas/API/3/0/SubmodelServiceSpecification/SSP-001","https://admin-shell.io/aas/API/3/0/SubmodelServiceSpecification/SSP-002","https://admin-shell.io/aas/API/3/0/SubmodelServiceSpecification/SSP-003","https://admin-shell.io/aas/API/3/0/AasxFileServerServiceSpecification/SSP-001","https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRegistryServiceSpecification/SSP-001","https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRegistryServiceSpecification/SSP-002","https://admin-shell.io/aas/API/3/0/SubmodelRegistryServiceSpecification/SSP-001","https://admin-shell.io/aas/API/3/0/SubmodelRegistryServiceSpecification/SSP-002","https://admin-shell.io/aas/API/3/0/DiscoveryServiceSpecification/SSP-001","https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRepositoryServiceSpecification/SSP-001","https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRepositoryServiceSpecification/SSP-002","https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-001","https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-002","https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-003","https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-004","https://admin-shell.io/aas/API/3/0/ConceptDescriptionServiceSpecification/SSP-001"]}}},"description":"The Description object enables servers to present their capabilities to the clients, in particular which profiles they implement. At least one defined profile is required. Additional, proprietary attributes might be included. Nevertheless, the server must not expect that a regular client understands them.","example":"{\n \"profiles\": [\n \"https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRegistryServiceSpecification/SSP-002\",\n \"https://admin-shell.io/aas/API/3/0/SubmodelRegistryServiceSpecification/SSP-002\"\n ]\n}"}}}},"401":{"description":"Unauthorized, e.g. the server refused the authorization attempt.","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}}},"x-semanticIds":["https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0"],"description":"Returns the self-describing information of a network resource (ServiceDescription)","method":"get","path":"/description","servers":[{"url":"{protocol}://{host_name}:{port}/api/{version_prefix}","variables":{"protocol":{"description":"Allows access through http and https (recommended)","default":"https","enum":["http","https"]},"host_name":{"description":"Hostname of server hosting the api","default":"admin-shell.io"},"port":{"description":"80 is default for http, 443 for https","default":"443","enum":["80","443"]},"version_prefix":{"default":"v3.0","enum":["v3.0"]}}}],"info":{"title":"DotAAS Part 2 | HTTP/REST | Submodel Service Specification","description":"The Value Profile of the Submodel Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](http://industrialdigitaltwin.org/en/content-hub). \nPublisher: Industrial Digital Twin Association (IDTA) April 2023","contact":{"name":"Industrial Digital Twin Association (IDTA)","email":"info@idtwin.org"},"license":{"name":"CC BY 4.0","url":"https://creativecommons.org/licenses/by/4.0/"},"version":"V3.0.1_SSP-003"},"postman":{"name":"Returns the self-describing information of a network resource (ServiceDescription)","description":{"type":"text/plain"},"url":{"path":["description"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/Submodel//dotaas-part-2-http-rest-submodel-service-specification -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns the self-describing information of a network resource (ServiceDescription) - - - -Returns the self-describing information of a network resource (ServiceDescription) - -
- -Requested Description - -
Schema
    = 1`"} defaultValue={undefined}>
- -Unauthorized, e.g. the server refused the authorization attempt. - -
Schema
    messages object[]
- -Forbidden - -
Schema
    messages object[]
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Submodel/get-submodel-value-only.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Submodel/get-submodel-value-only.api.mdx deleted file mode 100644 index ab00e898fd2..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Submodel/get-submodel-value-only.api.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: get-submodel-value-only -title: "Returns the Submodel in the ValueOnly representation" -description: "Returns the Submodel in the ValueOnly representation" -sidebar_label: "Returns the Submodel in the ValueOnly representation" -hide_title: true -hide_table_of_contents: true -api: {"tags":["Submodel API"],"operationId":"GetSubmodel-ValueOnly","parameters":[{"name":"level","in":"query","description":"Determines the structural depth of the respective resource content","required":false,"schema":{"type":"string","default":"deep","enum":["deep"]}},{"name":"extent","in":"query","description":"Determines to which extent the resource is being serialized","required":false,"schema":{"type":"string","default":"withoutBlobValue","enum":["withBlobValue"]}}],"responses":{"200":{"description":"ValueOnly representation of the Submodel","content":{"application/json":{"schema":{"properties":{"submodelElements":{"minItems":1,"type":"array","items":{"allOf":[{"allOf":[{"type":"object","properties":{"extensions":{"minItems":1,"type":"array","items":{"allOf":[{"type":"object","properties":{"semanticId":{"allOf":[{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"supplementalSemanticIds":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}},{"required":["name"],"properties":{"name":{"maxLength":128,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueType":{"type":"string","enum":["xs:anyURI","xs:base64Binary","xs:boolean","xs:byte","xs:date","xs:dateTime","xs:decimal","xs:double","xs:duration","xs:float","xs:gDay","xs:gMonth","xs:gMonthDay","xs:gYear","xs:gYearMonth","xs:hexBinary","xs:int","xs:integer","xs:long","xs:negativeInteger","xs:nonNegativeInteger","xs:nonPositiveInteger","xs:positiveInteger","xs:short","xs:string","xs:time","xs:unsignedByte","xs:unsignedInt","xs:unsignedLong","xs:unsignedShort"]},"value":{"type":"string"},"refersTo":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}}]}}}},{"required":["modelType"],"properties":{"category":{"maxLength":128,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"idShort":{"type":"string","allOf":[{"maxLength":128,"minLength":1},{"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"},{"pattern":"^[a-zA-Z][a-zA-Z0-9_]*$"}]},"displayName":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":128}}}]}},"description":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":1023}}}]}},"modelType":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataSpecificationIec61360","Entity","File","MultiLanguageProperty","Operation","Property","Range","ReferenceElement","RelationshipElement","Submodel","SubmodelElementCollection","SubmodelElementList"]}}}]},{"type":"object","properties":{"semanticId":{"allOf":[{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"supplementalSemanticIds":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}},{"required":["modelType"],"type":"object","properties":{"qualifiers":{"minItems":1,"type":"array","items":{"allOf":[{"type":"object","properties":{"semanticId":{"allOf":[{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"supplementalSemanticIds":{"minItems":1,"type":"array","items":{"allOf":[{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}},{"required":["type","valueType"],"properties":{"kind":{"type":"string","enum":["ConceptQualifier","TemplateQualifier","ValueQualifier"]},"type":{"maxLength":128,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueType":{"type":"string","enum":["xs:anyURI","xs:base64Binary","xs:boolean","xs:byte","xs:date","xs:dateTime","xs:decimal","xs:double","xs:duration","xs:float","xs:gDay","xs:gMonth","xs:gMonthDay","xs:gYear","xs:gYearMonth","xs:hexBinary","xs:int","xs:integer","xs:long","xs:negativeInteger","xs:nonNegativeInteger","xs:nonPositiveInteger","xs:positiveInteger","xs:short","xs:string","xs:time","xs:unsignedByte","xs:unsignedInt","xs:unsignedLong","xs:unsignedShort"]},"value":{"type":"string"},"valueId":{"allOf":[{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}]}},"modelType":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataSpecificationIec61360","Entity","File","MultiLanguageProperty","Operation","Property","Range","ReferenceElement","RelationshipElement","Submodel","SubmodelElementCollection","SubmodelElementList"]}}},{"type":"object","properties":{"embeddedDataSpecifications":{"minItems":1,"type":"array","items":{"required":["dataSpecification","dataSpecificationContent"],"type":"object","properties":{"dataSpecification":{"allOf":[{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"dataSpecificationContent":{"oneOf":[{"allOf":[{"required":["modelType"],"type":"object","properties":{"modelType":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataSpecificationIec61360","Entity","File","MultiLanguageProperty","Operation","Property","Range","ReferenceElement","RelationshipElement","Submodel","SubmodelElementCollection","SubmodelElementList"]}}},{"required":["preferredName"],"properties":{"preferredName":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":255}}}]}},"shortName":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":18}}}]}},"unit":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"unitId":{"allOf":[{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]},"sourceOfDefinition":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"symbol":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"dataType":{"type":"string","enum":["BLOB","BOOLEAN","DATE","FILE","HTML","INTEGER_COUNT","INTEGER_CURRENCY","INTEGER_MEASURE","IRDI","IRI","RATIONAL","RATIONAL_MEASURE","REAL_COUNT","REAL_CURRENCY","REAL_MEASURE","STRING","STRING_TRANSLATABLE","TIME","TIMESTAMP"]},"definition":{"minItems":1,"type":"array","items":{"allOf":[{"required":["language","text"],"type":"object","properties":{"language":{"pattern":"^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$","type":"string"},"text":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}},{"properties":{"text":{"maxLength":1023}}}]}},"valueFormat":{"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueList":{"required":["valueReferencePairs"],"type":"object","properties":{"valueReferencePairs":{"minItems":1,"type":"array","items":{"required":["value","valueId"],"type":"object","properties":{"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"valueId":{"allOf":[{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}},{"properties":{"referredSemanticId":{"required":["keys","type"],"type":"object","properties":{"type":{"type":"string","enum":["ExternalReference","ModelReference"]},"keys":{"minItems":1,"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string","enum":["AnnotatedRelationshipElement","AssetAdministrationShell","BasicEventElement","Blob","Capability","ConceptDescription","DataElement","Entity","EventElement","File","FragmentReference","GlobalReference","Identifiable","MultiLanguageProperty","Operation","Property","Range","Referable","ReferenceElement","RelationshipElement","Submodel","SubmodelElement","SubmodelElementCollection","SubmodelElementList"]},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"}}}}}}}}]}}}}}},"value":{"maxLength":2000,"minLength":1,"pattern":"^([\\t\\n\\r -퟿- ]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$","type":"string"},"levelType":{"required":["max","min","nom","typ"],"type":"object","properties":{"min":{"type":"boolean"},"nom":{"type":"boolean"},"typ":{"type":"boolean"},"max":{"type":"boolean"}}},"modelType":{"pattern":"DataSpecificationIec61360","type":"string"}}}]}]}}}}}}]}}}}}}},"400":{"description":"Bad Request, e.g. the request parameters of the format of the request body is wrong.","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"401":{"description":"Unauthorized, e.g. the server refused the authorization attempt.","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}},"default":{"description":"Default error handling for unmentioned status codes","content":{"application/json":{"schema":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"code":{"maxLength":32,"minLength":1,"type":"string"},"correlationId":{"maxLength":128,"minLength":1,"type":"string"},"messageType":{"type":"string","enum":["Undefined","Info","Warning","Error","Exception"]},"text":{"type":"string"},"timestamp":{"pattern":"^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((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|\\+00:00|-00:00)$","type":"string"}}}}}}}}}},"x-semanticIds":["https://admin-shell.io/aas/API/GetSubmodelById/3/0"],"description":"Returns the Submodel in the ValueOnly representation","method":"get","path":"/submodel/$value","servers":[{"url":"{protocol}://{host_name}:{port}/api/{version_prefix}","variables":{"protocol":{"description":"Allows access through http and https (recommended)","default":"https","enum":["http","https"]},"host_name":{"description":"Hostname of server hosting the api","default":"admin-shell.io"},"port":{"description":"80 is default for http, 443 for https","default":"443","enum":["80","443"]},"version_prefix":{"default":"v3.0","enum":["v3.0"]}}}],"info":{"title":"DotAAS Part 2 | HTTP/REST | Submodel Service Specification","description":"The Value Profile of the Submodel Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](http://industrialdigitaltwin.org/en/content-hub). \nPublisher: Industrial Digital Twin Association (IDTA) April 2023","contact":{"name":"Industrial Digital Twin Association (IDTA)","email":"info@idtwin.org"},"license":{"name":"CC BY 4.0","url":"https://creativecommons.org/licenses/by/4.0/"},"version":"V3.0.1_SSP-003"},"postman":{"name":"Returns the Submodel in the ValueOnly representation","description":{"type":"text/plain"},"url":{"path":["submodel","$value"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Determines the structural depth of the respective resource content","type":"text/plain"},"key":"level","value":""},{"disabled":false,"description":{"content":"Determines to which extent the resource is being serialized","type":"text/plain"},"key":"extent","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/Submodel//dotaas-part-2-http-rest-submodel-service-specification -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## Returns the Submodel in the ValueOnly representation - - - -Returns the Submodel in the ValueOnly representation - -
Query Parameters
- -ValueOnly representation of the Submodel - -
Schema
    = 1`"} defaultValue={undefined}>
- -Bad Request, e.g. the request parameters of the format of the request body is wrong. - -
Schema
    messages object[]
- -Unauthorized, e.g. the server refused the authorization attempt. - -
Schema
    messages object[]
- -Forbidden - -
Schema
    messages object[]
- -Internal Server Error - -
Schema
    messages object[]
- -Default error handling for unmentioned status codes - -
Schema
    messages object[]
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Submodel/sidebar.js b/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Submodel/sidebar.js deleted file mode 100644 index b0e1ee3922f..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/API Submodel/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/Submodel//dotaas-part-2-http-rest-submodel-service-specification"},{"type":"category","label":"Submodel API","link":{"type":"generated-index","title":"Submodel API","slug":"/category/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/Submodel/submodel-api"},"items":[{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/Submodel//get-submodel-value-only","label":"Returns the Submodel in the ValueOnly representation","className":"api-method get"}]},{"type":"category","label":"Description API","link":{"type":"generated-index","title":"Description API","slug":"/category/_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/Submodel/description-api"},"items":[{"type":"doc","id":"_versioned_docs/version-3.1.0/kits/Digital Twin Kit/Software Development View/API Specs/Submodel//get-description","label":"Returns the self-describing information of a network resource (ServiceDescription)","className":"api-method get"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/page-adoption-view.md b/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/page-adoption-view.md deleted file mode 100644 index 98f16d5a76d..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/page-adoption-view.md +++ /dev/null @@ -1,2065 +0,0 @@ ---- -title: Adoption View ---- - -![EcoPass KIT Pictotogram](/img/kit-icons/ecopass-kit-icon.svg) - -## Introduction - -The EcoPass KIT will be the key enabler for various stakeholders to use digital product passports, which represent a digital collection of specific information about a physical product in a standardized exchange format. This data is governed by agreed-upon ownership and access rights, which are conveyed through the Eclipse Data Space Connector (EDC). The primary purpose of the product passport is to enable the electronic registration, processing and sharing of product-related details among various entities in the supply chain, including several businesses and authorities. The demand for interoperable product passports exists worldwide, driven by the need to establish sustainable and transparent supply chains across different types of products, for which the adoption of standards will become crucial. -In this context, Catena-X offers a decentralized ecosystem supported by standards and principles like data sovereignty, which can effectively implement such a product passport system. The objective of the EcoPass KIT is therefore to: - -- Provide a comprehensive overview of the business context and benefits of product passports. -- Offer guidelines for industry stakeholders. -- Provide a detailed description and offer tools to implement product passports. - -## Vision & Mission - -### Vision: Empowering Sustainability – One Product at a Time - -The EcoPass KIT envisions a future where sustainability is at the core of every product's lifecycle, from design and manufacturing to usage and end-of-life. By fostering transparency, traceability and informed decision-making, we aim to inspire solution and service providers to create innovative, eco-friendly products that reduce environmental impact and drive the global economy towards a circular model. - -### Mission: Unleashing Circularity Potential - -The EcoPass KIT enables the scalable usage of digital product passports in order to address the pressing issue of inefficient resource usage and lack of product transparency. With growing concerns over environmental impact, limited resources and waste generation, there is an urgent need for a comprehensive solution to drive sustainable practices across the value chain. The KIT offers unified data models, a reference application for passport utilization as well as the required API. Low entry barriers will allow you to adapt digital product passports rapidly and pay your contribution to a fully circular value chain without the necessity of vast expertise or resources. Designed for multiple products, the KIT offers scalability, high-quality product information and a set of tools for regulatory compliance. Our mission is to unlock the circular potential of every component and material, fostering a culture of sustainability, innovation, and shared responsibility among all stakeholders. - -All described specifications in the KIT are based on [Catena-X standards](https://catena-x.net/de/standard-library) such as the Asset Administration Shell, SSI and decentral Digital Twin Registry. They refer to other Catena-X KITs like the [Connector KIT](https://eclipse-tractusx.github.io/docs-kits/kits/tractusx-edc/docs/kit/adoption-view/Adoption%20View) (EDC), [Data Chain KIT](https://eclipse-tractusx.github.io/docs-kits/category/data-chain-kit/) (Item Relationship Service = IRS) and [Business Partner KIT](https://eclipse-tractusx.github.io/docs-kits/category/business-partner-kit/) to ensure interoperability and data sovereignty according to IDSA and Gaia-X principles. - -## Business Value - -Following this mission, the EcoPass KIT serves as an instrumental tool promoting sustainable and circular value chains. The improved transparency, traceability and accountability offered with digital product passports will facilitate informed decision-making for various stakeholders. This will bring ethical sourcing, efficient use of resources and reduction of environmental impacts to a new level. By making use of the Catena-X standards defined within the EcoPass KIT, product passports will ensure interoperability for stakeholders and systems to communicate seamlessly. This standardized language is crucial to improve efficiency, lower operational costs and create faster data processing. It ensures a consistent approach to data collection, storage and visualization to enhance the accuracy, reliability and comparability of information. -The following section will highlight the five major advantages of the Catena-X EcoPass KIT, which are also displayed below. - -![AdoptionView Business Value](./resources/adoption-view/adoption-view-BusinessValue.svg) - -**Seamless Integration and Collaboration**: By leveraging the EcoPass KIT, service providers can easily integrate with the Catena-X marketplace, promoting efficient collaboration and exchange of information with other businesses in the network. The unified data model and API specification simplifies the process, reducing the time and resources needed for integration and fostering interoperability between various players. - -**Enhanced Consumer Trust and Brand Loyalty**: Utilizing the KIT to develop solutions for the Catena-X marketplace allows service providers to showcase their commitment to transparency and sustainability. This fosters consumer trust and brand loyalty, as increasingly conscious customers prefer products and services that align with their values and make a positive impact on the environment. - -**Data-Driven Decision Making**: The EcoPass KIT enables service providers to harness the power of high-quality data sets from various sources in the Catena-X network. This wealth of information supports data-driven decision-making, helping businesses optimize their processes, reduce waste and identify opportunities for growth and innovation. Leveraging the dynamic data attributes within a passport, the product's evolving condition can be reflected, which offers a highly valuable increase of knowledge about the product’s behavior, quality and performance. - -**Regulatory Compliance and Risk Mitigation**: By offering solutions based on the KIT, service providers can help businesses comply with evolving regulations and industry standards. The increased transparency and traceability provided by digital product passports facilitate compliance management, offer the creation of certificates, and reduce the risks associated with non-compliance, such as penalties and reputational damage. - -**Competitive Advantage through Innovation**: The KIT's foundation for value-added services and innovative solutions provides service providers with a unique competitive edge in the Catena-X marketplace. By developing and offering cutting-edge products and services that cater to the growing demand for sustainable and transparent solutions, service providers can differentiate themselves in a crowded market and seize new business opportunities. - -## Use Case Explanation - -### Today's Challenges - -Today's globalized supply chains often struggle with transparency, data fragmentation and inefficiencies through the lack of digitally available product information. Traceability becomes difficult, hindering the ability to track products' origins and ensure accountability. Risk management and compliance efforts are compromised, impacting product quality and sustainability. Customer expectations for transparency and sustainability information remain unmet, potentially leading to dissatisfaction and loss of market share. Moreover, supply chains lack the resilience and responsiveness needed to adapt to disruptions effectively. -Embracing a digital product passport can address these challenges, enabling transparent, efficient and sustainable supply chains. Implementing the EcoPass KIT can enable companies to address these challenges by creating a comprehensive, accurate and up-to-date record of their products' lifecycles. This information can be used to improve resource efficiency, optimize recycling processes and reduce waste, ultimately driving the adoption of circular economy principles. - -### How can the EcoPass KIT help to address regulatory challenges? - -- Manufacturers are required to disclose information regarding the environmental impact of their products under the European Union's (EU) Ecodesign Directive. The EcoPass KIT can assist producers in adhering to this rule by offering a digital record of the environmental impact of their products. -- Companies are required to provide information regarding their efforts to address forced labor and human trafficking in their supply chains under the California Transparency in Supply Chains Act (CTSCA). The EcoPass KIT's digital record of a company's supply chain operations can assist businesses to comply with this law. -- Certain manufacturers of products are required to take back and recycle their products at the end of their functional lifespans under the German Waste Management Act (Kreislaufwirtschaftsgesetz). The EcoPass KIT, which offers a digital record of the goods that have been returned and recycled, can assist producers in adhering to this obligation. - -### Ecopass KIT benefits for value chain partners and solution providers - -Stakeholders along the value chain, as well as solution providers can reap the benefits of utilizing KITs in their organization. The Figure below shows an overview of these benefits, further explanation can be found below the illustration. - -![ValueChain Benefits](./resources/adoption-view/adoption-view-ValueChainBenefits.svg) - -**Value Chain Partners** can benefit from the EcoPass KIT especially by bringing the product transparency to a next level which will allow for several areas to increase the company’s value. Multiple risks (e.g. regulatory compliance) can be mitigated, cost and process efficiency may be improved, the strategic knowledge about products increases and the possibility for new business is being established. - -1. **Regulatory Compliance**: Improve compliance with regulations and industry standards by utilizing a digital product passport to demonstrate responsible sourcing, production and waste management practices. -2. **Enhanced Transparency**: Visibility of the product's condition, origins and components will lead to better decision-making and higher resource efficiency. -3. **Efficient Data Management**: Adopting a digital product passport will reduce administrative burdens and facilitate seamless data exchange between stakeholders. -4. **Increased Accountability**: A clear chain of custody for products fosters accountability among value chain participants for product quality, safety and sustainability. -5. **Risk Mitigation**: Comprehensive product data helps value chain participants to proactively identify and mitigate risks, ensuring higher product quality and safety standards. -6. **Strengthened Customer Trust**: Offering transparency of business practices and sustainability efforts builds trust with customers and enhances brand loyalty. -7. **Supply Chain Optimization**: Data-driven insights enable the optimization of supply chain processes to support the integration of sustainable approaches. -8. **Foster Collaborations**: Connecting and sharing information across the value chain facilitates collaboration with other stakeholders to promote joint efforts towards sustainability challenges. - -**Solution Providers** will gain a head start in delivering comprehensive and efficient digital product passport solutions. The pre-built features accelerate time-to-market, reduce costs and ensure a reliable, scalable and compliant system. In addition, solution providers can leverage a KIT as the basis to build their own customized solutions and to offer their customers innovative and value-driven digital product passport services in an efficient and simplified way. - -1. **New Market & Customer Base**: The possibility of developing innovative solutions and providing them through the Catena-X marketplace fosters new market opportunities and scalability of the customer base. -2. **Accelerated Time-to-Market**: The KIT provides the thematical and technical basis to build solutions, significantly reducing the time and resources required to develop digital product passport solutions. -3. **Flexibility and Customization**: While the KIT offers a solid foundation, it is designed to allow solution providers for customizing and tailoring the platform to meet specific needs and preferences of the target market and value chain participants. -4. **Risk Mitigation**: The predefined KIT tools support solution providers in reducing the risk of development errors and vulnerabilities. -5. **Cost Efficiency**: The KIT's standardized data model and open interface simplify the process of connecting to the Catena-X network, reducing the investment needs for integration. -6. **Competitive Advantage**: Adopting the KIT quickly positions solution providers in the market faster with cutting-edge services gaining a competitive advantage. -7. **Alignment with Industry Standards**: The KITs adhere to industry standards, making it easier for solution providers to align with existing supply chain ecosystems and collaborate with other stakeholders. -8. **Data Utilization**: The wealth of data available in the Catena-X network is leveraged to drive innovation and develop data-driven solutions tailored to the unique needs of various industries. - -#### Battery Pass: A real-world example - -In the automotive industry, a Battery Passport or Digital Product Passport for batteries plays a crucial role in ensuring transparency, traceability, and sustainability in the battery supply chain. Here's a real-world example of how a digital product passport might be set up for a battery used in electric vehicles (EVs), including its benefits, illustrated below: - -![BP realWorldExample](./resources/adoption-view/adoption-view-BatteryPass_a_example.svg) - -1. **Battery Manufacturing**: During the production stage, the battery manufacturer collects and records relevant data, such as the battery's unique identifier, type and model, manufacturing date and location, energy capacity and raw materials composition, including the content of critical elements like lithium, cobalt and nickel. -2. **Supply Chain Transparency**: Information about the battery's sourcing, manufacturing and distribution processes is documented, ensuring compliance with environmental and social standards. This includes data on the origin of raw materials, labor practices and the environmental footprint of each stage of the supply chain. -3. **Vehicle Integration**: When the battery is integrated into an electric vehicle, the Battery Pass is linked to the car's unique identification number (VIN), allowing seamless tracking and communication between the battery, the vehicle and relevant stakeholders. -4. **In-Use Performance Tracking**: As the vehicle is used, the Battery Pass continuously collects data on the battery's performance, such as its state of charge, charging cycles and degradation over time. This information is essential for the vehicle owner, car manufacturer and service providers to monitor the battery's health and optimize its lifespan. -5. **End-of-Life Management**: When the battery reaches the end of its useful life, the Battery Passport provides detailed instructions for proper disposal and recycling, ensuring compliance with regulations and facilitating the recovery of valuable materials. The data stored in the Battery Passport helps recycling facilities to efficiently process the battery, reducing waste and promoting a circular economy. - -Throughout this process, the Battery Passport serves as a single, secure, and easily accessible source of information for various stakeholders, such as vehicle manufacturers, suppliers, service providers, regulators and vehicle owners. By implementing a digital product passport like the Battery Pass in the automotive industry, companies can promote transparency, traceability, and sustainability, ultimately contributing to a more eco-friendly and circular economy. -For more information please read the [Battery Pass Viewer App Success Story](./Success%20Stories/BatteryPass_Viewer_App.mdx)! - -### How the KIT can help - -The EcoPass KIT addresses the real-world problem of battery traceability and sustainability in the automotive industry by providing a standardized, easy-to-implement solution for creating and managing digital product passports. Here's how the EcoPass KIT can help and scale in this context: - -1. **Standardization and Interoperability**: The EcoPass KIT offers a unified data model and is planning an API specification, allowing for seamless integration across different stakeholders, including manufacturers, suppliers, service providers and regulatory bodies. This standardization promotes interoperability and streamlines communication throughout the battery lifecycle. -2. **Simplified Adoption**: By providing a comprehensive and easy-to-use KIT, EcoPass can lower the barrier to entry for businesses of all sizes, enabling them to implement digital product passports without extensive technical expertise or resources. This can encourage widespread adoption of the solution, resulting in a larger-scale positive impact on sustainability and traceability. -3. **Scalable Solution**: The EcoPass KIT is designed to accommodate various product types, sizes and applications, ensuring its relevance and adaptability to the evolving automotive industry. This scalability allows the KIT to be utilized for a wide range of battery technologies, facilitating its adoption across diverse sectors. -4. **Enhanced Data Quality and Analysis**: The EcoPass KIT enables the collection and management of high-quality data throughout the product lifecycle. This wealth of information can be used by stakeholders to make data-driven decisions, optimize processes and identify opportunities for innovation and improvement in battery design, manufacturing and recycling. -5. **Facilitated Regulatory Compliance**: With the EcoPass KIT in place, businesses can more easily comply with the evolving regulations and industry standards related to battery traceability and sustainability. The digital product passport provides a comprehensive record of the battery's lifecycle, supporting compliance management and reducing the risk of penalties and reputational damage. - -By providing a standardized, scalable and easy-to-adopt solution, the EcoPass KIT will play a significant role in addressing the challenges of product traceability and sustainability in the automotive industry, promoting a more transparent, environmentally friendly and circular economy. - -## Semantic Models - -Depending on the use case and related KIT, Catena-X provides different semantic models that help to structure and make use of data via semantic information. These models help to provide a basic meaning to the data and their relationship, thereby enabling interoperability between data sets. Catena-X data models rely on principles as understandability, standardization, accuracy, differentiation, auditability, comprehensiveness, and provision of insights to drive improvement actions. The KIT entails the main data models of a Digital Product Passport and Battery Passport, whereat both are justified with an underlying regulation. - -Other specific product passports which are further described in the EcoPass KIT are the [battery](#battery-passport), [transmission](#transmission-passport) and [electric drive](#electric-drive-passport). All of them depend on the generic Digital Product Passport data model. Further data models will follow. - -The goal of these passports is to create unified data models that can be used and adapted across the automotive industry. These data models are modelled according to the [CX-0003](https://catena-x.net/en/standard-library) SAMM Standard in Version 1.1.0 (updated link once published). For detailed information please follow the embedded links to the Catena-X Standard library. - -### Digital Product Passport - -#### Digital Product Passport Introduction - -Digital Product Passports addresses three needs by the industry: First, they gather all relevant information about a product in a single, digital tool. Second, digital product passports answer increasing regulatory requirements and demand for sustainability information along the value chain of a product. And third, Digital Product Passports are an important enabler for a circular economy. -The collected data is defined via standards specified by the Catena-X network and obtained from the industry. The content of the Product Passport is product-related information that is useful and necessary for the consumer, and other actors who will deal with the product till end of its life, and is limited to the required minimum of the necessary information. -The data model in version 4.0.0 corresponds to the Digital Product Passport information required by the proposed Ecodesign Regulation ([ESPR-2022](<(https://commission.europa.eu/energy-climate-change-environment/standards-tools-and-labels/products-labelling-rules-and-requirements/sustainable-products/ecodesign-sustainable-products_en)>)) from March 30th, 2022. In the future, delegated acts for specific product groups would require a product passport to be available for each product. The data model will be updated, as newer versions of the regulation will be published. The latest to the model corresponding version of the document was the [provisional agreement](https://eur-lex.europa.eu/legal-content/EN/TXT/PDF/?uri=CONSIL:ST_5147_2024_INIT) between the EU Council and the Parliament from January 9th, 2024. The text is informal, but the content of the final regulation was agreed between these two institutions. - -It is important to note that the data model contains information/data fields, which are mandatory for the fulfilment of the regulation ([ESPR-2022](<(https://commission.europa.eu/energy-climate-change-environment/standards-tools-and-labels/products-labelling-rules-and-requirements/sustainable-products/ecodesign-sustainable-products_en)>)). It is also worth mentioning that sharing information within the network is based on decentralized technologies and is always based on the individual decision of each provider. - -The Digital Product Passport is the core model and can be used as the root class for other, specific, product models. The latest model `v.4.0.0` consists out of the following information: - -- Passport metadata -- Product identification -- Product operation -- Product handling -- Product characteristic -- Sustainability information -- Materials information -- Commercial information -- Sources (documents) -- Additional data - -In addition, the Digital Product Passport data model offers the following advantages: - -- **Self-describing**: Which means it has all the details necessary to comprehend what it includes. Different systems can easily interpret the Passport as a result. -- **Extendable**: New information can be added without much difficulty. As a result, the Passport will be able to adapt to the changing requirements. -- **Common semantics**: The model of a generic passport is established in Catena-X which other passes can build upon. - -#### Link to current Digital Product Passport model - -The semantic models are located [here](https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.generic.digital_product_passport). For each version there is a separated directory containing the ttl-file and generated samples. - -#### Example Digital Product Passport Payload - -
- Payload - -```json -{ - "metadata": { - "backupReference": "https://dummy.link", - "registrationIdentifier": "https://dummy.link/ID8283746239078", - "economicOperatorId": "BPNL0123456789ZZ", - "predecessor": "urn:uuid:00000000-0000-0000-0000-000000000000", - "issueDate": "2000-01-01", - "version": "1.0.0", - "passportIdentifier": "urn:uuid:550e8400-e29b-41d4-a716-446655440000", - "status": "draft", - "expirationDate": "2000-01-01" - }, - "characteristics": { - "generalPerformanceClass": "A", - "physicalState": "solid", - "physicalDimension": { - "volume": { - "value": 20.0, - "unit": "unit:cubicMetre" - }, - "grossWeight": { - "value": 20.0, - "unit": "unit:gram" - }, - "diameter": { - "value": 20.0, - "unit": "unit:millimetre" - }, - "grossVolume": { - "value": 20.0, - "unit": "unit:cubicMetre" - }, - "width": { - "value": 20.0, - "unit": "unit:millimetre" - }, - "length": { - "value": 20.0, - "unit": "unit:millimetre" - }, - "weight": { - "value": 20.0, - "unit": "unit:gram" - }, - "height": { - "value": 20.0, - "unit": "unit:millimetre" - } - }, - "lifespan": [ - { - "value": 36, - "unit": "unit:day", - "key": "guaranteed lifetime" - } - ] - }, - "commercial": { - "placedOnMarket": "2000-01-01" - }, - "identification": { - "batch": [ - { - "value": "BID12345678", - "key": "batchId" - } - ], - "codes": [ - { - "value": "8703 24 10 00", - "description": "GBT", - "key": "TARIC" - } - ], - "type": { - "manufacturerPartId": "123-0.740-3434-A", - "nameAtManufacturer": "Mirror left" - }, - "classification": [ - { - "classificationStandard": "GIN 20510-21513", - "classificationID": "1004712", - "classificationDescription": "Generic standard for classification of parts in the automotive industry." - } - ], - "serial": [ - { - "value": "SN12345678", - "key": "partInstanceId" - } - ], - "dataCarrier": { - "carrierType": "QR", - "carrierLayout": "upper-left side" - } - }, - "sources": [ - { - "header": "Sustainability Document Material XY", - "category": "Product Specifications", - "type": "URL", - "content": "https://dummy.link" - } - ], - "materials": { - "substancesOfConcern": { - "substanceOfConcern": [ - { - "unit": "unit:partPerMillion", - "hazardClassification": { - "category": "category 1A", - "statement": "Causes severe skin burns and eye damage.", - "class": "Skin corrosion" - }, - "documentation": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "concentrationRange": [ - { - "max": 2.6, - "min": 2.1 - } - ], - "name": { - "name": "phenolphthalein", - "type": "IUPAC" - }, - "location": "Housing", - "concentration": 5.3, - "exemption": "shall not apply to product x containing not more than 1,5 ml of liquid", - "id": [ - { - "type": "CAS", - "id": "201-004-7" - } - ] - } - ], - "applicable": true - }, - "materialComposition": { - "applicable": true, - "chemicalMaterial": [ - { - "unit": "unit:partPerMillion", - "recycled": 12.5, - "critical": true, - "renewable": 23.5, - "documentation": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "name": { - "name": "phenolphthalein", - "type": "IUPAC" - }, - "concentration": 5.3, - "id": [ - { - "type": "CAS", - "id": "201-004-7" - } - ] - } - ] - } - }, - "handling": { - "spareParts": { - "producer": [ - { - "id": "BPNL0123456789ZZ" - } - ], - "sparePart": [ - { - "manufacturerPartId": "123-0.740-3434-A", - "nameAtManufacturer": "Mirror left" - } - ] - }, - "applicable": true - }, - "additionalData": [ - { - "description": "Description of an attribute", - "label": "Maximum permitted battery power", - "type": { - "typeUnit": "unit:volume", - "dataType": "array" - }, - "data": "23", - "children": [ - { - "description": "Description of an attribute", - "label": "Maximum permitted battery power", - "type": { - "typeUnit": "unit:volume", - "dataType": "array" - }, - "data": "23" - } - ] - } - ], - "operation": { - "import": { - "importer": { - "eori": "GB123456789000", - "id": "BPNL0123456789ZZ" - }, - "applicable": true - }, - "manufacturer": { - "facility": [ - { - "facility": "BPNA1234567890AA" - } - ], - "manufacturingDate": "2000-01-31", - "manufacturer": "BPNLtdiHqzA3Mtyk" - } - }, - "sustainability": { - "reparabilityScore": "B", - "productFootprint": { - "material": [ - { - "lifecycle": "main product production", - "rulebook": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "unit": "kg CO2 / kWh", - "performanceClass": "A", - "manufacturingPlant": [ - { - "facility": "BPNA1234567890AA" - } - ], - "type": "Climate Change Total", - "value": 12.678, - "declaration": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ] - } - ], - "carbon": [ - { - "lifecycle": "main product production", - "rulebook": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "unit": "kg CO2 / kWh", - "performanceClass": "A", - "manufacturingPlant": [ - { - "facility": "BPNA1234567890AA" - } - ], - "type": "Climate Change Total", - "value": 12.678, - "declaration": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ] - } - ], - "environmental": [ - { - "lifecycle": "main product production", - "rulebook": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "unit": "kg CO2 / kWh", - "performanceClass": "A", - "manufacturingPlant": [ - { - "facility": "BPNA1234567890AA" - } - ], - "type": "Climate Change Total", - "value": 12.678, - "declaration": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ] - } - ] - }, - "status": "original", - "durabilityScore": "A" - } -} -``` - -
- -### Battery Passport - -#### Battery Passport Introduction - -The Catena-X standards, which are crucial to create a more sustainable battery business, serve as the foundation for the data model behind the Battery Passport. The Battery Passport assists in enhancing the traceability and sustainability of batteries by offering a thorough record of a battery's life cycle. This will mitigate the battery industry's environmental effect and make it easier to recycle batteries. - -Due to requirements of the regulation [(EU) 2023/1542](https://eur-lex.europa.eu/legal-content/EN/TXT/PDF/?uri=CELEX:32023R1542) for batteries and waste batteries, a data model for Battery Passport was created, which increases the efficiency of circular economy ecosystems of all partners in the value network. The battery passport is a tool for the exchange of information and enables tracking and tracing of batteries usage information. -The Battery Passport is a standardized data model that will enable stakeholders to access the relevant data. The version of the Battery Passport Data Model `v.5.0.0` consists out of the following information: - -- Passport metadata -- Product identification -- Product operation -- Product handling -- Product characteristic -- Sustainability information -- Materials information -- Commercial information -- Sources (documents) -- Conformity information -- Safety information -- Performance information - -It is important to note that the data model contains information/data fields, which are mandatory for the fulfilment of the regulation ([(EU) 2023/1542](https://eur-lex.europa.eu/legal-content/EN/TXT/PDF/?uri=CELEX:32023R1542)). It is also worth mentioning that sharing information within the network is based on decentralized technologies and is always based on the individual decision of each provider. - -#### Link to current Battery Pass model - -The semantic models are located [here](https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.battery.battery_pass). For each version there is a separated directory containing the ttl-file and a generated samples. - -The latest version is the `v5.0.0` which is based on the generic Digital Product Passport `v4.0.0` model which can be found [here](https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.generic.digital_product_passport). - -#### Example Battery Passport Payload - -
- Payload - -```json -{ - "characteristics": { - "physicalDimension": { - "length": { - "value": 20.0, - "unit": "unit:millimetre" - }, - "width": { - "value": 20.0, - "unit": "unit:millimetre" - }, - "weight": { - "value": 20.0, - "unit": "unit:gram" - }, - "height": { - "value": 20.0, - "unit": "unit:millimetre" - } - }, - "warranty": { - "lifeValue": 36, - "lifeUnit": "unit:day" - } - }, - "metadata": { - "backupReference": "https://dummy.link", - "registrationIdentifier": "https://dummy.link/ID8283746239078", - "economicOperatorId": "BPNL0123456789ZZ", - "predecessor": "urn:uuid:00000000-0000-0000-0000-000000000000", - "issueDate": "2000-01-01", - "version": "1.0.0", - "passportIdentifier": "urn:uuid:550e8400-e29b-41d4-a716-446655440000", - "status": "draft", - "expirationDate": "2000-01-01" - }, - "identification": { - "chemistry": "NCM", - "idDmc": "34567890", - "identification": { - "batch": [ - { - "value": "BID12345678", - "key": "batchId" - } - ], - "codes": [ - { - "value": "8703 24 10 00", - "description": "GBT", - "key": "TARIC" - } - ], - "type": { - "manufacturerPartId": "123-0.740-3434-A", - "nameAtManufacturer": "Mirror left" - }, - "classification": [ - { - "classificationStandard": "GIN 20510-21513", - "classificationID": "1004712", - "classificationDescription": "Generic standard for classification of parts in the automotive industry." - } - ], - "serial": [ - { - "value": "SN12345678", - "key": "partInstanceId" - } - ], - "dataCarrier": { - "carrierType": "QR", - "carrierLayout": "upper-left side" - } - }, - "category": "SLI" - }, - "performance": { - "rated": { - "roundTripEfficiency": { - "depthOfDischarge": 90.5, - "temperature": 20.0, - "50PercentLife": 89.0, - "initial": 96.0 - }, - "selfDischargingRate": 0.25, - "performanceDocument": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "testReport": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "temperature": { - "lower": -18.0, - "upper": 60.0 - }, - "lifetime": { - "report": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "cycleLifeTesting": { - "temperature": 20.0, - "depthOfDischarge": 90.5, - "appliedDischargeRate": 4.0, - "cycles": 1500, - "appliedChargeRate": 3.0 - }, - "expectedYears": 8 - }, - "power": { - "at20SoC": 35000.0, - "temperature": 20.0, - "value": 40000.0, - "at80SoC": 39000.0 - }, - "resistance": { - "temperature": 20.0, - "cell": 0.025, - "pack": 0.55, - "module": 0.2 - }, - "voltage": { - "temperature": 20.0, - "min": 2.5, - "nominal": 3.7, - "max": 4.2 - }, - "energy": { - "temperature": 20.0, - "value": 0.5 - }, - "capacity": { - "temperature": 20.0, - "value": 4.0, - "thresholdExhaustion": 80.0 - } - }, - "dynamic": { - "selfDischargingRate": 0.25, - "roundTripEfficiency": { - "remaining": { - "value": 50.0, - "time": "2023-12-07T10:39:13.576+01:00" - }, - "fade": { - "value": 50.0, - "time": "2023-12-07T10:39:13.576+01:00" - } - }, - "operatingEnvironment": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "stateOfCharge": { - "value": 50.0, - "time": "2023-12-07T10:39:13.576+01:00" - }, - "performanceDocument": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "fullCycles": { - "value": 1500, - "time": "2023-12-07T10:39:13.576+01:00" - }, - "power": { - "remaining": { - "value": 40000.0, - "time": "2023-12-07T10:39:13.576+01:00" - }, - "fade": { - "value": 50.0, - "time": "2023-12-07T10:39:13.576+01:00" - } - }, - "negativeEvents": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "resistance": { - "increase": { - "cell": { - "value": 50.0, - "time": "2023-12-07T10:39:13.576+01:00" - }, - "pack": { - "value": 50.0, - "time": "2023-12-07T10:39:13.576+01:00" - }, - "module": { - "value": 50.0, - "time": "2023-12-07T10:39:13.576+01:00" - } - }, - "remaining": { - "cell": { - "value": 0.3, - "time": "2023-12-07T10:39:13.576+01:00" - }, - "pack": { - "value": 0.3, - "time": "2023-12-07T10:39:13.576+01:00" - }, - "module": { - "value": 0.3, - "time": "2023-12-07T10:39:13.576+01:00" - } - } - }, - "capacity": { - "fade": { - "value": 50.0, - "time": "2023-12-07T10:39:13.576+01:00" - }, - "throughput": { - "value": 4.0, - "time": "2023-12-07T10:39:13.576+01:00" - }, - "capacity": { - "value": 4.0, - "time": "2023-12-07T10:39:13.576+01:00" - } - }, - "energy": { - "remaining": { - "value": 0.5, - "time": "2023-12-07T10:39:13.576+01:00" - }, - "soce": { - "value": 50.0, - "time": "2023-12-07T10:39:13.576+01:00" - }, - "throughput": { - "value": 0.5, - "time": "2023-12-07T10:39:13.576+01:00" - } - } - } - }, - "sources": [ - { - "header": "Sustainability Document Material XY", - "category": "Product Specifications", - "type": "URL", - "content": "https://dummy.link" - } - ], - "materials": { - "hazardous": { - "cadmium": { - "concentration": 5.3, - "location": "Housing", - "critical": true, - "impactOfSubstances": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "materialUnit": "unit:partPerMillion", - "documentation": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ] - }, - "other": [ - { - "materialName": { - "name": "phenolphthalein", - "type": "IUPAC" - }, - "critical": true, - "impactOfSubstances": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "documentation": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "concentration": 5.3, - "materialIdentification": [ - { - "type": "CAS", - "id": "201-004-7" - } - ], - "location": "Housing", - "materialUnit": "unit:partPerMillion" - } - ], - "mercury": { - "concentration": 5.3, - "location": "Housing", - "critical": true, - "impactOfSubstances": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "materialUnit": "unit:partPerMillion", - "documentation": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ] - }, - "lead": { - "recycled": 12.5, - "critical": true, - "impactOfSubstances": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "documentation": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "location": "Housing", - "concentration": 5.3, - "materialUnit": "unit:partPerMillion" - } - }, - "active": { - "nickel": { - "location": "Housing", - "recycled": 12.5, - "critical": true, - "documentation": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ] - }, - "lithium": { - "location": "Housing", - "recycled": 12.5, - "critical": true, - "documentation": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ] - }, - "cobalt": { - "location": "Housing", - "recycled": 12.5, - "critical": true, - "documentation": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ] - }, - "other": [ - { - "materialName": { - "name": "phenolphthalein", - "type": "IUPAC" - }, - "location": "Housing", - "materialIdentification": [ - { - "type": "CAS", - "id": "201-004-7" - } - ], - "recycled": 12.5, - "critical": true, - "documentation": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ] - } - ], - "lead": { - "recycled": 12.5, - "critical": true, - "impactOfSubstances": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "documentation": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "location": "Housing", - "concentration": 5.3, - "materialUnit": "unit:partPerMillion" - } - }, - "composition": [ - { - "unit": "unit:partPerMillion", - "recycled": 12.5, - "critical": true, - "renewable": 23.5, - "documentation": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "name": { - "name": "phenolphthalein", - "type": "IUPAC" - }, - "concentration": 5.3, - "location": "Housing", - "id": [ - { - "type": "CAS", - "id": "201-004-7" - } - ] - } - ] - }, - "safety": { - "usableExtinguishAgent": [ - { - "fireClass": "A, B", - "document": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "media": "Dry Powder" - } - ], - "safeDischarging": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "meaningOfLabels": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "dismantling": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "removalFromAppliance": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "safetyMeasures": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ] - }, - "handling": { - "spareParts": { - "producer": [ - { - "id": "BPNL0123456789ZZ" - } - ], - "sparePart": [ - { - "manufacturerPartId": "123-0.740-3434-A", - "nameAtManufacturer": "Mirror left" - } - ] - }, - "applicable": true - }, - "conformity": { - "declarationOfConformityId": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "thirdPartyAssurance": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "resultOfTestReport": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "declarationOfConformity": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "dueDiligencePolicy": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ] - }, - "operation": { - "intoServiceDate": "1446-48-65", - "manufacturer": { - "facility": [ - { - "facility": "BPNA1234567890AA" - } - ], - "manufacturingDate": "2000-01-31", - "manufacturer": "BPNLmANsF8W8vj3P" - } - }, - "sustainability": { - "documents": { - "separateCollection": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "sustainabilityReport": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "euTaxonomyDisclosureStatement": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "wastePrevention": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ] - }, - "carbonFootprint": [ - { - "lifecycle": "main product production", - "rulebook": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "unit": "kg CO2 / kWh", - "performanceClass": "A", - "manufacturingPlant": [ - { - "facility": "BPNA1234567890AA" - } - ], - "type": "Climate Change Total", - "value": 12.678, - "declaration": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ] - } - ], - "status": "original" - } -} -``` - -
- -### Transmission Passport - -#### Transmission Passport Introduction - -In July 2023, the European Commission presented a proposal for a regulation addressing the whole life cycle of vehicles, from design to end-of-life, aimed at improving design and end-of-life management of vehicles for a more resource-efficient automotive sector. It would set circularity requirements on vehicle design and production concerning reusability, recyclability, recoverability and the use of recycled content. It would also lay down requirements on information and labelling of parts, components and materials in vehicles. - -As preparation for the implementation of the proposed regulation and its requirements, manufacturers and OEMs within the Catena-X network decided on developing data models for the most commonly used products. - -In contrast to the previous version `v.1.0.0` of the transmission, the Transmission Passport `v.2.0.0` corresponds to the [digital product passport](#digital-product-passport) information required by the proposed Ecodesign Regulation and describes the data that is collected and available during the lifespan of a transmission. The consumers can see at a glance the relevant data about the transmission which is installed in the specified vehicle. By incorporating circularity parameters, the Transmission Passport aims to enhance transparency and promote a circular economy within the European Union. Detailed descriptions can be found in the Ecodesign for Sustainable Products Regulation Proposal (ESPR). -The Transmission Passport model `v.2.0.0` includes the following product specific information: - -- Type of drive -- Transmission performance information -- Torque converter information -- Speed resistance information -- Standard gear ratio information -- Transmission spreading information -- Transmission oil information -- Electric machine information -- Electric performance information - -Product unspecific information incudes following information: - -- Passport metadata -- Product identification -- Product operation -- Product handling -- Product characteristic -- Sustainability information -- Materials information -- Commercial information -- Sources (documents) - -It is important to note that the data model contains information/data fields, which are mandatory for the fulfilment of the regulation ([ESPR-2022](<(https://commission.europa.eu/energy-climate-change-environment/standards-tools-and-labels/products-labelling-rules-and-requirements/sustainable-products/ecodesign-sustainable-products_en)>)). It is also worth mentioning that sharing information within the network is based on decentralized technologies and is always based on the individual decision of each provider. - -#### Link to current Transmission Passport model - -The semantic models are located [here](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.transmission.transmission_pass). For each version there is a separated directory containing the ttl-file and a generated samples. - -#### Example Transmission Passport Payload - -
- Payload - -```json -{ - "productSpecificParameters": { - "serviceHistory": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "oil": { - "oilType": ["ZF Lifeguard Hybrid 2"], - "oilCapacity": 8.9 - }, - "torqueConverter": ["NW 200 TTD"], - "driveType": ["full hybrid"], - "spreading": 6.79, - "torque": 500, - "power": 300, - "standardGearRatio": [ - { - "gearRatio": 4.1567, - "gear": "1" - } - ], - "speedResistance": [ - { - "speed": 7800, - "gear": "1" - } - ], - "electricalPerformance": { - "applicable": true, - "electricalMachine": { - "torque": { - "torquePeak": 180, - "torqueContinuous": 178, - "time": 10 - }, - "power": { - "powerContinuous": 16, - "powerPeak": 22, - "time": 10 - }, - "speed": 16700, - "voltage": 52 - } - } - }, - "productUnspecificParameters": { - "characteristics": { - "physicalDimension": { - "volume": { - "value": 20.0, - "unit": "unit:cubicMetre" - }, - "grossWeight": { - "value": 20.0, - "unit": "unit:gram" - }, - "diameter": { - "value": 20.0, - "unit": "unit:millimetre" - }, - "grossVolume": { - "value": 20.0, - "unit": "unit:cubicMetre" - }, - "width": { - "value": 20.0, - "unit": "unit:millimetre" - }, - "length": { - "value": 20.0, - "unit": "unit:millimetre" - }, - "weight": { - "value": 20.0, - "unit": "unit:gram" - }, - "height": { - "value": 20.0, - "unit": "unit:millimetre" - } - }, - "warranty": 60, - "lifeTime": 500000 - }, - "metadata": { - "backupReference": "https://dummy.link", - "registrationIdentifier": "https://dummy.link/ID8283746239078", - "economicOperatorId": "BPNL0123456789ZZ", - "predecessor": "urn:uuid:00000000-0000-0000-0000-000000000000", - "issueDate": "2000-01-01", - "version": "1.0.0", - "passportIdentifier": "urn:uuid:550e8400-e29b-41d4-a716-446655440000", - "status": "draft", - "expirationDate": "2000-01-01" - }, - "commercial": { - "placedOnMarket": "2000-01-01" - }, - "identification": { - "batch": [ - { - "value": "BID12345678", - "key": "batchId" - } - ], - "codes": [ - { - "value": "8703 24 10 00", - "description": "GBT", - "key": "TARIC" - } - ], - "type": { - "manufacturerPartId": "123-0.740-3434-A", - "nameAtManufacturer": "Mirror left" - }, - "classification": [ - { - "classificationStandard": "GIN 20510-21513", - "classificationID": "1004712", - "classificationDescription": "Generic standard for classification of parts in the automotive industry." - } - ], - "serial": [ - { - "value": "SN12345678", - "key": "partInstanceId" - } - ], - "dataCarrier": { - "carrierType": "QR", - "carrierLayout": "upper-left side" - } - }, - "sources": [ - { - "header": "Sustainability Document Material XY", - "category": "Product Specifications", - "type": "URL", - "content": "https://dummy.link" - } - ], - "materials": { - "substancesOfConcern": { - "substanceOfConcern": [ - { - "unit": "unit:partPerMillion", - "hazardClassification": { - "category": "category 1A", - "statement": "Causes severe skin burns and eye damage.", - "class": "Skin corrosion" - }, - "documentation": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "concentrationRange": [ - { - "max": 2.6, - "min": 2.1 - } - ], - "name": { - "name": "phenolphthalein", - "type": "IUPAC" - }, - "location": "Housing", - "concentration": 5.3, - "exemption": "shall not apply to product x containing not more than 1,5 ml of liquid", - "id": [ - { - "type": "CAS", - "id": "201-004-7" - } - ] - } - ], - "applicable": true - }, - "materialComposition": { - "applicable": true, - "chemicalMaterial": [ - { - "unit": "unit:partPerMillion", - "recycled": 12.5, - "critical": true, - "renewable": 23.5, - "documentation": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "name": { - "name": "phenolphthalein", - "type": "IUPAC" - }, - "concentration": 5.3, - "id": [ - { - "type": "CAS", - "id": "201-004-7" - } - ] - } - ] - } - }, - "handling": { - "spareParts": { - "producer": [ - { - "id": "BPNL0123456789ZZ" - } - ], - "sparePart": [ - { - "manufacturerPartId": "123-0.740-3434-A", - "nameAtManufacturer": "Mirror left" - } - ] - }, - "applicable": true - }, - "operation": { - "import": { - "importer": { - "eori": "GB123456789000", - "id": "BPNL0123456789ZZ" - }, - "applicable": true - }, - "manufacturer": { - "facility": [ - { - "facility": "BPNA1234567890AA" - } - ], - "manufacturingDate": "2000-01-31", - "manufacturer": "BPNLOeWgETkaumoQ" - } - }, - "sustainability": { - "reparabilityScore": "B", - "productFootprint": { - "material": [ - { - "lifecycle": "main product production", - "rulebook": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "unit": "kg CO2 / kWh", - "performanceClass": "A", - "manufacturingPlant": [ - { - "facility": "BPNA1234567890AA" - } - ], - "type": "Climate Change Total", - "value": 12.678, - "declaration": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ] - } - ], - "carbon": [ - { - "lifecycle": "main product production", - "rulebook": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "unit": "kg CO2 / kWh", - "performanceClass": "A", - "manufacturingPlant": [ - { - "facility": "BPNA1234567890AA" - } - ], - "type": "Climate Change Total", - "value": 12.678, - "declaration": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ] - } - ], - "environmental": [ - { - "lifecycle": "main product production", - "rulebook": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "unit": "kg CO2 / kWh", - "performanceClass": "A", - "manufacturingPlant": [ - { - "facility": "BPNA1234567890AA" - } - ], - "type": "Climate Change Total", - "value": 12.678, - "declaration": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ] - } - ] - }, - "status": "original", - "durabilityScore": "A" - } - } -} -``` - -
- -### Electric Drive Passport - -#### Electric Drive Introduction - -In July 2023, the European Commission presented a proposal for a regulation addressing the whole life cycle of vehicles, from design to end-of-life, aimed at improving design and end-of-life management of vehicles for a more resource-efficient automotive sector. As preparation for the implementation of the proposed regulation and its requirements, manufacturers and OEMs within the Catena-X network decided on developing data models for the most commonly used products. As well as the transmission, the electric drive is one of such a component. - -The data model corresponds to the [digital product passport](#digital-product-passport) information required by the proposed Ecodesign Regulation and describes the data that is collected and available during the lifespan of a electric drive. The consumers can see at a glance the relevant data about the electric drive which is installed in the specified vehicle. The Electric Drive Passport model `v.1.0.0` includes the following product specific information: - -- General information -- System and performance data -- Inverter information -- E-Machine information -- Transmission information -- Cooling and lubricants information -- Specific documents - -Product unspecific information incudes following information: - -- Passport metadata -- Product identification -- Product operation -- Product handling -- Product characteristic -- Sustainability information -- Materials information -- Commercial information -- Sources (documents) - -It is important to note that the data model contains information/data fields, which are mandatory for the fulfilment of the regulation ([ESPR-2022](<(https://commission.europa.eu/energy-climate-change-environment/standards-tools-and-labels/products-labelling-rules-and-requirements/sustainable-products/ecodesign-sustainable-products_en)>)). It is also worth mentioning that sharing information within the network is based on decentralized technologies and is always based on the individual decision of each provider. - -#### Link to current Electric Drive model - -The semantic models are located [here](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.electric_drive.electric_drive_passport). For each version there is a separated directory containing the ttl-file and a generated samples. - -#### Example Electric Drive Payload - -
- Payload - -```json -{ - "specific": { - "eMachine": { - "ratedSpeed": 8000, - "weight": { - "value": 20.5, - "unit": "unit:gram" - }, - "permanentMagnetType": "Ceramic", - "statorDiameter": 450, - "id": "1785030A72B5752", - "technology": "ESM" - }, - "transmission": { - "transmissionId": "384502A54FC9", - "gearboxStructure": "Planetary", - "oil": { - "oilType": ["ZF Lifeguard Hybrid 2"], - "oilCapacity": 8.9 - } - }, - "inverter": { - "maximumPhaseCurrent": 700, - "inverterCurrent": 500, - "softwareVersion": "2.525.b" - }, - "generalInformation": { - "compatibleVehicleTypes": ["battery-electric vehicle"], - "service": { - "history": ["2020-02-15"], - "lastServiceDate": "2022-03-03" - } - }, - "systemAndPerformance": { - "torque": { - "maximum": { - "value": 300, - "period": 10 - }, - "continuous": 200, - "maxAxle": { - "value": 300, - "period": 10 - } - }, - "gearRatio": 4.1567, - "power": { - "maximum": { - "value": 200, - "period": 10, - "ECER85": 195 - }, - "continuousRegenerated": 5, - "continuous": 180, - "maxRegenerated": { - "maxPeriod": 10, - "maxValue": 200 - } - }, - "voltage": 400 - }, - "electricDriveDocuments": { - "requiredToolsForDismantling": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "technicalDismantlingInstructions": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ] - }, - "coolingAndLubricants": { - "maximumOilPressure": { - "value": 1, - "time": "2024-03-17T23:44:37.176+01:00" - }, - "oilCapacityEdrive": 50, - "maximumOilTemperature": 80.5, - "coolingTopology": "air-cooled", - "oilTypeEdrive": "5W-30", - "oilModule": true, - "minimumOilPressure": { - "value": 1, - "time": "2024-03-17T23:44:37.176+01:00" - } - } - }, - "unspecific": { - "metadata": { - "backupReference": "https://dummy.link", - "registrationIdentifier": "https://dummy.link/ID8283746239078", - "economicOperatorId": "BPNL0123456789ZZ", - "predecessor": "urn:uuid:00000000-0000-0000-0000-000000000000", - "issueDate": "2000-01-01", - "version": "1.0.0", - "passportIdentifier": "urn:uuid:550e8400-e29b-41d4-a716-446655440000", - "status": "draft", - "expirationDate": "2000-01-01" - }, - "characteristics": { - "generalPerformanceClass": "A", - "physicalState": "solid", - "physicalDimension": { - "volume": { - "value": 20.5, - "unit": "unit:cubicMetre" - }, - "grossWeight": { - "value": 20.5, - "unit": "unit:gram" - }, - "diameter": { - "value": 20.5, - "unit": "unit:millimetre" - }, - "grossVolume": { - "value": 20.5, - "unit": "unit:cubicMetre" - }, - "width": { - "value": 20.5, - "unit": "unit:millimetre" - }, - "length": { - "value": 20.5, - "unit": "unit:millimetre" - }, - "weight": { - "value": 20.5, - "unit": "unit:gram" - }, - "height": { - "value": 20.5, - "unit": "unit:millimetre" - } - }, - "lifespan": [ - { - "value": 36, - "unit": "unit:day", - "key": "guaranteed lifetime" - } - ] - }, - "commercial": { - "placedOnMarket": "2000-01-01" - }, - "identification": { - "batch": [ - { - "value": "BID12345678", - "key": "batchId" - } - ], - "codes": [ - { - "value": "8703 24 10 00", - "description": "GBT", - "key": "TARIC" - } - ], - "type": { - "manufacturerPartId": "123-0.740-3434-A", - "nameAtManufacturer": "Mirror left" - }, - "classification": [ - { - "classificationStandard": "IEC", - "classificationID": "61360- 2:2012 ", - "classificationDescription": "Standard data element types with associated classification scheme for electric components." - } - ], - "serial": [ - { - "value": "SN12345678", - "key": "partInstanceId" - } - ], - "dataCarrier": { - "carrierType": "QR", - "carrierLayout": "upper-left side" - } - }, - "sources": [ - { - "header": "Sustainability Document Material XY", - "category": "Product Specifications", - "type": "URL", - "content": "https://dummy.link" - } - ], - "materials": { - "substancesOfConcern": { - "substanceOfConcern": [ - { - "unit": "unit:partPerMillion", - "hazardClassification": { - "category": "category 1A", - "statement": "Causes severe skin burns and eye damage.", - "class": "Skin corrosion" - }, - "documentation": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "concentrationRange": [ - { - "max": 2.6, - "min": 2.1 - } - ], - "name": { - "name": "phenolphthalein", - "type": "IUPAC" - }, - "location": "Housing", - "concentration": 5.3, - "exemption": "shall not apply to product x containing not more than 1,5 ml of liquid", - "id": [ - { - "type": "CAS", - "id": "201-004-7" - } - ] - } - ], - "applicable": true - }, - "materialComposition": { - "applicable": true, - "chemicalMaterial": [ - { - "unit": "unit:partPerMillion", - "recycled": 12.5, - "critical": true, - "renewable": 23.5, - "documentation": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "name": { - "name": "phenolphthalein", - "type": "IUPAC" - }, - "concentration": 5.3, - "id": [ - { - "type": "CAS", - "id": "201-004-7" - } - ] - } - ] - } - }, - "handling": { - "spareParts": { - "producer": [ - { - "id": "BPNL0123456789ZZ" - } - ], - "sparePart": [ - { - "manufacturerPartId": "123-0.740-3434-A", - "nameAtManufacturer": "Mirror left" - } - ] - }, - "applicable": true - }, - "operation": { - "import": { - "importer": { - "eori": "GB123456789000", - "id": "BPNL0123456789ZZ" - }, - "applicable": true - }, - "manufacturer": { - "facility": [ - { - "facility": "BPNA1234567890AA" - } - ], - "manufacturingDate": "2000-01-31", - "manufacturer": "BPNLdL8kmGQO8go6" - } - }, - "sustainability": { - "reparabilityScore": "B", - "productFootprint": { - "material": [ - { - "lifecycle": "main product production", - "rulebook": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "unit": "kg CO2 / kWh", - "performanceClass": "A", - "manufacturingPlant": [ - { - "facility": "BPNA1234567890AA" - } - ], - "type": "Climate Change Total", - "value": 12.678, - "declaration": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ] - } - ], - "carbon": [ - { - "lifecycle": "main product production", - "rulebook": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "unit": "kg CO2 / kWh", - "performanceClass": "A", - "manufacturingPlant": [ - { - "facility": "BPNA1234567890AA" - } - ], - "type": "Climate Change Total", - "value": 12.678, - "declaration": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ] - } - ], - "environmental": [ - { - "lifecycle": "main product production", - "rulebook": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ], - "unit": "kg CO2 / kWh", - "performanceClass": "A", - "manufacturingPlant": [ - { - "facility": "BPNA1234567890AA" - } - ], - "type": "Climate Change Total", - "value": 12.678, - "declaration": [ - { - "contentType": "URL", - "header": "Sustainability Document Material XY", - "content": "https://dummy.link" - } - ] - } - ] - }, - "status": "original", - "durabilityScore": "A" - } - } -} -``` - -
- -## Creation of new passports - -The process for the creation can be structured like following: - -- Preparation phase -- Research phase -- Documentation phase -- Approval phase I. -- Data modelling phase -- Approval phase II. -- Release phase -- Communication & Standardization - -In case of a new proposal, the checking of the already existing passports or aspect models is necessary. If none of the already existing passports or aspect models comply with the proposed requirements a new passport must be requested. - -In case of request from one of the involved companies, the checking of the already existing passports or aspect models is necessary. If none of the already existing aspect models fulfil the request a new aspect model must be requested. - -Development teams should be formed and designated. The team members must be from at least two different companies, that has involvement in the production of the product which the aspect model was requested for. From each of the involved companies subject matter experts should get involved. Involvement of a legal expert is necessary. The lifecycle of the product and the related scenarios should be discovered and documented. Scenarios should be assigned to the responsible parties. All responsible parties should validate their data availability. - -Collection of possible data attributes must be documented in a shared file. The possible data attributes should be aligned with the already existing, related aspect models to avoid duplications. After the list of the possible attributes are agreed on by the responsible parties, for testing and validation purposes other companies should be involved. - -In case of a new or changed aspect model, the changes need to be submitted and requested from the association. The approval is dependent on many different factors. - -Linking with other already existing data models, if reasonable, is mandatory. The data model must be created with the catena-x conform modelling language. - -To get the approval, specific requirements have to be fulfilled. Several iterations between modelling adjustments and reviews can be made. - -Note: Data model creation and standardization will be supported in the association - -![Image: Passport Creation](./resources/adoption-view/passport_model_creation.svg) - -## Business Architecture - -The Business Architecture illustrates the interaction between the EcoPass KIT and other KITs, components, data models, and artifacts used for identity and access management, illustrated by the Figure below. - -![Image: Business Architecture](./resources/adoption-view/adoption-view-EcoPassKITBusinessArch.svg) - -The core of the network is to provide interoperability between different applications. For this reason, a common semantic is indispensable. In the Catena-X ecosystem, it has been agreed to use the description language SAMM to describe data models. -To additionally provide a standardized interface, the open standard of the International Digital Twin Association (IDTA) is used, abbreviated as IDTA. This [standard](https://industrialdigitaltwin.org/wp-content/uploads/2023/04/IDTA-01002-3-0_SpecificationAssetAdministrationShell_Part2_API.pdf) corresponds to the Asset Administration Shell (AAS 3.0). -It is used to discover digital twins and exchange actual usage data. The registration and search of digital twins is done by using the [Digital Twin KIT](https://eclipse-tractusx.github.io/docs-kits/kits/Digital%20Twin%20Kit/Adoption%20View%20Digital%20Twin%20Kit) which reference implementation is the [Digital Twin Registry](https://github.com/eclipse-tractusx/sldt-digital-twin-registry/tree/main) in Tractus-X. -To control access to both usage and meta data, the EcoPass KIT relies on the [Connector KIT](https://eclipse-tractusx.github.io/docs-kits/kits/tractusx-edc/docs/kit/adoption-view/Adoption%20View/). Interactions between two parties occur exclusively peer-to-peer via the standardized interfaces of the Connector KIT, based on the International Data Space Protocol. -Data sovereignty is enabled by so-called verifiable credentials. These rely on the technology of Self-Sovereign Identity (SSI) and are enabled through the Connector KIT. In short, consumers must present their signed credentials, defined by a data provider, before a data contract (and thus a data exchange) can take place. It should be mentioned that this concept is still in the prototype phase as of Release 3.2 and will be expanded in future releases. - -## NOTICE - -This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - -- SPDX-License-Identifier: CC-BY-4.0 -- SPDX-FileCopyrightText: 2023, 2024 ZF Friedrichshafen AG -- SPDX-FileCopyrightText: 2023, 2024 Robert Bosch GmbH -- SPDX-FileCopyrightText: 2023, 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -- SPDX-FileCopyrightText: 2023, 2024 T-Systems International GmbH -- SPDX-FileCopyrightText: 2023, 2024 SAP SE -- SPDX-FileCopyrightText: 2023, 2024 CGI Deutschland B.V. & Co. KG -- SPDX-FileCopyrightText: 2023, 2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V. für ihre Institute IPK und IPK -- SPDX-FileCopyrightText: 2023, 2024 BASF SE -- SPDX-FileCopyrightText: 2023, 2024 Henkel AG & Co. KGaA -- SPDX-FileCopyrightText: 2023, 2024 Contributors to the Eclipse Foundation -- Source URL: diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/adoption-view-EcoPassKIT_IT_Arch.png b/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/adoption-view-EcoPassKIT_IT_Arch.png deleted file mode 100644 index 713ca78a154..00000000000 Binary files a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/adoption-view-EcoPassKIT_IT_Arch.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/adoption-view-EcoPassKIT_IT_Arch.png.license b/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/adoption-view-EcoPassKIT_IT_Arch.png.license deleted file mode 100644 index e24cf459351..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/adoption-view-EcoPassKIT_IT_Arch.png.license +++ /dev/null @@ -1,15 +0,0 @@ -## NOTICE - -This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - -- SPDX-License-Identifier: CC-BY-4.0 -- SPDX-FileCopyrightText: 2023,2023 ZF Friedrichshafen AG -- SPDX-FileCopyrightText: 2023,2023 Robert Bosch GmbH -- SPDX-FileCopyrightText: 2023,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -- SPDX-FileCopyrightText: 2023,2023 T-Systems International GmbH -- SPDX-FileCopyrightText: 2023,2023 SAP SE -- SPDX-FileCopyrightText: 2023,2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V. für ihre Institute IPK und IPK -- SPDX-FileCopyrightText: 2023,2023 BASF SE -- SPDX-FileCopyrightText: 2023,2023 Henkel AG & Co. KGaA -- SPDX-FileCopyrightText: 2023,2023 Contributors to the Eclipse Foundation -- Source URL: https://github.com/eclipse-tractusx/eco-pass-kit diff --git a/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/Software Development View/02-page_software-development-view.md b/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/Software Development View/02-page_software-development-view.md deleted file mode 100644 index 3a2de2da840..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/Software Development View/02-page_software-development-view.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -id: Specification OSim Kit -title: Specification -description: 'OSim Kit' ---- - -![osim kit banner](@site/static/img/OSimKitIcon.svg) - -### OSim Kit - -## Sample Data - -### Sample-1 - -The following example shows the payload used for exchange of simulation results between the OSim partners. The format corresponds with AAS format serialized as a JSON string. - -```json -{ - "owner": { "id": "BPNL00000007OTZ3" }, - "dataQuality": 1, - "description": "Daily standard simulation", - "comment": "successful simulation", - "expirationTimestamp": "2023-03-24T09:15:24.000Z", - "runId": "0fece48b-c8d1-4180-1a9caca6d67e", - "shipments": [ - { - "handlingUnits": [ - { - "name": "Palette", - "volume": 1, - "weight": 189, - "batches": [ - { - "unitOfMeasurement": "KG", - "materialName": "KK1000GR-Gehäuse-Rot", - "quantity": 50, - "materialNumber": "KK1000GR", - "batchOrderId": "Order-0001", - "batchId": "Batch_1", - "hazardousGoods": false, - "batchExpirationTimestamp": "2023-08-22T16:00:00.000Z", - "batchNumber": "45" - } - ], - "handlingUnitId": "HUT_1", - "amount": 1 - } - ], - "shipmentId": "DE51515151", - "recipientTimestampPlanned": "2023-04-19T09:00:00.000Z", - "destination": { "id": "BPNL00000007OTZ3" }, - "recipient": { "id": "BPNL00000007OTZ4" }, - "logistics": { "id": "BPNL00000007OS0H" }, - "preceding": {}, - "splittingAllowed": true, - "destinationTimestamp": "2023-03-19T09:00:00.000Z" - } - ], - "timestamp": "2023-03-09T14:13:42.806Z" -} -``` - -### Sample-2 - -The following example shows the payload used for exchange of scenario data between the OSim partners. The format corresponds with AAS format serialized as a JSON string. - -```json -{ - "materialFlowScenarioRequest": { - "scenarioSimResults": { - "resultOwnId": "916b5688-8bd8-4d7e-83b9-e0d40939274e", - "resultOwnSimRunInitial": { - "owner": {}, - "dataQuality": 0, - "description": "Please simulate asap", - "comment": "successful simulation", - "expirationTimestamp": "2023-03-24T09:15:24.000Z", - "runId": "0fece48b-c8d1-4180-1a9caca6d67e", - "shipments": [ - { - "handlingUnits": [ - { - "name": "Palette", - "volume": 1.0, - "weight": 189.0, - "batches": [ - { - "unitOfMeasurement": "KG", - "materialName": "KK1000GR-Gehäuse-Rot", - "quantity": 50.0, - "materialNumber": "KK1000GR", - "materialHazardousGoods": false, - "batchOrderId": "Order-0001", - "batchId": "Batch_1", - "batchExpirationTimestamp": "2023-08-22T16:00:00.000Z", - "batchNumber": "45" - } - ], - "handlingUnitId": "HUT_1", - "amount": 1 - } - ], - "shipmentId": "DE51515151", - "recipientTimestampPlanned": "2023-04-19T09:00:00.000Z", - "destination": {}, - "recipient": {}, - "logistics": {}, - "preceding": {}, - "splittingAllowed": true, - "destinationTimestamp": "2023-03-19T09:00:00.000Z" - } - ], - "timestamp": "2023-03-09T14:13:42.806Z" - }, - "resultOwnSimRunUpdated": { - "owner": {}, - "dataQuality": 0, - "description": "Please simulate asap", - "comment": "successful simulation", - "expirationTimestamp": "2023-03-24T09:15:24.000Z", - "runId": "0fece48b-c8d1-4180-1a9caca6d67e", - "shipments": [ - { - "handlingUnits": [ - { - "name": "Palette", - "volume": 1.0, - "weight": 189.0, - "batches": [ - { - "unitOfMeasurement": "KG", - "materialName": "KK1000GR-Gehäuse-Rot", - "quantity": 50.0, - "materialNumber": "KK1000GR", - "materialHazardousGoods": false, - "batchOrderId": "Order-0001", - "batchId": "Batch_1", - "batchExpirationTimestamp": "2023-08-22T16:00:00.000Z", - "batchNumber": "45" - } - ], - "handlingUnitId": "HUT_1", - "amount": 1 - } - ], - "shipmentId": "DE51515151", - "recipientTimestampPlanned": "2023-04-19T09:00:00.000Z", - "destination": {}, - "recipient": {}, - "logistics": {}, - "preceding": {}, - "splittingAllowed": true, - "destinationTimestamp": "2023-03-19T09:00:00.000Z" - } - ], - "timestamp": "2023-03-09T14:13:42.806Z" - } - }, - "scenarioParameter": { - "unitOfMeasurement": "KG", - "parameterScenario": "8d464b8b-6977-4952-8a22-0489067ca081", - "parameterComment": "updated Delivery Date", - "materialName": "KK1000GR-Gehäuse-Rot", - "parameterQuantityUpdated": 1.0, - "parameterId": "847c71e5-614a-468b-a3a0-674bf2af3004", - "materialNumber": "KK1000GR", - "parameterDeliveryDateUpdated": "2023-10-10T09:00:00.000Z", - "parameterDeliveryDateInitial": "2023-10-09T10:00:00.000Z", - "parameterOrderId": "OID-011123456", - "parameterQuantityInitial": 1.0 - }, - "scenarioHeader": { - "scenarioOwnerRole": "Customer", - "scenarioCreationTimestamp": "2023-10-04T09:10:00.000Z", - "scenarioExpirationTimestamp": "2023-10-07T09:10:00.000Z", - "scenarioOwner": "BPNL0000007OTZ3", - "scenarioDescription": "Changes in Delivery Date", - "scenarioId": "8d464b8b-6977-4952-8a22-0489067ca081", - "scenarioTitle": "Delivery Modification" - } - } -} -``` diff --git a/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/Software Development View/04-receive-latest-simulation-result.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/Software Development View/04-receive-latest-simulation-result.api.mdx deleted file mode 100644 index c2c20ba6240..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/Software Development View/04-receive-latest-simulation-result.api.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -id: receive-latest-simulation-result -title: "receiveLatestSimulationResult" -description: "Receive latest simulation result which can be stored in own OSim Manager instance" -sidebar_label: "receiveLatestSimulationResult" -hide_title: true -hide_table_of_contents: true -api: {"tags":["receiveLatestSimulationResult"],"description":"Receive latest simulation result which can be stored in own OSim Manager instance","operationId":"receiveLatestSimulationResult","parameters":[{"name":"requestId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"8d628899-3e6f-4666-91c3-74ee7ab88b2b"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"owner":{"type":"object","properties":{"id":{"type":"string"}}},"dataQuality":{"type":"integer"},"description":{"type":"string"},"comment":{"type":"string"},"expirationTimestamp":{"type":"string"},"runId":{"type":"string"},"shipments":{"type":"array","items":{"type":"object","properties":{"handlingUnits":{"type":"array","items":{"type":"object","properties":{"volume":{"type":"integer"},"batches":{"type":"array","items":{"type":"object","properties":{"unitOfMeasurement":{"type":"string"},"materialName":{"type":"string"},"quantity":{"type":"integer"},"materialNumber":{"type":"string"},"batchOrderId":{"type":"string"},"batchId":{"type":"string"},"hazardousGoods":{"type":"boolean"},"batchExpirationTimestamp":{"type":"string"},"batchNumber":{"type":"string"}}}},"handlingUnitId":{"type":"string"},"amount":{"type":"integer"},"name":{"type":"string"},"weight":{"type":"integer"}}}},"shipmentId":{"type":"string"},"recipientTimestampPlanned":{"type":"string"},"destination":{"type":"object","properties":{"id":{"type":"string"}}},"recipient":{"type":"object","properties":{"id":{"type":"string"}}},"logistics":{"type":"object","properties":{"id":{"type":"string"}}},"preceding":{"type":"object","properties":{}},"splittingAllowed":{"type":"boolean"},"destinationTimestamp":{"type":"string"}}}},"timestamp":{"type":"string"}}},"examples":{"0":{"value":"{ \n \"owner\": { \"id\": \"BPNS00000007OTZ3\" }, \n \"dataQuality\": 1, \n \"description\": \"Daily standard simulation\", \n \"comment\": \"successful simulation\", \n \"expirationTimestamp\": \"2023-03-24T09:15:24.000Z\", \n \"runId\": \"0fece48b-c8d1-4180-1a9caca6d67e\", \n \"shipments\": [ \n { \n \"handlingUnits\": [ \n { \n \"name\": \"Palette\", \n \"volume\": 1, \n \"weight\": 189, \n \"batches\": [ \n { \n \"unitOfMeasurement\": \"KG\", \n \"materialName\": \"KK1000GR-Gehäuse-Rot\", \n \"quantity\": 50, \n \"materialNumber\": \"KK1000GR\", \n \"batchOrderId\": \"Order-0001\", \n \"batchId\": \"Batch_1\", \n \"hazardousGoods\": false, \n \"batchExpirationTimestamp\": \"2023-08-22T16:00:00.000Z\", \n \"batchNumber\": \"45\" \n } \n ], \n \"handlingUnitId\": \"HUT_1\", \n \"amount\": 1 \n } \n ], \n \"shipmentId\": \"DE51515151\", \n \"recipientTimestampPlanned\": \"2023-04-19T09:00:00.000Z\", \n \"destination\": { \"id\": \"BPNS00000007OTZ3\" }, \n \"recipient\": { \"id\": \"BPNS00000007OTZ4\" }, \n \"logistics\": { \"id\": \"BPNS00000007OS0H\" }, \n \"preceding\": {}, \n \"splittingAllowed\": true, \n \"destinationTimestamp\": \"2023-03-19T09:00:00.000Z\" \n } \n ], \n \"timestamp\": \"2023-03-09T14:13:42.806Z\" \n}"}}}}},"responses":{"200":{"description":"OK","content":{"text":{"schema":{"type":"string","example":"The POST has succeeded. The receiveLatestSimulationResult has been successfully processed in the backend system."}}}},"400":{"description":"Bad request","content":{"text":{"schema":{"type":"string","example":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)."}}}},"401":{"description":"Unauthorized","content":{"text":{"schema":{"type":"string","example":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response."}}}},"402":{"description":"Payload is empty","content":{"text":{"schema":{"type":"string","example":"The payload of the API call is empty."}}}},"403":{"description":"Forbidden","content":{"text":{"schema":{"type":"string","example":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource."}}}},"404":{"description":"Payload structure unknown","content":{"text":{"schema":{"type":"string","example":"The payload structure is unknown or correspond not to the defined semantic model"}}}},"405":{"description":"Method not allowed","content":{"text":{"schema":{"type":"string","example":"The method used to receive the data was not POST"}}}},"406":{"description":"Payload content invalid","content":{"text":{"schema":{"type":"string","example":"The content of the payload is invalid. E.g. “owner unknown”"}}}},"500":{"description":"Internal server error","content":{"text":{"schema":{"type":"string","example":"The server has encountered a situation it does not know how to handle."}}}},"501":{"description":"Service unavailable","content":{"text":{"schema":{"type":"string","example":"The server is not ready to handle the request."}}}}},"servers":[{"url":"https://{server-url}"}],"method":"post","path":"/api/receiveLatestSimulationResult/requestId/{requestId}","jsonRequestBodyExample":{"owner":{"id":"string"},"dataQuality":0,"description":"string","comment":"string","expirationTimestamp":"string","runId":"string","shipments":[{"handlingUnits":[{"volume":0,"batches":[{"unitOfMeasurement":"string","materialName":"string","quantity":0,"materialNumber":"string","batchOrderId":"string","batchId":"string","hazardousGoods":true,"batchExpirationTimestamp":"string","batchNumber":"string"}],"handlingUnitId":"string","amount":0,"name":"string","weight":0}],"shipmentId":"string","recipientTimestampPlanned":"string","destination":{"id":"string"},"recipient":{"id":"string"},"logistics":{"id":"string"},"preceding":{},"splittingAllowed":true,"destinationTimestamp":"string"}],"timestamp":"string"},"info":{"title":"OSim API","description":"Osim API for requesting and receiving simulation results as well as for interactions related to scenario management.","version":"2.0.0"},"postman":{"name":"receive Latest Simulation Result","description":{"content":"Receive latest simulation result which can be stored in own OSim Manager instance","type":"text/plain"},"url":{"path":["api","receiveLatestSimulationResult","requestId",":requestId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"requestId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/OSim Kit/Software Development View//osim-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## receiveLatestSimulationResult - - - -Receive latest simulation result which can be stored in own OSim Manager instance - -
Path Parameters
Request Body
    owner object
    shipments object[]
    handlingUnits object[]
    batches object[]
    destination object
    recipient object
    logistics object
    preceding object
- -OK - -
Schema
  • string
- -Bad request - -
Schema
  • string
- -Unauthorized - -
Schema
  • string
- -Payload is empty - -
Schema
  • string
- -Forbidden - -
Schema
  • string
- -Payload structure unknown - -
Schema
  • string
- -Method not allowed - -
Schema
  • string
- -Payload content invalid - -
Schema
  • string
- -Internal server error - -
Schema
  • string
- -Service unavailable - -
Schema
  • string
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/Software Development View/05-request-scenario-feedback.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/Software Development View/05-request-scenario-feedback.api.mdx deleted file mode 100644 index 99ea43510e0..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/Software Development View/05-request-scenario-feedback.api.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -id: request-scenario-feedback -title: "requestScenarioFeedback" -description: "The requestScenarioFeedback is a request from a OSim partner for feedback on the possible fulfillment of the described scenario." -sidebar_label: "requestScenarioFeedback" -hide_title: true -hide_table_of_contents: true -api: {"tags":["requestScenarioFeedback"],"operationId":"requestScenarioFeedback","description":"The requestScenarioFeedback is a request from a OSim partner for feedback on the possible fulfillment of the described scenario.","parameters":[{"name":"bpns","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"BPNS00000007OTZ3"}],"requestBody":{"content":{"application/json":{"schema":{"required":["materialFlowScenarioRequest"],"type":"object","properties":{"materialFlowScenarioRequest":{"required":["scenarioHeader","scenarioParameter","scenarioSimResults"],"type":"object","properties":{"scenarioSimResults":{"required":["resultOwnId","resultOwnSimRunInitial","resultOwnSimRunUpdated"],"type":"object","properties":{"resultOwnId":{"type":"string"},"resultOwnSimRunInitial":{"required":["comment","dataQuality","description","expirationTimestamp","owner","runId","shipments","timestamp"],"type":"object","properties":{"owner":{"type":"object"},"dataQuality":{"type":"integer"},"description":{"type":"string"},"comment":{"type":"string"},"expirationTimestamp":{"type":"string"},"runId":{"type":"string"},"shipments":{"type":"array","items":{"required":["destination","destinationTimestamp","handlingUnits","logistics","preceding","recipient","recipientTimestampPlanned","shipmentId","splittingAllowed"],"type":"object","properties":{"handlingUnits":{"type":"array","items":{"required":["amount","batches","handlingUnitId","name","volume","weight"],"type":"object","properties":{"name":{"type":"string"},"volume":{"type":"number"},"weight":{"type":"number"},"batches":{"type":"array","items":{"required":["batchExpirationTimestamp","batchId","batchNumber","batchOrderId","materialHazardousGoods","materialName","materialNumber","quantity","unitOfMeasurement"],"type":"object","properties":{"unitOfMeasurement":{"type":"string"},"materialName":{"type":"string"},"quantity":{"type":"number"},"materialNumber":{"type":"string"},"materialHazardousGoods":{"type":"boolean"},"batchOrderId":{"type":"string"},"batchId":{"type":"string"},"batchExpirationTimestamp":{"type":"string"},"batchNumber":{"type":"string"}}}},"handlingUnitId":{"type":"string"},"amount":{"type":"integer"}}}},"shipmentId":{"type":"string"},"recipientTimestampPlanned":{"type":"string"},"destination":{"type":"object"},"recipient":{"type":"object"},"logistics":{"type":"object"},"preceding":{"type":"object"},"splittingAllowed":{"type":"boolean"},"destinationTimestamp":{"type":"string"}}}},"timestamp":{"type":"string"}}},"resultOwnSimRunUpdated":{"required":["comment","dataQuality","description","expirationTimestamp","owner","runId","shipments","timestamp"],"type":"object","properties":{"owner":{"type":"object"},"dataQuality":{"type":"integer"},"description":{"type":"string"},"comment":{"type":"string"},"expirationTimestamp":{"type":"string"},"runId":{"type":"string"},"shipments":{"type":"array","items":{"required":["destination","destinationTimestamp","handlingUnits","logistics","preceding","recipient","recipientTimestampPlanned","shipmentId","splittingAllowed"],"type":"object","properties":{"handlingUnits":{"type":"array","items":{"required":["amount","batches","handlingUnitId","name","volume","weight"],"type":"object","properties":{"name":{"type":"string"},"volume":{"type":"number"},"weight":{"type":"number"},"batches":{"type":"array","items":{"required":["batchExpirationTimestamp","batchId","batchNumber","batchOrderId","materialHazardousGoods","materialName","materialNumber","quantity","unitOfMeasurement"],"type":"object","properties":{"unitOfMeasurement":{"type":"string"},"materialName":{"type":"string"},"quantity":{"type":"number"},"materialNumber":{"type":"string"},"materialHazardousGoods":{"type":"boolean"},"batchOrderId":{"type":"string"},"batchId":{"type":"string"},"batchExpirationTimestamp":{"type":"string"},"batchNumber":{"type":"string"}}}},"handlingUnitId":{"type":"string"},"amount":{"type":"integer"}}}},"shipmentId":{"type":"string"},"recipientTimestampPlanned":{"type":"string"},"destination":{"type":"object"},"recipient":{"type":"object"},"logistics":{"type":"object"},"preceding":{"type":"object"},"splittingAllowed":{"type":"boolean"},"destinationTimestamp":{"type":"string"}}}},"timestamp":{"type":"string"}}}}},"scenarioParameter":{"required":["materialName","materialNumber","parameterComment","parameterDeliveryDateInitial","parameterDeliveryDateUpdated","parameterId","parameterOrderId","parameterQuantityInitial","parameterQuantityUpdated","parameterScenario","unitOfMeasurement"],"type":"object","properties":{"unitOfMeasurement":{"type":"string"},"parameterScenario":{"type":"string"},"parameterComment":{"type":"string"},"materialName":{"type":"string"},"parameterQuantityUpdated":{"type":"number"},"parameterId":{"type":"string"},"materialNumber":{"type":"string"},"parameterDeliveryDateUpdated":{"type":"string"},"parameterDeliveryDateInitial":{"type":"string"},"parameterOrderId":{"type":"string"},"parameterQuantityInitial":{"type":"number"}}},"scenarioHeader":{"required":["scenarioCreationTimestamp","scenarioDescription","scenarioExpirationTimestamp","scenarioId","scenarioOwner","scenarioOwnerRole","scenarioTitle"],"type":"object","properties":{"scenarioOwnerRole":{"type":"string"},"scenarioCreationTimestamp":{"type":"string"},"scenarioExpirationTimestamp":{"type":"string"},"scenarioOwner":{"type":"string"},"scenarioDescription":{"type":"string"},"scenarioId":{"type":"string"},"scenarioTitle":{"type":"string"}}}}}}},"examples":{"0":{"value":"{\n \"materialFlowScenarioRequest\" : {\n \"scenarioSimResults\" : {\n \"resultOwnId\" : \"916b5688-8bd8-4d7e-83b9-e0d40939274e\",\n \"resultOwnSimRunInitial\" : {\n \"owner\" : { },\n \"dataQuality\" : 0,\n \"description\" : \"Please simulate asap\",\n \"comment\" : \"successful simulation \",\n \"expirationTimestamp\" : \"2023-03-24T09:15:24.000Z\",\n \"runId\" : \"0fece48b-c8d1-4180-1a9caca6d67e\",\n \"shipments\" : [ {\n \"handlingUnits\" : [ {\n \"name\" : \"Palette\",\n \"volume\" : 1.0,\n \"weight\" : 189.0,\n \"batches\" : [ {\n \"unitOfMeasurement\" : \"KG\",\n \"materialName\" : \"KK1000GR-Gehäuse-Rot\",\n \"quantity\" : 50.0,\n \"materialNumber\" : \"KK1000GR\",\n \"materialHazardousGoods\" : false,\n \"batchOrderId\" : \"Order-0001\",\n \"batchId\" : \"Batch_1\",\n \"batchExpirationTimestamp\" : \"2023-08-22T16:00:00.000Z\",\n \"batchNumber\" : \"45\"\n } ],\n \"handlingUnitId\" : \"HUT_1\",\n \"amount\" : 1\n } ],\n \"shipmentId\" : \"DE51515151\",\n \"recipientTimestampPlanned\" : \"2023-04-19T09:00:00.000Z\",\n \"destination\" : { },\n \"recipient\" : { },\n \"logistics\" : { },\n \"preceding\" : { },\n \"splittingAllowed\" : true,\n \"destinationTimestamp\" : \"2023-03-19T09:00:00.000Z\"\n } ],\n \"timestamp\" : \"2023-03-09T14:13:42.806Z\"\n },\n \"resultOwnSimRunUpdated\" : {\n \"owner\" : { },\n \"dataQuality\" : 0,\n \"description\" : \"Please simulate asap\",\n \"comment\" : \"successful simulation \",\n \"expirationTimestamp\" : \"2023-03-24T09:15:24.000Z\",\n \"runId\" : \"0fece48b-c8d1-4180-1a9caca6d67e\",\n \"shipments\" : [ {\n \"handlingUnits\" : [ {\n \"name\" : \"Palette\",\n \"volume\" : 1.0,\n \"weight\" : 189.0,\n \"batches\" : [ {\n \"unitOfMeasurement\" : \"KG\",\n \"materialName\" : \"KK1000GR-Gehäuse-Rot\",\n \"quantity\" : 50.0,\n \"materialNumber\" : \"KK1000GR\",\n \"materialHazardousGoods\" : false,\n \"batchOrderId\" : \"Order-0001\",\n \"batchId\" : \"Batch_1\",\n \"batchExpirationTimestamp\" : \"2023-08-22T16:00:00.000Z\",\n \"batchNumber\" : \"45\"\n } ],\n \"handlingUnitId\" : \"HUT_1\",\n \"amount\" : 1\n } ],\n \"shipmentId\" : \"DE51515151\",\n \"recipientTimestampPlanned\" : \"2023-04-19T09:00:00.000Z\",\n \"destination\" : { },\n \"recipient\" : { },\n \"logistics\" : { },\n \"preceding\" : { },\n \"splittingAllowed\" : true,\n \"destinationTimestamp\" : \"2023-03-19T09:00:00.000Z\"\n } ],\n \"timestamp\" : \"2023-03-09T14:13:42.806Z\"\n }\n },\n \"scenarioParameter\" : {\n \"unitOfMeasurement\" : \"KG\",\n \"parameterScenario\" : \"8d464b8b-6977-4952-8a22-0489067ca081\",\n \"parameterComment\" : \"updated Delivery Date\",\n \"materialName\" : \"KK1000GR-Gehäuse-Rot\",\n \"parameterQuantityUpdated\" : 1.0,\n \"parameterId\" : \"847c71e5-614a-468b-a3a0-674bf2af3004\",\n \"materialNumber\" : \"KK1000GR\",\n \"parameterDeliveryDateUpdated\" : \"2023-10-10T09:00:00.000Z\",\n \"parameterDeliveryDateInitial\" : \"2023-10-09T10:00:00.000Z\",\n \"parameterOrderId\" : \"OID-011123456\",\n \"parameterQuantityInitial\" : 1.0\n },\n \"scenarioHeader\" : {\n \"scenarioOwnerRole\" : \"Customer\",\n \"scenarioCreationTimestamp\" : \"2023-10-04T09:10:00.000Z\",\n \"scenarioExpirationTimestamp\" : \"2023-10-07T09:10:00.000Z\",\n \"scenarioOwner\" : \"BPNS0000007OTZ3\",\n \"scenarioDescription\" : \"Changes in Delivery Date\",\n \"scenarioId\" : \"8d464b8b-6977-4952-8a22-0489067ca081\",\n \"scenarioTitle\" : \"Delivery Modification\"\n }\n }\n}"}}}}},"responses":{"200":{"description":"OK","content":{"text":{"schema":{"type":"string","example":"The request has succeeded. The requestScenarioFeedback has been successfully processed in the backend system."}}}},"400":{"description":"Bad request","content":{"text":{"schema":{"type":"string","example":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)."}}}},"401":{"description":"Unauthorized","content":{"text":{"schema":{"type":"string","example":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response."}}}},"402":{"description":"Unknown BPNS","content":{"text":{"schema":{"type":"string","example":"The BPNS which is given as parameter is not registered in the data provider database as a direct partner."}}}},"403":{"description":"Forbidden","content":{"text":{"schema":{"type":"string","example":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource."}}}},"405":{"description":"Method not allowed","content":{"text":{"schema":{"type":"string","example":"The method used to request a scenario feedback was not POST"}}}},"500":{"description":"Internal server error","content":{"text":{"schema":{"type":"string","example":"The server has encountered a situation it does not know how to handle."}}}},"501":{"description":"Service unavailable","content":{"text":{"schema":{"type":"string","example":"The server is not ready to handle the request."}}}}},"servers":[{"url":"https://{server-url}"}],"method":"post","path":"/api/requestScenarioFeedback/bpns/{bpns}","jsonRequestBodyExample":{"materialFlowScenarioRequest":{"scenarioSimResults":{"resultOwnId":"string","resultOwnSimRunInitial":{"owner":{},"dataQuality":0,"description":"string","comment":"string","expirationTimestamp":"string","runId":"string","shipments":[{"handlingUnits":[{"name":"string","volume":0,"weight":0,"batches":[{"unitOfMeasurement":"string","materialName":"string","quantity":0,"materialNumber":"string","materialHazardousGoods":true,"batchOrderId":"string","batchId":"string","batchExpirationTimestamp":"string","batchNumber":"string"}],"handlingUnitId":"string","amount":0}],"shipmentId":"string","recipientTimestampPlanned":"string","destination":{},"recipient":{},"logistics":{},"preceding":{},"splittingAllowed":true,"destinationTimestamp":"string"}],"timestamp":"string"},"resultOwnSimRunUpdated":{"owner":{},"dataQuality":0,"description":"string","comment":"string","expirationTimestamp":"string","runId":"string","shipments":[{"handlingUnits":[{"name":"string","volume":0,"weight":0,"batches":[{"unitOfMeasurement":"string","materialName":"string","quantity":0,"materialNumber":"string","materialHazardousGoods":true,"batchOrderId":"string","batchId":"string","batchExpirationTimestamp":"string","batchNumber":"string"}],"handlingUnitId":"string","amount":0}],"shipmentId":"string","recipientTimestampPlanned":"string","destination":{},"recipient":{},"logistics":{},"preceding":{},"splittingAllowed":true,"destinationTimestamp":"string"}],"timestamp":"string"}},"scenarioParameter":{"unitOfMeasurement":"string","parameterScenario":"string","parameterComment":"string","materialName":"string","parameterQuantityUpdated":0,"parameterId":"string","materialNumber":"string","parameterDeliveryDateUpdated":"string","parameterDeliveryDateInitial":"string","parameterOrderId":"string","parameterQuantityInitial":0},"scenarioHeader":{"scenarioOwnerRole":"string","scenarioCreationTimestamp":"string","scenarioExpirationTimestamp":"string","scenarioOwner":"string","scenarioDescription":"string","scenarioId":"string","scenarioTitle":"string"}}},"info":{"title":"OSim API","description":"Osim API for requesting and receiving simulation results as well as for interactions related to scenario management.","version":"2.0.0"},"postman":{"name":"request Scenario Feedback","description":{"content":"The requestScenarioFeedback is a request from a OSim partner for feedback on the possible fulfillment of the described scenario.","type":"text/plain"},"url":{"path":["api","requestScenarioFeedback","bpns",":bpns"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"bpns"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "post api-method" -info_path: docs-kits/kits/OSim Kit/Software Development View//osim-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## requestScenarioFeedback - - - -The requestScenarioFeedback is a request from a OSim partner for feedback on the possible fulfillment of the described scenario. - -
Path Parameters
Request Body
    materialFlowScenarioRequest object required
    scenarioSimResults object required
    resultOwnSimRunInitial object required
    shipments object[] required
    handlingUnits object[] required
    batches object[] required
    resultOwnSimRunUpdated object required
    shipments object[] required
    handlingUnits object[] required
    batches object[] required
    scenarioParameter object required
    scenarioHeader object required
- -OK - -
Schema
  • string
- -Bad request - -
Schema
  • string
- -Unauthorized - -
Schema
  • string
- -Unknown BPNS - -
Schema
  • string
- -Forbidden - -
Schema
  • string
- -Method not allowed - -
Schema
  • string
- -Internal server error - -
Schema
  • string
- -Service unavailable - -
Schema
  • string
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/Software Development View/sidebar.js b/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/Software Development View/sidebar.js deleted file mode 100644 index 4b9d63c21a8..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/Software Development View/sidebar.js +++ /dev/null @@ -1,88 +0,0 @@ -module.exports = [ - { type: 'doc', id: 'kits/OSim Kit/Software Development View//osim-api' }, - { - type: 'category', - label: 'requestLatestSimulationResult', - link: { - type: 'generated-index', - title: 'requestLatestSimulationResult', - slug: '/category/kits/OSim Kit/Software Development View/request-latest-simulation-result', - }, - items: [ - { - type: 'doc', - id: 'kits/OSim Kit/Software Development View//request-latest-simulation-result', - label: 'requestLatestSimulationResult', - className: 'api-method get', - }, - ], - }, - { - type: 'category', - label: 'receiveLatestSimulationResult', - link: { - type: 'generated-index', - title: 'receiveLatestSimulationResult', - slug: '/category/kits/OSim Kit/Software Development View/receive-latest-simulation-result', - }, - items: [ - { - type: 'doc', - id: 'kits/OSim Kit/Software Development View//receive-latest-simulation-result', - label: 'receiveLatestSimulationResult', - className: 'api-method post', - }, - ], - }, - { - type: 'category', - label: 'requestScenarioFeedback', - link: { - type: 'generated-index', - title: 'requestScenarioFeedback', - slug: '/category/kits/OSim Kit/Software Development View/request-scenario-feedback', - }, - items: [ - { - type: 'doc', - id: 'kits/OSim Kit/Software Development View//request-scenario-feedback', - label: 'requestScenarioFeedback', - className: 'api-method post', - }, - ], - }, - { - type: 'category', - label: 'receiveScenarioFeedback', - link: { - type: 'generated-index', - title: 'receiveScenarioFeedback', - slug: '/category/kits/OSim Kit/Software Development View/receive-scenario-feedback', - }, - items: [ - { - type: 'doc', - id: 'kits/OSim Kit/Software Development View//receive-scenario-feedback', - label: 'receiveScenarioFeedback', - className: 'api-method get', - }, - ], - }, - { - type: 'category', - label: 'pushScenarioState', - link: { - type: 'generated-index', - title: 'pushScenarioState', - slug: '/category/kits/OSim Kit/Software Development View/push-scenario-state', - }, - items: [ - { - type: 'doc', - id: 'kits/OSim Kit/Software Development View//push-scenario-state', - label: 'pushScenarioState', - className: 'api-method get', - }, - ], - }, -]; diff --git a/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/page_changelog.md b/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/page_changelog.md deleted file mode 100644 index 955b6baccd2..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/page_changelog.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -id: OSim Kit Changelog -title: Changelog -description: 'OSim Kit' -sidebar_position: 1 ---- - -![osim kit banner](@site/static/img/OSimKitIcon.svg) - -### OSim Kit - -All notable changes to this Kit will be documented in this file. - -## [2.0.0] – 2024-03-08 - -### Added - -Additionally to the “simulation flow” released in the version 1.0.0 this version was extended by “scenario flow” - -- Adoption View: - - Business process for scenario related data exchange - - MaterialFlowScenarioRequest aspect model -- Development View: - - requestScenarioFeedback API - - receiveScenarioFeedback API - - pushScenarioState API - -### Changed - -- n/a - -### Removed - -- n/a - -## [1.0.0] - 2023-08-18 - -### Added - -- Initial version of the Kit including adoption and development view - -### Changed - -- ./. - -### Removed - -- ./. diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/Software Development View/page_software-development-view.md b/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/Software Development View/page_software-development-view.md deleted file mode 100644 index 2e646163a7f..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/Software Development View/page_software-development-view.md +++ /dev/null @@ -1,260 +0,0 @@ ---- -id: Specification -title: Specification -description: 'PCF-Exchange-KIT' -sidebar_position: 3 ---- - -![PCF Exchange kit banner](/img/kit-icons/pcf-kit-icon.svg) - -## Introduction - -The developer view provides a detailed guide on how to utilize the PCF exchange KIT effectively. Developer will learn how to integrate the kit into there applications and make use of the feature of exchanging PCF values via the Catena-X network. -IT-Administrators will learn how they need to provide PCF data and which components are needed therefore. - -This Kit covers various aspects, starting from how utilize the available API Endpoints, the used data models and how to make them available to the Catena-X network. - -## Building Block View - -The following figure shows the current high level architecture of the use case PCF exchange. It is build on an asynchronous data exchange. - -![Building Block View](../resources/development-view/BuildingblockView.png) - -## Sequence View - -The following chapter illustrates the process from searching for an EDC point, to querying a PCF value, and finally transmitting the requested value. - -### EDC Discovery and dDTR Access - -For receiving the EDC Endpoints for a requested partner, the EDC Discovery Service is used, following the [CX-0001]([test](https://catena-x.net/de/standard-library)) Standard. For receiving endpoints, at least the BPN-L needs to be known to get the related endpoints. For more details the used Catena-X Standard is linked. - -![EDCDiscoveryAndDTRAccess](../resources/development-view/EDCDiscoveryanddDTRAccess.png) - -### PCF Request - -To actual request PCF values via the PCF API endpoint first of all the EDC PCF asset needs to be identified. Therefore the decentralized Digital Twin Registry (dDTR) is used. Data provider must register their dDTR(s) as EDC assets following the CX-0002 standard. After identifying the dDTR the Digital Twin with the related PCF submodel can be looked up (see [API calls [0003 +0004]](#api-calls)). An example is documented [here](#payload-for-requesting-pcf-sub-model). - -After successfully locating the corresponding material twin containing a PCF submodel, the EDC asset containing the PCF request endpoint cen be extracted (Example Payload can be found [here](#payload-for-edc-data-asset-pcf)) and the query for a PCF dataset can be initiated, as illustrated in the attached sequence diagram. - -![PCF Request](../resources/development-view/PCFRequestthroughAAS.png) - -In case no matching material twin or PCF submodel exists, the flow falls back to a direct lookup of an EDC asset containing the PCF request endpoint provided within the offers of any EDC registered for the Data provider's BPNL. - -![PCF Request without Twin or Submodel](../resources/development-view/PCFRequestWithoutTwinOrSubmodel.png) - ->**Note** -> The API Wrapper shown in the sequence diagrams is optional. The management API of the EDC can also be used directly. - -### PCF Update - -The sequence diagram provided below presents an example of a PCF update flow. An update is feasible only for assets that have been previously requested at least once, as demonstrated in [PCF Request](#sequence-view). Proactive updates without a prior request are not achievable with the current version. - -![PCF Update](../resources/development-view/PCFUpdatePushedThroughEDC.png) - -#### API Calls - -| Call | Method | Path | Param | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------| -| [001](https://eclipse-tractusx.github.io/docs-kits/next/kits/Digital%20Twin%20Kit/Software%20Development%20View/API%20EDC%20Discovery/post-list-of-bpns-or-an-empty-array-to-retrieve-available-company-connector-authorization-required-roles-view-connectors) (Look up EDC Endpoints) | POST | /api/administration/Connectors/discovery/ | `[]` | -| [002](https://eclipse-tractusx.github.io/docs-kits/next/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/catalog) (Look up dDTR) | POST | /v2/catalog/request | --> Lookup Asset in the EDC catalog (EDC asset type data.core.digitalTwinRegistry) | -| [003](https://eclipse-tractusx.github.io/docs-kits/next/kits/Digital%20Twin%20Kit/Software%20Development%20View/API%20AAS%20Discovery/get-all-asset-administration-shell-ids-by-asset-link) (Lookup Twin ID) | GET | /lookup/shells | `assetIds= [{"key": "manufacturerPartId", "value":"mat345",{"key":"digitalTwinType", "value": "PartType"}}]` | -| [004](https://eclipse-tractusx.github.io/docs-kits/next/kits/Digital%20Twin%20Kit/Software%20Development%20View/API%20AAS%20Registry/get-all-asset-administration-shell-descriptors) (Look Up PCF Submodel/EDC Asset ID) | GET | /shell-descriptors | `{DIGITAL TWIN ID}` | -| [005](../resources/development-view/catena-x-pcf-endpoint-1_1_0.yaml) (Requesting PCF Value) | GET | /productIds | {productId} | -| [006](../resources/development-view/catena-x-pcf-endpoint-1_1_0.yaml) (Sending PCF Value) | PUT | /productIds | {productId} | - -- The assetIds under [003] must be base64 encoded! -- When responding on PCF exchange request the "requestID" is mandatory in the PUT call. -- When sharing a PCF update the "requestID" is NOT allowed in the PUT call. -- The EDC asset used to receive PCF is NOT looked up through AAS, but identified by type ("data.pcf.exchangeEndpoint"). -- The Open API specification defining all mandatory PCF Exchange endpoints and the da structures transfered through those can be found [here](../resources/development-view/catena-x-pcf-endpoint-1_1_0.yaml) - -##### Payload for Requesting PCF Sub Model - -The following JSON shows the structure of a registered PCF submodel in the DTR. The subprotocolBody is used for asset bundling. For this, the CX Standard [CX-0002](https://catena-x.net/en/standard-library) is to be followed. - -The digital twin id can be searched via the `manufacturerPartId` and the ``digitalTwinType:"PartType"``. - -The sub-model PCF must be registered with the ``idshort: PCFExchangeEndpoint``. - -```json -{ - "description": [ - { - "language": "en", - "text": "PCF endpoint for material 'mat345'" - } - ], - "idShort": "PCFExchangeEndpoint", - "identification": "urn:uuid:205cf8d1-8f07-483c-9c5b-c8d706c7d05d", - "semanticId": { - "type": "ExternalReference", - "keys": [ - { - "type": "GlobalReference", - "value": "urn:samm:io.catenax.pcf:6.0.0#Pcf" - } - ] - }, - "endpoints": [ - { - "interface": "PCF-1.1", - "protocolInformation": { - "href": "https://edc.data.plane/productIds/mat345", - "endpointProtocol": "HTTP", - "endpointProtocolVersion": ["1.1"], - "subprotocol": "DSP", - "subprotocolBody": "id=c34018ab-5820-4065-9087-416d78e1ab60;dspEndpoint=https://some.controlplane.url:7173/api/v1/dsp", - "subprotocolBodyEncoding": "plain" - } - } - ] -} -``` - -#### Payloads for EDC Asset - -##### Payload for EDC Data Asset PCF - -The following JSON shows the the EDC Asset for PCF defined in the EDC using the asset bundling mentioned under [Payload for Requesting PCF Sub Model](#api-calls). - -```json -{ - "@context": { - "edc": "https://w3id.org/edc/v0.0.1/ns/", - "odrl": "http://www.w3.org/ ns/odrl/2/", - "dcat": "http://www.w3.org/ns/dcat#", - "dct": "http://purl.org/dc/terms/", - "rdfs": "http://www.w3.org/2000/01/rdf-schema#", - "cx-taxo": "https://w3id.org/catenax/taxonomy#", - "cx-common": "https://w3id.org/catenax/ontology/common#", - "aas-semantics": "https://admin-shell.io/aas/3/0/HasSemantics/" - }, - "@id": "c34018ab-5820-4065-9087-416d78e1ab60", - "@type": "edc:Asset", - "edc:properties": { - "rdfs:label": "PCF Data", - "rdfs:comment": "Endpoint for PCF data", - "cx-common:version": "1.1", - "aas-semantics:semanticId": {"@id":"urn:samm:io.catenax.pcf:6.0.0#Pcf"}, - "edc:contentType": "application/json", - "dct:type": {"@id":"cx-taxo:PcfExchange"} - }, - "edc:dataAddress": { - "edc:type": "HttpData", - "edc:baseUrl": "https://some.url/service", - "edc:proxyBody": "true", - "edc:proxyPath": "true", - "edc:proxyQueryParams": "true", - "edc:proxyMethod": "true", - "edc:contentType": "application/json" - } -} -``` - -#### Payload for EDC Policy - -The following JSON is an policy definition including the policiy credentials for "active membership", "frameworkagreement pcf" and "pcf base usage purpose". The [frameworkagreement document](https://catena-x.net/fileadmin/user_upload/04_Einfuehren_und_umsetzen/Governance_Framework/231016_Catena-X_Use_Case_Framework_PCF.pdf) is published via the association and are available via the Catena-X homepage. The membership credential is automatically created after finishing successfully the onboarding process. - -##### Payload to create a SSI based Policy - -```json -{ - "@context": { - "@vocab": "https://w3id.org/edc/v0.0.1/ns/" - }, - "@id": "", - "policy": { - "@context": [ - "https://www.w3.org/ns/odrl.jsonld", - { - "cx-policy": "https://w3id.org/catenax/policy/v1.0.0/" - } - ], - "@type": "Policy", - "profile": "cx-policy:profile2405", - "permission": [ - { - "action": "use", - "constraint": { - "and": [ - { - "leftOperand": "cx-policy:Membership", - "operator": "eq", - "rightOperand": "active" - }, - { - "leftOperand": "cx-policy:FrameworkAgreement", - "operator": "eq", - "rightOperand": "pcf:1.0" - }, - { - "leftOperand": "cx-policy:UsagePurpose", - "operator": "eq", - "rightOperand": "cx.pcf.base:1" - } - ] - } - } - ] - } -} -``` - -For more examples how to define policies with SSI have a look [here](https://github.com/eclipse-tractusx/ssi-docu/blob/main/docs/architecture/cx-3-2/edc/policy.definitions.md). - -#### Payload Contract Definition - -```json -{ - "@id": "54ef3326-42b2-4221-8c5a-3a6270d54db8", - "edc:accessPolicyId": "a343fcbf-99fc-4ce8-8e9b-148c97605aab", - "edc:contractPolicyId": "a343fcbf-99fc-4ce8-8e9b-148c97605aab", - "edc:assetsSelector":[ - { - "@type": "Criterion", - "edc:operandLeft": "@id", - "edc:operator": "=", - "edc:operandRight": "c34018ab-5820-4065-9087-416d78e1ab60" - } - ] -} -``` - -## Error Handling - -In case no material twin or no PCF submodel is found, EDC Asset type has to be used to find the Endpoint needed to perform the PCF request. - -## Standards - -### Used CX Standards - -- [CX-0001 EDC Discovery API v1.0.2](https://catena-x.net/en/standard-library) -- [CX-0002 Digital Twins in Catena-X v2.2.0](https://catena-x.net/en/standard-library) -- [CX-0003 SAMMSemanticAspectMetaModel v1.1.0](https://catena-x.net/en/standard-library) -- [CX-0018 Eclipse Data Space Connector (EDC) v3.0.0](https://catena-x.net/en/standard-library) -- [CX-0126-Industry Core: Part Type v2.0.0](https://catena-x.net/en/standard-library) -- [CX-0136 PCF UseCase v1.0.0](https://catena-x.net/en/standard-library) - -## Other Standards - -- [Pathfinder Framework - v2.0.0](https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221) - -## NOTICE - -This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - -- SPDX-License-Identifier: CC-BY-4.0 -- SPDX-FileCopyrightText: 2023, 2024 ZF Friedrichshafen AG -- SPDX-FileCopyrightText: 2023, 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -- SPDX-FileCopyrightText: 2023, 2024 T-Systems International GmbH -- SPDX-FileCopyrightText: 2023, 2024 SAP SE -- SPDX-FileCopyrightText: 2023, 2024 SIEMENS AG -- SPDX-FileCopyrightText: 2023, 2024 SUPPLY ON AG -- SPDX-FileCopyrightText: 2023, 2024 Volkswagen AG -- SPDX-FileCopyrightText: 2023, 2024 Robert Bosch GmbH -- SPDX-FileCopyrightText: 2023, 2024 Mercedes Benz Group -- SPDX-FileCopyrightText: 2023, 2024 BASF SE -- SPDX-FileCopyrightText: 2023, 2024 CCT -- SPDX-FileCopyrightText: 2023, 2024 Gris Group -- SPDX-FileCopyrightText: 2023, 2024 Contributors to the Eclipse Foundation -- [Source URL](https://github.com/eclipse-tractusx/pcf-exchange-kit) diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/catena-x-pcf-request-endpoint.info.mdx b/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/catena-x-pcf-request-endpoint.info.mdx deleted file mode 100644 index b5ee8b66ba8..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/catena-x-pcf-request-endpoint.info.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -id: catena-x-pcf-request-endpoint -title: "Catena-X-pcf-request-endpoint" -description: " A API for request, send and update PCF data" -sidebar_label: Introduction -sidebar_position: 0 -hide_title: true -custom_edit_url: null ---- - -import ApiLogo from "@theme/ApiLogo"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiDemoPanel/Export"; - -Version: 1.1.0 - -# Catena-X-pcf-request-endpoint - - -An API to request, send and update PCF data via the Catena-X Network. diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/get-pcf.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/get-pcf.api.mdx deleted file mode 100644 index a1bf2ef1cbc..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/get-pcf.api.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: get-pcf -title: "get_pcf" -description: "get_pcf" -sidebar_label: "get_pcf" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"get_pcf","parameters":[{"name":"Edc-Bpn","description":"The caller's Catena-X BusinessPartnerNumber","example":"BPNL0000005AMPL3","in":"header","required":true,"schema":{"type":"string"}},{"name":"productId","description":"ID of the product/materiual the PCF is requested for","example":"urn:id:8534x67","in":"path","required":true,"schema":{"type":"string"}},{"name":"requestId","description":"ID identifying the call (will be referenced in corresponding PCF response)","example":"2daa49aa-ee16-4df3-bca3-69ddead40419","in":"query","required":true,"schema":{"type":"string"}},{"name":"message","in":"query","required":false,"description":"URL encoded, max 250 chars","example":"No%20offset%20included%2C%20please%21","schema":{"type":"string"}}],"responses":{"202":{"description":"PCF was accepted. PCF will be sent later via to POST endpoint."}},"description":"get_pcf","method":"get","path":"/productIds/{productId}","info":{"title":"Catena-X-pcf-request-endpoint","version":"1.1.0"},"postman":{"name":"get pcf","description":{"type":"text/plain"},"url":{"path":["productIds",":productId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ID identifying the call (will be referenced in corresponding PCF response)","type":"text/plain"},"key":"requestId","value":""},{"disabled":false,"description":{"content":"URL encoded, max 250 chars","type":"text/plain"},"key":"message","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the product/materiual the PCF is requested for","type":"text/plain"},"type":"any","value":"","key":"productId"}]},"header":[{"disabled":false,"description":{"content":"(Required) The caller's Catena-X BusinessPartnerNumber","type":"text/plain"},"key":"Edc-Bpn","value":""}],"method":"GET"}} -sidebar_class_name: "get api-method" -info_path: docs-kits/kits/PCF-Exchange-Kit/Software-Development-View/pcf-exchange-api//catena-x-pcf-request-endpoint -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## get_pcf - - - -get_pcf - -
Path Parameters
Query Parameters
Header Parameters
- -PCF was accepted. PCF will be sent later via to POST endpoint. - -
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/set-pcf.api.mdx b/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/set-pcf.api.mdx deleted file mode 100644 index e154ee4c9d2..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/set-pcf.api.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: set-pcf -title: "set_pcf" -description: "set_pcf" -sidebar_label: "set_pcf" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"set_pcf","parameters":[{"name":"Edc-Bpn","description":"The caller's Catena-X BusinessPartnerNumber","example":"BPNL0000005AMPL3","in":"header","required":true,"schema":{"type":"string"}},{"name":"productId","description":"ID of the product/materiual the PCF referring to","example":"urn:id:8534x67","in":"path","required":true,"schema":{"type":"string"}},{"name":"requestId","description":"ID identifying the request call (same as within original PCF request), if the PUT is responing to a call. Can be dismissed in a PCF update call.","example":"2daa49aa-ee16-4df3-bca3-69ddead40419","in":"query","required":false,"schema":{"type":"string"}}],"requestBody":{"description":"The requested PCF in WBCSD format","required":true,"content":{"application/json":{"schema":{"description":"A Product (Carbon) Footprint represents the carbon footprint of a product with values as specified in the Catena-X PCF Rulebook in accordance with the WBCSD (World Business Council for Sustainable Development) Pathfinder framework and the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD/ PACT initiative.","type":"object","properties":{"id":{"description":"Mandatory: The product footprint identifier as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","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}$)"},"specVersion":{"description":"Mandatory: Version of the product footprint data specification as defined in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string"},"partialFullPcf":{"description":"Mandatory: Indicator for partial or full PCF (Product Carbon Footprint) declaration as specified in the Catena-X PCF Rulebook.","type":"string","enum":["Cradle-to-gate","Cradle-to-grave"]},"precedingPfIds":{"description":"Optional: Set of preceding PCF (Product Carbon Footprint) identifiers without duplicates as specified in the Catena-X PCF Rulebook in accordance with the WBCSD (World Business Council for Sustainable Development) Pathfinder framework and the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD/ PACT initiative. Declared as \"optional\" in WBCSD, needs to be covered by application.","type":"array","items":{"description":"Entity for defining a preceding PCF (Product Carbon Footprint) identifier entity as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"object","properties":{"id":{"description":"Mandatory: The product footprint identifier as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","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}$)"}},"required":["id"]}},"version":{"description":"Mandatory: Version of the product (carbon) footprint as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example set to \"0\" per default.","type":"number","minimum":0},"created":{"description":"Mandatory: Timestamp of the creation of the Product (Carbon) Footprint as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","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))?"},"extWBCSD_pfStatus":{"description":"Mandatory: Status indicator of a product (carbon) footprint as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example set to \"Active\" per default.","type":"string","enum":["Active","Deprecated"]},"validityPeriodStart":{"description":"Optional: Start of interval during which the product (carbon) footprint is declared as valid as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. If specified, the validity period start must be equal to or greater than the reference period end.","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))?"},"validityPeriodEnd":{"description":"Optional: End of interval during which the product (carbon) footprint is declared as valid as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","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))?"},"comment":{"description":"Optional: Additional information and instructions related to the calculation of the product (carbon) footprint as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string"},"companyName":{"description":"Mandatory: Name of the product (carbon) footprint data owner as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","minLength":1},"companyIds":{"description":"Mandatory: Non-empty set of Uniform Resource Names (URN). Each value is supposed to uniquely identify the product (carbon) footprint data owner as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. For Catena-X Industry Core compliance the set of URNs must contain at least the Business Partner Number Legal Entity (BPNL) in the specified format urn:bpn:id:BPNL[a-zA-Z0-9]{12}. ","type":"array","items":{"type":"string","format":"uri"},"minItems":1},"productDescription":{"description":"Optional: Free-form description of the product as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string"},"productIds":{"description":"Mandatory: Non-empty set of product identifiers. Each value is supposed to uniquely identify the product as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X productId corresponds with Industry Core manufacturerPartId.","type":"array","items":{"type":"string","format":"uri"},"minItems":1},"extWBCSD_productCodeCpc":{"description":"Mandatory: UN (United Nations) Product Classification Code (CPC - Central Classification Code) of a given product as specified the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, which will probably be declared as \"optional\" in a later WBCSD specification version. In Catena-X for example specified with default value \"011-99000\".","type":"string"},"productName":{"description":"Mandatory: Non-empty trade name of a product as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X productNameCompany corresponds with Industry Core nameAtManufacturer. ","type":"string","minLength":1},"pcf":{"description":"A PCF (Product Carbon Footprint) represents the carbon footprint of a product and related data as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"object","properties":{"declaredUnit":{"description":"Mandatory: Unit of analysis of a product in context of the PCF (product carbon footprint) as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example list of valid units includes \"piece\".","type":"string","enum":["liter","kilogram","cubic meter","kilowatt hour","megajoule","ton kilometer","square meter","piece"]},"unitaryProductAmount":{"description":"Mandatory: Amount of units contained within a product in context of the PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","minimum":0,"exclusiveMinimum":true},"productMassPerDeclaredUnit":{"description":"Mandatory: Mass of a product per declared unit in context of the PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook.","type":"number","minimum":0,"exclusiveMinimum":false},"exemptedEmissionsPercent":{"description":"Mandatory: Percentage of emissions excluded from PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","maximum":5,"exclusiveMaximum":false,"minimum":0,"exclusiveMinimum":false},"exemptedEmissionsDescription":{"description":"Optional: Rationale behind exclusion of specific PCF (Product Carbon Footprint) emissions as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string"},"boundaryProcessesDescription":{"description":"Optional: Processes attributable to each lifecycle stage as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string"},"geographyCountrySubdivision":{"description":"Optional: Subdivision of a country which must be an ISO 3166-2 subdivision code as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","pattern":"([A-Z]{2}-[A-Z0-9]{1,3}|)"},"geographyCountry":{"description":"Optional: Two letter country code that must conform to data type ISO 3166CC as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","pattern":"([A-Z]{2})"},"geographyRegionOrSubregion":{"description":"Mandatory: Region according to list as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","enum":["Africa","Americas","Asia","Europe","Oceania","Australia and New Zealand","Central Asia","Eastern Asia","Eastern Europe","Latin America and the Caribbean","Melanesia","Micronesia","Northern Africa","Northern America","Northern Europe","Polynesia","South-eastern Asia","Southern Asia","Southern Europe","Sub-Saharan Africa","Western Asia","Western Europe","Global"]},"referencePeriodStart":{"description":"Mandatory: Start of time boundary for which a PCF (Product Carbon Footprint) value is considered to be representative as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","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))?"},"referencePeriodEnd":{"description":"Mandatory: End of time boundary for which a PCF (Product Carbon Footprint) value is considered to be representative as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","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))?"},"crossSectoralStandardsUsed":{"description":"Mandatory: Discloses the cross-sectoral standards applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"array","items":{"description":"Entity for defining an accounting standard used for product carbon footprint calculation as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"object","properties":{"crossSectoralStandard":{"description":"Mandatory: Discloses a cross-sectoral standard applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","enum":["GHG Protocol Product standard","ISO Standard 14067","ISO Standard 14044"]}},"required":["crossSectoralStandard"]}},"productOrSectorSpecificRules":{"description":"Mandatory: Product or sector specific rules applied for calculating or allocating GHG (Greenhouse Gas) emissions, e.g. PCRs (Product Category Rules), including operators or publishers and according rule names as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"array","items":{"description":"Entity for defining a product or sector specific rule of a product carbon footprint as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"object","properties":{"extWBCSD_operator":{"description":"Mandatory: Operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example must always be \"Other\".","type":"string","enum":["PEF","EPD International","Other"]},"productOrSectorSpecificRules":{"description":"Mandatory: Product-specific or sector-specific set of rules used for calculating or allocating GHG (Greenhouse Gas) emissions applied from the specified operator as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"array","items":{"description":"Name of a rule applied by a specified operator as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"object","properties":{"ruleName":{"description":"Name of a rule applied by a specific operator as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string","minLength":1}},"required":["ruleName"]},"uniqueItems":true,"minItems":1},"extWBCSD_otherOperatorName":{"description":"Optional: Other operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by a default value.","type":"string","minLength":1}},"required":["extWBCSD_operator","productOrSectorSpecificRules"]},"uniqueItems":true},"extWBCSD_characterizationFactors":{"description":"Mandatory: IPCC (Intergovernmental Panel on Climate Change) version of the GWP (Global Warming Potential) characterization factors used for calculating the PCF (Product Carbon Footprint) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by default with value \"AR6\".","type":"string","enum":["AR5","AR6"]},"extWBCSD_allocationRulesDescription":{"description":"Optional: Allocation rules used and underlying reasoning in context of a product carbon footprint as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by default with value \"In accordance with Catena-X PCF Rulebook\".","type":"string"},"extTFS_allocationWasteIncineration":{"description":"Mandatory: Allocation approach used for waste incineration with energy recovery as specified by the TFS (Together For Sustainability) initiative. In Catena-X for example must be specified by value \"cut-off\".","type":"string","enum":["cut-off","reverse cut-off","system expansion"]},"primaryDataShare":{"description":"Mandatory starting 2025: Share of primary data in percent as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","maximum":100,"exclusiveMaximum":false,"minimum":0,"exclusiveMinimum":false},"secondaryEmissionFactorSources":{"description":"Mandatory: Emission factors used for the PCF (Product Carbon Footprint) calculation as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"array","items":{"description":"Entity for defining an emission factor data source used to calculate a product carbon footprint as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"object","properties":{"secondaryEmissionFactorSource":{"description":"Mandatory: Emission factor data source used to calculate a product carbon footprint as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"string"}},"required":["secondaryEmissionFactorSource"]},"uniqueItems":true},"dataQualityRating":{"description":"Mandatory starting 2025: Quantitative data quality indicators of a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"object","properties":{"coveragePercent":{"description":"Mandatory starting 2025: Percentage of PCF (Product Carbon Footprint) included in the data quality assessment based on the >5% emissions threshold as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example set to \"100\" per default.","type":"number","maximum":100,"exclusiveMaximum":false,"minimum":0,"exclusiveMinimum":false},"technologicalDQR":{"description":"Mandatory starting 2025: Technological representativeness of the sources used for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","maximum":3,"exclusiveMaximum":false,"minimum":1,"exclusiveMinimum":false},"temporalDQR":{"description":"Mandatory starting 2025: Temporal representativeness of the sources used for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","maximum":3,"exclusiveMaximum":false,"minimum":1,"exclusiveMinimum":false},"geographicalDQR":{"description":"Mandatory starting 2025: Geographical representativeness of the sources used for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","maximum":3,"exclusiveMaximum":false,"minimum":1,"exclusiveMinimum":false},"completenessDQR":{"description":"Mandatory starting 2025: Completeness of the data collected for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","maximum":3,"exclusiveMaximum":false,"minimum":1,"exclusiveMinimum":false},"reliabilityDQR":{"description":"Mandatory starting 2025: Reliability of the data collected for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","maximum":3,"exclusiveMaximum":false,"minimum":1,"exclusiveMinimum":false}}},"extWBCSD_packagingEmissionsIncluded":{"description":"Mandatory: Flag indicating whether packaging emissions are included in a PCF (Product Carbon Footprint) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example value is \"TRUE\" per default.","type":"boolean"},"pcfExcludingBiogenic":{"description":"Mandatory: Product carbon footprint of a product excluding biogenic emissions as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","minimum":0,"exclusiveMinimum":false},"pcfIncludingBiogenic":{"description":"Mandatory starting 2025: Product carbon footprint of a product including biogenic emissions as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Optional value in current specification version but will be mandatory in future version.","type":"number"},"fossilGhgEmissions":{"description":"Mandatory starting 2025: Emissions from combustion of fossil sources as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Identical to \"pcfExcludingBiogenic\", will be removed in later version.","type":"number","minimum":0,"exclusiveMinimum":false},"biogenicCarbonEmissionsOtherThanCO2":{"description":"Mandatory starting 2025: GWP (Global Warming Potential) of biogenic CO2e-emissions in production phase which contain only GHG (Greenhouse Gas) emissions other than CO2 - excludes biogenic CO2. For specification see Catena-X PCF Rulebook.","type":"number","minimum":0,"exclusiveMinimum":false},"biogenicCarbonWithdrawal":{"description":"Mandatory starting 2025: Biogenic carbon content in the product converted to CO2e as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","maximum":0,"exclusiveMaximum":false},"dlucGhgEmissions":{"description":"Mandatory starting 2025: Direct land use change CO2e emissions in context of a product carbon footprint as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","minimum":0,"exclusiveMinimum":false},"extTFS_luGhgEmissions":{"description":"Mandatory starting 2025: Land use CO2 emissions in context of a product carbon footprint as specified by the TFS (Together For Sustainability) initiative. TFS specific extension.","type":"number"},"aircraftGhgEmissions":{"description":"Mandatory starting 2025: GHG (Greenhouse Gas) emissions resulting from aircraft engine usage for the transport of the product as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","minimum":0,"exclusiveMinimum":false},"extWBCSD_packagingGhgEmissions":{"description":"Optional: Emissions resulting from the packaging of the product as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example value is zero per default.","type":"number","minimum":0,"exclusiveMinimum":false},"distributionStagePcfExcludingBiogenic":{"description":"Optional: Product carbon footprint for the distribution stage of a product excluding biogenic emissions as specified in the Catena-X PCF Rulebook.","type":"number","minimum":0,"exclusiveMinimum":false},"distributionStagePcfIncludingBiogenic":{"description":"Optional: Product carbon footprint for the distribution stage of a product including biogenic emissions as specified in the Catena-X PCF Rulebook.","type":"number"},"distributionStageFossilGhgEmissions":{"description":"Optional: Emissions from the combustion of fossil sources in the distribution stage as specified in the Catena-X PCF Rulebook.","type":"number","minimum":0,"exclusiveMinimum":false},"distributionStageBiogenicCarbonEmissionsOtherThanCO2":{"description":"Optional: GWP (Global Warming Potential) of biogenic CO2e-emissions in distribution phase which contain only GHG (Greenhouse Gas) emissions other than CO2 ? excludes biogenic CO2. For specification see Catena-X PCF Rulebook.","type":"number","minimum":0,"exclusiveMinimum":false},"distributionStageBiogenicCarbonWithdrawal":{"description":"Optional: GWP (Global Warming Potential) of biogenic CO2-withdrawal in distribution stage (biogenic CO2 contained in the product) as specified in the Catena-X PCF Rulebook.","type":"number","maximum":0,"exclusiveMaximum":false},"extTFS_distributionStageDlucGhgEmissions":{"description":"Optional: Direct land use change CO2 emissions during distribution stage in context of a product carbon footprint as specified in the Catena-X PCF Rulebook. TFS specific extension.","type":"number","minimum":0,"exclusiveMinimum":false},"extTFS_distributionStageLuGhgEmissions":{"description":"Optional: Land use CO2 emissions in context of a product carbon footprint as specified by the TFS (Together For Sustainability) initiative. TFS specific extension.","type":"number"},"carbonContentTotal":{"description":"Mandatory starting 2025: Total carbon content per declared unit in context of a product carbon footprint as specified in the Catena-X PCF Rulebook.","type":"number","minimum":0,"exclusiveMinimum":false},"extWBCSD_fossilCarbonContent":{"description":"Optional: Fossil carbon amount embodied in a product as specified in the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Must be calculated with kgC (kilogram Carbon) / declaredUnit equal to or greater zero; WBCSD specific extension, in Catena-X specified by a calculated value.","type":"number","minimum":0,"exclusiveMinimum":false},"carbonContentBiogenic":{"description":"Mandatory starting 2025: Biogenic carbon amount embodied in a product as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Must be calculated with kgC (kilogram Carbon) / declaredUnit equal to or greater zero.","type":"number","minimum":0,"exclusiveMinimum":false},"distributionStageAircraftGhgEmissions":{"description":"Optional: GHG (Greenhouse Gas) emissions for the distribution stage resulting from aircraft engine usage for the transport of the product as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.","type":"number","minimum":0,"exclusiveMinimum":false}},"required":["declaredUnit","unitaryProductAmount","productMassPerDeclaredUnit","exemptedEmissionsPercent","geographyRegionOrSubregion","referencePeriodStart","referencePeriodEnd","crossSectoralStandardsUsed","productOrSectorSpecificRules","extWBCSD_characterizationFactors","extTFS_allocationWasteIncineration","secondaryEmissionFactorSources","extWBCSD_packagingEmissionsIncluded","pcfExcludingBiogenic"]},"pcfLegalStatement":{"description":"Optional: Option for legal statement/ disclaimer as specified in the Catena-X PCF Rulebook.","type":"string"}},"required":["id","specVersion","partialFullPcf","version","created","extWBCSD_pfStatus","companyName","companyIds","productIds","extWBCSD_productCodeCpc","productName","pcf"]}}}},"responses":{"200":{"description":""}},"description":"set_pcf","method":"put","path":"/productIds/{productId}","jsonRequestBodyExample":{"id":"string","specVersion":"string","partialFullPcf":"Cradle-to-gate","precedingPfIds":[{"id":"string"}],"version":0,"created":"string","extWBCSD_pfStatus":"Active","validityPeriodStart":"string","validityPeriodEnd":"string","comment":"string","companyName":"string","companyIds":["string"],"productDescription":"string","productIds":["string"],"extWBCSD_productCodeCpc":"string","productName":"string","pcf":{"declaredUnit":"liter","unitaryProductAmount":0,"productMassPerDeclaredUnit":0,"exemptedEmissionsPercent":0,"exemptedEmissionsDescription":"string","boundaryProcessesDescription":"string","geographyCountrySubdivision":"string","geographyCountry":"string","geographyRegionOrSubregion":"Africa","referencePeriodStart":"string","referencePeriodEnd":"string","crossSectoralStandardsUsed":[{"crossSectoralStandard":"GHG Protocol Product standard"}],"productOrSectorSpecificRules":[{"extWBCSD_operator":"PEF","productOrSectorSpecificRules":[{"ruleName":"string"}],"extWBCSD_otherOperatorName":"string"}],"extWBCSD_characterizationFactors":"AR5","extWBCSD_allocationRulesDescription":"string","extTFS_allocationWasteIncineration":"cut-off","primaryDataShare":0,"secondaryEmissionFactorSources":[{"secondaryEmissionFactorSource":"string"}],"dataQualityRating":{"coveragePercent":0,"technologicalDQR":0,"temporalDQR":0,"geographicalDQR":0,"completenessDQR":0,"reliabilityDQR":0},"extWBCSD_packagingEmissionsIncluded":true,"pcfExcludingBiogenic":0,"pcfIncludingBiogenic":0,"fossilGhgEmissions":0,"biogenicCarbonEmissionsOtherThanCO2":0,"biogenicCarbonWithdrawal":0,"dlucGhgEmissions":0,"extTFS_luGhgEmissions":0,"aircraftGhgEmissions":0,"extWBCSD_packagingGhgEmissions":0,"distributionStagePcfExcludingBiogenic":0,"distributionStagePcfIncludingBiogenic":0,"distributionStageFossilGhgEmissions":0,"distributionStageBiogenicCarbonEmissionsOtherThanCO2":0,"distributionStageBiogenicCarbonWithdrawal":0,"extTFS_distributionStageDlucGhgEmissions":0,"extTFS_distributionStageLuGhgEmissions":0,"carbonContentTotal":0,"extWBCSD_fossilCarbonContent":0,"carbonContentBiogenic":0,"distributionStageAircraftGhgEmissions":0},"pcfLegalStatement":"string"},"info":{"title":"Catena-X-pcf-request-endpoint","version":"1.1.0"},"postman":{"name":"set pcf","description":{"type":"text/plain"},"url":{"path":["productIds",":productId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"ID identifying the request call (same as within original PCF request), if the PUT is responing to a call. Can be dismissed in a PCF update call.","type":"text/plain"},"key":"requestId","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the product/materiual the PCF referring to","type":"text/plain"},"type":"any","value":"","key":"productId"}]},"header":[{"disabled":false,"description":{"content":"(Required) The caller's Catena-X BusinessPartnerNumber","type":"text/plain"},"key":"Edc-Bpn","value":""},{"key":"Content-Type","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} -sidebar_class_name: "put api-method" -info_path: docs-kits/kits/PCF-Exchange-Kit/Software-Development-View/pcf-exchange-api//catena-x-pcf-request-endpoint -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import TabItem from "@theme/TabItem"; - -## set_pcf - - - -set_pcf - -
Path Parameters
Query Parameters
Header Parameters
Request Body required
- -The requested PCF in WBCSD format - -
    precedingPfIds object[]
    - -Optional: Set of preceding PCF (Product Carbon Footprint) identifiers without duplicates as specified in the Catena-X PCF Rulebook in accordance with the WBCSD (World Business Council for Sustainable Development) Pathfinder framework and the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD/ PACT initiative. Declared as "optional" in WBCSD, needs to be covered by application. - -
    = 1`"} defaultValue={undefined}>= 1`"} defaultValue={undefined}>
    pcf object required
    - -A PCF (Product Carbon Footprint) represents the carbon footprint of a product and related data as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - -
    crossSectoralStandardsUsed object[] required
    - -Mandatory: Discloses the cross-sectoral standards applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - -
    productOrSectorSpecificRules object[] required
    - -Mandatory: Product or sector specific rules applied for calculating or allocating GHG (Greenhouse Gas) emissions, e.g. PCRs (Product Category Rules), including operators or publishers and according rule names as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - -
    productOrSectorSpecificRules object[] required
    - -**Possible values:** `>= 1` - -
    - -Mandatory: Product-specific or sector-specific set of rules used for calculating or allocating GHG (Greenhouse Gas) emissions applied from the specified operator as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - -
    secondaryEmissionFactorSources object[] required
    - -Mandatory: Emission factors used for the PCF (Product Carbon Footprint) calculation as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - -
    dataQualityRating object
    - -Mandatory starting 2025: Quantitative data quality indicators of a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. - -
    5% emissions threshold as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example set to \"100\" per default."} schemaName={"number"} qualifierMessage={"**Possible values:** `<= 100`"} defaultValue={undefined}>5% of PCF emissions. Specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."} schemaName={"number"} qualifierMessage={"**Possible values:** `>= 1` and `<= 3`"} defaultValue={undefined}>5% of PCF emissions. Specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."} schemaName={"number"} qualifierMessage={"**Possible values:** `>= 1` and `<= 3`"} defaultValue={undefined}>5% of PCF emissions. Specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."} schemaName={"number"} qualifierMessage={"**Possible values:** `>= 1` and `<= 3`"} defaultValue={undefined}>5% of PCF emissions. Specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."} schemaName={"number"} qualifierMessage={"**Possible values:** `>= 1` and `<= 3`"} defaultValue={undefined}>5% of PCF emissions. Specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative."} schemaName={"number"} qualifierMessage={"**Possible values:** `>= 1` and `<= 3`"} defaultValue={undefined}>
- \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/sidebar.js b/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/sidebar.js deleted file mode 100644 index e6c25a0e6e8..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/sidebar.js +++ /dev/null @@ -1 +0,0 @@ -module.exports = [{"type":"doc","id":"kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/catena-x-pcf-request-endpoint"},{"type":"category","label":"PCF Exchange API","items":[{"type":"doc","id":"kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/get-pcf","label":"get_pcf","className":"api-method get"},{"type":"doc","id":"kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/set-pcf","label":"set_pcf","className":"api-method put"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/page_adoption-view.md deleted file mode 100644 index e410c6c2f4d..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/page_adoption-view.md +++ /dev/null @@ -1,524 +0,0 @@ ---- -id: Adoption View -title: Adoption View -description: 'PCF-Exchange-KIT' -sidebar_position: 2 ---- - -![PCF Exchange kit banner](/img/kit-icons/pcf-kit-icon.svg) - -## Introduction - -Sustainability has become increasingly important in the automotive industry in recent years. In particular, the topic of CO2 emissions is the focus of interest, and the product-specific CO2 footprint (PCF: product carbon footprint) has developed into a key indicator for sustainable product design and supply chains. Accordingly, there is a need to determine this data as precisely as possible across the automotive supply chain and to exchange it among partners in the network. This requires appropriate standards for calculation and exchange of data. - -In this context, Catena-X offers a decentralized ecosystem supported by standards and principles like data sovereignty, which can effectively implement such a PCF data exchange. The PCF KIT will be the key enabler for various stakeholders to calculate and exchange PCF data in a standardized format. The objective of the PCF KIT is therefore to: - -- Provide a comprehensive overview about the methods and tools for a PCF data exchange in the Catena-X dataspace. -- Offer various standards and guidelines for industry stakeholders. -- Provide a detailed description of the essential components required. - -## Vision & Mission - -### Vision - -Report and steer the de-carbonization of our value chain with dedicated measures based on real PCF values, without compromising upstream data sovereignty. - -### Mission - -Addressing supply chain carbon emissions today is missing reliable data about baseline emissions, effect of reductions, and best practices. This is due to three reasons: - -- Complexity of supply chains leading to huge amount of data: complex supply chains spanning different countries and actors from many industries lead to huge amounts of data. - -- Lack of Trust: Unwillingness to share data because of risk of losing competitive advantage, because data is shared with competitors. - -- Missing standards for measuring carbon emissions in a comparable way. - -At the core of our project is the recognition of a current challenge - the lack of transparency and accessibility to real PCF information in supply chains. Through our project, we strive to bridge this information gap by establishing a trusted and collaborative and interoperable environment. Suppliers will have the opportunity to share their PCF data with confidence, knowing that it remains sovereign and under their control. - -We will address this by working on trustworthy ecosystem that prioritizes data sovereignty, security, and collaboration on standards. Therefore, our mission is to revolutionize the supply chain industry by providing a platform where suppliers can securely share their primary Product Carbon Footprint (PCF) data throughout the supply chain. - -We are guided by the following principles: - -- **Building trust** by making clear rules for data exchange and by pre-agreed data contracts between partners in the value chain. -- Building trust through **data sovereignty and data security**. We will build an ecosystem to share minimal data on a need-to-know basis, incorporating 3rd party verification by trusted partners. Decentralized architectures ensure that data remains within companies and is only shared with authorized persons as needed. -- **Governance** on the principles of mutual collaboration in the automotive industry and across with all relevant actors of the value chain on the principle of equality between partners, involving relevant outside stakeholders and the scientific community. -- **Flexibility and interoperability** by building an ecosystem of interoperable apps based on open standards. Collaborative standards for collecting, calculating, and sharing emission and product data make these processes more efficient and comparable. -- **Scalability** and manageability of large amounts of data. Decentralized data ecosystems can handle and scale large amounts of data, as decentralized structures are created as required by participating companies. - -## Business Process - -### Premises and assumptions - -We assume that the calculation and exchange of PCF data is “new territory” for many companies. In large or larger enterprises (e.g., OEM or Tier-1 suppliers), the topic of sustainability with its various facets has been on the agenda for several years now. Appropriate structures and organizations were set up there. In this respect, it can be assumed that they have the expertise and resources for a PCF calculation. Corresponding, self-developed IT tools can also be found there. We cannot expect this for small and medium-sized enterprises (SMEs). In particular small companies often lack the knowledge and resources to calculate a PCF. - -The following premises are therefore relevant for the following customer journeys: - -- A PCF calculation requires expert or at least in-depth knowledge. -- A PCF calculation is currently mostly created manually; automation is not common or possible in most cases. -- Automation is also not yet feasible because there are no concepts or standards for verifying PCF data. -- Due to the (manual) effort, PCF calculation and data exchange will initially only be carried out for selected products. - -Accordingly, the presented customer journeys are characterized by manual process steps. However, as the topic becomes more widely known in the automotive supply chain (especially among SMEs), greater automation should be sought. This is the only way to represent a larger (ideally the entire) range of products. - -### Overview - -The scope of our business process is the calculation and the exchange of Product Carbon Footprint (PCF) data across the supply chain for parts / components that are already in series production (→ "after start of production (SOP)"). One can therefore assume that a real supply chain already exists for this part / component. - -To describe the process, we defined two customer journeys: - -1. The customer journey “PCF data exchange” describes an asynchronous communication process: A customer requests the PCF from their supplier for a component (“PCF Request”), and the supplier provides the requested data (“PCF Response”). -2. If necessary, the requested PCF data must first be determined; this leads to the second customer journey “PCF calculation”. - -The exchange-process is initiated top-down (e.g., at the OEM; but it can also start at any level of the supply chain), starting with a request of a customer to the supplier. It could then be continued step by step throughout the entire tier-n supply chain. Ideally, the entire supply chain (or actually: the entire supply tree) would be covered via this cascading request/response process. The result would be a PCF that is 100% based on requested and reported data. - -![PCF Request and Response](resources/adoption-view/PCFRequestandResponse.png) - -In the real world, this will not be implemented this way, at least in the short and medium term. It can be assumed that this process and information chain will break down at certain points in the supply chain. There, data is not requested, but is calculated using secondary data, as is standard procedure these days. There can be various reasons for this: - -- The affected part of the supply chain is only of minor relevance to the PCF; the effort required to determine the real data would therefore not be worthwhile. -- The supplier cannot or does not want to provide corresponding data. - -However, it is important that a PCF value reported from a supplier to its customer always represents the entire supply chain behind it. Therefore, the following data is recorded in a PCF calculation and aggregated to form the resulting PCF: - -- direct emissions, that are generated in the supplier's own production system ("Scope 1") -- indirect emissions from purchased energy ("Scope 2") -- upstream emissions caused by purchased products from the upstream supply chain ("Scope 3") - -![Scope of Catena-X Use Case](resources/adoption-view/ScopeofCatena-XUseCase.png) - -The data for direct and indirect emissions will usually come from internal data sources, as these emission-shares are generated in the supplier's own production system. The upstream emissions ("Scope 3") can either be requested from the respective sub-supplier. Or it could be calculated, e.g., by using information from eco-databases. Putting all together, the transparency on the PCF for a given part or component is created through a cascade of top-to-bottom PCF requests, and a cascade of aggregated PCF data from bottom to top. - -### Customer Journey "PCF Data Exchange" - -This customer journey describes the exchange of PCF data in an asynchronous request/response process. - -![PCF Data Exchange Overview](resources/adoption-view/PCFDataExchangeOverview.png) - -PCF data is exchanged between a data consumer (e.g., supplier on tier n) and a data provider (e.g., supplier on tier n+1). It is basically an asynchronous request/response process that is started by the data consumer: - -- The data consumer realizes that he needs the PCF for a specific component and that this data is not available in his local data (or is not of sufficient quality). -- With his PCF Data exchange tool, the data consumer checks whether the required PCF data is available via Catena-X (from a technical perspective, this means that there is already a digital twin for the component and that the PCF submodel is available for this twin). If so, the tool would “fetch up” this data. If not, the user can request this data from the supplier as described in the next steps. -- The data consumer submits a “PCF request” (according to the standardized API [CX-0136](https://catena-x.net/de/standard-library)) to his supplier. In doing so, he asks the supplier to provide PCF data for the specific component, which was determined in accordance with the requirements of the Catena-X PCF Rulebook ([CX-0029](https://catena-x.net/de/standard-library)). - -With this request, the process temporarily ends for the data consumer. The ball is now in the data provider's playing field.: - -- The data provider receives the PCF request (message/display in his PCF data exchange tool). To answer this request, he takes the following steps: -- The data provider checks whether the requested data is already available (i.e., whether the PCF has already calculated in the past but has not yet been provided to the customer). -- If the data is not yet available, the data provider must create it first. At this point, he starts the “PCF calculation” subjourney (see [below](#customer-journey-pcf-calculation)). At the end of this subjourney, the PCF data is available, and the provider can answer the original request with the next steps. -- The data provider sends a PCF Response (according to the standardized API see [CX-0136](https://catena-x.net/de/standard-library)) to the data consumer. At the same time, the data is made available in Catena-X (which means from a technical perspective, that a PCF submodel is attached to the corresponding digital twin of the component). - -For the data provider, the process is now over, and the consumer's request has been answered with the response. Now follow a few more steps on the consumer side. - -- The data consumer, who sent the initial PCF request, now receives the PCF response (message/display in his PCF data exchange tool). -- With the data exchange tool, the consumer can access and “pick up” the PCF data, according to the standardized PCF data model (see [Semantic Model](#semantic-models)). - ->**Remark:** ->There are currently no options for data verification or acceptance/rejection of transmitted data at this stage in the process. These topics are currently still being discussed at Catena-X association level and are therefore not yet covered in the processes and tools. This will only happen with later releases. - -- The data consumer can now transfer this data to his internal systems/databases (e.g., a PCF calculation tool), and use it for the internal business processes (e.g., PCF calculation or reporting). -This ends this customer journey. - -### Customer Journey “PCF Calculation” - -This customer journey describes the calculation of a [CX Rulebook-compliant PCF](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Archiv/Update_Standard_PDF_Feb._2023/1_Sustainability_v1.0/CX_-_0029_PCF_Rulebook_UseCaseSustainability_v_1.0.0.pdf), with some of the required data obtained via the Catena-X network. - -![PCF Calculation](resources/adoption-view/PCFCalculation.png) - -The calculation process will often be triggered by an incoming PCF request (see subjourney "[PCF data exchange](#customer-journey-pcf-data-exchange)", step 6). But of course, a PCF calculation can also be carried out proactively without a corresponding request via PCF Request. -To determine a PCF, an appropriate calculation tool is usually used, which guides the user through the process and ensures that all relevant data is taken into account. We will limit ourselves here to a generic, tool-independent presentation of the most important steps. - -1. Make a plan: What are the different components of the PCF? Where can I get the relevant data from? -→ This structuring should be supported by an appropriate process in the calculation tool. -2. Put the direct emissions from the production site (e.g., use of natural gas or fuels) into the calculation. -→ Get the raw data from internal data sources and enter them in the calculation tool. -3. Put the indirect emissions from purchased energy into the calculation. -→ Get the raw data (consumption values, energy mix, …) from internal data sources and from the energy supplier, and enter it in the calculation tool. -4. Upstream emissions: - - For sub-components with a (expected) relevant share on the PCF, the aim is to use real data (or primary data) for the calculation. Therefore, a PCF request is sent to the suppliers of these sub-components, to obtain appropriate real data (see subjourney ["PCF data exchange"](#customer-journey-pcf-data-exchange)). As soon as the data is available (via a PCF Response), it can be used as input for the calculation. - - For other sub-components, which only make up a small proportion of the upstream emissions, there will be no request of data to the supplier. Instead, the data will be obtained from a database for secondary data. -5. If necessary, put other emissions and further data into the calculation (e.g., transport emissions, waste, recycling quotas, ...). -6. Put it all together and get the overall PCF. -7. Transfer PCF to the exchange tool (or in general: make the PCF data available). - -### PCF Personas - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PersonaRole and Task (in larger companies)Specifics for SME ChallengesCatena-X Contribution
Purchaser In general, the purchaser will not be a sustainability expert! - Sustainability is for him just an additional dimension (as cost, quality, ...). -
    -
  • He requests sustainability data for purchased (sub)products from his suppliers.
    • -
  • In the sourcing process he evaluates the incoming offers (which will include more and more sustainability data).
    • -
  • He negotiates PCF targets with his suppliers.
    • -
  • He checks compliance with agreements and targets and evaluates the supplier's performance.
    • -
  • He will be often the one, who detects incidents (e.g., non-fulfillment of targets, missing certificates, ...).
    • -
- Different responsibilities and views possible: -
    -
  • A part / components / materials-oriented view
    • -
  • A supplier / commodity-oriented view
    • -
- 		-

We assume, that a SME will have a weaker negotiating position and assertiveness (as a large company), so it may be more difficult to …

-
    -
  • request PCF data from (sub)suppliers.
    • -
  • forward customers' CO2 targets to (sub)suppliers.
    • -
  • negotiate own objectives/targets.
    • -
- 		-

He requires sustainability data of parts/materials (e.g., PCF) for various purposes.

-

He requires standardized data.

-

He also requires product-unspecific sustainability data of suppliers (e.g., production site-specific certificates).

-

He needs data in different phases (e.g., product development, procurement, industrialization, series production).

- 		-

X defines standards for sustainability data.

-

CX provides up-to-date and reliable sustainability data

-
    -
  • of parts / materials
    • -
  • of suppliers
    • -
-

CX provides phase-specific data.

-

CX provides (standard) reports.

-

CX provides apps and services for data exchange.

-
PCF Calculator - He is an expert for PCF calculation. He could be described as a “PCF Engineer,” analogous to the role of a “Cost Engineer” established in many companies. -
    -
  • He has in-depth knowledge of PCF-, CCF- and LCA-methods.
    • -
  • He is responsible for the calculation of the own scope-1 and -2 values of a PCF
    • -
  • From this data and with the scope-3 data reported by suppliers (or obtained from databases), he calculates the PCF of his own products.
    • -
  • He hands the result over to the PCF Controller
    • -
  • He is a consultant in "costs vs. PCF" discussions (with internal, but also with external partners)
    • -
  • He analyzes customer incident requests (on behalf of the PCF controller).
    • -
  • If there are any discrepancies in reported PCF data, he initiates incident requests at the respective supplier (via the PCF controller).
    • -
- 		-

We assume, that at a SME there will be often a combined role: (Sustainability) Manager Product

-
    -
  • He is no sustainability expert! So, he must draw on external expertise if necessary
    • -
  • He must handle internal and external topics
    • -
-

Customer view:

-
    -
  • He is a key account for sustainability data (PCF and ESS) and an “interface” in both directions: customers and suppliers.
    • -
  • He releases sustainability data (esp. PCF) to customers
    • -
  • He receives PCF data from suppliers.
    • -
  • He is the addressee for (PCF) incidents
    • -
-

Internal View:

-
    -
  • He knows the product BoM (bill of material)
    • -
  • He steers “PCF vs. Cost" objectives at product levels.
    • -
  • He collaborates with external auditors.
    • -
  • He analyzes incoming incident request of customers
    • -
- 		Requires standardized PCF calculation method. -

Needs Scope 3 values from suppliers, to calculate own PCF with this data.

-

May need a calculation tool for Scope 1 and 2 values.

-

Requires access to eco-data (secondary data).

-

Needs BoM (bill of material) data for calculation and analysis.

- 		-

CX defines standards for PCF calculation.

-

CX provides up-to-date and reliable sustainability data of parts / materials.

-

CX provides apps and services for data exchange.

-

CX provides calculation tools.

-

CX provides access to eco-data(bases) for secondary data.

-
PCF Controller (product) -

his is more of an operational role (as opposed to the Sustainability Manager). He is a PCF expert who works with many internal and external partners.

-

He is the first point of contact for the purchaser on PCF topics.

-

External/Customer view:

-
    -
  • He is a key account for PCF data and, in this regard, the central interface to customers/suppliers.
    • -
  • He releases calculated PCF data to customer.
    • -
  • He receives PCF data from the suppliers.
    • -
  • He triggers incident management.
    • -
  • He initiates collaborative PCF optimization.
    • -
-

Internal View:

-
    -
  • He is the PCF data owner in the company.
    • -
  • He acts as a PCF data collector.
    • -
  • He receives PCF targets from the Sustainability Manager, evaluates them, and is consulted as a CO2 expert in negotiations.
    • -
  • He tracks PCF targets for purchased parts, and detects incidents in terms of non-fulfillment of targets.
    • -
  • He makes supplier performance reviews about PCF.
    • -
- 		- -

He requires up-to-date and reliable PCF data of parts / materials.

-

He needs data in different phases of the product lifecycle (e.g., in product development, sourcing, industrialization, series production).

-

He requires standardized data.

-

He needs a tool to exchange PCF data with internal and external partners.

-

He needs reports for tracking and monitoring of PCF data and targets.

- 		-

CX defines standards for PCF data.

-

CX provides apps and services for PCF data exchange.

-

CX provides up-to-date and reliable PCF data of parts / materials.

-

CX provides phase-specific data.

-
Sustainability Manager (product) -

This is more of a strategic role than an operational role.

-

He is responsible for the coordination and steering of PCF and cost objectives at product level

-

He ensures the consistency of product objectives with corporate objectives.

-

He defines PCF targets for products and breaks them down on part / components / materials level.

-

He receives sustainability targets from customers.

-

He takes care of how sustainability targets (especially PCF) can be implemented and achieved.

-

He performs analyses in the context of sustainability.

-

He collaborates with external auditors.

- 		- -

He collaborates with external auditors.

-

He requires standardized data.

-

He needs data in different phases of the product lifecycle (e.g., in product development, sourcing, industrialization, series production).

-

He needs reports for tracking and monitoring of sustainability data.

-

He needs a tool to exchange sustainability data with internal and external partners.

- He needs tools for: -
    -
  • PCF target breakdown.
    • -
  • PCF optimization (e.g., “what if analysis”).
    • -
  • Controlling of competing targets (sustainability vs. costs vs. quality …).
    • -
- 		-

CX defines standards for sustainability data (esp. PCF).

-

CX provides apps and services for data exchange.

-

CX provides up-to-date and reliable sustainability data of parts / materials.

-

CX provides phase-specific data.

-

CX provides (standard) reports.

-

CX provides analysis tools.

-
Sustainability Manager (corporate) -

He has no active role in Catena-X (e.g.: getting reports is a passive, not an active role in this sense).

-

He sets corporate goals and breaks them down for different sectors and functions in the company.

-

He gets input from the Sustainability Manager Product.

- 		-

The role exists in principle; it is rather the question of who will take it over (e.g., personal union with Management, or possibly Sust. Manager).

-

Thesis: an SME does CCF rather than PCF.

- 		-

He requires (aggregated) sustainability data.

-

He requires “high level” (standard) reports.

- 		CX provides up-to-date and reliable sustainability data.
Salespeople -

He is the central interface to the customer.

-

He is the owner of the customer quotation process.

-

He negotiates PCF targets with customers (→purchaser).

-

He presents sustainability data (esp. PCF) to customers.

-

He is accountable for incident management with customers.

- 		- -

He needs sustainability data (e.g., PCF) of own products (parts / materials)

-

He requires tools for information or data exchange (with both internal partners and external customers).

- 		-

CX provides sustainability data of own products.

-

CX provides apps and services for data exchange.

-
Auditor (external) -

He does a yearly audit of conformity with Catena-X methodology.

-

At the beginning (before go-live) there is a one-time audit of the use of the Catena-X network and methods in the company to be audited.

-

The onboarding of suppliers requires a self-declaration of applying Catena-X methodology.

-

The auditor has a clearing role in case of escalated incidents.

- 		He needs additional infxormation and data to be able to verify the reported PCF data. -

CX provides up-to-date and verifiable sustainability data.

-

Catena-X provides access to metadata that allows the reported PCF data to be verified.

-
Sustainability Associations / InstitutionsThey provide industry-specific averages and benchmarks of PCF values.
- -## Semantic Models - -Depending on the use case and related KIT, Catena-X provides different semantic models that help to structure and make use of data via semantic information. These models help to provide a basic meaning to the data and their relationship, thereby enabling interoperability between data sets. Catena-X data models rely on principles as understandability, standardization, accuracy, differentiation, audibility, comprehensiveness, and provision of insights to drive improvement actions. - -### PCF - -#### Introduction PCF Data Model - -In an era defined by growing environmental consciousness and sustainability imperatives, the concept of measuring and reducing carbon footprints has become paramount across industries. A pivotal key in this pursuit is a aligned and standardized Product Carbon Footprint Data Model. This data model not only facilitates the systematic calculation and comparison of carbon footprints but also offers a structured approach to managing environmental impact data. - -As the global community grapples with the impacts of climate change, consumers, businesses, and governments are seeking actionable ways to mitigate their carbon emissions. The need for a consistent and universally accepted method of quantifying these emissions from diverse products has given rise to the significance of a Standardized Product Carbon Footprint Data Model. This model acts as a lingua franca, enabling stakeholders to communicate and analyze carbon footprint information transparently and comprehensively. - -For this KIT only the data model PCF is used. The data model follows the Catena-X Standard [CX-0136](https://catena-x.net/de/standard-library) and is modeled following the [CX-0003](https://catena-x.net/de/standard-library) Standard. - -#### Example Payload - -The following json shows a example payload for a requested pcf value. - -```json -{ - "specVersion" : "2.0.1-20230314", - "companyIds" : [ "urn:bpn:id:BPNL000000000DWF", "urn:id:56789"], - "extWBCSD_productCodeCpc" : "011-99000", - "created" : "2022-05-22T21:47:32Z", - "companyName" : "My Corp", - "extWBCSD_pfStatus" : "Active", - "version" : 0, - "productName" : "My Product Name", - "pcf" : { - "biogenicCarbonEmissionsOtherThanCO2" : 1.0, - "distributionStagePcfExcludingBiogenic" : 1.5, - "biogenicCarbonWithdrawal" : 0.0, - "distributionStageBiogenicCarbonEmissionsOtherThanCO2" : 1.0, - "extWBCSD_allocationRulesDescription" : "In accordance with Catena-X PCF Rulebook", - "exemptedEmissionsDescription" : "No exemption", - "distributionStageFossilGhgEmissions" : 0.5, - "exemptedEmissionsPercent" : 0.0, - "geographyCountrySubdivision" : "US-NY", - "extTFS_luGhgEmissions" : 0.3, - "distributionStageBiogenicCarbonWithdrawal" : 0.0, - "pcfIncludingBiogenic" : 1.0, - "aircraftGhgEmissions" : 0.0, - "productMassPerDeclaredUnit" : 0.456, - "productOrSectorSpecificRules" : [ { - "extWBCSD_operator" : "PEF", - "productOrSectorSpecificRules" : [ { - "ruleName" : "urn:tfs-initiative.com:PCR:The Product Carbon Footprint Guideline for the Chemical Industry:version:v2.0" - } ], - "extWBCSD_otherOperatorName" : "NSF" - } ], - "extTFS_allocationWasteIncineration" : "cut-off", - "pcfExcludingBiogenic" : 2.0, - "referencePeriodEnd" : "2022-12-31T23:59:59Z", - "extWBCSD_characterizationFactors" : "AR5", - "secondaryEmissionFactorSources" : [ { - "secondaryEmissionFactorSource" : "ecoinvent 3.8" - } ], - "unitaryProductAmount" : 1000.0, - "declaredUnit" : "liter", - "referencePeriodStart" : "2022-01-01T00:00:01Z", - "geographyRegionOrSubregion" : "Africa", - "fossilGhgEmissions" : 0.5, - "distributionStageAircraftGhgEmissions" : 0.0, - "boundaryProcessesDescription" : "Electricity consumption included as an input in the production phase", - "geographyCountry" : "DE", - "extWBCSD_packagingGhgEmissions" : 0, - "dlucGhgEmissions" : 0.4, - "carbonContentTotal" : 2.5, - "extTFS_distributionStageLuGhgEmissions" : 1.1, - "primaryDataShare" : 56.12, - "dataQualityRating" : { - "completenessDQR" : 2.0, - "technologicalDQR" : 2.0, - "geographicalDQR" : 2.0, - "temporalDQR" : 2.0, - "reliabilityDQR" : 2.0, - "coveragePercent" : 100 - }, - "extWBCSD_packagingEmissionsIncluded" : true, - "extWBCSD_fossilCarbonContent" : 0.1, - "crossSectoralStandardsUsed" : [ { - "crossSectoralStandard" : "GHG Protocol Product standard" - } ], - "extTFS_distributionStageDlucGhgEmissions" : 1.0, - "distributionStagePcfIncludingBiogenic" : 0.0, - "carbonContentBiogenic" : 0.0 - }, - "partialFullPcf" : "Cradle-to-gate", - "productIds" : [ "urn:id:98765", "urn:id:cx:12345" ], - "validityPeriodStart" : "2022-01-01T00:00:01Z", - "comment" : "Comment for version 42.", - "id" : "3893bb5d-da16-4dc1-9185-11d97476c254", - "validityPeriodEnd" : "2022-12-31T23:59:59Z", - "pcfLegalStatement" : "This PCF (Product Carbon Footprint) is for information purposes only. It is based upon the standards mentioned above.", - "productDescription" : "Ethanol, 95% solution", - "precedingPfIds" : [ { - "id" : "3893bb5d-da16-4dc1-9185-11d97476c254" - } ] -} -``` - -The entire data model is available as open source through following the link: -[Catena-X PCF Datamodel](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.pcf/5.0.0) - -## Business Architecture - -The PCF Exchange KIT can be used to exchange PCF data within the Catena-X ecosystem in a decentralized and interoperable manner, while maintaining a high level of data sovereignty. To achieve this, the PCF Exchange KIT leverages other KITs (particularly the platform-related ones), standardized data models, and an Identity and Access Management (IAM) system based on OAuth and Self-Sovereign Identity (SSI) technology. - -In order to ensure **interoperability**, as described in the section on [Semantic Models](#semantic-models), a standardized data model is essential. However, it's not only the data model but also the standardized interfaces (both the PCF Exchange API and the standardized API provided by the Connector Kit) that contribute to interoperability. - -To enable **data sovereignty**, Catena-X relies on **Self-Sovereign-Identity** (SSI). This allows data providers to precisely specify the conditions that must be met before requested data is transmitted. In the context of the PCF KIT, the "PCF Credential" and "Membership Credential" are mandatory. The PCF Credential references the [PCF Framework Agreement](https://catena-x.net/fileadmin/user_upload/04_Einfuehren_und_umsetzen/Governance_Framework/231016_Catena-X_Use_Case_Framework_PCF.pdf) signed by a data consumer. The Membership Credential additionally ensures that the requester is an active member of Catena-X. - -The diagram shown here illustrates the interaction between the PCF KIT and the other Catena-X components. -![Business Architecture](resources/adoption-view/BusinessArchitecture.png) - -## STANDARDS - -The standards of this release will be published soon. The relevant standards can be downloaded from the official [Catena-X Standard Library](https://catena-x.net/de/standard-library): - -- Product Carbon Footprint UseCase (Version 1.0.0) -- Product Carbon Footprint Rulebook (Version 2.0.0) - -## NOTICE - -This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - -- SPDX-License-Identifier: CC-BY-4.0 -- SPDX-FileCopyrightText: 2023,2024 ZF Friedrichshafen AG -- SPDX-FileCopyrightText: 2023,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) -- SPDX-FileCopyrightText: 2023,2024 T-Systems International GmbH -- SPDX-FileCopyrightText: 2023,2024 SAP SE -- SPDX-FileCopyrightText: 2023,2024 SIEMENS AG -- SPDX-FileCopyrightText: 2023,2024 SUPPLY ON AG -- SPDX-FileCopyrightText: 2023,2024 Volkswagen AG -- SPDX-FileCopyrightText: 2023,2024 Robert Bosch GmbH -- SPDX-FileCopyrightText: 2023,2024 Mercedes Benz Group -- SPDX-FileCopyrightText: 2023,2024 BASF SE -- SPDX-FileCopyrightText: 2023,2024 CCT -- SPDX-FileCopyrightText: 2023,2024 Gris Group -- SPDX-FileCopyrightText: 2023,2024 Contributors to the Eclipse Foundation -- [Source URL](https://github.com/eclipse-tractusx/pcf-exchange-kit) diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/EDCDiscoveryanddDTRAccess.png b/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/EDCDiscoveryanddDTRAccess.png deleted file mode 100644 index 3b6de7061de..00000000000 Binary files a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/EDCDiscoveryanddDTRAccess.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/PCFRequestthroughAAS.png b/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/PCFRequestthroughAAS.png deleted file mode 100644 index 49de7c3a2c9..00000000000 Binary files a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/PCFRequestthroughAAS.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/catena-x-pcf-endpoint-1_1_0.yaml b/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/catena-x-pcf-endpoint-1_1_0.yaml deleted file mode 100644 index 75854d1cbb0..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/catena-x-pcf-endpoint-1_1_0.yaml +++ /dev/null @@ -1,1105 +0,0 @@ -openapi: 3.0.0 -info: - title: Catena-X-pcf-request-endpoint - version: 1.1.0 -paths: - /productIds/{productId}: - get: - operationId: get_pcf - parameters: - - name: Edc-Bpn - description: The caller's Catena-X BusinessPartnerNumber - example: BPNL0000005AMPL3 - in: header - required: true - schema: - type: string - - name: productId - description: ID of the product/materiual the PCF is requested for - example: urn:id:8534x67 - in: path - required: true - schema: - type: string - - name: requestId - description: >- - ID identifying the call (will be referenced in corresponding PCF - response) - example: 2daa49aa-ee16-4df3-bca3-69ddead40419 - in: query - required: true - schema: - type: string - - name: message - in: query - required: false - description: URL encoded, max 250 chars - example: No%20offset%20included%2C%20please%21 - schema: - type: string - responses: - '202': - description: PCF was accepted. PCF will be sent later via to POST endpoint. - put: - operationId: set_pcf - parameters: - - name: Edc-Bpn - description: The caller's Catena-X BusinessPartnerNumber - example: BPNL0000005AMPL3 - in: header - required: true - schema: - type: string - - name: productId - description: ID of the product/materiual the PCF referring to - example: urn:id:8534x67 - in: path - required: true - schema: - type: string - - name: requestId - description: >- - ID identifying the request call (same as within original PCF - request), if the PUT is responing to a call. Can be dismissed in a - PCF update call. - example: 2daa49aa-ee16-4df3-bca3-69ddead40419 - in: query - required: false - schema: - type: string - requestBody: - description: The requested PCF in WBCSD format - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/ProductFootprintResponse' - responses: - '200': - description: '' -components: - schemas: - ProductFootprintResponse: - description: >- - A Product (Carbon) Footprint represents the carbon footprint of a - product with values as specified in the Catena-X PCF Rulebook in - accordance with the WBCSD (World Business Council for Sustainable - Development) Pathfinder framework and the technical specifications for - PCF Data Exchange (Version 2.0.0) from the WBCSD/ PACT initiative. - type: object - properties: - id: - description: >- - Mandatory: The product footprint identifier as specified in the - Catena-X PCF Rulebook in accordance with the technical - specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD - (World Business Council for Sustainable Development)/ PACT - initiative. - $ref: >- - #/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait - specVersion: - description: >- - Mandatory: Version of the product footprint data specification as - defined in the Catena-X PCF Rulebook in accordance with the - technical specifications for PCF Data Exchange (Version 2.0.0) from - the WBCSD (World Business Council for Sustainable Development)/ PACT - initiative. - $ref: >- - #/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text - partialFullPcf: - description: >- - Mandatory: Indicator for partial or full PCF (Product Carbon - Footprint) declaration as specified in the Catena-X PCF Rulebook. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PartialFullPcfCharacteristic - precedingPfIds: - description: >- - Optional: Set of preceding PCF (Product Carbon Footprint) - identifiers without duplicates as specified in the Catena-X PCF - Rulebook in accordance with the WBCSD (World Business Council for - Sustainable Development) Pathfinder framework and the technical - specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD/ - PACT initiative. Declared as "optional" in WBCSD, needs to be - covered by application. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PrecedingPfIdsCharacteristic - version: - description: >- - Mandatory: Version of the product (carbon) footprint as specified in - the Catena-X PCF Rulebook in accordance with the technical - specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD - (World Business Council for Sustainable Development)/ PACT - initiative. In Catena-X for example set to "0" per default. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_ProductFootprintVersion - created: - description: >- - Mandatory: Timestamp of the creation of the Product (Carbon) - Footprint as specified in the Catena-X PCF Rulebook in accordance - with the technical specifications for PCF Data Exchange (Version - 2.0.0) from the WBCSD (World Business Council for Sustainable - Development)/ PACT initiative. - $ref: >- - #/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp - extWBCSD_pfStatus: - description: >- - Mandatory: Status indicator of a product (carbon) footprint as - specified in the technical specifications for PCF Data Exchange - (Version 2.0.0) from the WBCSD (World Business Council for - Sustainable Development)/ PACT initiative. WBCSD specific extension, - in Catena-X for example set to "Active" per default. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PfStatusCharacteristic - validityPeriodStart: - description: >- - Optional: Start of interval during which the product (carbon) - footprint is declared as valid as specified in the Catena-X PCF - Rulebook in accordance with the technical specifications for PCF - Data Exchange (Version 2.0.0) from the WBCSD (World Business Council - for Sustainable Development)/ PACT initiative. If specified, the - validity period start must be equal to or greater than the reference - period end. - $ref: >- - #/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp - validityPeriodEnd: - description: >- - Optional: End of interval during which the product (carbon) - footprint is declared as valid as specified in the Catena-X PCF - Rulebook in accordance with the technical specifications for PCF - Data Exchange (Version 2.0.0) from the WBCSD (World Business Council - for Sustainable Development)/ PACT initiative. - $ref: >- - #/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp - comment: - description: >- - Optional: Additional information and instructions related to the - calculation of the product (carbon) footprint as specified in the - Catena-X PCF Rulebook in accordance with the technical - specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD - (World Business Council for Sustainable Development)/ PACT - initiative. - $ref: >- - #/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text - companyName: - description: >- - Mandatory: Name of the product (carbon) footprint data owner as - specified in the Catena-X PCF Rulebook in accordance with the - technical specifications for PCF Data Exchange (Version 2.0.0) from - the WBCSD (World Business Council for Sustainable Development)/ PACT - initiative. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_NonEmptyStringTrait - companyIds: - description: "Mandatory: Non-empty set of Uniform Resource Names (URN). Each value is supposed to uniquely identify the product (carbon) footprint data owner as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. For Catena-X Industry Core compliance the set of URNs must contain at least the Business Partner Number Legal Entity (BPNL) in the specified format urn:bpn:id:BPNL[a-zA-Z0-9]{12}.\_" - $ref: '#/components/schemas/urn_samm_io.catenax.pcf_6.0.0_IdsTrait' - productDescription: - description: >- - Optional: Free-form description of the product as specified in the - Catena-X PCF Rulebook in accordance with the technical - specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD - (World Business Council for Sustainable Development)/ PACT - initiative. - $ref: >- - #/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text - productIds: - description: >- - Mandatory: Non-empty set of product identifiers. Each value is - supposed to uniquely identify the product as specified in the - Catena-X PCF Rulebook in accordance with the technical - specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD - (World Business Council for Sustainable Development)/ PACT - initiative. In Catena-X productId corresponds with Industry Core - manufacturerPartId. - $ref: '#/components/schemas/urn_samm_io.catenax.pcf_6.0.0_IdsTrait' - extWBCSD_productCodeCpc: - description: >- - Mandatory: UN (United Nations) Product Classification Code (CPC - - Central Classification Code) of a given product as specified the - technical specifications for PCF Data Exchange (Version 2.0.0) from - the WBCSD (World Business Council for Sustainable Development)/ PACT - initiative. WBCSD specific extension, which will probably be - declared as "optional" in a later WBCSD specification version. In - Catena-X for example specified with default value "011-99000". - $ref: >- - #/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text - productName: - description: "Mandatory: Non-empty trade name of a product as specified in the Catena-X PCF Rulebook in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X productNameCompany corresponds with Industry Core nameAtManufacturer.\_" - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_NonEmptyStringTrait - pcf: - description: >- - A PCF (Product Carbon Footprint) represents the carbon footprint of - a product and related data as specified in the Catena-X PCF Rulebook - in accordance with the technical specifications for PCF Data - Exchange (Version 2.0.0) from the WBCSD (World Business Council for - Sustainable Development)/ PACT initiative. - $ref: '#/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PcfEntity' - pcfLegalStatement: - description: >- - Optional: Option for legal statement/ disclaimer as specified in the - Catena-X PCF Rulebook. - $ref: >- - #/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text - required: - - id - - specVersion - - partialFullPcf - - version - - created - - extWBCSD_pfStatus - - companyName - - companyIds - - productIds - - extWBCSD_productCodeCpc - - productName - - pcf - 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_org.eclipse.esmf.samm_characteristic_2.1.0_Text: - type: string - description: >- - Describes a Property which contains plain text. This is intended - exclusively for human readable strings, not for identifiers, measurement - values, etc. - urn_samm_io.catenax.pcf_6.0.0_PartialFullPcfCharacteristic: - type: string - description: >- - Characteristic for defining an indicator for partial or full PCF - (Product Carbon Footprint) declaration as specified in the Catena-X PCF - Rulebook. - enum: - - Cradle-to-gate - - Cradle-to-grave - urn_samm_io.catenax.pcf_6.0.0_PrecedingPfId: - description: >- - Entity for defining a preceding PCF (Product Carbon Footprint) - identifier entity as specified in the Catena-X PCF Rulebook in - accordance with the technical specifications for PCF Data Exchange - (Version 2.0.0) from the WBCSD (World Business Council for Sustainable - Development)/ PACT initiative. - type: object - properties: - id: - description: >- - Mandatory: The product footprint identifier as specified in the - Catena-X PCF Rulebook in accordance with the technical - specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD - (World Business Council for Sustainable Development)/ PACT - initiative. - $ref: >- - #/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait - required: - - id - urn_samm_io.catenax.pcf_6.0.0_PrecedingPfIdsCharacteristic: - description: >- - Characteristic for defining a non-empty set of product (carbon) - footprint identifiers as specified in the Catena-X PCF Rulebook in - accordance with the WBCSD (World Business Council for Sustainable - Development) Pathfinder framework and the technical specifications for - PCF Data Exchange (Version 2.0.0) from the WBCSD/ PACT initiative. - type: array - items: - $ref: '#/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PrecedingPfId' - urn_samm_io.catenax.pcf_6.0.0_ProductFootprintVersion: - type: number - minimum: 0 - description: >- - Characteristic for defining a product footprint version as specified in - the Catena-X PCF Rulebook in accordance with the technical - specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD - (World Business Council for Sustainable Development)/ PACT initiative. - 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.pcf_6.0.0_PfStatusCharacteristic: - type: string - description: >- - Characteristic for defining a status indicator of a product (carbon) - footprint as specified in the Catena-X PCF Rulebook in accordance with - the technical specifications for PCF Data Exchange (Version 2.0.0) from - the WBCSD (World Business Council for Sustainable Development)/ PACT - initiative. Enumeration with possible "Active" and "Deprecated". - enum: - - Active - - Deprecated - urn_samm_io.catenax.pcf_6.0.0_NonEmptyStringTrait: - type: string - description: Constraint for ensuring that a string has at least one character. - minLength: 1 - urn_samm_io.catenax.pcf_6.0.0_IdsTrait: - description: >- - Constraint for defining a non-empty set of URIs (Uniform Resource - Identifieres). - type: array - items: - type: string - format: uri - minItems: 1 - urn_samm_io.catenax.pcf_6.0.0_DeclaredUnitCharacteristic: - type: string - description: >- - Unit of analysis of the product with accepted values as specified in the - Catena-X PCF Rulebook in accordance with the technical specifications - for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business - Council for Sustainable Development)/ PACT initiative. For countable - products/ components/ materials, Catena-X for example adds the unit - "piece" to the value list specified by WBCSD. - enum: - - liter - - kilogram - - cubic meter - - kilowatt hour - - megajoule - - ton kilometer - - square meter - - piece - urn_samm_io.catenax.pcf_6.0.0_StrictlyPositiveDecimalTrait: - type: number - description: Constraint for defining a positive, non-zero decimal. - minimum: 0 - exclusiveMinimum: true - urn_samm_io.catenax.pcf_6.0.0_PositiveDecimalWeightTrait: - type: number - description: Constraint for defining a decimal equal to or greater than zero. - minimum: 0 - exclusiveMinimum: false - urn_samm_io.catenax.pcf_6.0.0_ExemptedEmissionsPercentTrait: - type: number - description: >- - Characteristic for defining the percentage of emissions excluded from a - PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook - in accordance with the technical specifications for PCF Data Exchange - (Version 2.0.0) from the WBCSD (World Business Council for Sustainable - Development)/ PACT initiative. - maximum: 5 - exclusiveMaximum: false - minimum: 0 - exclusiveMinimum: false - urn_samm_io.catenax.pcf_6.0.0_GeographyCountrySubdivisionTrait: - type: string - description: >- - Constraint for defining a geography country subdivision in compliance to - ISO 3166-2 as specified in the Catena-X PCF Rulebook in accordance with - the technical specifications for PCF Data Exchange (Version 2.0.0) from - the WBCSD (World Business Council for Sustainable Development)/ PACT - initiative. - pattern: ([A-Z]{2}-[A-Z0-9]{1,3}|) - urn_samm_io.catenax.pcf_6.0.0_GeographyCountryTrait: - type: string - description: >- - Constraint for defining a geography country conform to ISO 3166CC as - specified in the Catena-X PCF Rulebook in accordance with the technical - specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD - (World Business Council for Sustainable Development)/ PACT initiative. - pattern: ([A-Z]{2}) - urn_samm_io.catenax.pcf_6.0.0_GeographyRegionOrSubregionCharacteristic: - type: string - description: >- - Characteristic for defining a list of valid geographic regions as - specified in the Catena-X PCF Rulebook in accordance with the technical - specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD - (World Business Council for Sustainable Development)/ PACT initiative. - In Catena-X for example "Global" has been added to the value list. - enum: - - Africa - - Americas - - Asia - - Europe - - Oceania - - Australia and New Zealand - - Central Asia - - Eastern Asia - - Eastern Europe - - Latin America and the Caribbean - - Melanesia - - Micronesia - - Northern Africa - - Northern America - - Northern Europe - - Polynesia - - South-eastern Asia - - Southern Asia - - Southern Europe - - Sub-Saharan Africa - - Western Asia - - Western Europe - - Global - urn_samm_io.catenax.pcf_6.0.0_CrossSectoralStandardsUsedEnumerationCharacteristic: - type: string - description: >- - Characteristic for defining the enumeration of valid accounting - standards used for product carbon footprint calculation as specified in - the Catena-X PCF Rulebook in accordance with the technical - specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD - (World Business Council for Sustainable Development)/ PACT initiative. - enum: - - GHG Protocol Product standard - - ISO Standard 14067 - - ISO Standard 14044 - urn_samm_io.catenax.pcf_6.0.0_CrossSectoralStandard: - description: >- - Entity for defining an accounting standard used for product carbon - footprint calculation as specified in the Catena-X PCF Rulebook in - accordance with the technical specifications for PCF Data Exchange - (Version 2.0.0) from the WBCSD (World Business Council for Sustainable - Development)/ PACT initiative. - type: object - properties: - crossSectoralStandard: - description: >- - Mandatory: Discloses a cross-sectoral standard applied for - calculating or allocating GHG (Greenhouse Gas) emissions as - specified in the Catena-X PCF Rulebook in accordance with the - technical specifications for PCF Data Exchange (Version 2.0.0) from - the WBCSD (World Business Council for Sustainable Development)/ PACT - initiative. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_CrossSectoralStandardsUsedEnumerationCharacteristic - required: - - crossSectoralStandard - urn_samm_io.catenax.pcf_6.0.0_CrossSectoralStandardSet: - description: >- - Characteristic for defining the list of valid accounting standards used - for product carbon footprint calculation as specified in the Catena-X - PCF Rulebook in accordance with the technical specifications for PCF - Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for - Sustainable Development)/ PACT initiative. - type: array - items: - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_CrossSectoralStandard - urn_samm_io.catenax.pcf_6.0.0_ProductOrSectorSpecificRuleOperator: - type: string - description: >- - Enumeration of PCR (Product Category Rule) operators as specified in the - technical specifications for PCF Data Exchange (Version 2.0.0) from the - WBCSD (World Business Council for Sustainable Development)/ PACT - initiative. WBCSD specific extension for example in Catena-X. - enum: - - PEF - - EPD International - - Other - urn_samm_io.catenax.pcf_6.0.0_RuleName: - description: >- - Name of a rule applied by a specified operator as specified in the - Catena-X PCF Rulebook in accordance with the technical specifications - for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business - Council for Sustainable Development)/ PACT initiative. - type: object - properties: - ruleName: - description: >- - Name of a rule applied by a specific operator as specified in the - Catena-X PCF Rulebook in accordance with the technical - specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD - (World Business Council for Sustainable Development)/ PACT - initiative. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_NonEmptyStringTrait - required: - - ruleName - urn_samm_io.catenax.pcf_6.0.0_RuleNamesTrait: - description: >- - Constraint for defining a non-empty set of rule names as specified in - the Catena-X PCF Rulebook in accordance with the technical - specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD - (World Business Council for Sustainable Development)/ PACT initiative. - type: array - items: - $ref: '#/components/schemas/urn_samm_io.catenax.pcf_6.0.0_RuleName' - uniqueItems: true - minItems: 1 - urn_samm_io.catenax.pcf_6.0.0_ProductOrSectorSpecificRule: - description: >- - Entity for defining a product or sector specific rule of a product - carbon footprint as specified in the Catena-X PCF Rulebook in accordance - with the technical specifications for PCF Data Exchange (Version 2.0.0) - from the WBCSD (World Business Council for Sustainable Development)/ - PACT initiative. - type: object - properties: - extWBCSD_operator: - description: >- - Mandatory: Operator of PCR (Product Category Rule)/ PSR (Product - Specific Rule) as specified in the technical specifications for PCF - Data Exchange (Version 2.0.0) from the WBCSD (World Business Council - for Sustainable Development)/ PACT initiative. WBCSD specific - extension, in Catena-X for example must always be "Other". - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_ProductOrSectorSpecificRuleOperator - productOrSectorSpecificRules: - description: >- - Mandatory: Product-specific or sector-specific set of rules used for - calculating or allocating GHG (Greenhouse Gas) emissions applied - from the specified operator as specified in the Catena-X PCF - Rulebook in accordance with the technical specifications for PCF - Data Exchange (Version 2.0.0) from the WBCSD (World Business Council - for Sustainable Development)/ PACT initiative. - $ref: '#/components/schemas/urn_samm_io.catenax.pcf_6.0.0_RuleNamesTrait' - extWBCSD_otherOperatorName: - description: >- - Optional: Other operator of PCR (Product Category Rule)/ PSR - (Product Specific Rule) as specified in the technical specifications - for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business - Council for Sustainable Development)/ PACT initiative. WBCSD - specific extension, in Catena-X for example specified by a default - value. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_NonEmptyStringTrait - required: - - extWBCSD_operator - - productOrSectorSpecificRules - urn_samm_io.catenax.pcf_6.0.0_ProductOrSectorSpecificRuleSet: - description: >- - Characteristic for defining the set of product or sector specific rules - of a product carbon footprint as specified in the Catena-X PCF Rulebook - in accordance with the technical specifications for PCF Data Exchange - (Version 2.0.0) from the WBCSD (World Business Council for Sustainable - Development)/ PACT initiative. - type: array - items: - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_ProductOrSectorSpecificRule - uniqueItems: true - urn_samm_io.catenax.pcf_6.0.0_CharacterizationFactorsCharacteristic: - type: string - description: >- - Characteristic for defining the characterization factors of a product - carbon footprint as specified in the Catena-X PCF Rulebook in accordance - with the technical specifications for PCF Data Exchange (Version 2.0.0) - from the WBCSD (World Business Council for Sustainable Development)/ - PACT initiative. In Catena-X for example specified by a default value. - enum: - - AR5 - - AR6 - urn_samm_io.catenax.pcf_6.0.0_AllocationWasteIncinerationCharacteristic: - type: string - description: >- - Characteristic for defining the allocation approach used for waste - incineration as specified by the TFS (Together For Sustainability) - initiative. - enum: - - cut-off - - reverse cut-off - - system expansion - urn_samm_io.catenax.pcf_6.0.0_PercentTrait: - type: number - description: Constraint for a decimal number in the range of and including 0 and 100. - maximum: 100 - exclusiveMaximum: false - minimum: 0 - exclusiveMinimum: false - urn_samm_io.catenax.pcf_6.0.0_EmissionFactorDS: - description: >- - Entity for defining an emission factor data source used to calculate a - product carbon footprint as specified in the Catena-X PCF Rulebook in - accordance with the technical specifications for PCF Data Exchange - (Version 2.0.0) from the WBCSD (World Business Council for Sustainable - Development)/ PACT initiative. - type: object - properties: - secondaryEmissionFactorSource: - description: >- - Mandatory: Emission factor data source used to calculate a product - carbon footprint as specified in the Catena-X PCF Rulebook in - accordance with the technical specifications for PCF Data Exchange - (Version 2.0.0) from the WBCSD (World Business Council for - Sustainable Development)/ PACT initiative. - $ref: >- - #/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text - required: - - secondaryEmissionFactorSource - urn_samm_io.catenax.pcf_6.0.0_EmissionFactorDSSet: - description: >- - Characteristic for defining a set of emission factor sources used for - calculating a product carbon footprint as specified in the Catena-X PCF - Rulebook in accordance with the technical specifications for PCF Data - Exchange (Version 2.0.0) from the WBCSD (World Business Council for - Sustainable Development)/ PACT initiative. - type: array - items: - $ref: '#/components/schemas/urn_samm_io.catenax.pcf_6.0.0_EmissionFactorDS' - uniqueItems: true - urn_samm_io.catenax.pcf_6.0.0_DqiNumberTrait: - type: number - description: Constraint for defining a decimal between 1 and 3 including. - maximum: 3 - exclusiveMaximum: false - minimum: 1 - exclusiveMinimum: false - urn_samm_io.catenax.pcf_6.0.0_DataQualityIndicators: - description: >- - Characteristic for defining the quantitative data quality indicators of - a PCF (Product Carbon Footprint) as specified in the Catena-X PCF - Rulebook in accordance with the technical specifications for PCF Data - Exchange (Version 2.0.0) from the WBCSD (World Business Council for - Sustainable Development)/ PACT initiative. - type: object - properties: - coveragePercent: - description: >- - Mandatory starting 2025: Percentage of PCF (Product Carbon - Footprint) included in the data quality assessment based on the >5% - emissions threshold as specified in the Catena-X PCF Rulebook in - accordance with the technical specifications for PCF Data Exchange - (Version 2.0.0) from the WBCSD (World Business Council for - Sustainable Development)/ PACT initiative. In Catena-X for example - set to "100" per default. - $ref: '#/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PercentTrait' - technologicalDQR: - description: >- - Mandatory starting 2025: Technological representativeness of the - sources used for PCF (Product Carbon Footprint) calculation based on - weighted average of all inputs representing >5% of PCF emissions. - Specified in the Catena-X PCF Rulebook in accordance with the - technical specifications for PCF Data Exchange (Version 2.0.0) from - the WBCSD (World Business Council for Sustainable Development)/ PACT - initiative. - $ref: '#/components/schemas/urn_samm_io.catenax.pcf_6.0.0_DqiNumberTrait' - temporalDQR: - description: >- - Mandatory starting 2025: Temporal representativeness of the sources - used for PCF (Product Carbon Footprint) calculation based on - weighted average of all inputs representing >5% of PCF emissions. - Specified in the Catena-X PCF Rulebook in accordance with the - technical specifications for PCF Data Exchange (Version 2.0.0) from - the WBCSD (World Business Council for Sustainable Development)/ PACT - initiative. - $ref: '#/components/schemas/urn_samm_io.catenax.pcf_6.0.0_DqiNumberTrait' - geographicalDQR: - description: >- - Mandatory starting 2025: Geographical representativeness of the - sources used for PCF (Product Carbon Footprint) calculation based on - weighted average of all inputs representing >5% of PCF emissions. - Specified in the Catena-X PCF Rulebook in accordance with the - technical specifications for PCF Data Exchange (Version 2.0.0) from - the WBCSD (World Business Council for Sustainable Development)/ PACT - initiative. - $ref: '#/components/schemas/urn_samm_io.catenax.pcf_6.0.0_DqiNumberTrait' - completenessDQR: - description: >- - Mandatory starting 2025: Completeness of the data collected for PCF - (Product Carbon Footprint) calculation based on weighted average of - all inputs representing >5% of PCF emissions. Specified in the - Catena-X PCF Rulebook in accordance with the technical - specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD - (World Business Council for Sustainable Development)/ PACT - initiative. - $ref: '#/components/schemas/urn_samm_io.catenax.pcf_6.0.0_DqiNumberTrait' - reliabilityDQR: - description: >- - Mandatory starting 2025: Reliability of the data collected for PCF - (Product Carbon Footprint) calculation based on weighted average of - all inputs representing >5% of PCF emissions. Specified in the - Catena-X PCF Rulebook in accordance with the technical - specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD - (World Business Council for Sustainable Development)/ PACT - initiative. - $ref: '#/components/schemas/urn_samm_io.catenax.pcf_6.0.0_DqiNumberTrait' - 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.pcf_6.0.0_PositiveEmissionsTrait: - type: number - description: 'Only positive emission values (>0) are valid ' - minimum: 0 - exclusiveMinimum: false - urn_samm_io.catenax.pcf_6.0.0_PositiveOrNegativeEmission: - type: number - description: >- - Characteristic for defining (positive or negative) emissions in context - of a PCF (Product Carbon Footprint) as specified by the WBCSD (World - Business Council for Sustainable Development) Pathfinder initiative. - urn_samm_io.catenax.pcf_6.0.0_NegativeEmissionsTrait: - type: number - description: Only negative emission values (<0) are valid. - maximum: 0 - exclusiveMaximum: false - urn_samm_io.catenax.pcf_6.0.0_PcfEntity: - description: >- - Characteristic for defining a PCF (Product Carbon Footprint) as - specified in the Catena-X PCF Rulebook in accordance with the technical - specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD - (World Business Council for Sustainable Development)/ PACT initiative. - type: object - properties: - declaredUnit: - description: >- - Mandatory: Unit of analysis of a product in context of the PCF - (product carbon footprint) as specified in the Catena-X PCF Rulebook - in accordance with the technical specifications for PCF Data - Exchange (Version 2.0.0) from the WBCSD (World Business Council for - Sustainable Development)/ PACT initiative. In Catena-X for example - list of valid units includes "piece". - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_DeclaredUnitCharacteristic - unitaryProductAmount: - description: >- - Mandatory: Amount of units contained within a product in context of - the PCF (Product Carbon Footprint) as specified in the Catena-X PCF - Rulebook in accordance with the technical specifications for PCF - Data Exchange (Version 2.0.0) from the WBCSD (World Business Council - for Sustainable Development)/ PACT initiative. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_StrictlyPositiveDecimalTrait - productMassPerDeclaredUnit: - description: >- - Mandatory: Mass of a product per declared unit in context of the PCF - (Product Carbon Footprint) as specified in the Catena-X PCF - Rulebook. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PositiveDecimalWeightTrait - exemptedEmissionsPercent: - description: >- - Mandatory: Percentage of emissions excluded from PCF (Product Carbon - Footprint) as specified in the Catena-X PCF Rulebook in accordance - with the technical specifications for PCF Data Exchange (Version - 2.0.0) from the WBCSD (World Business Council for Sustainable - Development)/ PACT initiative. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_ExemptedEmissionsPercentTrait - exemptedEmissionsDescription: - description: >- - Optional: Rationale behind exclusion of specific PCF (Product Carbon - Footprint) emissions as specified in the Catena-X PCF Rulebook in - accordance with the technical specifications for PCF Data Exchange - (Version 2.0.0) from the WBCSD (World Business Council for - Sustainable Development)/ PACT initiative. - $ref: >- - #/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text - boundaryProcessesDescription: - description: >- - Optional: Processes attributable to each lifecycle stage as - specified in the Catena-X PCF Rulebook in accordance with the - technical specifications for PCF Data Exchange (Version 2.0.0) from - the WBCSD (World Business Council for Sustainable Development)/ PACT - initiative. - $ref: >- - #/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text - geographyCountrySubdivision: - description: >- - Optional: Subdivision of a country which must be an ISO 3166-2 - subdivision code as specified in the Catena-X PCF Rulebook in - accordance with the technical specifications for PCF Data Exchange - (Version 2.0.0) from the WBCSD (World Business Council for - Sustainable Development)/ PACT initiative. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_GeographyCountrySubdivisionTrait - geographyCountry: - description: >- - Optional: Two letter country code that must conform to data type ISO - 3166CC as specified in the Catena-X PCF Rulebook in accordance with - the technical specifications for PCF Data Exchange (Version 2.0.0) - from the WBCSD (World Business Council for Sustainable Development)/ - PACT initiative. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_GeographyCountryTrait - geographyRegionOrSubregion: - description: >- - Mandatory: Region according to list as specified in the Catena-X PCF - Rulebook in accordance with the technical specifications for PCF - Data Exchange (Version 2.0.0) from the WBCSD (World Business Council - for Sustainable Development)/ PACT initiative. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_GeographyRegionOrSubregionCharacteristic - referencePeriodStart: - description: >- - Mandatory: Start of time boundary for which a PCF (Product Carbon - Footprint) value is considered to be representative as specified in - the Catena-X PCF Rulebook in accordance with the technical - specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD - (World Business Council for Sustainable Development)/ PACT - initiative. - $ref: >- - #/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp - referencePeriodEnd: - description: >- - Mandatory: End of time boundary for which a PCF (Product Carbon - Footprint) value is considered to be representative as specified in - the Catena-X PCF Rulebook in accordance with the technical - specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD - (World Business Council for Sustainable Development)/ PACT - initiative. - $ref: >- - #/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp - crossSectoralStandardsUsed: - description: >- - Mandatory: Discloses the cross-sectoral standards applied for - calculating or allocating GHG (Greenhouse Gas) emissions as - specified in the Catena-X PCF Rulebook in accordance with the - technical specifications for PCF Data Exchange (Version 2.0.0) from - the WBCSD (World Business Council for Sustainable Development)/ PACT - initiative. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_CrossSectoralStandardSet - productOrSectorSpecificRules: - description: >- - Mandatory: Product or sector specific rules applied for calculating - or allocating GHG (Greenhouse Gas) emissions, e.g. PCRs (Product - Category Rules), including operators or publishers and according - rule names as specified in the Catena-X PCF Rulebook in accordance - with the technical specifications for PCF Data Exchange (Version - 2.0.0) from the WBCSD (World Business Council for Sustainable - Development)/ PACT initiative. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_ProductOrSectorSpecificRuleSet - extWBCSD_characterizationFactors: - description: >- - Mandatory: IPCC (Intergovernmental Panel on Climate Change) version - of the GWP (Global Warming Potential) characterization factors used - for calculating the PCF (Product Carbon Footprint) as specified in - the technical specifications for PCF Data Exchange (Version 2.0.0) - from the WBCSD (World Business Council for Sustainable Development)/ - PACT initiative. WBCSD specific extension, in Catena-X for example - specified by default with value "AR6". - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_CharacterizationFactorsCharacteristic - extWBCSD_allocationRulesDescription: - description: >- - Optional: Allocation rules used and underlying reasoning in context - of a product carbon footprint as specified in the technical - specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD - (World Business Council for Sustainable Development)/ PACT - initiative. WBCSD specific extension, in Catena-X for example - specified by default with value "In accordance with Catena-X PCF - Rulebook". - $ref: >- - #/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Text - extTFS_allocationWasteIncineration: - description: >- - Mandatory: Allocation approach used for waste incineration with - energy recovery as specified by the TFS (Together For - Sustainability) initiative. In Catena-X for example must be - specified by value "cut-off". - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_AllocationWasteIncinerationCharacteristic - primaryDataShare: - description: >- - Mandatory starting 2025: Share of primary data in percent as - specified in the Catena-X PCF Rulebook in accordance with the - technical specifications for PCF Data Exchange (Version 2.0.0) from - the WBCSD (World Business Council for Sustainable Development)/ PACT - initiative. - $ref: '#/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PercentTrait' - secondaryEmissionFactorSources: - description: >- - Mandatory: Emission factors used for the PCF (Product Carbon - Footprint) calculation as specified in the Catena-X PCF Rulebook in - accordance with the technical specifications for PCF Data Exchange - (Version 2.0.0) from the WBCSD (World Business Council for - Sustainable Development)/ PACT initiative. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_EmissionFactorDSSet - dataQualityRating: - description: >- - Mandatory starting 2025: Quantitative data quality indicators of a - PCF (Product Carbon Footprint) as specified in the Catena-X PCF - Rulebook in accordance with the technical specifications for PCF - Data Exchange (Version 2.0.0) from the WBCSD (World Business Council - for Sustainable Development)/ PACT initiative. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_DataQualityIndicators - extWBCSD_packagingEmissionsIncluded: - description: >- - Mandatory: Flag indicating whether packaging emissions are included - in a PCF (Product Carbon Footprint) as specified in the technical - specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD - (World Business Council for Sustainable Development)/ PACT - initiative. WBCSD specific extension, in Catena-X for example value - is "TRUE" per default. - $ref: >- - #/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Boolean - pcfExcludingBiogenic: - description: >- - Mandatory: Product carbon footprint of a product excluding biogenic - emissions as specified in the Catena-X PCF Rulebook in accordance - with the technical specifications for PCF Data Exchange (Version - 2.0.0) from the WBCSD (World Business Council for Sustainable - Development)/ PACT initiative. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PositiveEmissionsTrait - pcfIncludingBiogenic: - description: >- - Mandatory starting 2025: Product carbon footprint of a product - including biogenic emissions as specified in the Catena-X PCF - Rulebook in accordance with the technical specifications for PCF - Data Exchange (Version 2.0.0) from the WBCSD (World Business Council - for Sustainable Development)/ PACT initiative. Optional value in - current specification version but will be mandatory in future - version. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PositiveOrNegativeEmission - fossilGhgEmissions: - description: >- - Mandatory starting 2025: Emissions from combustion of fossil sources - as specified in the Catena-X PCF Rulebook in accordance with the - technical specifications for PCF Data Exchange (Version 2.0.0) from - the WBCSD (World Business Council for Sustainable Development)/ PACT - initiative. Identical to "pcfExcludingBiogenic", will be removed in - later version. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PositiveEmissionsTrait - biogenicCarbonEmissionsOtherThanCO2: - description: >- - Mandatory starting 2025: GWP (Global Warming Potential) of biogenic - CO2e-emissions in production phase which contain only GHG - (Greenhouse Gas) emissions other than CO2 - excludes biogenic CO2. - For specification see Catena-X PCF Rulebook. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PositiveEmissionsTrait - biogenicCarbonWithdrawal: - description: >- - Mandatory starting 2025: Biogenic carbon content in the product - converted to CO2e as specified in the Catena-X PCF Rulebook in - accordance with the technical specifications for PCF Data Exchange - (Version 2.1.0) from the WBCSD (World Business Council for - Sustainable Development)/ PACT initiative. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_NegativeEmissionsTrait - dlucGhgEmissions: - description: >- - Mandatory starting 2025: Direct land use change CO2e emissions in - context of a product carbon footprint as specified in the Catena-X - PCF Rulebook in accordance with the technical specifications for PCF - Data Exchange (Version 2.0.0) from the WBCSD (World Business Council - for Sustainable Development)/ PACT initiative. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PositiveEmissionsTrait - extTFS_luGhgEmissions: - description: >- - Mandatory starting 2025: Land use CO2 emissions in context of a - product carbon footprint as specified by the TFS (Together For - Sustainability) initiative. TFS specific extension. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PositiveOrNegativeEmission - aircraftGhgEmissions: - description: >- - Mandatory starting 2025: GHG (Greenhouse Gas) emissions resulting - from aircraft engine usage for the transport of the product as - specified in the Catena-X PCF Rulebook in accordance with the - technical specifications for PCF Data Exchange (Version 2.0.0) from - the WBCSD (World Business Council for Sustainable Development)/ PACT - initiative. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PositiveEmissionsTrait - extWBCSD_packagingGhgEmissions: - description: >- - Optional: Emissions resulting from the packaging of the product as - specified in the technical specifications for PCF Data Exchange - (Version 2.0.0) from the WBCSD (World Business Council for - Sustainable Development)/ PACT initiative. WBCSD specific extension, - in Catena-X for example value is zero per default. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PositiveEmissionsTrait - distributionStagePcfExcludingBiogenic: - description: >- - Optional: Product carbon footprint for the distribution stage of a - product excluding biogenic emissions as specified in the Catena-X - PCF Rulebook. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PositiveEmissionsTrait - distributionStagePcfIncludingBiogenic: - description: >- - Optional: Product carbon footprint for the distribution stage of a - product including biogenic emissions as specified in the Catena-X - PCF Rulebook. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PositiveOrNegativeEmission - distributionStageFossilGhgEmissions: - description: >- - Optional: Emissions from the combustion of fossil sources in the - distribution stage as specified in the Catena-X PCF Rulebook. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PositiveEmissionsTrait - distributionStageBiogenicCarbonEmissionsOtherThanCO2: - description: >- - Optional: GWP (Global Warming Potential) of biogenic CO2e-emissions - in distribution phase which contain only GHG (Greenhouse Gas) - emissions other than CO2 ? excludes biogenic CO2. For specification - see Catena-X PCF Rulebook. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PositiveEmissionsTrait - distributionStageBiogenicCarbonWithdrawal: - description: >- - Optional: GWP (Global Warming Potential) of biogenic CO2-withdrawal - in distribution stage (biogenic CO2 contained in the product) as - specified in the Catena-X PCF Rulebook. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_NegativeEmissionsTrait - extTFS_distributionStageDlucGhgEmissions: - description: >- - Optional: Direct land use change CO2 emissions during distribution - stage in context of a product carbon footprint as specified in the - Catena-X PCF Rulebook. TFS specific extension. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PositiveEmissionsTrait - extTFS_distributionStageLuGhgEmissions: - description: >- - Optional: Land use CO2 emissions in context of a product carbon - footprint as specified by the TFS (Together For Sustainability) - initiative. TFS specific extension. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PositiveOrNegativeEmission - carbonContentTotal: - description: >- - Mandatory starting 2025: Total carbon content per declared unit in - context of a product carbon footprint as specified in the Catena-X - PCF Rulebook. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PositiveEmissionsTrait - extWBCSD_fossilCarbonContent: - description: >- - Optional: Fossil carbon amount embodied in a product as specified in - the technical specifications for PCF Data Exchange (Version 2.1.0) - from the WBCSD (World Business Council for Sustainable Development)/ - PACT initiative. Must be calculated with kgC (kilogram Carbon) / - declaredUnit equal to or greater zero; WBCSD specific extension, in - Catena-X specified by a calculated value. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PositiveEmissionsTrait - carbonContentBiogenic: - description: >- - Mandatory starting 2025: Biogenic carbon amount embodied in a - product as specified in the Catena-X PCF Rulebook in accordance with - the technical specifications for PCF Data Exchange (Version 2.1.0) - from the WBCSD (World Business Council for Sustainable Development)/ - PACT initiative. Must be calculated with kgC (kilogram Carbon) / - declaredUnit equal to or greater zero. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PositiveEmissionsTrait - distributionStageAircraftGhgEmissions: - description: >- - Optional: GHG (Greenhouse Gas) emissions for the distribution stage - resulting from aircraft engine usage for the transport of the - product as specified in the Catena-X PCF Rulebook in accordance with - the technical specifications for PCF Data Exchange (Version 2.0.0) - from the WBCSD (World Business Council for Sustainable Development)/ - PACT initiative. - $ref: >- - #/components/schemas/urn_samm_io.catenax.pcf_6.0.0_PositiveEmissionsTrait - required: - - declaredUnit - - unitaryProductAmount - - productMassPerDeclaredUnit - - exemptedEmissionsPercent - - geographyRegionOrSubregion - - referencePeriodStart - - referencePeriodEnd - - crossSectoralStandardsUsed - - productOrSectorSpecificRules - - extWBCSD_characterizationFactors - - extTFS_allocationWasteIncineration - - secondaryEmissionFactorSources - - extWBCSD_packagingEmissionsIncluded - - pcfExcludingBiogenic \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/PURIS Kit/Software Development View/page_software-development-view.md b/docs-kits_versioned_docs/version-24.05/kits/PURIS Kit/Software Development View/page_software-development-view.md deleted file mode 100644 index 991779c0fcd..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/PURIS Kit/Software Development View/page_software-development-view.md +++ /dev/null @@ -1,727 +0,0 @@ ---- -id: Software Development PURIS Kit -title: Software Development View -description: 'PURIS Kit' -sidebar_position: 4 ---- - - - -## Introduction - -This page gives an overview that is relevant for implementing PURIS standards. The Architecture chapter describes the interactions of all components in the PURIS context as well as the shared aspect approach. The Policies chapter describe the access policies, usage policies, contract definitions and include information about the framework agreement. The Protocol chapter gives examples how the connector data asset is registered and how shell descriptors are created. In the chapter Sample Data the PURIS submodels are defined with a reference to the turtle file and an example JSON payload. A ready PURIS implementation and quick installation guides are referenced in the last chapter. - -## Architecture - -Shown in this chapter are the interactions of all components required to fulfil the PURIS standard. -Also the standards' transferred data objects are shown in the Catena-X context of registered assets. - -### Component Architecture - -Figure 1 shows the high-level architecture of the Submodel exchange in the Catena-X dataspace and the services that are involved. Both the data provider and the data consumer must be members of the Catena-X network in order to communicate with each other. With the help of Credential Service and the Identity Access Management (IAM) each participant can authenticate itself, verify the identity of the requesting party and decide whether to authorize the request. The data is provisioned in accordance with the [Digital Twin KIT](https://eclipse-tractusx.github.io/docs-kits/next/kits/Digital%20Twin%20Kit/Software%20Development%20View/dt-kit-interaction-patterns) in Catena-X. The architecture in this figure only applies to standards that are based on the Digital Twins in Catena-X ([Digital Twin KIT](https://eclipse-tractusx.github.io/docs-kits/next/kits/Digital%20Twin%20Kit/Software%20Development%20View/dt-kit-interaction-patterns)). - -![high-level architecture of the submodel exchange in the Catena-X](resources/PURIS-R2405-architecture-sketch.png) -*Figure 1: high-level architecture of the submodel exchange in the Catena-X* - -### Distribution of aspects in shared asset approach - -Figure 2 shows how the shared asset approach is realized. The orange lines show which submodels belong to the respective AAS. All specific submodels are bound to the specific Part Type's context e.g., meaning that each aspect is described for the specific catalog item on supplier and customer side represented by the AASs. See [Digital Twin KIT](https://eclipse-tractusx.github.io/docs-kits/category/digital-twin-kit) for more information on the shared asset approach. -The orange submodels are the submodels used within this standard's context. - -The grey submodels are used within the [Industry Core KIT](https://eclipse-tractusx.github.io/docs-kits/next/category/industry-core-kit) (PartTypeInformation, SingleLevelBomAsPlanned, SingleLevelUsageAsPlanned). Besides PartTypeInformation on supplier-side, no other models are mandatory. The Bill Of Material (BOM) and usage models can be used to build data chains, if the partners align to (see [Industry Core KIT](https://eclipse-tractusx.github.io/docs-kits/next/category/industry-core-kit)). This KIT relies on the "Part Type" life cycle of the Industry Core representing catalog items after sourcing. - -The blue dashed lines show the references between DTs based on Catena-X UUIDs and BPNL information that may be resolved by the Item Relationship Service (see [Industry Core KIT](https://eclipse-tractusx.github.io/docs-kits/next/category/industry-core-kit), [Data Chain KIT](https://eclipse-tractusx.github.io/docs-kits/category/data-chain-kit) and [Traceability KIT](https://eclipse-tractusx.github.io/docs-kits/category/traceability-kit)). - -The shared asset approach shown in figure 2 is one of the patterns described in the Digital Twin KIT. It preserves the sovereignty by provisioning the aspect on on the owning partner's side creating a common view on the asset. A shared asset approach is needed whenever the customer provides data for a part type digital twin. The following implications apply: - -- The supplier generates the Catena-X ID and provides the aspect model PartTypeInformation while the customer reuses the generated Catena-X ID for his digital twin representation (see Industry Core KIT). -- If only the supplier would provide the Planned Production Output, no digital twin representation would be needed on the customer-side. -- Also if only the customer provides information (e.g. Short-Term Material Demand), the supplier needs to create the digital twin first so that the customer can create his representation. -- While one supplier side twin can be created to handle multiple customers, a customer must create the representation of the specific twin per supplier - also if it's the same part type from customer point of view. - -Note: from business point of view a quid-pro-quo principle of exchanged information is recommended (stock for stock, production for demand, delivery information as needed based inco term). - -![Figure 2: Conceptual levels of provisioning digital twins in the shared asset approach.](resources/PURIS-Conceptual-levels-R2405.png) -*Figure 2: Conceptual levels of provisioning digital twins in the shared asset approach.* - -## Policies​ - -### Access Policies​ - -To enable data sovereignty, access and usage policies are important to protect the data assets of a data provider in the connector, as described in the [Connector KIT](https://eclipse-tractusx.github.io/docs-kits/next/category/connector-kit). -To decide which company has access to the data assets, access policy should be used. Note that without protecting data assets with access policies, they become publicly available in the Catena-X network which is not recommended. - -Therefore, every asset should be protected and only be made available through specified BPNL policy groups or specific BPNL policies. For a detailed description, see [Business Partner Validation Extension, Release 0.6.0](https://github.com/eclipse-tractusx/tractusx-edc/tree/f07dc2bcfab393774f796de3560508f300061b62/edc-extensions/bpn-validation). - -### BPNL Access Policy​ - -This policy allows limiting access to a data offer based on a list of specific BPNLs. This translates to the following functionality: - -- The data offer creator will be able to create a policy listing all the BPN that can access the data offer. -- This means that only the connectors registered in the Catena-X network with the BPNL listed in the policy can see the data offer and accept it (for the creation of data contracts and subsequent data exchange). - -**Implementation Hint**: - -Examples including a JSON payload for a BPNL group access policy are described in the [tractus-x EDC repository, Release 0.6.0](https://github.com/eclipse-tractusx/tractusx-edc/tree/f07dc2bcfab393774f796de3560508f300061b62/edc-extensions/bpn-validation). -This reference implementation also provides an extension to add the BPNL of the requesting party to the header of a proxied request. As a result, during implementation one can use this bpnl to design the internal submodel api design. - -### Usage Policies​ - -To decide which company can use the data asset under specific conditions, usage policies (also referred to as contract policies) are used. Therefore, they are more specific than access policies and only used just after access is granted. Currently, the usage policies aren't technically enforced but based on a legal framework agreements. Signing of framework agreements can be enforced during negotiation depending on the connector implementation. - -Policies are defined based on the [W3C ODRL format](https://www.w3.org/TR/odrl-model/). This allows a standardized way of formulating policy payloads. It further allows to stack different constraints with the odrl:and operator. Therefore, every data provider can decide on his or her own under which conditions their data assets are shared in the network. It is recommended to restrict the data usage for all exchanged data standards. An example of one usage policy containing three different constraints is shown and described in the following: - -```json -{ - "@context": { - "odrl": http://www.w3.org/ns/odrl/2/ - }, - "@type": "PolicyDefinitionRequestDto", - "@id": "", // Important for the contract definition - "policy": { - "@type": "Policy", - "odrl:permission": [ - { - "odrl:action": "USE", - "odrl:constraint": { - "@type": "LogicalConstraint", - "odrl:and": [ // All of the following three constraints have to be fullfilled (and, not or) - // First constraint to verify the the Catena-X membership - { - "@type": "Constraint", - "odrl:leftOperand": "Membership", - "odrl:operator": { - "@id": "odrl:eq" - }, - "odrl:rightOperand": "active" - }, - // Second constraint to verify if the framework agreement for PURIS - { - "@type": "Constraint", - "odrl:leftOperand": "FrameworkAgreement.puris", - "odrl:operator": { - "@id": "odrl:eq" - }, - "odrl:rightOperand": "active" - } - ] - } - } - ] - } -} -``` - -#### Membership Policy​ - -To verify the participants Catena-X membership, the Membership verifiable credential can be used. In case of a policy, the data can only be used from verified Catena-X members. The payload is shown in the first constraint-part of the example above and described in detail in the [connector part of the SSI documentation](https://github.com/eclipse-tractusx/ssi-docu/blob/main/docs/architecture/cx-3-2/edc/policy.definitions.md#1-membership-constraint). - -```json -{ - "@type": "Constraint", - "odrl:leftOperand": "Membership", - "odrl:operator": { - "@id": "odrl:eq" - }, - "odrl:rightOperand": "active" -} -``` - -#### Framework Agreement Policy​ - -To verify if a participant accepted the framework agreement of a specific use case created by the [Catena-X association](https://catena-x.net/en/catena-x-introduce-implement/governance-framework-for-data-space-operations), the `FrameworkAgreement.puris` verifiable credential can be used for the PURIS framework agreement. In case of a policy, the data can only be used from accepted and verified PURIS framework agreement members. This is shown in the second constraint-part of the example above. - -```json -{ - "@type": "Constraint", - "odrl:leftOperand": "FrameworkAgreement.puris", - "odrl:operator": { - "@id": "odrl:eq" - }, - "odrl:rightOperand": "active" -} -``` - -### Contract Definitions​ - -In the connector, every policy is associated with a contract. Thus, a contract definition is needed, detailing what policies are required when contracting assets. -When using an above mentioned Access Policy, their `ACCESS_POLICY_ID` needs to be included as a value of the accessPolicyId key in the contract definition. -When using an above mentioned Usage Policy, their `CONTRACT_POLICY_ID` needs to be included as a value of the contractPolicyId key in the contract definition. - -```json -{ - "id": "{{CONTRACT_DEFINITION_ID}}", - "criteria": [ - { - "operandLeft": "asset:prop:id", - "operator": "=", - "operandRight": "{{ASSET_ID}}" - } - ], - "accessPolicyId": "{{ACCESS_POLICY_ID}}", - "contractPolicyId": "{{CONTRACT_POLICY_ID}}" -} -``` - -For a more detailed tutorial on creating contracts for assets, see in [Chapter 3 of the End-to-End Adopter Journey](https://eclipse-tractusx.github.io/docs/tutorials/e2e/boost/provideData). - -## Protocol - -This chapter contains data structures that are designed for providing data in the PURIS standards. -The PURIS KIT does not define its own protocol, as it is using the communication pattern described in the [Digital Twin KIT](https://eclipse-tractusx.github.io/docs-kits/next/kits/Digital%20Twin%20Kit/Software%20Development%20View/dt-kit-interaction-patterns) and relies on the [Part Type Twin definitions of the Industry Core KIT](https://eclipse-tractusx.github.io/docs-kits/kits/Industry%20Core%20Kit/Software%20Development%20View/Digital%20Twins%20Development%20View%20Industry%20Core%20Kit). - -Examples of how the required data structures for that pattern may look like for PURIS are described in this chapter. - -### Connector Data Asset Structure - -To allow partners to find data regarding a specific Industry Core Part Type Twin, the provider has to register a connector data asset (see [Connector KIT](https://eclipse-tractusx.github.io/docs-kits/next/category/connector-kit)) specifying the address of the Digital Twin Registry of the provider (see [Digital Twin KIT](https://eclipse-tractusx.github.io/docs-kits/next/kits/Digital%20Twin%20Kit/Software%20Development%20View/dt-kit-interaction-patterns)). -The structure is as follows: - -```json -{ - "@context": { - "@vocab": "https://w3id.org/edc/v0.0.1/ns/", - "cx-common": "https://w3id.org/catenax/ontology/common#", - "cx-taxo": "https://w3id.org/catenax/taxonomy#", - "dct": "http://purl.org/dc/terms/" - }, - "@id": "{{CONNECTOR_ASSET_ID}}", // defined by yourself - "properties": { - "dct:type": {"@id": "cx-taxo:DigitalTwinRegistry"}, - "cx-common:version": "3.0" - }, - "privateProperties": { - }, - "dataAddress": { - "@type": "DataAddress", - "type": "HttpData", - "baseUrl": "{{ DIGITAL_TWIN_REGISTRY_ENDPOINT }}", - "proxyQueryParams": "true", - "proxyBody": "false", - "proxyPath": "true", - "proxyMethod": "false", - } -} -``` - -The property `@id` must uniquely identify the connector data asset. -Other fields are predetermined by the used standard and protocol. - -### Connector Data Asset Structure for "Submodel" - -In order to allow partners to receive the actual "Item Stock" data as defined in chapter 3, the provider has to register a connector data asset (see [Connector KIT](https://eclipse-tractusx.github.io/docs-kits/next/category/connector-kit)) specifying the address of the submodel endpoint (see [Digital Twin KIT](https://eclipse-tractusx.github.io/docs-kits/next/category/digital-twin-kit)) providing the actual data. - -```json -{ - "@context": { - "@vocab": "https://w3id.org/edc/v0.0.1/ns/", - "cx-common": "https://w3id.org/catenax/ontology/common#", - "cx-taxo": "https://w3id.org/catenax/taxonomy#", - "dct": "http://purl.org/dc/terms/", - "aas-semantics": "https://admin-shell.io/aas/3/0/HasSemantics/" - }, - "@id": "{{CONNECTOR_ASSET_ID}}", // defined by yourself - "properties": { - "dct:type": {"@id": "cx-taxo:Submodel"}, - "cx-common:version": "3.0", - "aas-semantics:semanticId": {"@id": "urn:samm:io.catenax.item_stock:2.0.0#ItemStock"} - }, - "privateProperties": { - }, - "dataAddress": { - "@type": "DataAddress", - "type": "HttpData", - "baseUrl": "{{ SUBMODEL_ENDPOINT }}", - "proxyQueryParams": "false", - "proxyBody": "false", - "proxyPath": "true", - "proxyMethod": "false", - } -} -``` - -The property `@id` must uniquely identify the connector data asset. - -Other fields are predetermined by the used standard and protocol. - -Especially the semantic ID can be found in the Sample Data chapter and has to match the aspect model to be transferred. - -### Shell Descriptors - -The Shell Descriptor defines the metadata of the Industry Core Part Type Twin. The following example Shell Descriptor represents a the Shell Descriptor of a supplier who provides access to an "Item Stock" submodel (see [GitHub](https://github.com/eclipse-tractusx/sldt-semantic-models)) for two customers using the legacy access control in the digital twin registry reference implementation. For further information on the creation of Part Type Twins, refer to the [Digital Twin KIT](https://eclipse-tractusx.github.io/docs-kits/next/kits/Digital%20Twin%20Kit/Software%20Development%20View/dt-kit-software-development-view) and the [Industry Core KIT](https://eclipse-tractusx.github.io/docs-kits/next/category/industry-core-kit). - -When searching the data assets catalog of a data provider, a data consumer uses the assetId determined via subprotocolBody of the Submodel Descriptor's endpoint definition of subprotocol type "DSP" of the Submodel Descriptor of interest. - -The relevant Submodel can be identified based on the semantic Id (see Sample Data chapter). - -```json -{ - "id": "{{TECHNIAL_TWIN_ID}}", - "globalAssetId": "{{MATERIAL_NUMBER_CX}}", - "idShort": "Semiconductor", - "specificAssetIds": [ - { - "name": "digitalTwinType", - "value": "PartType", - "externalSubjectId": { - "type": "ExternalReference", - "keys": [ - { - "type": "GlobalReference", - "value": "{{SUPPLIER_BPNL}}" - }, - { - "type":"GlobalReference", - "value":"{{CUSTOMER_BPNL}}" - }, - { - "type":"GlobalReference", - "value":"{{OTHER_CUSTOMER_BPNL}}" - } - ] - } - }, - { - "name": "manufacturerPartId", - "value": "{{MATERIAL_NUMBER_SUPPLIER}}", - "externalSubjectId": { - "type": "ExternalReference", - "keys": [ - { - "type": "GlobalReference", - "value": "{{SUPPLIER_BPNL}}" - }, - { - "type":"GlobalReference", - "value":"{{CUSTOMER_BPNL}}" - }, - { - "type":"GlobalReference", - "value":"{{OTHER_CUSTOMER_BPNL}}" - } - ] - } - }, - { - "name": "manufacturerId", - "value": "{{SUPPLIER_BPNL}}", - "externalSubjectId": { - "type": "ExternalReference", - "keys": [ - { - "type": "GlobalReference", - "value": "{{SUPPLIER_BPNL}}" - }, - { - "type":"GlobalReference", - "value":"{{CUSTOMER_BPNL}}" - }, - { - "type":"GlobalReference", - "value":"{{OTHER_CUSTOMER_BPNL}}" - } - ] - } - }, - { - "name": "customerPartId", - "value": "{{MATERIAL_NUMBER_CUSTOMER}}", - "externalSubjectId": { - "type": "ExternalReference", - "keys": [ - { - "type": "GlobalReference", - "value": "{{SUPPLIER_BPNL}}" - }, - { - "type":"GlobalReference", - "value":"{{CUSTOMER_BPNL}}" - } - ] - } - }, - { - "name": "customerPartId", - "value": "{{MATERIAL_NUMBER_OTHER_CUSTOMER}}", - "externalSubjectId": { - "type": "ExternalReference", - "keys": [ - { - "type": "GlobalReference", - "value": "{{SUPPLIER_BPNL}}" - }, - { - "type":"GlobalReference", - "value":"{{OTHER_CUSTOMER_BPNL}}" - } - ] - } - } - ], - "submodelDescriptors": [ - { - "id": "e5c96ab5-896a-482c-8761-efd74777ca97", - "semanticId": { - "type": "ExternalReference", - "keys": [ - { - "type": "GlobalReference", - "value": "urn:samm:io.catenax.item_stock:2.0.0#ItemStock" - } - ] - }, - "endpoints": [ - { - "interface": "SUBMODEL-3.0", - "protocolInformation": { - "href": "{{SUPPLIER_CONNECTOR_DATAPLANE_PUBLIC_API}}/{{PATH_IF_NEEDED}}", - "endpointProtocol": "HTTP", - "endpointProtocolVersion": [ - "1.1" - ], - "subprotocol": "DSP", - "subprotocolBody": "id={{CONNECTOR_ASSET_ID}};dspEndpoint={{SUPPLIER_CONNECTOR_DSP_ENDPOINT}}", - "subprotocolBodyEncoding": "plain", - "securityAttributes": [ - { - "type": "NONE", - "key": "NONE", - "value": "NONE" - } - ] - } - } - ] - }, - { - "id": "a6c96ab5-896a-482c-8761-efd74777ca99", - "semanticId": { - "type": "ExternalReference", - "keys": [ - { - "type": "GlobalReference", - "value": "urn:samm:io.catenax.item_stock:2.0.0#ItemStock" - } - ] - }, - "endpoints": [ - { - "interface": "SUBMODEL-3.0", - "protocolInformation": { - "href": "{{SUPPLIER_CONNECTOR_DATAPLANE_PUBLIC_API}}/{{PATH_IF_NEEDED}}", - "endpointProtocol": "HTTP", - "endpointProtocolVersion": [ - "1.1" - ], - "subprotocol": "DSP", - "subprotocolBody": "id={{CONNECTOR_ASSET_ID}};dspEndpoint={{SUPPLIER_CONNECTOR_DSP_ENDPOINT}}", - "subprotocolBodyEncoding": "plain", - "securityAttributes": [ - { - "type": "NONE", - "key": "NONE", - "value": "NONE" - } - ] - } - } - ] - } - ] -} -``` - -## Sample Data - -The semantic models in the business context are defined in the PURIS Adoption View. This chapter gives additional information for each aspect model by providing the example data objects in JSON format, link to the RDF turtle file on GitHub and unique semantic id of the aspect model. - -### 1. Item Stock v.2.0.0 - -GitHub link to semantic data model in RDF turtle format: -This aspect model has the following semantic id: - -`urn:samm:io.catenax.item_stock:2.0.0#ItemStock` - -**Example**: Item stock of 20 pieces for an order position of a given material with the Catena-X ID "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df". This data object is created by the customer for its supplier, therefore with a direction "INBOUND". - -```json -{ - "materialGlobalAssetId": "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df", - "positions": [ { - "orderPositionReference": { - "supplierOrderId": "M-Nbr-4711", - "customerOrderId": "C-Nbr-4711", - "customerOrderPositionId": "PositionId-01" - }, - "allocatedStocks": [ { - "isBlocked": false, - "stockLocationBPNA": "BPNA1234567890ZZ", - "lastUpdatedOnDateTime": "2023-04-28T14:23:00.123456+14:00", - "quantityOnAllocatedStock": { - "value": 20.0, - "unit": "unit:piece" - }, - "stockLocationBPNS": "BPNS1234567890ZZ" - } ] - } ], - "direction": "INBOUND" -} -``` - -### 2. Short-Term Material Demand v1.0.0 - -GitHub link to semantic data model in RDF turtle format: -This aspect model has the following semantic id: - -`urn:samm:io.catenax.short_term_material_demand:1.0.0#ShortTermMaterialDemand` - -**Example 1**: A demand quantity of 180 pieces with a demand category "series" and a demand quantity of 100 pieces with demand category "after-sales" for a material with Catena-X ID "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df". The customer location varies for the different demand series. This Short-Term Material Demand is the demand that a supplier received from a customer. - -```json -{ - "materialGlobalAssetId": "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df", - "demandSeries": [ - { - "lastUpdatedOnDateTime": "2023-11-05T08:15:30.123-05:00", - "expectedSupplierLocation": "BPNS8888888888XX", - "demands": [ - { - "demand": { - "value": 180.0, - "unit": "unit:piece" - }, - "day": "2023-10-09" - } - ], - "customerLocation": "BPNS8888888888XX", - "demandCategory": { - "demandCategoryCode": "SR99" - } - }, - { - "expectedSupplierLocation": "BPNS8888888888XX", - "lastUpdatedOnDateTime": "2023-11-05T08:15:30.123-05:00", - "demands": [ - { - "demand": { - "value": 100.0, - "unit": "unit:piece" - }, - "day": "2023-10-09" - } - ], - "customerLocation": "BPNS5555555555XX", - "demandCategory": { - "demandCategoryCode": "A1S1" - } - } - ] -} -``` - -### 3. Delivery Information v2.0.0 - -GitHub link to semantic data model in RDF turtle format: -This aspect model has the following semantic id: - -`urn:samm:io.catenax.delivery_information:2.0.0#DeliveryInformation` - -The JSONs snippets below provide an example of the value-only serialization of the "DeliveryInformation" aspect model for three different delivery situations: - -1. A not yet departed delivery - estimated departure and arrival dates -2. A delivery in transit - actual departure and estimated arrival dates -3. A delivery with actual arrival times - actual departure and arrival dates - -**Example 1**: The order has not yet departed from its origin, as is indicated by the estimated values for both departure and arrival (see transitEvents property). This is an example of estimated delivery. - -```json -{ - "materialGlobalAssetId": "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df", - "positions": [ { - "orderPositionReference": { - "supplierOrderId": "M-Nbr-4711", - "customerOrderId": "C-Nbr-4711", - "customerOrderPositionId": "PositionId-01" - }, - "deliveries": [ { - "lastUpdatedOnDateTime": "2023-04-28T14:23:00.123456+14:00", - "deliveryQuantity": { - "value": 20.0, - "unit": "unit:piece" - }, - "transitEvents": [ { - "dateTimeOfEvent": "2023-04-01T14:23:00+01:00", - "eventType": "estimated-departure" - }, - { - "dateTimeOfEvent": "2023-04-05T14:23:00+01:00", - "eventType": "estimated-arrival" - } ], - "trackingNumber": "1Z9829WDE02128", - "incoterm": "EXW", - "transitLocations": { - "destination": { - "bpnsProperty": "BPNS0000000410ZZ", - "bpnaProperty": "BPNA0000002082ZZ" - }, - "origin": { - "bpnsProperty": "BPNS0000000185ZZ", - "bpnaProperty": "BPNA0000001982ZZ" - } - } - } ] - } ] -} -``` - -**Example 2**: The status of this delivery is currently in transit, denoted by the actual departure and estimated arrival values (see transitEvents property). - -```json -{ - "materialGlobalAssetId": "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df", - "positions": [ { - "orderPositionReference": { - "supplierOrderId": "M-Nbr-4711", - "customerOrderId": "C-Nbr-4711", - "customerOrderPositionId": "PositionId-01" - }, - "deliveries": [ { - "lastUpdatedOnDateTime": "2023-04-28T14:23:00.123456+14:00", - "deliveryQuantity": { - "value": 20.0, - "unit": "unit:piece" - }, - "transitEvents": [ { - "dateTimeOfEvent": "2023-04-01T14:23:00+01:00", - "eventType": "actual-departure" - }, - { - "dateTimeOfEvent": "2023-04-05T14:23:00+01:00", - "eventType": "estimated-arrival" - } ], - "trackingNumber": "1Z9829WDE02128", - "incoterm": "EXW", - "transitLocations": { - "destination": { - "bpnsProperty": "BPNS0000000410ZZ", - "bpnaProperty": "BPNA0000002082ZZ" - }, - "origin": { - "bpnsProperty": "BPNS0000000185ZZ", - "bpnaProperty": "BPNA0000001982ZZ" - } - } - } ] - } ] -} -``` - -**Example 3**: As seen from the actual departure and actual arrival values (see transitEvents property), this is an example of a completed delivery. - -```json -{ - "materialGlobalAssetId": "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df", - "positions": [ { - "orderPositionReference": { - "supplierOrderId": "M-Nbr-4711", - "customerOrderId": "C-Nbr-4711", - "customerOrderPositionId": "PositionId-01" - }, - "deliveries": [ { - "lastUpdatedOnDateTime": "2023-04-28T14:23:00.123456+14:00", - "deliveryQuantity": { - "value": 20.0, - "unit": "unit:piece" - }, - "transitEvents": [ { - "dateTimeOfEvent": "2023-04-01T14:23:00+01:00", - "eventType": "actual-departure" - }, - { - "dateTimeOfEvent": "2023-04-05T14:23:00+01:00", - "eventType": "actual-arrival" - } ], - "trackingNumber": "1Z9829WDE02128", - "incoterm": "EXW", - "transitLocations": { - "destination": { - "bpnsProperty": "BPNS0000000410ZZ", - "bpnaProperty": "BPNA0000002082ZZ" - }, - "origin": { - "bpnsProperty": "BPNS0000000185ZZ", - "bpnaProperty": "BPNA0000001982ZZ" - } - } - } ] - } ] -} -``` - -### 4. Planned Production Output Exchange v2.0.0 - -GitHub link to semantic data model in RDF turtle format: -This aspect model has the following semantic id: - -`urn:samm:io.catenax.planned_production_output:2.0.0#PlannedProductionOutput` - -Example: The *Planned Production Output* quantities for three consecutive days in two different sites (BPNS) for a material with Catena-X ID "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df". - -```json -{ - "materialGlobalAssetId": "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df", - "positions": [ - { - "lastUpdatedOnDateTime": "2023-04-01T14:23:00+01:00", - "orderPositionReference": { - "supplierOrderId": "M-Nbr-4711", - "customerOrderId": "C-Nbr-4711", - "customerOrderPositionId": "PositionId-01" - }, - "allocatedPlannedProductionOutputs": [ - { - "plannedProductionQuantity": { - "value": 10.0, - "unit": "unit:piece" - }, - "productionSiteBpns": "BPNS0123456789ZZ", - "estimatedTimeOfCompletion": "2023-04-01T14:23:00+01:00" - }, - { - "plannedProductionQuantity": { - "value": 20.0, - "unit": "unit:piece" - }, - "productionSiteBpns": "BPNS0123456789YZ", - "estimatedTimeOfCompletion": "2023-04-02T14:23:00+01:00" - }, - { - "plannedProductionQuantity": { - "value": 10.0, - "unit": "unit:piece" - }, - "productionSiteBpns": "BPNS0123456789ZZ", - "estimatedTimeOfCompletion": "2023-04-03T14:23:00+01:00" - } - ] - } - ] -} -``` - -## Reference Implementation - -The [PURIS demonstrator and its documentation](https://github.com/eclipse-tractusx/puris/tree/29a20f9ea38e1eb54a9d9c938b94b57dfc898c32/docs) are available at the Eclipse-TractusX GitHub. -The application serves as a reference implementation for the item stock, allowing to - -- request item stocks from partners -- provide item stocks to partners -- import item stock data for provision - -Arc42 of PURIS is found [here](https://github.com/eclipse-tractusx/puris/blob/main/docs/arc42/Index.md). - -### Setup - -The PURIS demonstrator can be deployed by following the [Project Installation](https://github.com/eclipse-tractusx/puris/blob/29a20f9ea38e1eb54a9d9c938b94b57dfc898c32/INSTALL.md) guide. -To run a test scenario locally, follow the [local testing and development guide](https://github.com/eclipse-tractusx/puris/blob/29a20f9ea38e1eb54a9d9c938b94b57dfc898c32/local/INSTALL.md). -A guide to run the integration tests is found [here](https://github.com/eclipse-tractusx/puris/blob/29a20f9ea38e1eb54a9d9c938b94b57dfc898c32/local/postman/README.md). diff --git a/docs-kits_versioned_docs/version-24.05/kits/PURIS Kit/Software Development View/resources/PURIS-Conceptual-levels-R2405.png b/docs-kits_versioned_docs/version-24.05/kits/PURIS Kit/Software Development View/resources/PURIS-Conceptual-levels-R2405.png deleted file mode 100644 index 63cf9fecf70..00000000000 Binary files a/docs-kits_versioned_docs/version-24.05/kits/PURIS Kit/Software Development View/resources/PURIS-Conceptual-levels-R2405.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-24.05/kits/PURIS Kit/Software Development View/resources/PURIS-R2405-architecture-sketch.png b/docs-kits_versioned_docs/version-24.05/kits/PURIS Kit/Software Development View/resources/PURIS-R2405-architecture-sketch.png deleted file mode 100644 index bb9da104407..00000000000 Binary files a/docs-kits_versioned_docs/version-24.05/kits/PURIS Kit/Software Development View/resources/PURIS-R2405-architecture-sketch.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-24.05/kits/PURIS Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-24.05/kits/PURIS Kit/page_adoption-view.md deleted file mode 100644 index c0c9f6f5337..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/PURIS Kit/page_adoption-view.md +++ /dev/null @@ -1,232 +0,0 @@ ---- -id: Adoption View PURIS Kit -title: Adoption View -description: 'PURIS Kit' -sidebar_position: 2 ---- - -### PURIS Kit - -## Vision & Mission - -### Vision - -***Revolutionizing the Global Supply Chain Ecosystem with Integrated, Proactive Data Sharing and Collaboration*** - -The introduction of the **P**redictive **U**nit **R**eal-Time **I**nformation **S**ervice (PURIS) enriches a company's resilience strategy through enhanced data sharing, giving stakeholders heightened transparency and comprehensive information. This clarity allows PURIS users to detect supply chain issues earlier, initiate solution-finding more swiftly, and access a wider array of options, leading to more effective, cost-efficient, and environmentally friendly outcomes. By facilitating proactive anticipation, concurrent management, and reactive recovery, PURIS supports the supply chain across pre-, during-, and post-disruption phases, thereby improving operational efficiency and resilience within the Catena-X network. - -### Mission - -***Empowering Stakeholders with Real-time, Predictive Insights for Proactive Supply Chain Management*** - -Building on a robust foundation, PURIS is redefining the paradigms of supply chain by establishing necessary standards and guidelines that ensure a comprehensive and compliant exchange of information. This initiative is not just about data exchange; it's about transforming the very fabric of supply chain interactions to foster and enable a proactive, rather than reactive, management approach. - -At the heart of PURIS's mission is the goal to provide stakeholders with advanced capabilities that enable informed, strategic decision-making. By integrating daily and predictive data, spanning (1) **Item Stock**, (2) **Short-term Material Demand**, (3) **Planned Production Outputs**, and (4) **Delivery Information**, PURIS creates a rich data landscape. This empowers businesses to anticipate, adapt, and align their operations with both current and upcoming events. - -Key aspects of PURIS include: - -- Ensuring that only necessary information is exchanged, maintaining privacy and compliance while offering a clear view of the supply situation based on actual, operational data. -- making the application accessible to all players in the supply chain, aiming to become a foundational building block for future industry standards. -- Facilitating a transparent, efficient, and compliant information exchange, enhancing predictive monitoring and early detection capabilities to optimize resource allocation and decision-making. -- Cultivating a collaborative environment where stakeholders can align on shared objectives, transitioning the industry towards a more transparent, predictable, and resilient supply chain ecosystem. -By considering these principles, PURIS is not just enhancing current supply chain management practices but is also paving the way for a more agile, informed, and responsive automotive industry. - -#### Example Use Case - -***Empowering Stakeholders with Predictive Insights for Proactive Supply Chain Management*** - -The rapid growth of the Electric Vehicle (EV) market has presented several significant supply chain challenges for automotive manufacturers. One of the critical issues involves managing the intricate supply chain for EV batteries, which are composed of various components such as lithium, cobalt, and nickel, sourced globally. This supply chain is not only highly complex but also highly volatile, with frequent fluctuations in demand and supply affecting production schedules, inventory levels, and ultimately, delivery times to consumers. - -In light of these challenges, the mission of PURIS, providing advanced data exchange and collaboration capabilities, becomes crucial. The mission addresses a concrete industry problem: the need for greater transparency, predictability, and efficiency in managing the EV battery supply chain. By enabling predictive insights into material shortages and facilitating daily data exchange on production outputs and material demands, stakeholders can proactively manage their operations, reduce risks of disruption, and optimize inventory management. - -##### Implementation Example - -1. Automotive manufacturers and suppliers enhance transparency in the supply chain by sharing daily data— manufacturers on short-term material demand and suppliers on planned production outputs. This shared data network allows manufacturers to validate whether their production demand will be met, reducing the risk of the bullwhip effect caused by information asymmetry. Conversely, suppliers gain insights into future demand, enabling them to optimize their production schedules more effectively. While this system doesn't predict customers' call offs, it allows both parties to make informed decisions, aligning production with actual market needs and ensuring a steady supply of EV batteries. -2. By leveraging standardized item stock and delivery information exchanges, manufacturers and suppliers can view daily inventory levels across the supply chain. This visibility enables them to manage stock more effectively, minimizing excess inventory and reducing the risk of stock shortages. -3. In the face of a sudden spike in demand or an unforeseen disruption in the supply of critical materials like lithium, the standardized data exchange framework allows for seamless information sharing among stakeholders. Manufacturers can quickly communicate their needs to suppliers, who can then adjust their delivery schedules or production outputs accordingly. This dynamic collaboration ensures that production is not halted and that customer demand is met without delay. - -##### Impact & Benefits - -This use case illustrates how PURIS enhancing data collaboration directly addresses the challenges of the EV battery supply chain. By providing a comprehensive, daily view of demand, stock levels, and production schedules, stakeholders can make informed decisions, respond flexibly to changes, and maintain efficient operations. Ultimately, this leads to shorter lead times, cost reductions, and a more responsive supply chain, benefiting manufacturers, suppliers, and consumers alike in the rapidly evolving EV market. - -## Business Value - -The traditional approach to managing supply chains is often unflexible and manual, leading to delays and limited proactive actions. This is particularly challenging when dealing with potential shortages that can affect the entire supply chain. -PURIS transforms this by creating a collaborative network within the CATENA-X data space, where partners, including suppliers and customers, share and use daily data. This approach allows for a dynamic and interconnected supply chain management, enhancing the ability to monitor supply and demand, identify potential issues early, and make informed decisions. -The benefits of adopting PURIS and the KIT for suppliers and customers include: - -- **Enhanced Operational Efficiency**: Automation and daily data sharing improve processes, reduce errors, and enhance inventory management, leading to lower costs, faster lead times, and better market responsiveness. -- **Strategic Supply Chain Resilience**: Predictive analytics help anticipate and mitigate risks, ensuring continuous and reliable service, maintaining customer trust, and safeguarding revenue. -- **Data-Driven Decision Making**: Access to comprehensive data supports advanced analytics and informed strategic choices, fostering innovation and tailored services for the automotive industry. -- **Ecosystem Collaboration and Innovation**: Participation in the Catena-X data space fosters collaboration and innovation, driving digital transformation in the automotive sector. -- **Sustainability and Regulatory Compliance**: Improved efficiency and transparency contribute to waste reduction, lower emissions, and compliance with environmental regulations and sustainability goals. - -By integrating PURIS KIT, service providers in the CATENA-X data space are not just responding to digital advancements but are actively defining the future of automotive supply chain management, emphasizing efficiency, resilience, and innovation. - -## Use Case / Domain explanation - -Given the context of the automotive industry and the integration of PURIS within the Catena-X network, let's delve into a specific use case domain: Optimization of supply chain visibility for electric vehicle (EV) production. This use case aims to address the challenges of electric vehicle manufacturing, which requires a complex network of suppliers and a high degree of component diversity. - -### Today's Challenge - -The shift to electric vehicle (EV) production presents companies with new and distinct challenges, particularly due to the complex and often volatile supply chain for EV components such as batteries, electric motors, and power electronics. Manufacturers frequently encounter challenges like unpredictable lead times, fluctuating demand for raw materials, and the need for stringent quality and safety standards. These factors lead to inefficiencies and elevated production costs, underscoring the importance of reliable supply chains to address these challenges effectively. - -Challenge - -1. Supply Chain Opacity: The lack of daily data and transparency in the supply chain makes it difficult to anticipate disruptions, manage inventory efficiently, and ensure timely delivery of components. -2. Complex and Volatile Supplier Network: The EV supply chain, with its widespread and diverse suppliers, faces visibility and control challenges. Demand volatility, influenced by key companies, impacts forecasting and immediate needs. Enhanced visibility can reduce costs by improving inventory management. -3. Regulatory and Environmental Compliance: With increasing regulation on carbon emissions and waste, there is a pressing need for manufacturers to ensure sustainable practices along the entire supply chain. - -Opportunities - -1. Increased Resilience: By engaging in this use case, stakeholders commit to a resilient supply chain capable of withstanding disruptions and adapting to changes in demand or supply conditions. -2. Innovation and Competitive Advantage: Embracing digital transformation through Catena-X compliant systems provides a foundation for innovation, allowing for novel solutions in EV production and beyond. -3. Sustainability and Compliance: Meeting the growing demands for environmental sustainability and regulatory compliance becomes attainable, enhancing brand reputation and stakeholder trust. - -### Benefits for LE (OEM, tier 1, etc.), SME, Solution Provider - -- **For Large Enterprises (LEs)**: Achieving daily visibility into the supply chain not only optimizes inventory levels and reduces lead times but also aids in strategic decision-making for future product developments. LEs benefit from enhanced agility, allowing them to better respond to market demand and regulatory changes while minimizing environmental impact. -- **For Small and Medium-sized Enterprises (SMEs)**: Currently companies often need to integrate to different customers' solutions to provide data or do it manually. Being part of a standardized, transparent network levels the playing field, giving SMEs the opportunity to showcase their capabilities and integrate more effectively into the supply chains of larger OEMs. It also reduces the barriers to entry for new markets and facilitates access to critical information that can drive operational improvements and innovation. -- **For Solution Providers**: Solution providers should align with Catena-X by offering interoperable, standardized services for the supply chain. This includes predictive analytics and collaborative platforms, enhancing innovation without risking lock-in, and promoting a competitive ecosystem. - -### Use Case Conclusion - -Addressing the challenge of optimizing supply chain visibility for EV production through the Catena-X network and KIT system provides tangible benefits for all stakeholders involved, from reducing operational inefficiencies and costs to fostering sustainability and innovation. The collaboration facilitated by this ecosystem encourages sharing of best practices, co-development of standards, and joint efforts in solving industry-wide challenges, ultimately leading to a more coherent, resilient, and sustainable automotive sector. - -## Semantic Models - -The information about the provided PURIS standardization objects is detailed in this section. It's used in ongoing business relationships and build-to-order (BTO) contexts, not for build-to-stock (BTS) situations without existing business ties. - -| Semantic Model | Version | Link to GitHub Repository | -| ------------------------------------------ | :-----: | ----------------------------------------------------------------------------------------------------------------------------------------------- | -| Item Stock (Release 24.05) | v.2.0.0 | [io.catenax.item_stock](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.item_stock) | -| Short-Term Material Demand (Release 24.05) | v.1.0.0 | [io.catenax.material_demand](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.material_demand) | -| Planned Production Output (Release 24.05) | v.2.0.0 | [io.catenax.planned_production_output](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.planned_production_output) | -| Delivery Information (Release 24.05) | v.2.0.0 | [io.catenax.delivery_information](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.delivery_information) | - -### Item Stock - -The Item Stock is the amount of material allocated to a partner that hasn't been shipped from the supplier and sits in the outbound warehouse or that has reached the customer but hasn't been used yet and sits in the inbound warehouse. By standardizing the Item Stock's definition and provisioning data via digital twins, all participants in the supply chain can share details about their material and product inventory quickly. This improves coordination and increases the options available to address any supply shortages. - -**Benefits for LEs, SMEs, and Solution Providers**: - -- **LEs**: They gain daily visibility into material availability, reducing the risk of production delays and enabling more efficient inventory management. -- **SMEs**: SMEs can enhance their responsiveness to market changes and improve supply chain collaboration, leading to better resource utilization and cost savings. -- **Solution Providers**: They can offer more valuable services by providing insights into inventory levels, helping users optimize their supply chain and reduce wastage. - -### Short-Term Material Demand - -This exchange refers to the amount of material a customer's production line needs from an item from a supplier within the next four weeks. It's meant to add context to regular orders, not replace them. Customers can also clarify which demands are essential for their upcoming production and which are extra, perhaps for creating safety stocks. This extra detail helps suppliers plan their production and suggest proactive solutions for potential shortages. -**Benefits for LEs, SMEs, and Solution Providers**: - -- **LEs**: Enables better production planning of the supplier by providing the actual material demand, which results in reduced risk of production halts and less shortages. -- **SMEs**: Enhanced ability to communicate urgent needs, helping them maintain steady production and build safety stocks efficiently. -- **Solution Providers**: Better insight into client needs allows for tailored solutions and proactive management of supply challenges. - -### Planned Production Output - -The exchange illustrates the quantity of material a supplier intends to produce for a specific customer, as agreed upon with the partners, yet remains unmanufactured. By standardizing this exchange through digital platforms, it enables clear communication of forthcoming production volumes, allowing supply chain participants to align their expectations and planning, enhancing responsiveness to market needs and production adjustments. -**Benefits for LEs, SMEs, and Solution Providers**: - -- **LEs**: They can better anticipate the availability of necessary materials, allowing for more accurate scheduling and efficient use of production resources. -- **SMEs**: SMEs gain insights into their suppliers' production plans, enabling them to adjust their strategies and operations accordingly for better resource allocation. -- **Solution Providers**: They can offer enhanced forecasting and planning services, helping clients optimize their supply chain and production processes based on upcoming production outputs. - -### Delivery Information - -Delivery Information includes logistics details and delivery metrics. Logistics details specify the shipment's timing, location, and quantity. Delivery metrics focus on the planned versus actual departure and arrival times, such as shipments leaving a supplier's factory or arriving at a customer's factory. The model provides data on departure and arrival dates and times, locations, quantities shipped, tracking numbers, and other essential logistics information to help coordinate and streamline the delivery process. - -**Benefits for LEs, SMEs, and Solution Providers**: - -- **LEs**: Enhanced tracking and coordination of incoming and outgoing shipments, enabling better production planning and inventory management. -- **SMEs**: Improved visibility into delivery timings and quantities helps in adjusting operations, reducing storage costs, and enhancing customer satisfaction. -- **Solution Providers**: Ability to offer more accurate and timely logistics services, enhancing value to clients through better supply chain transparency and efficiency. - -## Business Process - -PURIS orchestrates a set of business processes within the Catena-X network, enhancing supply chain visibility and operational coordination. These processes, characterized by their adaptability to multi-sourcing strategies, are described as follows: - -**Actors and Roles**: - -- **Data Senders**: Act as data consumers needing information on customers' production output and material demand. -- **Data Receivers**: Act as data providers, offering detailed information about their material demand and production plans to suppliers. - -**Data Exchange and Allocation**: - -- **Delivery Information**: Unidirectional and direct exchange of information that maintains the confidentiality of delivery data, tailored according to INCOTERMS. -- **Item Stock**: Bidirectional exchange of actual allocated inventory data, not forecasts, considering specific warehouse locations and integrating into consignment processes. -- **Planned Production Output**: Suppliers planned production output to meet customer specific requirements. -- **Short-Term Material Demand**: Complements regular orders with detailed insights into customers' immediate production material requirements, with demand data specifically broken down for each supplier. - -**Key Processes**: - -- **Single Sourcing**: Direct allocation of orders and material demand in a one-to-one relationship between customer and supplier. -- **Multi-Sourcing**: One item is supplied from more than one supplier. The exchanged data must be allocated to each supplier. -- **Multi-Customer**: One item is provided to more than one customer. The exchanged data must be allocated to each customer. -- **Demand Categories**: Differentiation between regular and extraordinary demand to assist suppliers in prioritization and planning. -- **Production Planning**: Daily versus non-daily planning, with a recommendation for daily planning to enhance accuracy and responsiveness. - -The business process facilitated by PURIS enables partners in the Catena-X network to swiftly act on up-to-date information, adapt to the fluidity of market conditions, and develop a well-rounded view of supply chain operations. This comprehensive approach not only encourages collaborative partnerships but also advances risk mitigation strategies and bolsters the overall resilience of the supply chain ecosystem. - -### Business Architecture - -#### Introduction - -PURIS enables exchange of data with suppliers and customers via standardized interfaces (see Digital Twin KIT, Industry Core KIT). The PURIS KIT delivers: - -- Operative capabilities to exchange information with direct upstream / downstream supply chain partners in a strict 1-up / 1-down manner. -- Data models that MUST be applied for the interoperable data exchange -- Process help on how to provision data correctly, especially in regard to multi-sourcing and multi-customer scenarios. -- Ideas on value-adding usage of these concepts (see use case example above). - -To allow all partners to benefit in the best way from PURIS, each involved party needs to provide their data on the basis of the latest information from the shop floor and its internal systems. - -#### Components - -From conceptual point of view a PURIS system consists of different building blocks. These building blocks in the following diagram show which participant deploys which components. Identification and Access Management is omitted for simplicity reasons. - -![PURIS KIT Architecture](resources/purisKitArchitecture.png) - -The PURIS App is a software application that allows to exchange relevant data with partners. It's meant to - -- Provide data following the shared asset approach (see Digital Twin KIT). It manages the Digital Twin Registry (AAS Registry and AAS Discovery API) and provides the data in the correct format via Submodel API. -- Manage the apis and assets in the Connector (see Connector KIT). - -The following components are needed for the communication based on the PURIS standard: - -- PURIS App = Component orchestrating the Data Exchange following this KIT (as explained above) while providing business value. -- Connector = Component that manages data and API as assets to enable the sovereign data exchange (see Connector KIT) -- Digital Twin Registry = Component that provides AAS Registry and AAS Discovery API implementations (see Digital Twin KIT) -- Data Provisioning & Transformation = Proprietary component allowing to use OWN data or to use PURIS data in internal systems. -- Identity and Access Management (IAM) = Identity Provider spanning authentication and authorization within Catena-X and / or your company. Includes the Credential Service to proof e.g. that a participant signed the Framework Agreement. - -## Logic & Schema - -PURIS enables data exchange between partners (one-up/one-down) within Catena-X using the Connector, focusing on a short-term horizon, such as 4 weeks, without imposing a strict time limit. - -- PURIS allows organizations to exchange material flow-related data with contractual partners (one-up, one-down) -- PURIS respects the data sovereignty of each participant with regard to its own data or data owner - -![PURIS communicates and exchanges data within Catena-X using the EDC.](resources/PURIS_logic.png) - -## Standards - -Our relevant standards can be downloaded from the official [Catena-X Standard Library](https://catena-x.net/de/standard-library): - -| Standard | Standard Name | Version | -| -------------------------- | ------------- | :-----: | -| Delivery Information | CX-0118 | v2.0.0 | -| Short-Term Material Demand | CX-0120 | v2.0.0 | -| Planned Production Output | CX-0121 | v2.0.0 | -| Item Stock | CX-0122 | v2.0.0 | - -## Notice - -This work is licensed under the CC-BY-4.0 - -- SPDX-License-Identifier: CC-BY-4.0 -- SPDX-FileCopyrightText: 2024,Contributors of the Eclipse Foundation -- SPDX-FileCopyrightText: 2024,ISTOS GmbH (a member of the DMG Mori Group) -- SPDX-FileCopyrightText: 2024,Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST) -- SPDX-FileCopyrightText: 2024,TRUMPF Werkzeugmaschinen SE + Co. KG -- SPDX-FileCopyrightText: 2024,Volkswagen AG diff --git a/docs-kits_versioned_docs/version-24.05/kits/PURIS Kit/page_changelog.md b/docs-kits_versioned_docs/version-24.05/kits/PURIS Kit/page_changelog.md deleted file mode 100644 index 1cb68dcc7dc..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/PURIS Kit/page_changelog.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: PURIS Kit Changelog -title: Changelog -description: 'PURIS Kit' -sidebar_position: 1 ---- - -### PURIS Kit - -All notable changes to this Kit will be documented in this file. - -## [0.2.0] - 2024-05-29 - -### Added​ - -- documentation of the adoption view -- documentation of the software development view - -### Changed​ - -- ./. - -### Removed​ - -- ./. - -## [0.1.0] - 2023-11-29 - -### Added - -- Initial version of the Kit including the adoption view - -### Changed - -- ./. - -### Removed - -- ./. diff --git a/docs-kits_versioned_docs/version-24.05/kits/PURIS Kit/resources/PURIS_logic.png b/docs-kits_versioned_docs/version-24.05/kits/PURIS Kit/resources/PURIS_logic.png deleted file mode 100644 index 559b0c86f51..00000000000 Binary files a/docs-kits_versioned_docs/version-24.05/kits/PURIS Kit/resources/PURIS_logic.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-24.05/kits/PURIS Kit/resources/purisKitArchitecture.png b/docs-kits_versioned_docs/version-24.05/kits/PURIS Kit/resources/purisKitArchitecture.png deleted file mode 100644 index e4e8c900c34..00000000000 Binary files a/docs-kits_versioned_docs/version-24.05/kits/PURIS Kit/resources/purisKitArchitecture.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/Software Development View/part_aspect-models.mdx b/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/Software Development View/part_aspect-models.mdx deleted file mode 100644 index b4938f70672..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/Software Development View/part_aspect-models.mdx +++ /dev/null @@ -1,101 +0,0 @@ ---- -sidebar_class_name: hidden ---- - - - -import AspectModelOverview from './../../Industry Core Kit/Software Development View/part_aspect-model-overview.mdx' - -Aspect models are mostly easy to create by transforming a company's internal data into the target aspect model. Transformations are mostly straightforward in these cases. If necessary, special steps in creating aspect models are mentioned in the corresponding sections. - - - -### TractionBatteryCode - -The aspect provides the information of the Traction battery code of a battery cell, a battery module or a battery pack according to the chinese standard GB/T 34014-2017. Furthermore, it provides the traction battery codes for the assembled sub parts of the component, e.g. Traction battery code of a battery module plus all the traction battery codes of the assembled battery cells of this battery module. - -Aspect model in GitHub: -- Version 1.0.0: https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.traction_battery_code/1.0.0 - -##### Example: Submodel `TractionBatteryCode` for a Battery Cell - -```json -{ - "productType": "cell", - "tractionBatteryCode": "X12CCPM27KLPCLE662382320" -} -``` - -##### Example: Submodel `TractionBatteryCode` for a Battery Module - -```json -{ - "productType": "module", - "tractionBatteryCode": "B54MCPM27KLPCLE6A7519857", - "subcomponents": [ - { - "productType": "cell", - "tractionBatteryCode": "X12CCPM27KLPCLE662382320" - }, - { - "productType": "cell", - "tractionBatteryCode": "X12CCPM27KLPCLE662382321" - } - ] -} -``` - -##### Example: Submodel `TractionBatteryCode` for a Battery Pack - -```json -{ - "productType": "pack", - "tractionBatteryCode": "4A6PCPM27KLPCLE742946319", - "subcomponents": [ - { - "productType": "module", - "tractionBatteryCode": "B54MCPM27KLPCLE6A7519857", - "subcomponents": [ - { - "productType": "cell", - "tractionBatteryCode": "X12CCPM27KLPCLE662382320" - }, - { - "productType": "cell", - "tractionBatteryCode": "X12CCPM27KLPCLE662382321" - } - ] - }, - { - "productType": "module", - "tractionBatteryCode": "B54MCPM27KLPCLE6A7519858", - "subcomponents": [ - { - "productType": "cell", - "tractionBatteryCode": "X12CCPM27KLPCLE662382322" - }, - { - "productType": "cell", - "tractionBatteryCode": "X12CCPM27KLPCLE662382323" - } - ] - } - ] -} -``` diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/architecture_level_1.png b/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/architecture_level_1.png deleted file mode 100644 index 514bafb2f38..00000000000 Binary files a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/architecture_level_1.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/quality_notifications.png b/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/quality_notifications.png deleted file mode 100644 index da8b0f195f6..00000000000 Binary files a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/quality_notifications.png and /dev/null differ diff --git a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/operation-view/bridge.md b/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/operation-view/bridge.md deleted file mode 100644 index 1faa8b1695e..00000000000 --- a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/operation-view/bridge.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -sidebar_position: 1 -title: Bridging ---- - - -For Bridging between Knowledge Agents API and AAS, this KIT recommends deploying the [Tractus-X Knowledge Agents AAS Bridge (KA-AAS)](https://github.com/eclipse-tractusx/knowledge-agents-aas-api) - -(C) 2021,2024 Contributors to the Eclipse Foundation. SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/Success Stories/mdp_application.md b/docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/Success Stories/mdp_application.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/Success Stories/mdp_application.md rename to docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/Success Stories/mdp_application.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/BehaviourTwinMDP_Kit.svg b/docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/BehaviourTwinMDP_Kit.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/BehaviourTwinMDP_Kit.svg rename to docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/BehaviourTwinMDP_Kit.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_AppStory1.png b/docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_AppStory1.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_AppStory1.png rename to docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_AppStory1.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_AppStory2.png b/docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_AppStory2.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_AppStory2.png rename to docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_AppStory2.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_AppStory3.png b/docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_AppStory3.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_AppStory3.png rename to docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_AppStory3.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_AppStory4.png b/docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_AppStory4.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_AppStory4.png rename to docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_AppStory4.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_AppStory5.png b/docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_AppStory5.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_AppStory5.png rename to docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_AppStory5.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_AppStory6.png b/docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_AppStory6.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_AppStory6.png rename to docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_AppStory6.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_AppStory6a.png b/docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_AppStory6a.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_AppStory6a.png rename to docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_AppStory6a.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_AppStory7.png b/docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_AppStory7.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_AppStory7.png rename to docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_AppStory7.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_IntCheckUC1.png b/docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_IntCheckUC1.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_IntCheckUC1.png rename to docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_IntCheckUC1.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_IntCheckUC2.png b/docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_IntCheckUC2.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_IntCheckUC2.png rename to docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_IntCheckUC2.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_Proc_0.png b/docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_Proc_0.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_Proc_0.png rename to docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_Proc_0.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_Proc_1.png b/docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_Proc_1.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_Proc_1.png rename to docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_Proc_1.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_Proc_2.png b/docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_Proc_2.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_Proc_2.png rename to docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_Proc_2.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_Proc_3.png b/docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_Proc_3.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_Proc_3.png rename to docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_Proc_3.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_Proc_4.png b/docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_Proc_4.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_Proc_4.png rename to docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_Proc_4.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_Proc_5.png b/docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_Proc_5.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/Pic_Proc_5.png rename to docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/Pic_Proc_5.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/RKIT_Building_Block_Architecture_Overview_V1.png b/docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/RKIT_Building_Block_Architecture_Overview_V1.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/RKIT_Building_Block_Architecture_Overview_V1.png rename to docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/RKIT_Building_Block_Architecture_Overview_V1.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/RKIT_Building_Block_Architecture_Overview_V2.png b/docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/RKIT_Building_Block_Architecture_Overview_V2.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/RKIT_Building_Block_Architecture_Overview_V2.png rename to docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/RKIT_Building_Block_Architecture_Overview_V2.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/mdp_kit_v1.0.mp4 b/docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/mdp_kit_v1.0.mp4 similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/images/mdp_kit_v1.0.mp4 rename to docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/images/mdp_kit_v1.0.mp4 diff --git a/docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/page_adoption-view.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/page_adoption-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/page_adoption-view.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/page_changelog.md b/docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/page_changelog.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/page_changelog.md rename to docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/page_changelog.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/page_development-view.md b/docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/page_development-view.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Behaviour Twin MDP Kit/page_development-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Behaviour Twin MDP Kit/page_development-view.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Documentation BPDM/_category_.json b/docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Documentation BPDM/_category_.json similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Documentation BPDM/_category_.json rename to docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Documentation BPDM/_category_.json diff --git a/docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Documentation BPDM/bpdm_arc42.md b/docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Documentation BPDM/bpdm_arc42.md new file mode 100644 index 00000000000..c5249ff0583 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Documentation BPDM/bpdm_arc42.md @@ -0,0 +1,1335 @@ +--- +id: bpdm_arc42 +title: Architecture documentation (arc42) +description: 'Architecture documentation (arc42)' +sidebar_position: 1 +--- + +![Business partner kit banner](/img/kit-icons/bp-kit-icon.svg) + +## Business Partner KIT + +## Business Partner Data Management Application for Golden Record (BPDM) + +- [Business Partner Data Management Application for Golden Record (BPDM)](#business-partner-data-management-application-for-golden-record-bpdm) +- [Introduction and Goals](#introduction-and-goals) + - [Goals Overview](#goals-overview) + - [Requirements Overview](#requirements-overview) + - [Quality Goals {#\_quality\_goals}](#quality-goals-quality-goals) + - [Stakeholders](#stakeholders) +- [Architecture Constraints](#architecture-constraints) +- [System Scope and Context](#system-scope-and-context) + - [Business Context](#business-context) + - [Technical Context](#technical-context) +- [Solution Strategy (High Level Picture)](#solution-strategy-high-level-picture) +- [Building Block View](#building-block-view) + - [High-Level Architecture (Generic Endpoint)](#high-level-architecture-generic-endpoint) + - [Keycloak Authentication \& Autorization Flow](#keycloak-authentication--autorization-flow) +- [Runtime View](#runtime-view) + - [Upsert Generic Business Partner](#upsert-generic-business-partner) + - [Update on Golden Record Change](#update-on-golden-record-change) +- [Business Partner Data Records - States](#business-partner-data-records---states) + - [Automatically executing golden record process](#automatically-executing-golden-record-process) + - [Manually triggering golden record process](#manually-triggering-golden-record-process) +- [Deployment View](#deployment-view) + - [Applications Deployment without Kubernetes](#applications-deployment-without-kubernetes) + - [Single Application Kubernetes Deployment](#single-application-kubernetes-deployment) +- [Crosscutting Concepts](#crosscutting-concepts) + - [Business Partner Data Management Standards](#business-partner-data-management-standards) + - [Logging Behavior](#logging-behavior) +- [Architecture Decisions](#architecture-decisions) +- [Quality Requirements](#quality-requirements) +- [Risks and Technical Debts](#risks-and-technical-debts) +- [Glossary](#glossary) + - [NOTICE](#notice) + +## Introduction and Goals + +This document describes the Catena-X Business Partner Data Management Application, short BPDM. + +In the Catena-X Automotive Network, the so-called Golden Record, together with a unique identifier, the Business Partner Number (BPN), creates an efficient solution to the increasing data retention costs. + +The Golden Record is a concept that identifies, links and harmonizes identical data on legal entites, sites and addresses from different sources (“sharing members"). During the creation of the Golden Record data, duplicates are removed, the quality within the data records is improved, missing information is added and deviations are automatically corrected. This is done using public, commercial or other agreed sources of trust and/or information. This approach reduces costs of business partner data maintenance and validation for all the companies concerned. + +The BPN, as the unique identifier of the Golden Record, can be stored as a verifiable credential used in an SSI solution so that a business partner can provide it for authentication and authorization. + +The Golden Record business partner data in combination with the BPN acts as the basis for a range of supplementary value-added services to optimize business partner data management. These are referred to as value-added services. Together with decentralized, self-determined identity management, they create a global, cross-industry standard for business partner data and a possible 360° view of the value chain. + +> [!NOTE] +> A Business Partner Data cleaning as well as Golden Record Creation Process is **not** part of this reference implementation! + +**Additional Information Material**: + +- Visit BPDM on the official Catena-X Website: [bpdm_catenax_website](https://catena-x.net/en/offers-standards/bpdm) + +## Goals Overview + +The following goals have been established for this system: + +| Priority | Goal | +| -------- | ------------------------------------------------------------------------------------------------------------ | +| 1 | Provide unique global business partner IDs within the Catena-X Network | +| 1 | Provide centralized Master Data Management for business partner data | +| 2 | Enable network-based data sharing for business partner data to increase overall data quality and reliability | +| 2 | Enable also Small and medium-sized Businesses (SMEs) to use the services | +| 3 | Provide a change history für business partner data | + +## Requirements Overview + +> [!IMPORTANT] +> **Cross-Check with CACs** + +![bpdm_usecase_diagram](@site/static/img/usecase_diagram.drawio.svg) + +The following Usecases together with its requirements exist for this system: + +| Req-Id | Requirement | Explanation | +| ------- | ------------------ | ----------- | +| BPDM-R1 | Upload and curate BP data | CX Member can upload their business partner and get curated business partner information back, based on the Golden Record | +| BPDM-R2 | Provide changelog for BP | A changelog is provided to determine which changes on which date are available | +| BPDM-R3 | Provide GR | Based on the shared business partner information and external service providers a Golden Record is created | +| BPDM-R4 | Provide changelog for GR | A changelog is provided to determine which changes on which date are available | +| BPDM-R5 | Keep GR up-to-date based on external resources | Golden Records must regularly checked for changes based on external resources | +| BPDM-R6 | Provide unique business partner IDs | For each Golden Record a unique ID, the so called Business Partner Number (BPN) is created | + +## Quality Goals {#quality goals} + +| Priority | Quality Goal | Scenario | +| -------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 1 | Security | All users and services which access the Golden Record Application must be authenticated and authorized. Only the Golden Record Application itself is allowed to perform changes on data. Consuming services/users are only allowed to read data. In addition they are only allowed to read the specific data that belongs with this, the Data Sovereignty principles of Catena-X has to be fulfilled | +| 1 | Integrity | Only the Golden Record Application is allowed to perform changes on the data. In addition, all changes must be traceable and must be able to be rolled back | +| 1 | Legally | No natural persons are allowed to get uploaded and stored. For all other uploaded Business Partner data it is mandatory that users (CX Members) can only see their own uploaded data and that it is not possible to draw conclusions about other business partner relationships | +| 1 | Integrity & Correctness | It must be ensured that the data of the golden record which is created during the process is correct. | +| 2 | Reliability | The Golden Record Application is a central foundation in the Catena-X Network. It provides all participants and services, business partner data and the unique Business Partner Number (BPN) as identifier. Therefore the BPDM Services must be always/highly available | +| 2 | Functional Stability | Since the Golden Record Application is a central foundation in the Catena-X Network the defined standards of the API and datamodel for the associated Release Version must be fulfilled | +| 1 | Sensitivity of data | the uploaded business partner data is highly sensitive, that's why it must be ensured that no unauthorized user/system can access data which does not belong to it. More over it must be guaranteed that no one can see the business partners related to the specific Catena-X Member. | + +[](@site/static/img/iso_25010.png) + +## Stakeholders + +| Role/Name | Expectations | Example | +| ----------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- | +| Big Company (CX-Member) | Company wants to have cleaned and enriched business partner data objects with a BPN. | | +| SME Company (CX-Member) | Company wants to have cleaned and enriched business partner data objects with a BPN based on a CSV data. | | +| CX Apps | Other apps and their use cases want to use the business partner data objects and the BPN for their processes | The CX Portal will use the BPN for on-boarding new companies into the network. Traceability Apps will use BPN to describe business partners | + +## Architecture Constraints + +| Constraint ID | Constraint | Description | +| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | +| C-1 | Software and third party software must be compliant to the Catena-X and Eclipse Foundation Guidelines/Policies [eclipse_foundation](https://www.eclipse.org/projects/dev_process/) | | +| C-2 | [Eclipse Dataspace Connector](https://github.com/eclipse-tractusx/tractusx-edc/tree/main) must be used for data transfer between different legal entities | | + +## System Scope and Context + +## Business Context + +The following figure depicts the business context setup for BPDM: + +![bpdm_business_context](@site/static/img/cx_bpdm_context_business.drawio.svg) + +The following are the various components of the business context setup: + +### **Master Data Management (Catena-X Member)** + +A backend system that's operated by a company which is participating in the Catena-X Ecosystem and consuming digital services or data assets. + +### **Small-Medium-Enterprises (SME) (Catena-X Member)** + +A SME company that's participating in the Catena-X Ecosystem and consuming digital services or data assets. + +### **Catena-X Portal/Marketplace (CX Portal)** + +The Portal which provides an entry point for the Catena-X Members, to discover Apps that are offered in Catena-X. + +### **Value Added Services** + +- Value Added Services can be provided be either the Operator itself or by an external App/Service Provider. The Value Added Services provide data or service offers based on Catena-X Network data. +- There are several value added services that can be offered in context of business partner data. For example a Fraud Prevention Dashboard/API, Country Risk Scoring and so on. + +### **Catena-X Operative Environment for BPDM** + +- Within Catena-X there will be only one central operation environment that operates the BPDM Application. This operative environment provides the services and data for other operation environment or applications which needs to consume business partner data or golden record data. + +### **Catena-X BPDM Application** + +- The BPDM Application which offers services to Catena-X Members, Catena-X Use Cases and Catena-X BPDM Value Added Services for consuming and processing business partner data as well as Golden Record Information and BPN Numbers. + +### **Curation & Enrichment Services** + +- To offer the BPDM and Golden Record Services, Catena-X uses services from external third party service providers. These can either be operated by the operator itself or external companies that have a contract with the operator. + +## Technical Context + +The technical context setup including deployment is depicted in the following figure: +![cx_bpdm_deployment_context](@site/static/img/cx_bpdm_context_technical.drawio.svg) + +- The BPDM Application follows a microservice approach to separate the different components of the system. +- Within Catena-X there will be only one central operation environment that operates the BPDM Application. This operation environment provides the services and data for other operation environment or applications which needs to consume business partner data or golden record data. + +## Solution Strategy (High Level Picture) + +The following high level view gives a basic overview about the BPDM Components: + +![cx_bpdm_highlevel](@site/static/img/cx_bpdm_highlevel.drawio.svg) + +### **BPDM Gate** + +- The BPDM Gate provides the interfaces for Catena-X Members to manage their business partner data within Catena-X. +- Based on the network data a Golden Record Proposal is created. +- The BPDM Gate has its own persistence layer in which the business partner data of the Catena-X Members are stored. +- For the current reference implementation, multi-tenancy is realized via a 1:1 deployment for each Catena-X Member. This means that every Catena-X Member who shares his business partner data, has its own Gate and own persistence. + +### **BPDM Pool** + +- The BPDM Pool is the central instance for business partner data within Catena-X. +- The BPDM Pool provides the interface and persistance for accessing Golden Record Data and the unique Business Partner Number. +- In comparison to the BPDM Gate, there is only one central instance of the BPDM Pool. + +### **BPN Issuer** + +- Every participant in the Catena-X network shall have a unique Business Partner Number (BPN) according to the concept defined by the Catena-X BPN concept. The task of the BPN Generator is to issue such a BPN for a presented Business Partner data object. In that, the BPN Generator serves as the central issuing authority for BPNs within Catena-X. +- Technically, it constitutes a service that is available as a singleton within the network. +- Currently, creation of BPNs is part of the BPDM Pool implementation. After implementing the BPDM Orchestrator, it can be considered if it should be an independent component. + +### **BPDM Orchestrator** + +- Intention of the BPDM Orchestrator is to provide a passive component that offers standardized APIs for the BPDM Gate, BPDM Pool and Data Curation and Enrichment Services to orchestrate the process of Golden Record Creation and handling the different states a business partner record can have during this process. + +## Building Block View + +### High-Level Architecture (Generic Endpoint) + +![bpdm_current_architecture_Generic](@site/static/img/cx_bpdm_architecture_v3_3.drawio.svg) + +#### **Simulator Service** + +- To become more independent in testing the BPDM Application, a Simulator Service was developed. +- The Simulator Services supports the E2E Test Cases to validate the flow from BPDM Gate to BPDM Pool and back again. + +#### **EDC Operator** + +- The diagram above shows two EDCs on Operator side. This is only for visualization purpose. On a technical level there is only one EDC. + +#### **SME** + +- Currently there is no SME Application available + +## Runtime View + +### Upsert Generic Business Partner + +> [!NOTE] +> An additional endpoint was implemented as requirements came up that required business partner data records not to be fed directly into the golden record process after an upload. Instead, this endpoint makes it possible to change the status of a business partner data record from "inital" to "ready". Only data records with the status "ready" are fed into the golden record process. +> We are aware that the existing integration scenarios, such as with the portal team, are impacted by this. For this reason, we recommend that the gate is configured accordingly so that the status is set to "ready" by default when a data record is uploaded. The operator can configure this behavior in the gate individually based on the requirements. + +```mermaid +sequenceDiagram + autonumber + + SharingMember->>Gate: PUT api/catena/input/business-partners
Payload: Business Partner Data A + Gate-->>Gate: Persist Business Partner Data Input + Gate-->>Gate: Set Sharing State to 'Initial' + Gate-->>Gate: Add Changelog Entry 'Create' for Business Partner Input + Gate-->>SharingMember: Upserted Business Partner + + SharingMember->>Gate: POST api/catena/sharing-state/ready
Payload: External ID A + Gate-->>Gate: Set Sharing State to 'Ready' + Gate-->>SharingMember: OK + + loop Polling for Ready Business Partners + Gate-->>Gate: Fetch Business Partners in State 'Ready' + Gate->>Orchestrator: POST api/golden-record-tasks
Payload: Business Partner Input Data in mode 'UpdateFromSharingMember' + Orchestrator-->>Orchestrator: Create Golden Record Task for Business Partner Data + Orchestrator-->>Orchestrator: Set Golden Record Task State
Result State: 'Pending' + Orchestrator-->>Orchestrator: Set Golden Record Task State
Step: 'CleanAndSync'
StepState: 'Queued' + Orchestrator-->>Gate: Created Golden Record Task + Gate-->>Gate: Set Sharing State
Type: 'PENDING'
Task ID: Golden Record Task ID + end + + loop Polling for Step 'CleanAndSync' + CleaningServiceDummy->>Orchestrator: POST api/golden-record-tasks/step-reservations
Payload: Step 'CleanAndSync' + Orchestrator-->>Orchestrator: Set Golden Record Task State
Step: 'CleanAndSync'
StepState: 'Reserved' + Orchestrator-->>CleaningServiceDummy: Golden Record Task + CleaningServiceDummy-->>CleaningServiceDummy: Set L/S/A and Generic Business Partner Dummy Cleaning Result + CleaningServiceDummy-->>CleaningServiceDummy: Set BPN References to L/S/A result + CleaningServiceDummy->>Orchestrator: POST api/golden-record-tasks/step-results
Payload: Dummy Result + Orchestrator-->>Orchestrator: Set Golden Record Task Business Partner Data to Dummy Result + Orchestrator-->>Orchestrator: Set Golden Record Task State
Step: 'PoolSync'
StepState: 'Queued' + Orchestrator-->>CleaningServiceDummy: Accept + end + + loop Polling for Step 'PoolSync' + Pool->>Orchestrator: POST api/golden-record-tasks/step-reservations
Payload: Step 'PoolSync' + Orchestrator-->>Orchestrator: Set Golden Record Task State
Step: 'PoolSync'
StepState: 'Reserved' + Orchestrator-->>Pool: Golden Record Task + opt Golden Record Legal Entity Data marked as changed + Pool-->>Pool: Upsert Legal Entity from Golden Record Task Legal Entity Data + Pool-->>Pool: Add Changelog Entry for BPNL + end + opt Golden Record Site Data marked as changed + Pool-->>Pool: Upsert Site from Golden Record Task Site Data + Pool-->>Pool: Add Changelog Entry for BPNS + end + opt Golden Record Address Data marked as changed + Pool-->>Pool: Upsert Address from Golden Record Task Address Data + Pool-->>Pool: Add Changelog Entry for BPNA + end + Pool-->>Pool: Set BPNs in Golden Record Task Generic Business Partner Data + Pool->>Orchestrator: POST api/golden-record-tasks/step-results
Payload: Updated Result + Orchestrator-->>Pool: Accept + Orchestrator-->>Orchestrator: Set Golden Record Task State
Step: 'PoolSync'
Step State: 'Success' + Orchestrator-->>Orchestrator: Set Golden Record Task State
Result State: 'Success' + end + + loop Polling for finished Golden Record Tasks + Gate-->>Gate: Query sharing states in Sharing State Type 'PENDING' + Gate->>Orchestrator: POST golden-record-tasks/state/search
Payload: Golde Record Task ID + Orchestrator-->Gate: Golden Record Task State and Result + Gate-->>Gate: Persist Business Partner Output + Gate-->>Gate: Set Sharing State 'Success' + Gate-->>Gate: Add Changelog Entry 'Create' for Business Partner Output + end + + SharingMember->>Gate: POST api/catena/output/changelog/search
Payload: From After Last Search Time + Gate-->>SharingMember: Changelog entry with Business Partner External ID + SharingMember->>Gate: POST api/catena/output/business-partners/search
Payload: External ID + Gate-->>SharingMember: Business Partner Output +``` + +### Update on Golden Record Change + +```mermaid +sequenceDiagram + autonumber + + Pool-->Pool: Add Changelog Entry for BPNL + + loop Polling Pool Changelog + Gate->>Pool: POST api/catena/changelog/search
Payload: From After Last Search Time + Pool-->>Gate: Changelog entry for BPNL + Gate-->>Gate: Query Business Partner Output with BPNL + Gate->>Orchestrator: POST api/golden-record-tasks
Payload: Business Partner Output Data in mode 'UpdateFromPool' + Orchestrator-->>Orchestrator: Create Golden Record Task for Business Partner Data + Orchestrator-->>Orchestrator: Set Golden Record Task State
Result State: 'Pending' + Orchestrator-->>Orchestrator: Set Golden Record Task State
Step: 'Clean'
StepState: 'Queued' + Orchestrator-->>Gate: Created Golden Record Task + Gate-->>Gate: Set Sharing State
Type: 'PENDING'
Task ID: Golden Record Task ID + end + + loop Polling for Step 'Clean' + CleaningServiceDummy->>Orchestrator: POST api/golden-record-tasks/step-reservations
Payload: Step 'Clean' + Orchestrator-->>Orchestrator: Set Golden Record Task State
Step: 'CleanAndSync'
StepState: 'Reserved' + Orchestrator-->>CleaningServiceDummy: Golden Record Task + CleaningServiceDummy->>Orchestrator: POST api/golden-record-tasks/step-results
Payload: Golden Record Task Business Partner Data + Orchestrator-->>Orchestrator: Set Golden Record Task Business Partner Data to Dummy Result + Orchestrator-->>Orchestrator: Set Golden Record Task State
Step: 'Clean'
Step State: 'Success' + Orchestrator-->>Orchestrator: Set Golden Record Task State
Result State: 'Success' + Orchestrator-->>CleaningServiceDummy: Accept + end + + loop Polling for finished Golden Record Tasks + Gate-->>Gate: Query sharing states in Sharing State Type 'PENDING' + Gate->>Orchestrator: POST golden-record-tasks/state/search
Payload: Golden Record Task ID + Orchestrator-->Gate: Golden Record Task State and Result + Gate-->>Gate: Persist Business Partner Output + Gate-->>Gate: Set Sharing State 'Success' + Gate-->>Gate: Add Changelog Entry 'Create' for Business Partner Output + end + + SharingMember->>Gate: POST api/catena/output/changelog/search
Payload: From After Last Search Time + Gate-->>SharingMember: Changelog entry with Business Partner External ID + SharingMember->>Gate: POST api/catena/output/business-partners/search
Payload: External ID + Gate-->>SharingMember: Business Partner Output + +``` + +## Business Partner Data Records - States + +This sections describes the different states a business partner data record can have. + +### Automatically executing golden record process + +```mermaid +--- +title: state diagram business partner for automatically executing golden record process +--- +stateDiagram-v2 + [*] --> ready: sharing member uploads bp into gate + note right of ready + Gate is configured to automatically
set state to ready after bp upload + end note + ready --> pending: scheduler initiates
the golden record process + state if_state <> + pending --> if_state: run golden record process + if_state --> success: if golden record process succeeded + if_state --> error: if golden record process failed +``` + +### Manually triggering golden record process + +```mermaid +--- +title: state diagram business partner for manual golden record process triggering +--- +stateDiagram-v2 + [*] --> initial: sharing member uploads bp into gate + note right of initial + POST api/catena/sharing-state/ready
Payload: External ID A + end note + initial --> ready: sharing member or third-party
service calls separate endpoint + ready --> pending: scheduler initiates
the golden record process + state if_state <> + pending --> if_state: run golden record process + if_state --> success: if golden record process succeeded + if_state --> error: if golden record process failed +``` + +## Deployment View + +### Applications Deployment without Kubernetes + +```mermaid +C4Context + + Person(bpdm_user, "(Technical) User of the BPDM APIs") + + System(pool_postgres, "Pool Database", "Postgres: 14.5") + System(gate_postgres, "Gate Database", "Postgres: 14.5") + + Deployment_Node(pool_machine, "OS Environment", "Linux Alpine 3.16"){ + Deployment_Node(pool_java, "Runtime Environment", "JAVA RE 17") { + Container(pool_container, "Pool Application", "Spring Boot: 3.1") + } + } + + Deployment_Node(gate_machine, "OS Environment", "Linux Alpine 3.16"){ + Deployment_Node(gate_java, "Runtime Environment", "JAVA RE 17") { + Container(gate_container, "Gate Application", "Spring Boot: 3.1") + } + } + + Deployment_Node(orchestrator_machine, "OS Environment", "Linux Alpine 3.16"){ + Deployment_Node(orchestrator_java, "Runtime Environment", "JAVA RE 17") { + Container(orchestrator_container, "Orchestrator Application", "Spring Boot: 3.1") + } + } + + Deployment_Node(dummy_machine, "OS Environment", "Linux Alpine 3.16"){ + Deployment_Node(dummy_java, "Runtime Environment", "JAVA RE 17") { + Container(dummy_container, "Cleaning Service Dummy Application", "Spring Boot: 3.1") + } + } + + Rel(bpdm_user, pool_container, "HTTP/S") + Rel(pool_container, pool_postgres, "TCP/IP") + + Rel(bpdm_user, gate_container, "HTTP/S") + Rel(gate_container, gate_postgres, "TCP/IP") + + Rel(pool_container, orchestrator_container, "HTTP/S") + Rel(gate_container, orchestrator_container, "HTTP/S") + Rel(dummy_container, orchestrator_container, "HTTP/S") + +``` + +### Single Application Kubernetes Deployment + +```mermaid +C4Context + + Person(bpdm_user, "(Technical) User of the BPDM APIs") + + Deployment_Node(kubernetes, "Kubernetes Environment", "Kubernetes 1.28"){ + + Container(ingress, "Ingress", "Ingress Kubernetes Resource") + Container(nginx, "Ingress Controller", "Nginx Reverse Proxy") + Container(service, "Service", "Service Kubernetes Resource") + + Container(database, "Database Deployment", "Chart bitnami/postgres:11.9.13") + Container(other_bpdm, "Other BPDM Application Deployment", "Helm Chart") + + Deployment_Node(deployment, "Deployment", "Deployment Kubernetes Resource"){ + Deployment_Node(replicaSet_1, "Replica Set", "Ingress ReplicaSet Resource"){ + Deployment_Node(pod_1, "Pod", "Pod Kubernetes Resource"){ + Container(container_1, "BPDM Application Container", "Spring Boot 3 on Linux Alpine 3.6") + Container(volume_1, "Config Volume", "Kubernetes Volume Mount") + } + } + } + + Deployment_Node(kubernetes_config, "Kubernetes Configurations", "Logical Grouping"){ + Container(configMap, "Application Configuration", "Kubernetes ConfigMap Resource") + Container(secret, "Secret Configuration", "Kubernetes Secret Resource") + + } +} + +Rel(bpdm_user, nginx, "Sends URL", "HTTPS") +Rel(ingress, nginx, "Routing Information") +Rel(nginx, service, "Routes to") +Rel(service, container_1, "HTTP") + +Rel(container_1, volume_1, "mounts") +Rel(volume_1, configMap, "mounts") +Rel(volume_1, secret, "mounts") + +Rel(container_1, database, "TCP/IP") +Rel(container_1, other_bpdm, "") + +UpdateLayoutConfig($c4ShapeInRow="3", $c4BoundaryInRow="1") + + + +``` + +## Crosscutting Concepts + +## Authentication & Autorization + +### Roles, Rights, Permissions + +The authorization concept of the golden record process services (BPDM) has evolved. This impacts the permissions of portal users as well as as the creation of technical users in the Portal. + +#### Relevant concepts + +The golden record process contains sharing members which need to share their data (input) to the golden record process and read the result of that process (output). The Pool is a central place that offers golden records that have been created from the shared business partner data. Golden records are distinguished between whether they belong to Catena-X members or not. + +#### BPDM Permission Groups + +We defined the following relevant permission groups in BPDM: + +1.Gate Admin: Create, update and read sharing member business partner input data as well as read the output data of the golden record process. + +2.Gate Input Manager: Create, update and read sharing member business partner input data. + +3.Gate Input Consumer: Read sharing member business partner input data. + +4.Gate Output Consumer: Read sharing member business partner output data. + +5.Pool Admin: Read, create and update golden records as well as meta data in the Pool. + +6.Pool Cx Member: Read golden records that belong to Catena-X members from the Pool. + +7.Pool Sharing Member: Read golden records of Catena-X members and the overall changelog. + +8.Orchestrator Admin: Full access to Golden Record Tasks. + +9.Orchestrator Task Creator: Create Golden Record Tasks, view task results and status. + +10.Orchestrator Clean And Sync Task Processor: Reserve and resolve Golden Record Tasks in step 'Clean And +Sync'. + +11.Orchestrator Clean Task Processor: Reserve and resolve Golden Record Tasks in step 'Clean'. + +12.Orchestrator Pool Task Processor: Reserve and resolve Golden Record Tasks in step 'Pool'. + +#### Permissions + +##### Permissions as client resources + +| BPDM Pool | BPDM Gate | BPDM Orchestrator | +|-------------------------------------------|-------------------------------------------|--------------------------------------------| +| • read_partner | • read_input_partner | • create_task | +| • write_partner | • write_input_partner | • read_task | +| • read_partner_member | • read_input_changelog | • create_reservation_clean | +| • read_changelog | • read_output_partner | • create_result_clean | +| • read_changelog_member | • read_output_changelog | • create_reservation_cleanAndSync | +| • read_metadata | • read_sharing_state | • create_result_cleanAndSync | +| • write_metadata | • write_sharing_state | • create_reservation_poolSync | +| | • read_stats | • create_result_poolSync | + +##### Permissions by permission group + +Gate Permission + +| Admin | Input Manager | Input Consumer | Output Consumer | +|-------------------|----------------------------------------|----------------------------------------|----------------------------------------| +| All of BPDM Gate | • read_input_partner | • read_input_changelog | • read_output_changelog | +| | • write_input_partner | • read_input_partner | • read_output_partner | +| | • read_input_changelog | • read_input_changelog | • read_output_changelog | +| | • read_sharing_state | • read_sharing_state | • read_sharing_state | +| | • write_sharing_state | • read_stats | • read_stats | +| | • read_stats | | | + +#### Pool Permission + +| Admin | Cx Member | Sharing Member | +|-------------------|----------------------------------------|----------------------------------------| +| All of BPDM Pool | • read_partner_member | • read_partner_member | +| | • read_changelog_member | • read_changelog_member | +| | • read_metadata | • read_metadata | +| | | • read_changelog | + +#### Orchestrator Permissions + +| Admin | Task Creator | Clean And Sync Task Processor | Clean Task Processor | Pool Task Processor | +|-------------------------|---------------------------------|---------------------------------------------|---------------------------------|----------------------------------| +| All of BPDM Orchestrator | • create_task • read_task | •create_reservation_cleanAndSync • create_result_cleanAndSync | • create_reservation_clean •create_result_clean | • create_reservation_poolSync • create_result_poolSync | + +#### Mapping to Portal user roles for all companies (for all Catena-X members) + +| BPDM Permission Group | Portal Role | +|--|--| +| Gate Admin | Service Manager | +| Pool Cx Member | CX User | + +#### Technical Users + +The golden record service provider needs to be able to generate technical users for each permission group (1 - 8). The technical users for sharing member roles 1 - 4 should be associated with the sharing member's BPNL (So that resulting tokens will have the sharing member's BPNL for authorization purposes). Furthermore, there needs to be one technical user option per Pool and Orchestrator permission group. + +### Resulting technical users to be creatable in the Portal + +#### For BPDM service + +- Gate BPNLX Admin (for each Sharing Member) + +- Pool Admin + +- Pool Cx Member + +- Pool Sharing Member + +#### For VAS + +- Gate BPNLX Consumer: Having both roles 'Gate BPNLX Input Consumer' and 'Gate BPNLX Output Consumer ' (for each Sharing Member) + +Companies which have booked the golden record service should not be able to create any technical users for BPDM. Any such feature to create technical users for companies that are not the golden record service provider should be removed. + +#### Demo Configuration + +BPDM is configurable to have arbitrary configurations when it comes to redirect URLs and clients. As long as the above requirements are implemented, BPDM can be configured to be compatible with any Portal environment. + +Still, for the sake of defining a demo configuration, here is a proposal: + +Clients: + +BPDM Pool + +BPDM Gate + +#### BPDM Pool + +Valid Origin:* + +Description: BPDM Pool + +BPDM Gate: + +Valid Origin: * + +Description: BPDM Gate + +#### Keycloak Example Configuration + +This example configuration includes the roles, clients and client scopes that BPDM currently expects. The actual client IDs are subject to change depending on the name they receive in the Portal Keycloak configuration.CX-Central.json + +For more details see: * + +### EDC Communication + +#### Data Offer Configuration + +Communication with BPDM application must be via EDC. The standards for EDC Assets are defined as follows: + +- [BPDM Pool API Asset Structure](https://github.com/catenax-eV/product-standardization-prod/blob/main/standards/CX-0012-BusinessPartnerDataPoolAPI/4.0.0/CX-0012-BusinessPartnerDataPoolAPI-v4.0.0.md#223-data-asset-structure) +- [BPDM Gate API Asset Structure](https://github.com/catenax-eV/product-standardization-prod/blob/main/standards/CX-0074-BusinessPartnerGateAPI/3.0.0/CX-0074-BusinessPartnerGateAPI-v3.0.0.md#223-data-asset-structure) + +An example postman collection for Asset definition you can find [here](https://github.com/eclipse-tractusx/bpdm/blob/main/docs/postman/EDC%20Provider%20Setup.postman_collection.json) + +#### Verified Credentials + +Gate + +To enable communication for uploading and downloading from the gate through EDC, it's essential to have a Verifiable Credential stored in the wallet for BPDM Framework Agreement. This credential will be verified during EDC communication. Additionally, the BPN-Verifiable Credential needs to be validated to ensure that only the sharing member has access to its own gate. + +Pool + +To enable communication for downloading from the pool through EDC, it's essential to have a Verifiable Credential stored in the wallet for BPDM Framework Agreement. This credential will be verified during EDC communication. Additionally, the Membership Credential needs to be validated to ensure that only onboarded catena-x members have access to the pool. + +Purposes +Additionally each of the purposes need to be checked. You can find them [here](https://github.com/catenax-eV/cx-odrl-profile/blob/main/profile.md#usagepurpose). All purposes beginning with cx.bpdm.gate and cx.bpdm.pool are relevant. + +#### Keycloak Authentication & Autorization Flow + +```mermaid + +sequenceDiagram + participant BPDM EDC + participant OpenIDConnect Server + participant BPDM Gate + + autonumber + + BPDM EDC -->>OpenIDConnect Server: Send Client Credentials + OpenIDConnect Server-->> BPDM EDC: Respond OAuth2 Token + BPDM EDC -->> BPDM Gate: Send Request with OAuth2 Token in Authorization Header + BPDM Gate -->> OpenIDConnect Server: Validate Token + OpenIDConnect Server -->> BPDM Gate: Confirms validity of Token + BPDM Gate -->> BPDM Gate: Check "resource_access" section of OAuth Token + + +``` + +### Business Partner Data Management Standards + +[bpdm_standards](https://catena-x.net/de/standard-library) + +### Logging Behavior + +As Spring Boot applications BPDM employs Spring +specific [logging behavior](https://docs.spring.io/spring-boot/docs/3.0.0/reference/htmlsingle/#features.logging) + +We enhance the default log entries with user request information including the determined user ID and a generated request ID. +Not all logs belong to an ongoing user request in which case these entries are empty. + +In addition to the Spring standard logs the BPDM applications keep a log of the following events: + +- INFO: User requesting resource with resource name and HTTP verb +- INFO: Request HTTP response +- INFO: Update/Create Golden Record Business Partners +- INFO: Creating BPNs +- ERROR: Uncaught exceptions occurring in the service logic + +## Architecture Decisions + +### Use a multi gate deployment approach to realize multi-tenancy + +- status: accepted +- date: 2023-06-01 +- deciders: devs, architects +- consulted: ea, pca + +### Context and Problem Statement + +In BPDM a wide range of CX Member share their business partner data with our system. It must be ensured that each CX Member has only access to its own data. That's why our system must realize some kind of multi-tenancy. + + +### Decision Drivers + +- in the automotive industry there are requirements and standards like TISAX that high confidential business partner data must be stored in secure manner + +### Considered Options + +- Use one Gate and implement multi-tenancy within the code base and database +- Use multiple Gates so that every member will have its own Gate with database + +### Decision Outcome + +Chosen option: "Use multiple Gates so that every member will have its own Gate with database", because so far its the most easiest and secure way to realize multi-tenancy in context of a reference implementation. It also provides the highest flexibility regarding to possible upcoming requirements. For example perspectively Gates could be deployed in different regions or locations. Also data is stored by default in different databases which gives additional security by default. + + +#### Consequences + +- Good, because easier Identity and Access Management +- Good, because data separation by default +- Good, because better failure tolerance. +- Good, because flexibility in upcoming requirements. +- Bad, because we need a separate deployment and configuration for a new Gate when a new CX Member wants to use BPDM Service. As reference implementation this is fine, for production Usecases these deployments can be automated. + +#### Implications on EDC and Asset Configuration + +- Even if there are multiple BPDM Gate instances there will be only one deployed EDC + +- In fact, new EDC Assets and Configurations must be applied for each new Catena-X Member who subscribes BPDM Application Service +- In context of reference implementation it is done manually. For operationalization an Operator should automate this. + +#### Implications on SMEs + +- To exchange business partner data accross legal entities and enabling contract negotiation, each SME needs to have its own EDC + +- The EDC itself can be provided as offer by the operator or other "EDC as a Service" Service Provider + +#### Implications on Value-Added-Services + +- Currently it is out-of-scope that BPDM provides a kind of list or routing mechanism about which Gates are available to consume. The team is evaluating the possibility getting this information based on Catena-X Portal registrations. + +- In fact for reference implementation a customer who wants to subscribe a Value Added Services has to provide his Gate/EDC Endpoints +- The Value Added Services also have to ensure by its own to secure and separate the data of each customer + + +### Pros and Cons of the Options + +#### Use one Gate and implement multi-tenancy within the code base and database + +- Good, because only one deployment is required +- Good, because better cost saving, because only one database is used + +- Bad, because higher implementation effort +- Bad, because unknown requirements in data separation. If data **must** be stored in different databases, all our efforts would be for nothing. +- … + +#### Use multiple Gates so that every member will have its own Gate with database + +- Good, because easier Identity and Access Management +- Good, because data separation by default +- Good, because better failure tolerance. +- Good, because flexibility in upcoming requirements. +- Bad, because we need a separate deployment and configuration for a new Gate when a new CX Member wants to use BPDM Service. As reference implementation this is fine, for production Usecases these deployments can be automated. + +### EDC is not a mandatory, but recommended component for accessing BPDM Pool API/Data + +- status: accepted +- date: 2023-06-07 +- deciders: devs, architects +- consulted: ea, pca + +#### Context and Problem Statement + +Ensuring Data Sovereignty is a very crucial point to be compliant to Catena-X Guidelines and passing the Quality Gates. A key aspect to technical realize Data Sovereignty is the Eclipse Dataspace Component (EDC). The question for this ADR is, clarifying if an EDC is required to access the BPDM Pool API/Data. + +#### Decision Outcome + +In alignment with PCA (Maximilian Ong) and BDA (Christopher Winter) it is not mandatory to have an EDC as a "Gatekeeper" in front of the BPDM Pool API for passing the Quality criteria/gates of Catena-X. Nevertheless it is recommended to use one. Especially when you think long-term about sharing data across other Dataspaces. + +#### Reason + +In case of BPDM Pool provides no confidential data about Business Partners. It's like a "phone book" which has public available data about the Business Partners which are commercially offered, because of the additional data quality and data enhancement features. + +#### Implications + +It must be ensured that only Catena-X Member have access to the BPDM Pool API. In Fact an Identity and Access Management is required in the Pool Backend which checks the technical users based on its associated roles and rights. + +### Using an API based service component approach for orchestration logic instead of a message bus approach + +#### Context and Problem Statement + +Based on this [github issue](https://github.com/eclipse-tractusx/bpdm/issues/377) an orchestration logic is needed for the bpdm solution to manage communication between services and handles processing states of business partner records during the golden record process. + +Orchestration logic can basically be realized via an API and service based approach or via a message bus approach. To keep on going with the development of BPDM solution a decision is needed which approach the team will follow to plan and implement the next tasks. + +#### Considered Options + +1. Using an API based service communication with an orchestrator service to handle business logic +2. Using a messaging based service communication with a message bus to handle business logic +3. Using a combination of orchestrator service together with a message bus to handle business logic + +#### Decision Outcome + +#### Chosen option: "1. Using an API based service communication with an orchestrator service to handle business logic", because + +- **Interoperability & Standardization**: + - Interoperability can be better realized and standardized via standardized APIs to grant third party services access and helps to prevent a vendor lock-in. + - Especially when thinking about BPDM as a reference implementation and there might be multiple operating environments in the future that offer BPDM solution. + +- **Flexibility**: + - Thinking about future requirements that might come up like decentralized Gates, encryption of data, not storing business partner data for long-term, this solution is more flexible to deal with new requirements. + +- **Anonymity**: + - Having a service that works as a proxy for the connection between Sharing Member data and cleaning services, can ensure that the uploaded data stay anonymous. + +- **Abstraction**: + - The API based service approach allows better abstraction (who can access which kind of data?). Based on API access and the modelling of input and output data object, we can easily configure/decide which service should be able to access which kind of data or only sub-models of the data + - Instead in a message bus and topic approach every subscriber would be able to easily see all data and can draw conclusions on ownership information and which sharing member was uploading which business partner data. + +- **Cost-effectiveness**: + - Building up on the existing infrastructure instead of setting up and operating an additional message bus system. + +- **Request/Response Model** + - Defined order via API, but not via messaging + - Defined input and output formats / data models for service interaction + +#### Decision against option 2. "Using a messaging based service communication with a message bus to handle business logic", because + +- **Error handling**: + - Error handling, error detection and tracing might become very complex in an event-based message bus architecture + - Also race conditions might get problematic for event-based development. + +- **Missing expertise** + - Missing expertise in Catena-X team in regards to event-based data exchange (RabbitMQ, AMQP) + - Missing expertise in operating and configuring securely a message bus system + - Higher Effort in research, because of new concepts and business-logic for data processing and service interaction. + +- **Cross-cutting concerns**: + - Cross-cutting aspects should not depend on technology specific solutions like a message bus + - Also there are already existing standard solutions available in for example Kubernetes or Spring Boot Framework. + +- **Difficulty in interoperability and integration**: + - Services in the chain need to 'play ball', they need to integrate into each other very well so well-defined payloads is important (Event Queue will just take any payload at first naturally) + - No Request/Response Feedback. + +- **Data Security**: + - Cleaning requests in the queue are visible to every Gate. Even if business partners are anonymous in principle this could be a security issue. + - Separate queues can also be problematic as it makes it visible in a message bus which Gate shared what business partner. So conclusions can be drawn which Member interacts with which business partners. + +- **Higher Costs**: + - potential higher cost operating cluster + +- **Complexity**: + - More complexity due to the Gates having to integrate to a message bus as well as an additional service + - More complexity, because of bigger changes in business logic + +- **Less flexibility for maybe upcoming requirements** + - Hypothesis: We assume it will be easier to implement EDC with an API based service orchestrator solution than with a message bus system + - Not clear how message queuing based solution would work with EDC component/communication + - Not clear how a decentralized approach would look like with an message bus approach + +#### **Decision against option 3. "Using a combination of orchestrator service together with a message bus to handle business logic", because** + +- Please see the downsides above for option 2 + +#### **Sum-up:** +> +> Arguments or advantages that comes with message bus, like a push mechanism, decoupling of services and asynchronous communication can also be realized via an API-based service interaction approach. Use cases for message bus are more focused on scenarios where you have to handle a lot of messages together with lots of message producers and consumers where most of them might be unknown in the network. But in our use case services are well-known and the number of producers and consumers are not that high. In addition, instead of communication via message bus, a callback approach for asynchronous communication might be more sufficient and could also be easier secured via EDC communication. + +- **Push mechanism**: In regards to push mechanism, we do not have time critical requirements so polling is suitable for the moment. And in addition a push based solution can also be realized without a message bus in between the services. + +- **Decoupling of services**: Making services more independent or decoupled is no good argument, because good API design also solves this issue and makes the services even more decoupled. In a message bus approach, every service depends on the input data and format which another service pushes inside + +- **Asynchronous communication**: Asynchronous communication can be done via message bus as well as with API based communication + +> **To sum up the benefits that brings a message bus approach, cannot be fully leveraged in our use case, so that the downsides outweigh the possible advantages.** + +### Alternatives in more detail + +#### Using an API based service communication with an orchestrator service to handle business logic + +[Here](https://github.com/eclipse-tractusx/bpdm/issues/377#issuecomment-1683880275) you can find a description of the first Variant. + +**❗Disclaimer**: Keep in mind that the shown interaction diagram is only a rough idea and the business logic and process flow must still be iterated and adjusted! + +#### Using a messaging based service communication with a message bus to handle business logic + +[Here](https://github.com/eclipse-tractusx/bpdm/issues/377#issuecomment-1683924791) you can find a description of the second Variant. + +**❗Disclaimer**: Keep in mind that the shown interaction diagram is only a rough idea and the business logic and process flow must still be iterated and adjusted! + +#### Using a combination of orchestrator service together with a message bus to handle business logic + +[Here](https://github.com/eclipse-tractusx/bpdm/issues/377#issuecomment-1683942552) you can find a description of the third Variant. + +**❗Disclaimer**: Keep in mind that the shown interaction diagram is only a rough idea and the business logic and process flow must still be iterated and adjusted! + + +### More Information / Outlook + +(Further/Next Steps to be discussed) + +Having in mind that a pushing mechanism might become required for a more efficient process orchestration or some other cases, it is not excluded to introduce an event queuing technology. We are open minded to this. But from current perspective we don't see hard requirements for this, so we want to focus on a minimal viable solution focusing on simplicity based on the KISS principle. + +## Limitations of OpenAPI text descriptions + +### Context and Problem Statement + +There are two known issues with defining text descriptions in OpenAPI/SpringDoc that affect us: + +1. Generic classes can't get specific schema descriptions determined by the type parameter using SpringDoc annotations. + Example: `TypeKeyNameVerboseDto` + With SpringDoc's annotation `@Schema(description=...)` we can set a description for `TypeKeyNameVerboseDto` in general, but not + for `TypeKeyNameVerboseDto` specifically. Internally OpenAPI generates a specific class schema named `TypeKeyNameVerboseDtoCountryCode` that + could theoretically have a different description. +2. There is an OpenAPI limitation not allowing to specify a field description for singular objects of complex type (contrary to collection objects of complex + type and objects of primitive type), + see [Github issue: Description of complex object parameters]( https://github.com/springdoc/springdoc-openapi/issues/1178). + E.g. OpenAPI supports field descriptions for `val name: String` and `val states: Collection`, but *not* + for `val legalAddress: LogisticAddressDto`. + The reason is that in the OpenAPI definition file, singular fields of complex type directly refer to the class schema using `$ref` and don't support a field + description, while collection fields contain an automatic wrapper type which supports a description. + So the only description possible for the last example is the catch-all schema description of `LogisticAddressDto`. The user should ideally get a more + specific description for the field `legalAddress` than for just any other `LogisticAddressDto`. + +### Considered Options + +- Programmatically change the schema description of specific generic class instances (Workaround for issue 1). +- Programmatically create a schema clone for each case a specific field description is needed (Workaround for issue 2). +- Live with the OpenAPI limitations. + +### Decision Outcome + +Chosen option: "Live with the OpenAPI limitations", because the improvement is not worth the added complexity. + + + +### Pros and Cons of the Options + +#### Programmatically change the schema description of specific generic class instances (Workaround for issue 1) + +Using the workaround described +in [Github issue: Ability to define different schemas for the same class](https://github.com/springdoc/springdoc-openapi/issues/685) it is possible to manually +override the description of each generated schema corresponding to a specific type instance in the `OpenAPI` configuration object, e.g. +for `TypeKeyNameVerboseDto` the generated schema name is `TypeKeyNameVerboseDtoCountryCode`. + +- Good, because this allows specific text descriptions for generic type instances (solves issue 1). +- Bad, because the descriptions must be assigned in the OpenAPI configuration class, not in the specific DTOs as for other descriptions. +- Bad, because this is hard to maintain. + +This option could be potentially improved introducing custom annotations that define the description for a specific type instance inside the relevant DTO, +like `@GenericSchema(type=CountryCode::class, description="...")"`. But the result is not worth the effort. + +#### Programmatically create a schema clone for each case a specific field description is needed (Workaround for issue 2) + +This is based on the first option but additionally adds schema clones with different name and description, e.g. `legalAddressAliasForLogisticAddressDto` might +be the clone of `LogisticAddressDto` used for field `legalAddress`. This schema name is referred by the field +using `@get:Schema(ref = "legalAddressAliasForLogisticAddressDto")`. + +- Bad, because this adds additional nearly identical class schemas that show up in the documentation. +- Bad, because the descriptions must be assigned in the OpenAPI configuration class, not in the specific DTOs as for other descriptions. +- Bad, because the correct schema clone must be referenced for each field using it which is very error-prone and inconsistent to other fields ( + using `@get:Schema(ref=...)` instead of `@get:Schema(description=...)`). +- Bad, because this is hard to maintain. + + + +### More Information + +The potential workarounds are implemented as proof-of-concept +in [Github pull request: Schema overriding hook for OpenApiConfig](https://github.com/eclipse-tractusx/bpdm/pull/405). + +## Recommended usage scenarios of an EDC enabled communication in Business Partner Data Management Solution + +### Context and Problem Statement + +Again and again the discussion arises in which scenarios third party applications (also often called value-added-services (VAS)) must use EDC enabled communication and in which scenarios no EDC is needed. In this document we want to outpoint some scenarios and give guidance for it. + +> :warning: NOTE: +> In the following diagrams the EDC component might be added multiple times within the same operating environment. This does not mean that multiple instances of EDC are used. It should only make more transparent when data or API calls takes place via EDC. It's on conceptual level, not on logical or physical. It's up to you how many instances of EDC you are operating. + +#### TLDR + +- EDC enabled communication must always be used when business data get exchanged between the systems of different legal entities! + +- For reference implementations you should always assume that the value-added-service will be operated by a different operating environment than the operating environment of the core Business Partner Data Management Solution! That means the reference implementation must support EDC enabled communication between itself and the Business Partner Data Management Solution! + +### Scenario 1.1: External web application/service that only visualizes data based on gate data and/or pool data + +#### Description + +In this scenario a third party service provider offers a value added services that implements a web dashboard to visualize processed data based on bpdm gate data and/or pool data and presenting it via this dashboard to the customer who owns the bpdm gate data. + +- EDC enabled communication is needed between the Master Data Management System of the Sharing Member and the bpdm gate operated by the Operating Environment. + +- EDC enabled communication is needed between the bpdm gate and the backend service that processes the data. + +- EDC enabled communication is needed between the bpdm pool and the backend service that processes the data. + +- No EDC is needed for presenting the visualization via a web frontend to the customer. + +![External web application that only visualizes data based on gate data](@site/static/img/kit-icons/edc-usage-1-1.drawio.svg) + +### Scenario 1.2: Internal web application that only visualizes data based on gate data and/or pool data + +#### Description + +In this scenario the operating environment itself operates a web application that implements a web dashboard to visualize processed data based on bpdm gate data and/or pool data and presenting it via this dashboard to the customer who owns the bpdm gate data. + +- EDC enabled communication is needed between the Master Data Management System of the Sharing Member and the bpdm gate operated by the Operating Environment. + +- No EDC enabled communication is needed for the backend service, processing gate and/or pool data, since every component is operated by the same legal entity, the operating environment. + +- No EDC is needed for presenting the visualization via a web frontend to the customer. + +![Internal web app that only visualizes data based on gate data](@site/static/img/kit-icons/edc-usage-1-2.drawio.svg) + +### Scenario 2.1: External web application/service that provides enriched data based on gate data and/or pool data + +#### Description + +In this scenario a third party service provider offers a value added services that implements an interface for exchanging data between its own backend system and the system of the customer. This means that business data get exchanged between the systems of two different legal entities. + +- EDC enabled communication is needed between the Master Data Management System of the Sharing Member and the bpdm gate operated by the Operating Environment. + +- EDC enabled communication is needed between the bpdm gate and the backend service that processes the data. + +-EDC enabled communication is needed between the bpdm pool and the backend service that processes the data. + +- EDC enabled communication is needed between the value-added-service backend and the customer system. + +![External web application that only visualizes data based on gate data](@site/static/img/kit-icons/edc-usage-2-1.drawio.svg) + +### Scenario 2.2: Internal web application/service that provides enriched data based on gate data and/or pool data + +#### Description + +In this scenario the operating environment itself operates a backend service or value added service that processes bpdm gate and/or pool data and implements an interface for exchanging data between its own backend system and the system of the customer. This means that business data get exchanged between the systems of two different legal entities. + +- EDC enabled communication is needed between the Master Data Management System of the Sharing Member and the bpdm gate operated by the Operating Environment. + +- EDC enabled communication is needed between the value-added-service backend and the customer system. + +- No EDC enabled communication is needed between the bpdm gate and the backend service that processes the data. + +- No EDC enabled communication is needed between the bpdm pool and the backend service that processes the data. +![Internal web application that only visualizes data based on gate data](@site/static/img/kit-icons/edc-usage-2-2.drawio.svg) + +## Quality Requirements + +- see: [Quality Goals](#quality-goals-quality-goals) + +## Risks and Technical Debts + +### **Open EDC Questions** + +- What capabilities will be provided in the future? +- How to deal with APIs provided behind an EDC? Swagger documentation cannot be seen by the requesting service? +- How can we authorize and authenticate a User/System with individual permissions after it passes the EDC? +- Will there by a Proxy EDC concept? +- ... + +### **Semantic Model and SSI Integration of the Golden Record** + +- Not in scope. + +### **Dependency on third party service provider** + +- Currently we are not flexible enough to easily change the third party service provider for golden record creation. Therefore the next step will be to introduce an own data persistence layer, getting more independent. +- ✔️Solved via "Simulator Application" + +### **Data Storage and anonymize concept** + +- How to anonymize the relations between CX-Member and its belonging Business Partner? +- 💡 Idea: using kind of "ticket numbering" +- ✔️ Solved via ticketing. + +### **Accessability for SMEs** + +- Uploading via CSV File. Does it requires an EDC? +- ⚠️Current State: Yes, is needed. + +### Technical Debts + +### Central-IDP + +As of now the [Central-IDP](https://github.com/eclipse-tractusx/portal-iam) in release 3.1.0 is not fully compatible with the standard configuration of the BPDM [rights and role concepts](08_Crosscutting_Concepts.md#authentication--autorization). +Therefore, the standard configuration of the BPDM deployment will **not** work with Central-IDP out of the box. +BPDM standard configuration needs to be adapted to be compatible. +This can be done over the application.yml files locally or in case of a Helm deployment these configuration overwrites can be placed in the `applicationConfig` values of the BPDM components (see [INSTALL](../../INSTALL.md) instructions). +[Here](#helm-configuration) a full Helm configuration for the needed adaptions is given. + +#### Pool and Gate Clients + +Client names for the Pool and Gate need to be adapted in the BPDM configuration in order to match with the Central-IDP configuration. + +```yaml +# Pool application.yml +bpdm: + security: + client-id: "Cl7-CX-BPDM" +``` + +```yaml +# Gate application.yml +bpdm: + security: + client-id: "Cl16-CX-BPDMGate" +``` + +#### Orchestrator Authorization + +The Central-IDP does not contain the roles and permissions for the BPDM Orchestrator as described in the [rights and role concepts chapter](08_Crosscutting_Concepts.md#authentication--autorization) and has no dedicated client for the Orchestrator component. + +The configuration of the BPDM Orchestrator can be adapted to compensate for the mismatch. + +```yaml +# Orchestrator application.yml +bpdm: + security: + client-id: "Cl7-CX-BPDM" + permissions: + createTask: "write_partner" + readTask: "write_partner" + reservation: + clean: "write_partner" + cleanAndSync: "write_partner" + poolSync: "write_partner" + result: + clean: "write_partner" + cleanAndSync: "write_partner" + poolSync: "write_partner" +``` + +With this configuration the Orchestrator looks into the permissions of the Pool receiving a bearer token. +Furthermore, the permission overwrites let the Orchestrator only be accessed by services that already have direct write permissions to the Pool, saying: + +If you can directly write into the Pool you are also allowed to manage tasks which lead to Pool updates. + +The permissions to access the Orchestrator endpoints are stricter in this way than they have to be with dedicated Orchestrator permissions. + +#### Service Accounts + +BPDM components need service accounts with the necessary permissions to connect with each other in an authenticated deployment. +As of now, the Central-IDP does not feature dedicated service accounts for single BPDM components but rather has one overall BPDM Admin service account. +This one service account needs to be used by the BPDM components in order to connect to each other and realise the golden record process. + +```yaml +# Pool application.yml +bpdm: + client: + orchestrator: + registration: + client-id: "sa-cl7-cx-5" + client-secret: "*****" +``` + +```yaml +# Gate application.yml +bpdm: + client: + orchestrator: + registration: + client-id: "sa-cl7-cx-5" + client-secret: "*****" + pool: + registration: + client-id: "sa-cl7-cx-5" + client-secret: "*****" +``` + +```yaml +# Cleaning Service dummy application.yml +bpdm: + client: + orchestrator: + registration: + client-id: "sa-cl7-cx-5" + client-secret: "*****" + pool: + registration: + client-id: "sa-cl7-cx-5" + client-secret: "*****" +``` + +#### Helm Configuration + +Here is a full helm values overwrite file containing all adaptions needed for the configuring the BPDM deployment to be compatible with the Central-IDP: + +```yaml +# BPDM values overwrite +keycloak: + enabled: false + +bpdm-pool: + applicationConfig: + bpdm: + security: + auth-server-url: "http://central-idp-host-name/auth" + client-id: "Cl7-CX-BPDM" + client: + orchestrator: + registration: + client-id: "sa-cl7-cx-5" + applicationSecrets: + bpdm: + client: + orchestrator: + registration: + client-secret: "*****" + +bpdm-gate: + applicationConfig: + bpdm: + security: + auth-server-url: "http://central-idp-host-name/auth" + client-id: "Cl7-CX-BPDM" + client: + orchestrator: + registration: + client-id: "sa-cl7-cx-5" + pool: + registration: + client-id: "sa-cl7-cx-5" + applicationSecrets: + bpdm: + client: + orchestrator: + registration: + client-secret: "*****" + pool: + registration: + client-secret: "*****" + +bpdm-orchestrator: + applicationConfig: + bpdm: + security: + auth-server-url: "http://central-idp-host-name/auth" + client-id: "Cl7-CX-BPDM" + permissions: + createTask: "write_partner" + readTask: "write_partner" + reservation: + clean: "write_partner" + cleanAndSync: "write_partner" + poolSync: "write_partner" + result: + clean: "write_partner" + cleanAndSync: "write_partner" + poolSync: "write_partner" + +bpdm-cleaning-service-dummy: + applicationConfig: + bpdm: + client: + orchestrator: + provider: + issuer-uri: "https://central-idp-host-name/auth/realms/CX-Central" + registration: + client-id: "sa-cl7-cx-5" + applicationSecrets: + bpdm: + client: + orchestrator: + registration: + client-secret: "*****" +``` + +#### Long-term mitigation + +Note that the mitigating BPDM configuration above has a major drawback. +All systems directly integrating into the BPDM components need to be absolutely trusted as they receive write privileges on the pool. + +The long-term resolution is to align the BPDM authorization concept with the Central-IDP configuration. +A proposal for this has already been submitted [here](https://github.com/eclipse-tractusx/portal-iam/issues/154). + +Another step in this direction is also using the Central-IDP as a dependency directly for the BPDM Helm charts as proposed [here](https://github.com/eclipse-tractusx/bpdm/issues/994). + +### Partner Network shows all golden records + +Currently, the Portal's Partner Network page shows all business partners even though the intention is to only show Catena-X members. + +#### Mitigation + +In order to resolve this issue a different endpoint needs to be integrated: `POST v6/members/legal-entities/search` + +Additionally, Central-IDP and the Portal need to make sure that the Portal users with the portal role `Cx-User` receive only the BPDM role `Pool Cx Member` as described in the [roles and rights concept](08_Crosscutting_Concepts.md#authentication--autorization). + +### Managing own company data error + +When trying to manage own company data on the Portal's UI we are currently experiencing an error for being unauthorized. + +This renders the Portal user with the role `Service Manager` unable to manage their own data. + +#### Mitigation + +The Portal can mitigate this issue by making sure that the portal user with role `Service Manager` obtains the role `Gate Admin` with permissions as defined in the [roles and rights concept](08_Crosscutting_Concepts.md#authentication--autorization). + +### Exposed technical users + +Through the Portal's marketplace service and subscription process the subscribing company receive access to the created BPDM technical users. +This leads to the danger of companies bypassing the EDC offers and directly accessing the BPDM APIs. + +Since this behaviour of creating technical users is an ingrained feature of the Portal there is no quick resolution to that mismatch. + +#### Mitigation + +As a mitigation the BPDM provider who is also the operator of the Central-IDP can decide to not use the automatic tehcnical user creation process of the Portal. +As a result, when BPDM services are requested the operator needs to create technical users directly in the Central-IDP. +These hidden technical users can then be used to configure [EDC assets](../../INSTALL.md#edc-installation). + +## Glossary + +The Glossary is currently under development and will be added below after internal approval ([DRAFT](https://confluence.catena-x.net/display/CORE/BPDM+Glossary+-+Internal+-+DRAFT)). + +The current version you can find in the Catena-X Standards. + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2023,2024 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023,2024 Mercedes Benz Group +- SPDX-FileCopyrightText: 2023,2024 Schaeffler AG +- SPDX-FileCopyrightText: 2023,2024 Contributors to the Eclipse Foundation +- Source URL: [https://github.com/eclipse-tractusx/bpdm](https://github.com/eclipse-tractusx/bpdm) diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/BPDM Bridge Dummy.postman_collection.json b/docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Software Development View/BPDM Bridge Dummy.postman_collection.json similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/BPDM Bridge Dummy.postman_collection.json rename to docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Software Development View/BPDM Bridge Dummy.postman_collection.json diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/BPDM Cleaning Service Dummy.postman_collection.json b/docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Software Development View/BPDM Cleaning Service Dummy.postman_collection.json similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/BPDM Cleaning Service Dummy.postman_collection.json rename to docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Software Development View/BPDM Cleaning Service Dummy.postman_collection.json diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/BPDM Gate.postman_collection.json b/docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Software Development View/BPDM Gate.postman_collection.json similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/BPDM Gate.postman_collection.json rename to docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Software Development View/BPDM Gate.postman_collection.json diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/BPDM Orchestrator.postman_collection.json b/docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Software Development View/BPDM Orchestrator.postman_collection.json similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/BPDM Orchestrator.postman_collection.json rename to docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Software Development View/BPDM Orchestrator.postman_collection.json diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/BPDM Pool.postman_collection.json b/docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Software Development View/BPDM Pool.postman_collection.json similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/BPDM Pool.postman_collection.json rename to docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Software Development View/BPDM Pool.postman_collection.json diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Local.postman_environment.json b/docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Software Development View/Local.postman_environment.json similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Local.postman_environment.json rename to docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Software Development View/Local.postman_environment.json diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/_category_.json b/docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Software Development View/_category_.json similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/_category_.json rename to docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Software Development View/_category_.json diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/page_software-development-view.md b/docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Software Development View/page_software-development-view.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/page_software-development-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Software Development View/page_software-development-view.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/page_use-cases.md b/docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Software Development View/page_use-cases.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/page_use-cases.md rename to docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Software Development View/page_use-cases.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Success Stories/page_country-risk.md b/docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Success Stories/page_country-risk.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Success Stories/page_country-risk.md rename to docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/Success Stories/page_country-risk.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/page_adoption-view.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/page_adoption-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/page_adoption-view.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/page_changelog.md b/docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/page_changelog.md similarity index 68% rename from docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/page_changelog.md rename to docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/page_changelog.md index 75ca23a1da3..497398d7ac6 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/page_changelog.md +++ b/docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/page_changelog.md @@ -11,7 +11,42 @@ sidebar_position: 1 All notable changes to this Kit will be documented in this file. -## [5.0.0] - unreleased +## [7.0.0] - 2024-12-01 + +Compatible for **release 24.12**. + +### Added + +- Added api hub hyperlink for swagger documentation for all services from business partner data management in development view of business partner kit. + +### Changed + +- ./. + +### Removed + +- Removed open api plug in usage from business partner kit. + +## [6.0.0] - 2024-07-16 + +### Added + +- BPDM Gate api endpoint: Post endpoint to upload business partner input data using csv file. +- BPDM Gate api endpoint: GET endpoint to download the csv file template for business partner upload. +- BPDM Apps: New attribute Tax Jurisdiction Code to the physical address of a business partner +- BPDM Orchestrator: New attribute Record Id to tasks. Now tasks come with a gate record identifier. + +### Changed + +- Documentation of gate service with new endpoints +- Documentation of orchestrator service with updated endpoints +- Documentation of pool service with updated endpoints for newly added attributes. + +### Removed + +- Documentation of BPDM Bridge Dummy service. + +## [5.0.0] - 2024-05-15 ### Added diff --git a/docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/page_software-operation-view.md b/docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/page_software-operation-view.md new file mode 100644 index 00000000000..0b00e90a5a9 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Business Partner Kit/page_software-operation-view.md @@ -0,0 +1,214 @@ +--- +id: Operation View +title: Operation View +description: 'Business Partner Kit' +sidebar_position: 3 +--- + +![Business partner kit banner](/img/kit-icons/bp-kit-icon.svg) + +### Business Partner KIT + +## Local Deployment + +BPDM is an acronym for business partner data management. This project provides core services for querying, adding and changing business partner base information in the Eclipse Tractus-X landscape. BPDM project is SpringBoot Kotlin software project managed by Maven and consists of three microservices. This section contains information on how to configure and run the BPDM application. + +This local deployment is an easy installation with helm charts. This setup is built to run on a kubernetes cluster. +Installation of BPDM applications with the Helm Charts has the most software requirements but is the qickest way to set up a running system. If you want to do local deployment without helm chart then you can refer [installation steps](https://github.com/eclipse-tractusx/bpdm/blob/main/INSTALL.md#local-installation) from [INSTALL.md](https://github.com/eclipse-tractusx/bpdm/blob/main/INSTALL.md) file on bpdm repository. Which will guide you about prerequisites, default installation steps and also guide you for quick installation steps in which security is not necessary by using the provided `no-auth` profile when running the BPDM applications. + +| Step | Action | Description | +|----------------------------------------------------------------------------------|-------------------------------------|-------------------------------------------------------------------------| +|![arrow down](@site/static/img/arrow_down.png)| **[Install the prerequisites](#step-1-prerequisites)**| Install all necessary tools for this setup | +|![vector](@site/static/img/vector.png) | **[Check out the Code](#step-2-check-out-the-code)** | Get all necessary code to deploy the service and dependencies to the kuberneetes cluster| +|![check](@site/static/img/check.png) | **[Installing the Service](#step-3-installing-the-services)**|Start cluster and interact with Services | + +### Step 1: Prerequisites + +1. [Docker](https://docs.docker.com/get-docker/) is installed and the Docker deamon is running with at least 8GB of memory +2. [helm](https://helm.sh/docs/intro/install/) is installed +3. [Minikube](https://minikube.sigs.k8s.io/docs/start/) is installed and running. + You can also use any other local Kubernetes cluster, this guide is just using Minikube as a reference. + + ```bash + minikube start --memory 8192 --cpus 2 + ``` + + _Optional_: enable minikube metrics + + ```bash + minikube addons enable metrics-server + ``` + +4. [kubectl](https://kubernetes.io/docs/tasks/tools/) is installed +5. [psql](https://www.compose.com/articles/postgresql-tips-installing-the-postgresql-client/) client is installed + +### Step 2: Check out the code + +Check out the project [BPDM](https://github.com/eclipse-tractusx/bpdm) or download a [released version](https://github.com/eclipse-tractusx/bpdm/releases) of the project. + +### Step 3: Installing the services + +#### 1.0 Start the cluster + +To deploy the services on kubernetes using helm charts, run + +```bash +cd local/bpdm +helm install your_namespace ./charts/bpdm/ +``` + +If postgresql is not available in your cluster then you might get following error. + +```bash +Error: INSTALLATION FAILED: An error occurred while checking for chart dependencies. You may need to run `helm dependency build` to fetch missing dependencies: found in Chart.yaml, but missing in charts/ directory: opensearch, postgresql +``` + +You can resolve it by adding dependancy to the build + +```bash +helm dependency build ./charts/bpdm/ +``` + +This can take up to **5 minutes**. + +When the deployment is finished you can expect that 4 deployments can be seen in the minikube dashboard: + +* bpdm-gate +* bpdm-pool +* bpdm-cleaning-dummy +* bpdm-orchestrator +* bpdm-keycloak +* bpdm-postgres + +Also in total 6 Pods are up and running. + +#### 1.1 Get the status of the deployment + +The minikube dashboard will give you feedback on how the status of the deployment currently is: + +```bash + minikube dashboard +``` + +Make sure you select the namespace **your_namespace** + +#### 1.2 Forward ports + +When the deployment has been finished, you can for port forwarding using k9s. Also, if k9s tool is not installed the you can use [installer](https://k9scli.io/topics/install/) + +```bash + +``` + +or port forwarding can also be achived kubernetes command + +```bash +kubectl port-forward : +``` + +After that you can access the: + +* **bpdm-gate:** [http://localhost:8081](http://localhost:8081) +* **bpdm-pool:** [http://localhost:8080](http://localhost:8080) + +This will install the BPDM applications with its own Postgres and Keycloak in default values. +Please keep in mind that these steps will also install the applications with default passwords. + +### Step 4: Override Default Secrets + +It is good practice to overwrite the default secrets and passwords that are used in the BPDM Charts. +For this, you can first define a bunch of environment variables holding new secret values and use them later during deployment: + +```bash +helm install your_namespace \ + --set-value postgres.auth.password=$BPDM_POSTGRES \ + --set-value keycloak.auth.adminPassword=$BPDM_KEYCLOAK_ADMIN \ + --set-value keycloak.bpdm.realm.clientSecrets.cleaningDummyOrchestrator=$BPDM_DUMMY_ORCH_CLIENT_SECRET \ + --set-value keycloak.bpdm.realm.clientSecrets.poolOrchestrator=$BPDM_POOL_ORCH_CLIENT_SECRET \ + --set-value keycloak.bpdm.realm.clientSecrets.gateOrchestrator=$BPDM_GATE_ORCH_CLIENT_SECRET \ + --set-value keycloak.bpdm.realm.clientSecrets.gatePool=$BPDM_GATE_POOL_CLIENT_SECRET \ + --set-value bpdm-gate.applicationSecrets.bpdm.client.orchestrator.registration=$BPDM_GATE_ORCH_CLIENT_SECRET \ + --set-value bpdm-gate.applicationSecrets.bpdm.client.pool.registration=$BPDM_GATE_POOL_CLIENT_SECRET \ + --set-value bpdm-pool.applicationSecrets.bpdm.client.orchestrator.registration=$BPDM_POOL_ORCH_CLIENT_SECRET \ + --set-value bpdm-cleaning-service-dummy.applicationSecrets.bpdm.client.orchestrator.registration=$BPDM_DUMMY_ORCH_CLIENT_SECRET\ + ./charts/bpdm +``` + +### Step 5: Installation without authentication + +For non-production purposes you may want to install BPDM applications that are not authenticated. +All BPDM applications offer a Spring profile to quickly remove all authentication configuration for their APIs and client connections. +In this case you can also disable the Keycloak dependency from being deployed. + +```bash +helm install your_namespace \ + --set-value keycloak.enabled=false + --set-value bpdm-gate.profiles=["no-auth"] \ + --set-value bpdm-orchestrator.profiles=["no-auth"] \ + --set-value bpdm-pool.profiles=["no-auth"] \ + --set-value bpdm-cleaning-service-dummy.profiles=["no-auth"] + ./charts/bpdm +``` + +You can also more fine-granulary remove authentication on APIs and BPDM client connections. +You can refer to the no-auth profile configurations (for example that of the [BPDM Gate(without authentication)](https://github.com/eclipse-tractusx/bpdm/blob/main/bpdm-gate/src/main/resources/application-no-auth.yml)) as a documentation. + +### Use External Dependencies + +The BPDM Charts deploy their own PostgreSQL and Keycloak dependencies. +However, for production it is recommended to host dedicated Postgres and Keycloak instances with which the BPDM applications should connect to. + +#### Additional Requirements + +* Postgres (15.4.0 supported) +* Keycloak (22.0.3 supported) + +#### Installation + +In this case, you can disable the dependencies and configure the connection to external systems in the application configuration. + +```bash +helm install your_namespace \ + --set-value keycloak.enabled=false + --set-value postgres.enabled=false + --set-value bpdm-gate.applicationConfig.bpdm.datasource.host=external-db \ + --set-value bpdm-gate.applicationConfig.bpdm.security.auth-server-url=http://external-keycloak \ + --set-value bpdm-pool.applicationConfig.bpdm.datasource.host=external-db \ + --set-value bpdm-pool.applicationConfig.bpdm.security.auth-server-url=http://external-keycloak \ + --set-value bpdm-orchestrator.applicationConfig.bpdm.security.auth-server-url=http://external-keycloak \ + --set-value bpdm-cleaning-service-dummy.applicationConfig.bpdm.client.orchestrator.provider.issuer-uri= http://external-keycloak/realms/CX-Central \ + ./charts/bpdm +``` + +### Fine-granular Configuration + +You can configure all BPDM applications over Helm values more fine-granulary via the `applicationConfig` and `applicationSecrets`. +Values under these groups are directly injected as application properties in the deployed containers. + +As a reference of what can be changed have a look at the respective application properties files of each application: + +1. [BPDM Gate](https://github.com/eclipse-tractusx/bpdm/blob/main/bpdm-gate/src/main/resources/application.yml) +2. [BPDM Pool](https://github.com/eclipse-tractusx/bpdm/blob/main/bpdm-pool/src/main/resources/application.yml) +3. [BPDM Orchestrator](https://github.com/eclipse-tractusx/bpdm/blob/main/bpdm-orchestrator/src/main/resources/application.yml) +4. [BPDM Cleaning Service Dummy](https://github.com/eclipse-tractusx/bpdm/blob/main/bpdm-cleaning-service-dummy/src/main/resources/application.yml) + +## Stopping the cluster + +1. stop minikube + + ```bash + minikube stop + ``` + +2. stop the processes used for port forwarding and minikube dashboard +3. shut down the Docker daemon + +## How to debug an application in the cluster + +If you want to connect your IDE to one of the applications in the cluster, you need to enable debug mode for that application by overriding the entrypoint (using the `command` and `args` fields in the deployment resource). How to do this depends on the application. For the BPDM, as it is based on Spring Boot and Kotlin, you would need to add this flag to the start command: + +```bash +-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=8000 +``` + +Then you can forward the port 8000 for the BPDM deployment to your host machine and connect your IDE to that port. diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/page-adoption-view.md b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/page-adoption-view.md similarity index 76% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/page-adoption-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/page-adoption-view.md index 9349c3bbc1b..46ab3104ab7 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/page-adoption-view.md +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/page-adoption-view.md @@ -2,7 +2,7 @@ title: Adoption View --- -![Circulairty Kit banner](/img/kit-icons/circularity-kit-icon.svg) +![Circulairty Kit Banner](/img/kit-icons/circularity-kit-icon.svg) ## Circularity KIT @@ -12,7 +12,7 @@ title: Adoption View The Circularity KIT shall empower stakeholders to transition towards a circular economy by providing frameworks, guidelines and best practices to enhance sustainability credentials, enable data-driven decision-making and foster collaboration and innovation in the automotive industry. -Secondary material content, **material** accounting, dismantling services, the CE-Assistant, and the secondary marketplace are the five focus topics that form the Circularity KIT as of now. The offered content and artifacts address important use cases such as sustainable materials management, waste minimization and resource efficiency, that contribute to more sustainable and circular automotive value loops. +Secondary material content, material accounting, dismantling services, the CE Assistant, and the secondary marketplace are the five focus topics that form the Circularity KIT as of now. The offered content and artifacts address important use cases such as sustainable materials management, waste minimization and resource efficiency, that contribute to more sustainable and circular automotive value loops. The overarching goals of the Circularity KIT, therefore, are to: @@ -32,7 +32,7 @@ The Circularity KIT serves as a practical set of tools, guidelines, and best pra In a world facing increasing environmental pressures and resource scarcity, transitioning to a circular economy is crucial. This approach ensures responsible resource management through R-strategies, secondary material quotas, material accounting, and optimized end-of-life processes. By closing the loop on material flows, we can reduce our environmental impact, drive innovation, and create economic opportunities that secure a sustainable future. -The KIT entails a description of the overall business value, use case context, an introduction to the subtopics secondary material content, material accounting, dismantling services, CE-Assistant as well as a circularity glossary and is complemented by user journeys, business processes, calculation frameworks, interoperable data models and standards needed to adopt the Catena-X circularity focus topics. +The KIT entails a description of the overall business value, use case context, an introduction to the subtopics secondary material content, material accounting, dismantling services, CE Assistant as well as a circularity glossary and is complemented by user journeys, business processes, calculation frameworks, interoperable data models and standards needed to adopt the Catena-X circularity focus topics. All described specifications in the KIT are based on Catena-X standards like Asset Administration Shell, SSI and a decentral Digital Twin Registry. They refer to other Catena-X KITs like the Traceability KIT to ensure interoperability and data sovereignty according to IDSA and Gaia-X principles. @@ -40,26 +40,34 @@ All described specifications in the KIT are based on Catena-X standards like Ass The Circularity KIT provides business opportunities for service providers in various ways: -1. **Unified Circular Economy Framework:** Service providers can leverage a comprehensive and standardized framework for implementing circular economy principles in the automotive industry. This unified approach simplifies integration and collaboration with other stakeholders, reducing investment costs and accelerating the development and deployment of innovative solutions. -2. **Access to New Market Opportunities:** The KIT enables service providers to tap into emerging market opportunities driven by the increasing demand for sustainable solutions. By offering tailored services on the Catena-X marketplace, service providers can scale their customer base, expand their reach, and unlock new revenue streams. -3. **Enhanced Sustainability Credentials:** By aligning with the principles of the Circularity KIT, service providers can demonstrate their commitment to sustainability and strengthen their reputation in the market. This commitment can lead to increased customer trust, better brand positioning, and a competitive advantage in the Catena-X network. -4. **Data-Driven Decision Making:** The Circularity KIT promotes data-driven decision making by offering access to material accounting data and insights into end-of-life processes within the automotive industry. Service providers can use this data to develop targeted solutions, optimize their offerings, and drive continuous improvement in their services. -5. **Collaboration and Innovation:** By using the Circularity KIT, service providers can actively participate in a network of automotive industry stakeholders committed to fostering a circular economy. This collaborative environment enables the exchange of ideas, knowledge, and best practices, driving innovation and enhancing the overall value of solutions offered in the Catena-X marketplace. +1. **Unified Circular Economy Framework**: Service providers can leverage a comprehensive and standardized framework for implementing circular economy principles in the automotive industry. This unified approach simplifies integration and collaboration with other stakeholders, reducing investment costs and accelerating the development and deployment of innovative solutions. +2. **Access to New Market Opportunities**: The KIT enables service providers to tap into emerging market opportunities driven by the increasing demand for sustainable solutions. By offering tailored services on the Catena-X marketplace, service providers can scale their customer base, expand their reach, and unlock new revenue streams. +3. **Enhanced Sustainability Credentials**: By aligning with the principles of the Circularity KIT, service providers can demonstrate their commitment to sustainability and strengthen their reputation in the market. This commitment can lead to increased customer trust, better brand positioning, and a competitive advantage in the Catena-X network. +4. **Data-Driven Decision Making**: The Circularity KIT promotes data-driven decision making by offering access to material accounting data and insights into end-of-life processes within the automotive industry. Service providers can use this data to develop targeted solutions, optimize their offerings, and drive continuous improvement in their services. +5. **Collaboration and Innovation**: By using the Circularity KIT, service providers can actively participate in a network of automotive industry stakeholders committed to fostering a circular economy. This collaborative environment enables the exchange of ideas, knowledge, and best practices, driving innovation and enhancing the overall value of solutions offered in the Catena-X marketplace. #### Circularity KIT Wheel In its first version the KIT covers 5 focus topics along an automotive value loop. -1. **Secondary Material Content:** promotes the use of secondary materials in the automotive industry by providing a standardized data model for data exchange and a calculation framework. -2. **Material Accounting:** provides standardized scrap/waste and secondary material data exchange for the ecosystem partners to create transparency about recycling activities and verifiable closed loops. -3. **EoL / Dismantling Services:** offers essential support for the digitalization and automation of the EoL phase to consequently close value loops. -4. **CE-Assistant (Circular Strategy Assistant):** is a decision support system that facilitates the selection of the optimal R-Strategy for end-of-life vehicles, with a focus on Reuse, Remanufacturing, Recycling, and Recovery, guided by a comprehensive technical and environmental assessment process. -5. **Secondary Marketplace:** buying and selling used components and secondary raw materials in order to create and open new opportunities for collaborating across the value chain and closing the loop on component and material level. +1. **EoL / Dismantling Services:** offers essential support for the digitalization and automation of the EoL phase to consequently close value loops. +2. **CE Assistant (Circular Economy strategy Assistant):** is a decision support system that facilitates the selection of the optimal R-Strategy for end-of-life vehicles, with a focus on Reuse, Remanufacturing, Recycling, and Recovery, guided by a comprehensive technical and environmental assessment process. +3. **Secondary Marketplace:** buying and selling used components and secondary raw materials in order to create and open new opportunities for collaborating across the value chain and closing the loop on component and material level. +4. **Material Accounting:** provides standardized scrap/waste and secondary material data exchange for the ecosystem partners to create transparency about recycling activities and verifiable closed loops. +5. **Secondary Material Content:** promotes the use of secondary materials in the automotive industry by providing a standardized data model for data exchange and a calculation framework. ##### Figure 1 ![Circularity KIT Wheel](resources/adoption-view/circularity_kit_wheel.svg) +#### End-to-end User Journey + +The following user journey of the Circularity KIT provides an end-to-end overview of the focus topics, connecting the circular flow of vehicles, components, and materials with the Catena-X solutions developed within this domain. + +##### Figure 2 + +![End-to-end User Journey - Circularity KIT](resources/adoption-view/Circularity_KIT_user_journey.svg) + ### Use Case / Domain Explanation Status Quo / Today's challenge: The automotive industry is one of the largest consumers of raw materials, including metals, plastics, and textiles. Managing these materials sustainably and efficiently is a significant challenge, with an increasing focus on reducing waste, improving recyclability, and ensuring responsible sourcing. Traditional linear models of material consumption led to resource depletion, environmental degradation, and missed economic opportunities. @@ -81,6 +89,256 @@ Benefits for OEMs, SMEs, and Solution Providers: - Access new market opportunities and scale their customer base through a circularity network and shared services. - Leverage the collective wisdom of industry stakeholders to drive continuous improvement and innovation. +### Informational Requirements at End of Life + +The regulatory movement and the industry trend towards circularity demand concerted action of all the industry participants addressing the R-strategies. Within the CE community of the Catena-x federation, two working groups with broad industry representation have been addressing the particular data requirements of the three R- strategies: Reuse, Remanufacturing and Recycle. + +The following whitepaper addresses the data parameters required to enable dismantlers to effectively support form-preserving R-strategies at the end-of-life stage, with a special focus on reuse and remanufacturing. By identifying the critical data elements for informed decision-making in the management of end-of-life vehicles, this paper aims to promote a more sustainable and economically viable approach to component utilization in the automotive industry: [Informational Requirements at Dismantling to enable form preserving R-Strategies](https://catena-x.net/fileadmin/user_upload/Publikationen_und_WhitePaper_des_Vereins/2407_Reuse_Reman_Use_Case_WP_v1.pdf) + +Addressing the challenging task of closing the loop for materials from an end-of-life vehicle to a new car component of a modern vehicle, has been attempted within the recycling working group, initially focusing on a few promising components and materials, but with the clear perspective to extend to more materials and their data requirements in further iterations and subsequent refinement of data models. Status of the whitepaper and its addressed examples can be found here: [Data requirements for recycling of ELVs](https://catena-x.net/fileadmin/user_upload/Publikationen_und_WhitePaper_des_Vereins/2407_Material_Recycling_WP_v1.pdf). + +#### Closing Loops, Preserving Resources: Creating tomorrow's EoL landscape and empower the circularity + +As part of the Circularity KIT, we are committed to developing services for the future of the circular economy in the end-of-life (EoL) sector of vehicles. This phase represents an important stage where decisions are made regarding the fate of vehicles and their components after their initial use. Recognizing the immense value of the world's limited resources, we are dedicated to minimizing waste and maximizing resource efficiency. + +One of our key strategies involves creating a framework for an improved communication among all stakeholders involved in the EoL phase. This collaborative approach allows us to consider the needs and requirements of all participants, facilitating the collection and exchange of essential information. Importantly, we view the end of a vehicle's life as the beginning of a new one in the context of resource conservation. + +Our overarching vision is to create a landscape that closes loops and preserves resources, ultimately empowering circularity in the industry. We aspire to provide digitized and scalable EoL services that align with circular economy principles and prioritize the preservation of components and materials. Simultaneously, we are committed to follow present and future changes in laws and regulations, which emphasizes environmentally friendly vehicle disposal and the recovery of critical raw materials (CRMs), aligning with the growing demand for closing component and material loops. + +Our mission centres on empowering EoL and maintenance stakeholders by fostering continuous collaboration within the Catena-X Network and beyond. Through the Circularity KIT working group, we aim to develop and align various means, including data, business, and network models, to empower all stakeholders involved in the EoL phase. This mission is closely tied to our vision of promoting digitized and scalable end-of-life services across the industry while upholding the principles of circular economy. + +Our strategy for achieving these goals involves several key steps. Firstly, we aim to enable EoL service models through data sharing based on digital twins (DT). This approach allows for efficient information sharing in an interoperable, standardized manner, which, in turn, supports dismantling and recycling operations. Furthermore, we are actively engaging with all relevant stakeholders, including policymakers, product designers (for circularity), and EoL service providers, to promote new "R-approaches" and facilitate their implementation. + +Ultimately, our efforts provide essential support for the digitalization and automation of the EoL phase, with the ultimate goal of closing loops in the automotive sector. Through these digitized and scalable EoL services, we aim to contribute significantly to sustainable development and resource conservation, aligning with the principles of the circular economy. + +### Business Context for End-of-Life + +#### Data Journey "End-of-Life" + +The "Data Journey" represents the entire process of dismantling an End-of-Life (EoL) vehicle. Each process step is accompanied by CX data models that would be necessary for digitally representing the individual process steps. This enables us to elevate the data journey for the dismantling process to a digital level and to gain an understanding of which data attributes and aspect models are required for each process step. It forms the foundation for the creation of digital EoL-solutions and the use of robotics. + +##### Figure 3 End-of-Life + +##### 3.1 + +![Data Journey - End fo Life 1](resources/adoption-view/figure_dataJourney_EOF1.svg) + +##### 3.2 + +![Data Journey - End fo Life 2](resources/adoption-view/figure_dataJourney_EOF2.svg) + +##### 3.3 + +![Data Journey - End fo Life 3](resources/adoption-view/figure_dataJourney_EOF3.svg) + +##### 3.4 + +![Data Journey - End fo Life 4](resources/adoption-view/figure_dataJourney_EOF4.svg) + +Future additions include data models for the following topics: + +- Decommissioning Certificate +- Material for Recycling +- Adress Aspects +- ID Conversion +- Certificate of Dismantler +- Diagnostic Data +- Physical dimensions +- Mandatory dismantling +- Demand request +- Compatibility of components/ Design changes history +- Quality issue history +- Technical drawings & specifications +- PCF Information + +#### User Journey "Certificate of Decomissioning" + +The user journey "Certificate of Decommissioning" (CoDM) describes the moment at which a vehicle is transferred into the End-of-Life (EoL) phase from the perspective of an authorized collection point for EoL-vehicles, such as an authorized dismantling facility. The CoDM resembles the official Certificate of Destruction (CoD) but marks the starting point of the upcoming CX concept of a digital CoD. + +##### Figure 4 + +![User Journey CODM](resources/adoption-view/figure_user_journey_codm.svg) + +##### Data Model and GitHub + +The relevant data model can be found on the following link on GitHub: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.decomissioning_certificate/1.0.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.decomissioning_certificate/1.0.0) + +The open availability on GitHub allows companies to combine their own internal target guidance programs with the data models from Catena-X to the EoL-Services. + +## CE Assistant + +### Introduction + +#### Empowering circular economy decisions: Introducing the CE Assistant + +In the dynamic landscape of sustainability and resource conservation, the Circular Economy strategy Assistant (CE Assistant) provides decision support for the selection of strategies concerning end-of-life vehicles. The core task of the CE-Assistant is to evaluate and select an R-Strategy - namely Reuse, Remanufacturing, Recycling, and Recovery. + +Based on the principles of Catena-X, the CE Assistant is aligned with a comprehensive assessment process that guides its functionality. This process is anchored in the Catena-X Digital Twin Framework, which combines the virtual representation and real-world insights. + +The CE Assistant; a set of standards, aspect models, APIs, system architectures, and decision logics; fosters the development of data-centric, Catena-X compliant decision support system for circular economy strategies. The core circularity lies in the flow of technical information in a collaborative effort involving entities across the automotive value chain. + +The concept of a Digital Twin (DT) builds the basis by providing a holistic virtual counterpart of products. The DT includes a set of unique identifiers, an evolving spectrum of aspects, connections to multiple data sources, and the capacity to track the entire lifecycle of assets and capture both individual and fleet-level knowledge. + +In accordance with IDSA and Gaia-X principles, interconnectivity and data sovereignty, the CE-Assistant bases on the principles of interoperability, realized by the Connector KIT (EDC) and Data Chain KIT (Item Relation Ship, IRS). + +The selection of circular economy strategies requires a comprehensive evaluation of emissions, natural resource preservation, energy management, and waste reduction. However, the effectiveness of such evaluations depends on access to detailed data covering the vehicle’s history, components, materials, and condition + +This is where the CE Assistant can help by supporting a user-centered approach that bridges the gap between data availability and informed decision-making. By offering transparency into the environmental implications of diverse circular economy strategies, the CE Assistant facilitates a faster, information based, and efficient decision rooted in the digital twin's insights. + +### Business Context + +The CE Assistant provides decision support and circular strategies, enabling several key features for businesses: + +1. **Component-level decision support:** The KIT provides decision support for selecting circular strategies at the component level. +2. **Efficient data-driven decisions:** Users can make faster and more efficient decisions based on data analysis. +3. **Enhanced circularity:** The KIT contributes to increasing the circularity of products and meeting reuse quotas. +4. **Sustainability milestones:** It helps achieve sustainability indicators and goals. +5. **Transparency on secondary materials:** The KIT offers transparency regarding the availability of secondary materials. +6. **Streamlined vehicle dismantling:** It optimizes the process of vehicle dismantling for improved resource recovery. + +### User Journey and Architecture Overview + +The user journey describes the system interaction of the CE Assistant with the user, the dismantling lead, with the aim of providing a recommendation for a component-level circular strategy for end-of-life vehicles. This involves breaking down the process of holistic decision-making into individual process steps and identifying the interaction with the user/system at each process step. + +#### Figure 5 + +![User Journey - CE Assistant ](resources/adoption-view/CE_assistant_user_journey.svg) + +The following figure shows how the CE Assistant is embedded in the overall architecture: + +##### Figure 6 + +![Architecture View - CE Assistant ](resources/adoption-view/CE_assistant_architecture_view.svg) + +### Logic / Schema + +To assess the appropriate R-Strategy for individual components, it's essential to have various types of EoL data available at different decision-making stages within the logic. This involves distinguishing between process-related, product type-specific, and instance-specific information. + +Process-related data encompasses details derived from the processes and operations of the executing company, such as the CO2 footprint of processes, energy consumption, and waste streams. Product type-specific data is rooted in the planning and development phase of the evaluated component and is influenced by the vehicle type and its design. This category includes information like weight, dimensions, installation requirements, and the bill of materials as built. Instance-specific data reflects the usage and maintenance conditions of individual components (e.g. mileage, quality status). This information is collected throughout the product's lifecycle using DT technology. + +The decision support regarding the best R-Strategy is a multi-stage process, starting with the logic for the technical feasibility assessment. Because only when the R-Strategy is technically feasible, it must be checked for other indicators afterwards. + +The outcome of the technical feasibility assessment will be analyzed to determine if an R-Strategy has to be excluded at the beginning based on regulatory requirements regarding an R-Strategy or a defect in functionality of specific components. + +As shown in Figure 7, the process is started by entering the vehicle identification number (VIN) into the system, thereby requesting the corresponding Catena-X data. The registered companies in the Catena-X network act as data providers for this vehicle-specific data, as they register respective assets and sub-models. Catena-X Shared Services handle existing data models, contracts, usage and access control policies, and ultimately the final data exchange. + +The system presents the information, such as corresponding vehicle, component and material based on DT data. This data is provided for the first overall manual inspection and evaluation. After that, the user selects the most relevant components for the R-Strategy decision. The decision logic is applied for this component and the possible R-Strategies are identified. + +The following criteria are evaluated in a chronological order: the basic reuse-potential, material composition and remaining lifetime in comparison with the specific thresholds and the disassembly capability. + +If one or more of these criteria are not fulfilled, the component will only be assigned to recovery or recycling. If the component qualifies for disassembly, a manual visual inspection and a functional check are conducted. For components, where the visual condition is relevant, such as body parts and interior components, the visual inspection is conducted first. In contrast, components, for which the technical condition is of significant relevance, such as engines and gearboxes, are first subjected to a functional test. Here, the data can also be provided in the Catena-X network as an update of the DT. Thereafter, a quality comparison of the component condition with threshold values takes place. When the quality is insufficient for reuse, the technical check for remanufacturing is carried out chronologically: assemblability, cleanability and restorability / upgradability. Finally, a possible strategy is given to the user as an intermediate result before further environmental assessment. + +#### Figure 7 + +![Decision logic regarding technical feasibility](resources/adoption-view/CE_assistant_technical_feasibility_logic.svg) + +After assessing the technical feasibility, the environmental impact of the previously selected component is calculated and evaluated using the Life Cycle Assessment (LCA) methodology, following ISO 14040 and ISO 14044 standards. R-strategies that are not technically feasible are excluded from the subsequent decision logic, as depicted in Figure 8. + +First, to obtain LCA-relevant activity data for EoL processes, process-related data of the dismantling and different R-Strategy processes needs to be entered into the decision support system by the user or retrieved from internal or external data collections. Examples for essential process-related data are: Use of process flows, operating resources, such as energy and material consumption, and location factors (e.g. distance to the nearest remanufacturer). + +With the help of the process-related data in combination with product type-specific data requested from the Catena-X network, a subsequent input and output analysis of the dismantling process and remaining R-strategies leads to the collection of parameters in a Life Cycle Inventory (LCI): material consumption, energy consumption (electricity and fuels) and direct emission release (e.g. in CO2, SO2, NOx). Life Cycle Impact Assessment (LCIA) methods are then used to transfer the LCI results into a quantifiable environmental impact, such as global warming potential, of the corresponding R-Strategy in addition to the previous dismantling. To note that the resulting impact values are a pure process view of the EoL, the intermediate results are referred to as "relative total environmental impact" of the assessed R-strategies. + +In order to decide for the best R-Strategy, the respective R-Strategy can be compared with each other and a comparison with production can also be made. + +Finally, all absolute environmental impacts of the R-strategies are compared, and the most environmentally friendly strategy is recommended as a decision support for the dismantling lead. Moreover, the results of the CE Assistant can also be made available to other stakeholders via the Catena-X network to enable, for example, feedback-to-design for product development. + +In the future research, consideration should also be given to the extent to which the use of a reused or remanufactured component causes emissions compared to a new component. Modern technological components can achieve a much higher level of efficiency in use, so that despite high emissions, it may make more sense to produce a new component than to extend the life cycle of the old component, which may have a significantly higher utilization cost. + +##### Figure 8 + +![Decision logic regarding environmental assessment](resources/adoption-view/CE_assistant_environmental_assessment.svg) + +### Whitepapers + +If you are eager to dive deeper into the world of the CE Assistant, including its data provision via the Digital Twin and expert insights on technically feasible circular strategies and environmentally friendly choices, we invite you to explore our informative publications. + +#### End-of-life decision support to enable circular economy in the automotive industry based on digital twin data + +- **Abstract**: With the EU Green Deal and the UN Sustainable Developments Goals, the vision of a greenhouse gas-neutral and resource-efficient economy is already firmly anchored in world politics. In this context, the automotive industry faces many challenges including the increasing scarcity of natural resources, a rising demand in terms of sustainable vehicle design, production and materials sourcing. Due to all this, end-of-life decisions regarding dismantling have become increasingly important. A high proportion of secondary materials will be required in the vehicles of the future. To response to these challenges, companies have turned their focus towards the circular economy as a central approach to close material loops. In the German research project “Catena-X” a new data ecosystem with digital twins is one enabler that is being developed. The digital twins represent a promising approach to the circular economy by ensuring transparent, product-specific and end-to-end data exchange throughout the entire product lifecycle, from the material sourcing to the eventual dismantling and recycling. As one particular and unique solution, a decision framework that facilitates the best circular strategy at the end of a vehicle's life is developed and presented in this paper. The underlying data-driven decision support framework is based on circular economy KPIs. This includes material, components and specific vehicle KPIs to best identify the most suitable circular strategy. The framework was methodologically developed by an interdisciplinary team of partners, who are stakeholders throughout the value chain and participants in the Catena-X project. An integrated approach of user-centered design, an adapted version of the V-model and the Scaled Agile Framework were used for the methodology in the development of the solution. The paper presents the concept of a digital twin for a decision support system, that includes a central decision logic that also includes the relevant KPIs and a survey for evaluating the decision logic utilized with a chosen dismantling company. +- **Link**: [End-of-life decision support to enable circular economy in the automotive industry based on digital twin data - ScienceDirect](https://www.sciencedirect.com/science/article/pii/S2212827123006091) + +##### Empowering End-of-Life Vehicle Decision Making with Cross-Company Data Exchange and Data Sovereignty via Catena-X + +- **Abstract:** The mobility sector is the world’s second-largest producer of energy-related CO2 emissions, and it is facing a global resource shortage. The demand for circular products, the use of secondary materials in future vehicles, and the need for sustainable business models in the mobility sector is increasing. However, a transparent and end-to-end data exchange throughout the entire value network is missing, which is hindering an efficient circular economy. Relevant information on the vehicle, its components and materials at the end of the product life cycle are often missing. In this context, this paper presents a decision support system based on Digital Twin data for a circular economy solution as a software application. It was developed within the German research project Catena-X following an integrated approach of user-centered design, the V-model, and within the Scaled Agile Framework. By combining these methodological approaches, customer-oriented solutions were developed and continuously improved at each stage of development to shorten the time-to-market. Catena-X is based on Gaia-X principles. In Gaia-X, necessary core services are developed, and contraction negotiation for data exchange and usage policies is enabled and implemented. The decision support system provides important information about the exact composition and condition of the vehicle, its components, and its materials. Thus, it helps to improve efficiency, sustainability, and the implementation of the circular economy. The decision support system was tested and validated with a use case that provided Digital Twin data on the end-of-life vehicle. +- **Link**: [Sustainability | Free Full-Text | Empowering End-of-Life Vehicle Decision Making with Cross-Company Data Exchange and Data Sovereignty via Catena-X (mdpi.com)](https://www.mdpi.com/2071-1050/15/9/7187) + +##### Digital Twins for Circular Economy - Enabling Decision Support for R-Strategies + +- **Abstract:** Digital twins (DT) for circular economy (CE) offer a promising approach as part of digital data ecosystems for more sustainable value creation. By mapping and analyzing product, component and material specific data along the lifecycle, it is possible to address current challenges such as climate change and resource scarcity. Within Catena-X, specific solutions based on this cross-company exchanged data and information are developed. Here, the “CE-Assistant” is presented. It is an application, which identifies the best CE Strategy based on DT data at the end of a vehicle's life. +- **Link:** [OA_Mügge_6-2022 | INDUSTRIE-MANAGEMENT](https://www.industrie-management.de/node/556) + +##### Digital Twins within the Circular Economy: Literature Review and Concept Presentation + +- **Abstract:** Digital twins offer a promising approach to sustainable value creation by providing specific life cycle data and enabling the monitoring and implementation of circular economy strategies throughout the product’s life cycle. By analyzing product, component, and material data, as well as process data, it is possible to create transparency throughout a product’s life cycle, build a data-driven product ecosystem, and establish new business and value creation models, from SMEs to large enterprises. This paper identifies application scenarios, their technological readiness level, and the challenges of digital twins for the circular economy in the manufacturing industry based on a systematic literature review. Gaps such as ensuring a continuous flow of information and taking into account the different levels of digitalization of companies are identified. As a main result, a holistic concept for the scoping of a digital twin for the circular economy is presented. One specific use case for end-of-life decision-making is elaborated upon. It is shown that the circular economy can be supported by digital twin data, especially for the optimal decision on end-of-life vehicles. +- **Link:** [https://www.mdpi.com/2071-1050/16/7/2748](https://www.mdpi.com/2071-1050/16/7/2748) + +## Secondary Marketplace + +### Introduction + +A secondary marketplace is fundamental to establish a circular economy where components and materials are available and offered to the interested users creating new value chains and extending the life of the parts and the materials before becoming waste. Digital platforms offering marketplace services are essential to enable trading of secondary materials and components, provide transparency into supply and demand that potential buyers and sellers can expect. + +The main goals of the Marketplace are: (1) to match the demand and the supply of available components and secondary raw materials and (2) to provide transparency on sales opportunities for used components which can be, for example, reused or re-manufactured. + +If offered, additional services such as grading, certifications for the offered listings (components or secondary materials) and transport handling and logistics could support trading processes. + +### Business Context + +A secondary marketplace enables closing the loop on economical and physical layers. Following the logic described in the previous chapter, there could be multiple scenarios related to R-strategies on how secondary marketplaces enable a circular economy. + +Potential sales scenarios: + +- Dismantling companies selling old components and material/scrap; +- Automotive manufacturers selling old unused components; +- Automotive manufacturers selling production waste and scrap; +- and others. + +Potential purchase scenarios: + +- Automotive companies buying components for re-manufacturing; +- Workshops buying components for re-use; +- Recyclers buying production waste and scrap; +- and others. + +In all of those cases, having additional information (e.g. product carbon footprint or digital product passport details) on the products offered on the marketplace is beneficial. + +### User Journey and Architecture Overview + +In general, there are several goals that buyers and sellers pursue on a secondary marketplace: + +- As a (Core) Purchaser, I want to search and filter for market supply on OE number level to match the market offers towards my demand. +- As a (Core) Purchaser, I want to reach as many possible sellers as possible to purchase parts that I cannot procure today. This includes brokers I don't buy from today. +- As a (Core) Seller, I want to place offers on the marketplace with standard upload tools and manually. +- As a (Core) Seller, I want to reach as many possible customers as possible to maximize my turnover. This includes customers I don't sell to today. + +The key user journey relevant in Catena-X circular economy area relates to the need of a buyer to have full reliable information on a product that he is intending to purchase. This is especially important given that many buyers are looking for parts for re-manufacturing or re-use, where product quality plays a vital role. Furthermore, in case of recycling, recyclers are interested to know material composition and additional information that would influence their purchasing decision. + +Some information could be provided by a variety of data models, but the highest value lies within the generic digital product passport (and by extension, battery passport, sealant passport, transmission passport). When a seller is publishing a listing with a product that he is willing to sell, there is only a limited amount of information he can provide with it, mostly the one available from the visual inspection or on-board data (such as mileage, OE-number, brand) as well as logistical/ sales information (such as location or price). When a potential buyer views the listing, he should have a possibility to request additional details from a data provider of the generic digital product passport (if available) for that product (see diagram below). More information on the digital product passport can be found in the [Ecopass KIT](https://eclipse-tractusx.github.io/docs-kits/kits/Eco_Pass_KIT/page-adoption-view/). + +#### Figure 9 + +![User Journey - Secondary Marketplace](resources/adoption-view/user_journey_secondary_marketplace.svg) + +This process is reflected in the architecture for communicating with the Catena-X network and data providers of the battery passport data model, as presented below. + +#### Figure 10 + +![Communication Architecture](resources/adoption-view/communication_architecture.svg) + +When it comes to the data exchange schema and other details, see the [Triangle for Secondary Marketplace](https://catena-x.net/de/standard-library) document for more information on how such a request could be realized within Catena-X environment and according to applicable guidelines (e.g. on interoperability and data sovereignty). In a decentral environment, such attributes as manufacturer part ID and OE number play a vital role in order to get access to the right component and the right data model at data provider’s side. + +### Semantic Models + +In the following, relevant semantic models for the secondary marketplace are listed. For further information about the listed data models please refer to the Catena-X standards library for the respective data model, marked as “CX-“, which contains the standardized data models with further descriptions and explanations. The standards library can be founded here: [Catena-X Standard-Library](https://catena-x.net/de/standard-library) + +The Marketplace Offer is an aspect model that is complementary to the concept of a secondary marketplace. It described a product (e.g. a used, dismantled component) that is placed for sale onto the marketplace, with key supporting information such as quantity, quality, or price. It provides essential information for potential buyers and could be used in the future to exchange product information between multiple marketplaces. This model can therefore be used to exchange offers between multiple marketplaces. As there is no exchange scenario defined yet, the Marketplace Offer is a recommendation and non-normative, since it is so far concerning the business application-internal data structure only. More information on this aspect model can be found under CX-0035 in the standards library or under the following link: [Marketplace Offer](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.market_place_offer) + +Additionally, two other aspect models could play a supporting role for secondary marketplaces. + +The Return Request aspect model could be used to flag a vehicle or product to indicate that there is a demand or a request for return. It specifies the aspect of the recall of a vehicle part and thus provides the information whether and why a return request exists for a product. More information on this aspect model can be found under CX-0033 in the standards library or under the following link: [Return Request](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.return_request) + +The Product Passport aspect model could provide reliable details on the product characteristics or lifecycle information, therefore complementing the basic Marketplace Offer information. More information on this aspect model can be found under CX-0103 in the standards library or under the following link: [Digital Product Passport](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.generic.digital_product_passport) + ## Material Accounting ### Introduction @@ -97,7 +355,7 @@ To realize this ambition, a standardized framework is imperative, one that facil The image below shows the big picture of a circular economy when material is tracked over its complete life cycle excluding the usage phase. -##### Figure 2 +##### Figure 11 ![Overview Material flow](resources/adoption-view/overview_material_flow.svg) @@ -110,7 +368,7 @@ From a business perspective, the material accounting KIT is characterized by the 3. **Increased Material Recycling:** The KIT promotes the recycling of materials within the same industry, increasing sustainability. 4. **Transparency:** It provides higher transparency regarding the availability of secondary materials. -### Use Case / Domain Explanation +### Use Case / Domain #### Material Accounting in Catena-X @@ -118,7 +376,7 @@ Catena-X offers a decentral, sovereign, cross-organizational data exchange. For The goal of the Material Accounting Feature inside the Catena-X consortium and association is to collaborate on exchanging standardized secondary material information across the upstream & downstream value in order to develop a standardized data model. To do so, we identified potential data points along a closed loop with OEM, recycler and supplier as stakeholders as seen in the picture below. Further feature content will follow in upcoming versions of the Circularity KIT. -##### Figure 3 +##### Figure 12 ![Data Points along the Value Chain](resources/adoption-view/datapoints_along_valuechain.svg) @@ -142,7 +400,7 @@ The secondary material content chapter of the Circularity KIT explores how the s This user journey illustrates the data exchange process through Catena-X in the context of secondary material content. The user journey outlines the various stakeholders along the value chain and within the individual tiers and their involvement. -##### Figure 4 +##### Figure 13 ![User Journey - SMC](resources/adoption-view/userJourney_smc.svg) @@ -159,7 +417,7 @@ The user journey follows the same process during all four lifecycle stages and d There are different scenarios in which SMC Data can be exchanged. According to the semantic model framework, this implies that there is a specific data model for each purpose (scenario). -_To ensure efficiency by avoiding redundancy and maintaining multiple data models, the concept of a shared aspect model was used: This means that there is one Secondary Material “base model”, which is the SecondaryMaterialContent. This serves as an enabler for data modelling and not for data exchange itself, it is bad practice to use it for data exchange._ +_In order to ensure efficiency by avoiding redundancy and maintaining multiple data models, the concept of a shared aspect model was used: This means that there is one Secondary Material “base model”, which is the SecondaryMaterialContent. This serves as an enabler for data modelling and not for data exchange itself, it is bad practice to use it for data exchange._ Instead, SecondaryMaterialContentCalculated or SecondaryMaterialContentVerifiable should be used when exchanging SMC data, depending on the actual scenario. @@ -173,7 +431,7 @@ In the table below, different scenarios are described to clarify which data mode | Prognosis-based SMC data exchange | In this scenario, SMC data is exchanged based on a prediction or forecast of future events in the automotive sector. | When the production of a previously produced car is continued, a prognosis of the SMC is made based on the previous production. | [SecondaryMaterialContentCalculated](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.secondary_material_content_calculated) | | Measured-information-based SMC data exchange | In this scenario, the SMC data that is exchanged is based on actual measured information and data. The relevant data is therefore verifiable. | During the production of a component, the order information of the used material clearly indicates the SMC of the used materials. | [SecondaryMaterialContentVerifiable](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.secondary_material_content_verifiable) | -#### Figure 5 +#### Figure 14 ![Depiction of SMC Data Models - SMC](resources/adoption-view/depiction_of_smc_data_models.svg) @@ -198,11 +456,11 @@ In addition to filling out the data model for Secondary Material Content, other #### 1. Material -The Model is designed to address the material at the lowest level requiring descriptive information, such as the material name in accordance with a standardized format, as well as the name and code of the referenced standard _(materialNameStandardizedValue; referencedStandard; referencedStandardID)._ For example, a material name may be given based on the ISO 1043 standard, in which case ISO would be the referenced standard and ‘1043’ the referenced standard ID. The material class _(materialClass)_ must be provided in accordance with the VDA standard 231-106. To provide relevant data regarding the material mass per declared unit of the material, the unit of measure, such as gram or kilogram _(unitOfMeasureKey)_, must first be defined. Next, the gross material input weight _(grossMaterialInputMass)_ as well as the net mass of the material _(materialNetMass)_ shall be provided. +The Model is designed to address the material at the lowest level requiring descriptive information, such as the material name in accordance with a standardized format, as well as the name and code of the referenced standard _(materialNameStandardizedValue; referencedStandard; referencedStandardID)_. For example, a material name may be given based on the ISO 1043 standard, in which case ISO would be the referenced standard and ‘1043’ the referenced standard ID. The material class _(materialClass)_ must be provided in accordance with the VDA standard 231-106. To provide relevant data regarding the material mass per declared unit of the material, the unit of measure, such as gram or kilogram _(unitOfMeasureKey)_, must first be defined. Next, the gross material input weight _(grossMaterialInputMass)_ as well as the net mass of the material _(materialNetMass)_ shall be provided. -Essential material characteristics that are mandatory within the data model include the use of bio-based materials and their material class _(bioBasedClass)_, as well as the percentage of material weight of each primary and secondary bio-based material _(primaryBioBased; secondaryBioBased)._ For secondary bio-based material it can be chosen whether a mass balancing approach was followed or not _(isMassBalanced)_. Further information on mass-balancing can be found under [_B. Accounting for chain of custody models_](#b-chain-of-custody-models). +Essential material characteristics that are mandatory within the data model include the use of bio-based materials and their material class _(bioBasedClass)_, as well as the percentage of material weight of each primary and secondary bio-based material _(primaryBioBased; secondaryBioBased)_. For secondary bio-based material it can be chosen whether a mass balancing approach was followed or not _(isMassBalanced)_. Further information on mass-balancing can be found under [_B. Accounting for chain of custody models_](#b-accounting-for-chain-of-custody-models). -Further, information regarding inorganic/fossil-based materials is required. The percentage of primary inorganic/fossil-based material weight _(percentageOfMaterialWeight)_ shall be provided. When it comes to secondary material, the percentage of material weight of chemically and mechanically recycled pre-consumer and post-consumer material according to ISO 14021 should be included _(percentageOfMaterialWeight)_. Post-Consumer material is divided into two streams: Post consumer material from end-of-life vehicles as well as post consumer from other sources. When chemical or mechanical recycling has been applied, it is important to disclose information whether a mass balancing approach was followed _(isMassBalanced)._ +Further, information regarding inorganic/fossil-based materials is required. The percentage of primary inorganic/fossil-based material weight _(percentageOfMaterialWeight)_ shall be provided. When it comes to secondary material, the percentage of material weight of chemically and mechanically recycled pre-consumer and post-consumer material according to ISO 14021 should be included _(percentageOfMaterialWeight)_. Post-Consumer material is divided into two streams: Post consumer material from end-of-life vehicles as well as post consumer from other sources. When chemical or mechanical recycling has been applied, it is important to disclose information whether a mass balancing approach was followed _(isMassBalanced)_. _Definition of pre-consumer material:_ @@ -222,9 +480,9 @@ _Definition of Reutilization:_ Even though Reutilization fosters the avoidance of waste, it does not count as recyclate according to ISO 14021 and is an optional attribute for this data model. -If available, the name of a certificate verifying the recycling content and a link to its PDF validating the provided information can be included _(certificate)._ +If available, the name of a certificate verifying the recycling content and a link to its PDF validating the provided information can be included _(certificate)_. -##### Figure 6 +##### Figure 15 ![Material Characteristics](resources/adoption-view/Relationship_between_Material_Characteristics.svg) @@ -232,15 +490,13 @@ The schematic depiction above provides a visual representation of the connection #### 2. Order Data -To clearly identify the order and relevant material, the order number _(orderNumber)_ can be provided on an optional basis. +To clearly identify the order and relevant material, the order number (orderNumber) can be provided on an optional basis. -#### B. Chain of Custody Models +#### B. Accounting for Chain of Custody Models -Disclaimer: For information regarding the calculation of a PCF on basis of the Chain of Custody Models please see the Catena-X [(PCF) Rulebook.](https://catena-x.net/de/standard-library) +Please see the Catena-X Product Carbon Footprint (PCF) Rulebook for further information. Chain of custody is an administrative process by which information about materials is transferred, monitored, and controlled as those materials move through supply chains [ISO 22095:2020]. There are in principle four chains of custody models possible, illustrated in the figure below. Their common objective is to guarantee correct bookkeeping and to corroborate a link between in-going content, e.g., ‘sustainable’, ‘recycled’ or ‘organic’ by harmonized definitions, and the finally out-going product. They differ regarding physical or administrative links. Furthermore, they differ on the set of rules for balancing, and the possibility to keep materials streams segregated or not. -Chain of custody is an administrative process by which information about materials is transferred, monitored, and controlled as those materials move through supply chains [ISO 22095:2020]. There are in principle four chains of custody models possible, illustrated in the figure below. Their common objective is to guarantee correct bookkeeping and to corroborate a link between in-going content, e.g., ‘sustainable’, ‘recycled’ or ‘organic’ by harmonized definitions, and the finally out-going product. They differ regarding physical or administrative links. Furthermore, they differ on the set of rules for balancing, and the possibility to keep materials streams segregated or not. - -##### Figure 7 +##### Figure 16 ![figure custody models](resources/adoption-view/custody_models.svg)[^1] @@ -248,18 +504,18 @@ Chain of custody is an administrative process by which information about materia The following table is adapted from the [Mass Balance EMF White Paper](https://emf.thirdlight.com/link/f1phopemqs36-8xgjzx/@/preview/1?o) and provides high-level explanations and differentiations for the four chain of custody models: -| Model | Explanation | Example | -| ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Identity Preservation | It is possible to physically track the product to its desired origin, ensuring unique traceability and physical separation of products from other sources along the supply chain. | Buying food from a single certified producer. | -| Segregation | Consists in the aggregation of volumes of products of identical origin or produced according to the same standards in one stock item. | Buying food from a trader that exclusively handles identically certified supplies. | -| Mass Balance | Considering the output, no physical or chemical difference exists between in-scope and out-of-scope. It involves balancing volume reconciliation to ensure the exact account of volumes of in- and out-of-scope source is maintained along the supply chain, provided that the volume or the ratio of sustainable material integrated is reflected in the product produced and sold to customers. This model requires that a reconciliation period is defined (e.g. a month, a year). | Buying a certain percentage of a supply from certified origin. Applies to, e.g., sustainable forestry for wooden materials, recycled, bio-based or renewable materials, organic cotton | -| Book and Claim – Restricted Certificate Trading | The certified product / component is disconnected from the certification data but belongs to the same production system or value chain. The certified product evolves in separate flows from the certified supply. Certificates are issued at the beginning of the supply chain by an independent body reflecting the sustainable content of supplies. The intended outcome is that outputs from one supply chain are associated with total claims corresponding to the certified input. | Buying material with renewable/recycled/ biobased content. Certificates with guarantee of origin or comparable certifications declaring e.g. recycled, renewable, biobased content. | +| Model | Explanation | Example | +| ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Identity Preservation | It is possible to physically track the product to its desired origin, ensuring unique traceability and physical separation of products from other sources along the supply chain. | Buying food from a single certified producer. | +| Segregation | Consists in the aggregation of volumes of products of identical origin or produced according to the same standards in one stock item. | Buying food from a trader that exclusively handles identically certified supplies. | +| Mass Balance | Considering the output, no physical or chemical difference exists between in-scope and out-of-scope. It involves balancing volume reconciliation to ensure the exact account of volumes of in- and out-of-scope source is maintained along the supply chain, provided that the volume or the ratio of sustainable material integrated is reflected in the product produced and sold to customers. This model requires that a reconciliation period is defined (e.g. a month, a year). | Buying a certain percentage of a supply from certified origin. Applies to, e.g., sustainable forestry for wooden materials, recycled, bio-based or renewable materials, organic cotton | +| Book and Claim – Restricted Certificate Trading | The certified product / component is disconnected from the certification data but belongs to the same production system or value chain. The certified product evolves in separate flows from the certified supply. Certificates are issued at the beginning of the supply chain by an independent body reflecting the sustainable content of supplies. The intended outcome is that outputs from one supply chain are associated with total claims corresponding to the certified input. | Buying material with renewable/recycled/ biobased content. Certificates with guarantee of origin or comparable certifications declaring e.g. recycled, renewable, biobased content. CO2 capture certificates from a production system controlled by the company, e.g. carbon capture and storage. | -Explanation chain of custody models [adapted from the above cited EMF Whitepaper] +For calculating the PCF according to the Catena-X rulebook all types of models may be taken into account, if the requirements listed below are met and an independent third-party chain of custody verification for the balance of materials is available. The balance between input and output shall be correct. The mass balance approach helps enabling fossil raw materials to be replaced by more sustainable alternative materials (e.g. with recycled content, bio-content). In contrast to a segregated use of alternative raw materials, mass balance enables to use existing production networks with minimized or no investments into new process technologies and production facilities. A book and claim model can be applied when there is no direct connection between the final product and the certified supply. An example for a book and claim model is applied in green electricity markets and receives more attention in other sectors as a way to support circular transformation of the industry, therefore it is accepted as a solution. There will be a regular review by Catena-X to decide about the further necessity. -#### Guiding Principles +##### Guiding Principles In implementing chain-of-custody methods, including the mass balance one, the following set of guiding principles shall be fulfilled: @@ -299,7 +555,7 @@ All secondary material usage types are being expressed as percentages of the rel ![pre consumer material content equation](resources/adoption-view/eq_pre_consumer_material_content.svg) -_Definition of pre-consumer material:_ +**Definition of pre-consumer material:** “Material diverted from the waste stream during a manufacturing process. Excluded is reutilization of materials such as rework, regrind or scrap generated in a process and capable of being reclaimed within the same process that generated it. Pre consumer material can be used in form of recovered or recycled material as a substitute for primary material.” @@ -307,7 +563,7 @@ _Definition of pre-consumer material:_ ![post consumer material content equation](resources/adoption-view/eq_post_consumer_material_content.svg) -_Definition of post-consumer material:_ +**Definition of post-consumer material:** “Material generated by households or by commercial, industrial and institutional facilities in their role as end-users of the product which can no longer be used for its intended purpose. This includes returns of material from the distribution chain. Post-consumer material can be used in form of recovered or recycled material as a substitute for primary material.” @@ -315,7 +571,7 @@ _Definition of post-consumer material:_ ![Reutilization content Equation](resources/adoption-view/equation_Reutilization_content.svg) -###### Definition of reutilization +**Definition of reutilization:** “Reutilization of materials such as rework, regrind, or scrap materials generated within the process and capable of being reused within the same process that generated it. Any operation by which products or components that are not waste are used again for the same purpose for which they were originally intended. Reutilization allows waste to be reduced and materials can be kept in cycle.” @@ -335,13 +591,13 @@ It is important to note that data quality may vary during different stages of th To calculate the average portion of, for instance, the amount of mechanical recycling of post-consumer material content in the whole material, the values along the data model must be multiplied. For example, the content of inorganic or fossil-based material, content of secondary inorganic or fossil-based material, post-consumer material content, and mechanical recycling would be multiplied as can be seen in the schematic depiction below. -##### Figure 8 +##### Figure 17 ![material_characteristics](resources/adoption-view/material_charactersitics.svg) #### D. Data Models and Github -The relevant data models can be found on GitHub: +The relevant data models can be found via the following links on GitHub: - [Secondary Material Content](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.shared.secondary_material_content) - [Secondary Material Content Calculated](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.secondary_material_content_calculated) @@ -349,209 +605,6 @@ The relevant data models can be found on GitHub: The open availability on GitHub allows companies to combine their own internal target guidance programs with the data models from Catena-X to SMC. -## End of Life / Dismantling Services - -### Introduction - -#### Closing Loops, Preserving Resources: Creating tomorrow's EoL landscape and empower the circularity - -As part of the Circularity KIT, we are committed to developing services for the future of the circular economy in the end-of-life (EoL) sector of vehicles. This phase represents an important stage where decisions are made regarding the fate of vehicles and their components after their initial use. Recognizing the immense value of the world's limited resources, we are dedicated to minimizing waste and maximizing resource efficiency. - -One of our key strategies involves creating a framework for an improved communication among all stakeholders involved in the EoL phase. This collaborative approach allows us to consider the needs and requirements of all participants, facilitating the collection and exchange of essential information. Importantly, we view the end of a vehicle's life as the beginning of a new one in the context of resource conservation. - -Our overarching vision is to create a landscape that closes loops and preserves resources, ultimately empowering circularity in the industry. We aspire to provide digitized and scalable EoL services that align with circular economy principles and prioritize the preservation of components and materials. Simultaneously, we are committed to follow present and future changes in laws and regulations, which emphasizes environmentally friendly vehicle disposal and the recovery of critical raw materials (CRMs), aligning with the growing demand for closing component and material loops. - -Our mission centres on empowering EoL and maintenance stakeholders by fostering continuous collaboration within the Catena-X Network and beyond. Through the Circularity KIT working group, we aim to develop and align various means, including data, business, and network models, to empower all stakeholders involved in the EoL phase. This mission is closely tied to our vision of promoting digitized and scalable end-of-life services across the industry while upholding the principles of circular economy. - -Our strategy for achieving these goals involves several key steps. Firstly, we aim to enable EoL service models through data sharing based on digital twins (DT). This approach allows for efficient information sharing in an interoperable, standardized manner, which, in turn, supports dismantling and recycling operations. Furthermore, we are actively engaging with all relevant stakeholders, including policymakers, product designers (for circularity), and EoL service providers, to promote new "R-approaches" and facilitate their implementation. - -Ultimately, our efforts provide essential support for the digitalization and automation of the EoL phase, with the ultimate goal of closing loops in the automotive sector. Through these digitized and scalable EoL services, we aim to contribute significantly to sustainable development and resource conservation, aligning with the principles of the circular economy. - -### Business Context - -#### Data Journey "End-of-Life" - -The "Data Journey" represents the entire process of dismantling an End-of-Life (EoL) vehicle. Each process step is accompanied by CX data models that would be necessary for digitally representing the individual process steps. This enables us to elevate the data journey for the dismantling process to a digital level and to gain an understanding of which data attributes and aspect models are required for each process step. It forms the foundation for the creation of digital EoL-solutions and the use of robotics. - -##### Figure 9 - -![Data Journey - End of LIfe](resources/adoption-view/figure_dataJourney_EOF.svg) - -Future additions include data models for the following topics: - -- Decommissioning Certificate -- Material for Recycling -- Adress Aspects -- ID Conversion -- Certificate of Dismantler -- Diagnostic Data -- Physical dimensions -- Mandatory dismantling -- Demand request -- Compatibility of components/ Design changes history -- Quality issue history -- Technical drawings & specifications -- PCF Information - -#### User Journey "Certificate of Decomissioning" - -The user journey "Certificate of Decommissioning" (CoDM) describes the moment at which a vehicle is transferred into the End-of-Life (EoL) phase from the perspective of an authorized collection point for EoL-vehicles, such as an authorized dismantling facility. The CoDM resembles the official Certificate of Destruction (CoD) but marks the starting point of the upcoming CX concept of a digital CoD. - -##### Figure 10 - -![User Journey CODM](resources/adoption-view/figure_user_journey_codm.svg) - -##### Data Model and GitHub - -The relevant data model can be found on the following link on GitHub: [https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.decomissioning_certificate/1.0.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.decomissioning_certificate/1.0.0) - -The open availability on GitHub allows companies to combine their own internal target guidance programs with the data models from Catena-X to the EoL-Services. - -## CE-Assistant - -### Introduction - -#### Empowering Circular Economy Decisions: Introducing the Circular Strategy Assistant - -In the dynamic landscape of sustainability and resource conservation, the Circular Strategy Assistant (CE-Assistant) emerges as a pioneering solution, providing decision support for the selection of optimal strategies concerning end-of-life vehicles. At its core, the CE-Assistant tackles the task of evaluating and choosing from a spectrum of R-Strategies—namely Reuse, Remanufacturing, Recycling, and Recovery. - -Rooted within the principles of Catena-X, the CE-Assistant is deeply aligned with a comprehensive assessment process that guides its functionality. This process is chiefly anchored in the Catena-X Digital Twin Framework, which encapsulates the essence of virtual representation and real-world insights. - -Central to this endeavor is the CE-Assistant—a set of standards, aspect models, APIs, system architectures, and decision logics—all designed to foster the development of data-centric, Catena-X compliant decision support systems for Circular Economy Strategies. The core circularity lies in the orchestrated flow of engineering information—a collaborative effort involving entities across the automotive value chain. - -The concept of Digital Twin (DT) serves as the backbone, offering a holistic virtual counterpart of assets. Defined with precision, the DT embodies a set of unique identifiers, an evolving spectrum of aspects, connectivity to diverse data sources, and the capacity to traverse the entire lifecycle of assets, encapsulating both individual and fleet-level knowledge. - -In accordance with IDSA and Gaia-X principles, interconnectivity and data sovereignty, the CE-Assistant thrives on the principles of interoperability, substantiated by the Connector KIT (EDC) and Data Chain KIT (Item Relationship Service - IRS). - -Undeniably, the selection of Circular Economy Strategies necessitates a comprehensive evaluation of emissions, natural resource preservation, energy management, and waste reduction. However, the effectiveness of such evaluation’s hinges on access to granular data encompassing the vehicle’s history, components, materials, and condition. - -This is precisely where the CE-Assistant can help by supporting a user-centered approach that bridges the gap between data availability and informed decision-making. By offering transparency into the environmental implications of diverse circular economy strategies, the CE-Assistant facilitates swifter, well-informed, and efficient decisions rooted in the digital twin's insights. - -### Business Context - -The CE-Assistant provides decision support and circular strategies, enabling several key features for businesses: - -1. **Component-Level Decision Support:** The KIT provides decision support for selecting circular strategies at the component level. -2. **Efficient Data-Driven Decisions:** Users can make faster and more efficient decisions based on data analysis. -3. **Enhanced Circularity:** The KIT contributes to increasing the circularity of products and meeting reuse quotas. -4. **Sustainability Milestones:** It helps achieve sustainability indicators and goals. -5. **Transparency on Secondary Materials:** The KIT offers transparency regarding the availability of secondary materials. -6. **Streamlined Vehicle Dismantling:** It optimizes the process of vehicle dismantling for improved resource recovery. - -#### Use Case / Domain Explanation - -The User Journey describes the system interaction of the CE Assistant with the user, the Dismantling Lead, with the aim of providing a recommendation for a component-level circular strategy for end-of-life vehicles. This involves breaking down the process of holistic decision-making into individual process steps and identifying the interaction with the user/system at each process step. - -##### Figure 11 - -![Figure UserJourney CE Assistant](resources/adoption-view/figure_userstory_ce_assistant.svg) - -#### Whitepaper - -If you are eager to dive deeper into the world of the CE-Strategy Assistant, including its data provision via the Digital Twin and expert insights on technically feasible circular strategies and environmentally friendly choices, we invite you to explore our informative publications. - -##### End-of-life decision support to enable circular economy in the automotive industry based on digital twin data - -- **Abstract**: With the EU Green Deal and the UN Sustainable Developments Goals, the vision of a greenhouse gas-neutral and resource-efficient economy is already firmly anchored in world politics. In this context, the automotive industry faces many challenges including the increasing scarcity of natural resources, a rising demand in terms of sustainable vehicle design, production and materials sourcing. Due to all this, end-of-life decisions regarding dismantling have become increasingly important. A high proportion of secondary materials will be required in the vehicles of the future. To response to these challenges, companies have turned their focus towards the circular economy as a central approach to close material loops. In the German research project “Catena-X” a new data ecosystem with digital twins is one enabler that is being developed. The digital twins represent a promising approach to the circular economy by ensuring transparent, product-specific and end-to-end data exchange throughout the entire product lifecycle, from the material sourcing to the eventual dismantling and recycling. As one particular and unique solution, a decision framework that facilitates the best circular strategy at the end of a vehicle's life is developed and presented in this paper. The underlying data-driven decision support framework is based on circular economy KPIs. This includes material, components and specific vehicle KPIs to best identify the most suitable circular strategy. The framework was methodologically developed by an interdisciplinary team of partners, who are stakeholders throughout the value chain and participants in the Catena-X project. An integrated approach of user-centered design, an adapted version of the V-model and the Scaled Agile Framework were used for the methodology in the development of the solution. The paper presents the concept of a digital twin for a decision support system, that includes a central decision logic that also includes the relevant KPIs and a survey for evaluating the decision logic utilized with a chosen dismantling company. -- **Link**: [End-of-life decision support to enable circular economy in the automotive industry based on digital twin data - ScienceDirect](https://www.sciencedirect.com/science/article/pii/S2212827123006091) - -##### Empowering End-of-Life Vehicle Decision Making with Cross-Company Data Exchange and Data Sovereignty via Catena-X - -- **Abstract:** The mobility sector is the world’s second-largest producer of energy-related CO2 emissions, and it is facing a global resource shortage. The demand for circular products, the use of secondary materials in future vehicles, and the need for sustainable business models in the mobility sector is increasing. However, a transparent and end-to-end data exchange throughout the entire value network is missing, which is hindering an efficient circular economy. Relevant information on the vehicle, its components and materials at the end of the product life cycle are often missing. In this context, this paper presents a decision support system based on Digital Twin data for a circular economy solution as a software application. It was developed within the German research project Catena-X following an integrated approach of user-centered design, the V-model, and within the Scaled Agile Framework. By combining these methodological approaches, customer-oriented solutions were developed and continuously improved at each stage of development to shorten the time-to-market. Catena-X is based on Gaia-X principles. In Gaia-X, necessary core services are developed, and contraction negotiation for data exchange and usage policies is enabled and implemented. The decision support system provides important information about the exact composition and condition of the vehicle, its components, and its materials. Thus, it helps to improve efficiency, sustainability, and the implementation of the circular economy. The decision support system was tested and validated with a use case that provided Digital Twin data on the end-of-life vehicle. -- **Link**: [Sustainability | Free Full-Text | Empowering End-of-Life Vehicle Decision Making with Cross-Company Data Exchange and Data Sovereignty via Catena-X (mdpi.com)](https://www.mdpi.com/2071-1050/15/9/7187) - -##### Digital Twins for Circular Economy - Enabling Decision Support for R-Strategies - -- **Abstract:** Digital twins (DT) for circular economy (CE) offer a promising approach as part of digital data ecosystems for more sustainable value creation. By mapping and analyzing product, component and material specific data along the lifecycle, it is possible to address current challenges such as climate change and resource scarcity. Within Catena-X, specific solutions based on this cross-company exchanged data and information are developed. Here, the “CE-Assistant” is presented. It is an application, which identifies the best CE-Strategy based on DT data at the end of a vehicle's life. -- **Link:** [OA_Mügge_6-2022 | INDUSTRIE-MANAGEMENT](https://www.industrie-management.de/node/556) - -#### Logic / Schema - -In order to evaluate which R-Strategy can be applied to individual components, instance-specific data must be available. This is ensured using DT data throughout the product lifecycle. Such an DT enables the collection of instance-specific data on the product, and thus provides the missing EoL data for vehicle disassembly. - -Depending on the decision-making step, instance specific data for the vehicle disassembly is partly necessary or product specific data is sufficient. Decision support regarding the best R-Strategy is preceded by the logic for the technical feasibility. Thus, only when the R-Strategy is technically feasible, it must be checked for other indicators. - -The outcome of the technical feasibility is to analyze if an R-Strategy has to be excluded at the beginning based on regulatory requirements regarding an R-Strategy or a defect in functionality of specific components. - -The process is started by entering the vehicle identification number (VIN) into the system, thereby requesting the corresponding Catena-X data. The registered companies in the Catena-X network act as data providers for this vehicle-specific data, as they register respective assets and sub-models. Catena-X Shared Services handle existing data models, contract, usage and access control policies, and ultimately the final data exchange. - -The system shows the first information, such as corresponding vehicle, component and material based on data from the DT. This data is provided for the first overall manual inspection and evaluation. After that, the user selects the most relevant components for the R-Strategy decision. The decision logic is applied for this component and the possible R-Strategies are identified. - -The core process means in a chronological order: The basic reuse-potential, material composition and remaining lifetime in comparison with the specific thresholds and the disassembly capability. - -If one or more of these criteria are not fulfilled, the component will only be assigned to recovery or recycling. If the component qualifies for disassembly, a manual visual inspection and a functional check are conducted. For components, where the visual condition is relevant, such as body parts and interior components, the visual inspection is conducted first. In contrast, components, for which the technical condition is of significant relevance, such as engines and gearboxes, are first subjected to a functional test. Here, the data can also be provided in the Catena-X network as an update of the DT. Thereafter, a quality comparison of the component condition with threshold values takes place. When the quality is insufficient for reuse, the technical check for remanufacturing is carried out chronologically: Assimilability, cleanability and restorability/upgradability. Finally, a possible strategy is given to the user as a result. - -##### Figure 12 - -![user story flowchart](resources/adoption-view/figure11.svg) - -## Secondary Marketplace - -### Introduction - -A secondary marketplace is fundamental to establish a circular economy where components and materials are available and offered to the interested users creating new value chains and extending the life of the parts and the materials before becoming waste. Digital platforms offering marketplace services are essential to enable trading of secondary materials and components, provide transparency into supply and demand that potential buyers and sellers can expect. - -The main goals of the Marketplace are: (1) to match the demand and the supply of available components and secondary raw materials and (2) to provide transparency on sales opportunities for used components which can be, for example, reused or re-manufactured. - -If offered, additional services such as grading, certifications for the offered listings (components or secondary materials) and transport handling and logistics could support trading processes. - -### Business Context - -A secondary marketplace enables closing the loop on economical and physical layers. Following the logic described in the previous chapter, there could be multiple scenarios related to R-strategies on how secondary marketplaces enable a circular economy. - -Potential sales scenarios: - -- Dismantling companies selling old components and material/scrap; -- Automotive manufacturers selling old unused components; -- Automotive manufacturers selling production waste and scrap; -- and others. - -Potential purchase scenarios: - -- Automotive companies buying components for re-manufacturing; -- Workshops buying components for re-use; -- Recyclers buying production waste and scrap; -- and others. - -In all of those cases, having additional information (e.g. product carbon footprint or digital product passport details) on the products offered on the marketplace is beneficial. - -### User Journey and Architecture Overview - -In general, there are several goals that buyers and sellers pursue on a secondary marketplace: - -- As a (Core) Purchaser, I want to search and filter for market supply on OE number level to match the market offers towards my demand. -- As a (Core) Purchaser, I want to reach as many possible sellers as possible to purchase parts that I cannot procure today. This includes brokers I don't buy from today. -- As a (Core) Seller, I want to place offers on the marketplace with standard upload tools and manually. -- As a (Core) Seller, I want to reach as many possible customers as possible to maximize my turnover. This includes customers I don't sell to today. - -The key user journey relevant in Catena-X circular economy area relates to the need of a buyer to have full reliable information on a product that he is intending to purchase. This is especially important given that many buyers are looking for parts for re-manufacturing or re-use, where product quality plays a vital role. Furthermore, in case of recycling, recyclers are interested to know material composition and additional information that would influence their purchasing decision. - -Some information could be provided by a variety of data models, but the highest value lies within the generic digital product passport (and by extension, battery passport, sealant passport, transmission passport). When a seller is publishing a listing with a product that he is willing to sell, there is only a limited amount of information he can provide with it, mostly the one available from the visual inspection or on-board data (such as mileage, OE-number, brand) as well as logistical/ sales information (such as location or price). When a potential buyer views the listing, he should have a possibility to request additional details from a data provider of the generic digital product passport (if available) for that product (see diagram below). More information on the digital product passport can be found in the [Ecopass KIT](https://eclipse-tractusx.github.io/docs-kits/kits/Eco_Pass_KIT/page-adoption-view/). - -#### Figure 13 - -![User Journey - Secondary Marketplace](resources/adoption-view/user_journey_secondary_marketplace.svg) - -This process is reflected in the architecture for communicating with the Catena-X network and data providers of the battery passport data model, as presented below. - -#### Figure 14 - -![Communication Architecture](resources/adoption-view/communication_architecture.svg) - -When it comes to the data exchange schema and other details, see the [Triangle for Secondary Marketplace](https://catena-x.net/de/standard-library) document for more information on how such a request could be realized within Catena-X environment and according to applicable guidelines (e.g. on interoperability and data sovereignty). In a decentral environment, such attributes as manufacturer part ID and OE number play a vital role in order to get access to the right component and the right data model at data provider’s side. - -### Semantic Models - -In the following, relevant semantic models for the secondary marketplace are listed. For further information about the listed data models please refer to the Catena-X standards library for the respective data model, marked as “CX-“, which contains the standardized data models with further descriptions and explanations. The standards library can be founded here: [Catena-X Standard-Library](https://catena-x.net/de/standard-library) - -The Marketplace Offer is an aspect model that is complementary to the concept of a secondary marketplace. It described a product (e.g. a used, dismantled component) that is placed for sale onto the marketplace, with key supporting information such as quantity, quality, or price. It provides essential information for potential buyers and could be used in the future to exchange product information between multiple marketplaces. This model can therefore be used to exchange offers between multiple marketplaces. As there is no exchange scenario defined yet, the Marketplace Offer is a recommendation and non-normative, since it is so far concerning the business application-internal data structure only. More information on this aspect model can be found under CX-0035 in the standards library or under the following link: [Marketplace Offer](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.market_place_offer) - -Additionally, two other aspect models could play a supporting role for secondary marketplaces. - -The Return Request aspect model could be used to flag a vehicle or product to indicate that there is a demand or a request for return. It specifies the aspect of the recall of a vehicle part and thus provides the information whether and why a return request exists for a product. More information on this aspect model can be found under CX-0033 in the standards library or under the following link: [Return Request](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.return_request) - -The Product Passport aspect model could provide reliable details on the product characteristics or lifecycle information, therefore complementing the basic Marketplace Offer information. More information on this aspect model can be found under CX-0103 in the standards library or under the following link: [Digital Product Passport](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.generic.digital_product_passport) - ## NOTICE This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). @@ -564,4 +617,10 @@ This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses - Copyright (c) 2023,2024 LRP Auto-Recycling Leipzig GmbH - Copyright (c) 2023,2024 Robert Bosch GmbH - Copyright (c) 2023,2024 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023,2024 TÜV Süd AG +- Copyright (c) 2023,2024 Valeo SA +- Copyright (c) 2023,2024 Volvo Group Aktiebolag +- Copyright (c) 2023,2024 Volvo Car Aktiebolag +- Copyright (c) 2023,2024 Brain of Materials AG +- Copyright (c) 2023,2024 thyssenkrupp Material Services GmbH - Copyright (c) 2023,2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/page-documentation.md b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/page-documentation.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/page-documentation.md rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/page-documentation.md diff --git a/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/page-glossary.md b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/page-glossary.md new file mode 100644 index 00000000000..3a0266e9cd1 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/page-glossary.md @@ -0,0 +1,107 @@ +--- +title: Glossary +--- + +| Term | Definition | Source | +| ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Aggregate State/ State of Matter | State of matter (German: "Aggregatzustand") is one of the distinct forms in which matter can exist. Three states of matter are observable at ambient conditions and free of electrical charge: solid, liquid, gas | State of matter - Wikipedia | +| Base Quantity | The International System of Quantities defines seven base quantities. The set of base quantities is chosen by convention where no base quantity can be expressed in terms of the others, but where every quantity in the system can be expressed in terms of the base quantities. | International System of Quantities - Wikipedia | +| Bio-based Materials | Material of biological origin excluding material embedded in geological formations and/or fossilised | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172132, P. 9 | +| Biomass | Material of biological origin, excluding material embedded in geological formations or transformed material of biological origin, excluding material embedded in geological formations or transformed to fossilized material and excluding peat | DIN ISO 14021 | +| By-Product | Substance or object, resulting from a production process, the primary aim of which is not the production of that item, and does not constitute waste (as defined in Directive 2008/98/E on waste) | European Commission, Categorisation System for the Circular Economy, doi:10.2777/172132, P. 9 | +| CAS Number | a unique numerical identifier assigned by the Chemical Abstracts Service (CAS) to every chemical substance described in the open scientific literature. / Except for a small selection of most common substances released under CC-BY-NC license the CAS numbers are a proprietary identification scheme to be licensed from CAS (USA) | CAS Registry Number - Wikipedia | +| Chain-of-Custody approach | Mass balance is one of several well-known chain of custody approaches that can be used to track the flow of materials through the value chain. The total quantity of the content in question is tracked through the production system and the allocation of this content is made to the end products based on verifiable accounting. The goal of this method is to ensure proper accounting and to confirm a link between the incoming content (e.g., "sustainable," "recycled," or "organic" according to some definition) and the eventual outgoing product. | [https://www.basf.com/global/documents/de/sustainability/we-source-responsibly/Mass-Balance-White-Paper-2020.pdf](https://www.basf.com/global/documents/de/sustainability/we-source-responsibly/Mass-Balance-White-Paper-2020.pdf) | +| Chemical Composition | Chemical composition refers to identity and number of the chemical elements that make up any particular chemical compound. In order to provide unambiguous information, "chemical element" and "chemical compound" must be defined as context. | Chemical composition - Wikipedia | +| Chemical Recycling | Chemical or feedstock recycling refers to the conversion of plastic polymers into their monomers or chemical building blocks or basic chemicals, i. e. depolymerisation by means of thermochemical or chemical processes, although there is currently no uniform, legally binding definition [13]. | Background Paper on Chemical Recycling - German Environmental Agency, Dec 2020 | +| Circular Economy | The circular economy is a model of production and consumption, which involves sharing, leasing, reusing, repairing, refurbishing and recycling existing materials and products as long as possible. In this way, the life cycle of products is extended. | European Parliament | +| Closed-Loop-Recycling | In a closed loop, the secondary material from one product system is either reused in the same product system or used in another product system without changing the inherent properties of the material. | PCF Rulebook | +| Component | Part or small assembly of parts used as part of a larger assembly | Article 2 Definitions 200053EG | +| Compostable | Characteristic of a product, packaging or associated component that allows it to biodegrade, generating a relatively homogeneous and stable humus-like substance. | DIN ISO 14021 | +| Consumer | Any natural person who, in contracts covered by this Directive, is acting for purposes which are outside his trade, business, craft or profession | 2011/83/EU on consumer rights | +| Co-Product | Any two or more products coming from the same unit process or product system. | PCF Rulebook, DIN EN ISO 14067, Feb. 2019, p.22 | +| Degradable | A characteristic of a product or packaging that, with respect to specific conditions, allows it to break down to a specific extent within a given time. | DIN ISO 14021 | +| Disposal | Disposal means any of the applicable operations provided for in Annex IIA to Directive 75/442/EEC, for instance deposit into or onto land, land treatment, deep injection, surface impoundment, release into water body, biological treatment, physico-chemical treatment. | Guideline 2000/53/EG | +| Dismantling ability | The ability of components to be removed from the vehicle. | ISO 22628:2002-02 | +| Dismantling Information | All information necessary for the proper and environmentally sound treatment of an end-of-life vehicle. It is provided to authorized treatment facilities by vehicle manufacturers and suppliers in the form of manuals or electronic media (such as CD-ROMs, online services). | Guideline 2000/53/E | +| Downcycling | Downcycling, or cascading, is the recycling of waste where the recycled material is of lower quality and functionality than the original material. | Downcycling - Wikipedia | +| Ecological Assessment | Compilation and evaluation of the inputs, outputs, and potential environmental impacts of a product system throughout its life cycle | Article 2 Definitions 200053EG | +| Economic operators | Manufacturers, distributors, take-back points, motor vehicle insurance companies, dismantling facilities, shredder plant operators, recovery facilities, recycling facilities, as well as other facilities for the treatment of end-of-life vehicles, including their components and materials. | Guideline 2000/53/EG | +| End-of-Life | The point at which a product or component is taken out of use | Article 2 Definitions 200053EG | +| End-of-Life Vehicle | Vehicles that are considered waste under Article 1 letter a) of Directive 75/442/EC | Article 2 Definitions 200053EG | +| End-of-Waste | The end-of-waste state for waste in Europe reached when the material is no longer considered a waste under the national implementation of the Waste Framework Directive. | PCF Rulebook, EN 15804 | +| Energy recovery | Energy recovery includes any process that refers to the use of waste as a raw material or the treatment of waste that cannot be recycled. The aim is to recover energy from materials and associated with this, to convert them into usable heat, electricity or fuel. | U.S. Environmental Protection Agency (2016) Energy Recovery from Waste | +| Fossil Materials | Fossil raw materials are all raw materials derived from organic material. They include coal, crude oil and natural gas. | Federal Geothermal Office | +| Hazardous substances | Any substance that is classified as hazardous according to Directive 67/548/EEC. | Guideline 2000/53/EG | +| ILCD Format | International Life Cycle Data Format | PCF Rulebook | +| Input | Product, material or energy flow that enters a unit process. | Pathfinder / PCF Rulebook | +| Intermediate Product | Output from a unit process that is input to other unit processes that require further transformation within the system | Article 2 Definitions 200053EG | +| Life Cycle | Consecutive and interlinked stages related to a product, from raw material acquisition or generation from natural resources to end-of-life treatment. | DIN EN ISO 14067, PCF Rulebook | +| Mass | In physics, mass is not the same as weight. Mass is both a property of a physical body and a measure of its resistance to acceleration. For disambiguation see definition of "Weight" below | Wikipedia | +| Mass-Balancing | Considering the output, no physical or chemical difference exists between in-scope and out-of-scope. It involves balancing volume reconciliation to ensure the exact account of volumes of in- and out-of-scope source is maintained along the supply chain, provided that the volume or the ratio of sustainable material integrated is reflected in the product produced and sold to customers. This model requires that a reconciliation period is defined (e.g. a month, a year). | PCF Rulebook | +| Material | Physical good used as input for production processes of goods or services or physical good supplied to a customer as output | Pathfinder / PCF Rulebook | +| Material Declaration | Material declaration (MD) is the process mandated to meet the obligations placed on (automobile) manufacturers, and thus on their suppliers, by national and international standards, laws and regulations. | IMDS Information Pages - Home - IMDS Public Pages (mdsystem.com) | +| Material Details | Collection of material information defined by given context in an information model | Catena-X definition | +| Material Identifier | Material Identifier is a alphanumerical identifier that serves programmatic functions (e.g., as data ID) but also satisfies chemical regulation (see material declaration) under national and international law. | Catena-X definition | +| Material Name | Trivial name (often name of a chemical group) used to denote some material in everyday speech or jargon. Entirely dependent on specific context. | Catena-X definition | +| Material Recovery | Material recovery is recovery by processes in which virgin material of the same substance is replaced or the material remains available for further material use. | Packaging Act § 3 para. 19 | +| Material Type | Groups of materials defined by convention (e.g., IMDS) or ISO Standard (e.g., ISO 62474) in order to simplify communication of relevance of material information (in search or filtering) | IEC 62474 – Material Declaration | +| Mechanical Recycling | End-of-life materials can be processed via collecting, sorting, shredding, melting and transforming it into secondary raw materials for a new application. This form of recycling involves processes in which e.g. the polymer structure is not significantly changed, and plastic is preserved as a material. Thus, in terms of its complexity, mechanical recycling takes place at a lower technical level than chemical recycling. | Mechanical recycling (basf.com) | +| Glossary and methods Open-loop recycling | In open-loop recycling, the material is reused in other product systems and is inherent properties are changed (e.g. recycled material may have a different chemical composition, a different chemical structure or a higher concentration of dissolved impurities compared to primary material) | PCF Rulebook | +| Output | Product, material or energy that leaves a unit process. | Pathfinder / PCF Rulebook | +| Post-consumer material | Material generated by households or by commercial, industrial and institutional facilities in their role as end-users of the product which can no longer be used for its intended purpose. This includes returns of material from the distribution chain. Post-consumer material can be used in the form of recovered or recycled material as a substitute for primary material. | DIN ISO 14021 | +| Pre-consumer Material | Material diverted from the waste stream during a manufacturing process. Excluded is reutilization of materials such as rework, regrind or scrap generated in a process and capable of being reclaimed within the same process that generated it. Pre-consumer material can be used in the form of recovered or recycled material as a substitute for primary material. | DIN ISO 14021 | +| Primary Material | Raw material coming from the environment, as well as materials of differing stages of processing (Raw materials, semi- and finished goods), which are used in the production process for the first time. | | +| Prevention | Measures to reduce the quantity and environmental harm of end-of-life vehicles, their materials, and substances | Guideline 2000/53/EG | +| Process | Set of interrelated or interacting activities that transform inputs into outputs. | DIN EN ISO 14067, PCF Rulebook | +| Producer | The vehicle manufacturer or the commercial importer of a vehicle into an EU Member State | Article 2 Definitions 200053EG | +| Product | Any good (tangible product) or service (intangible product) | PCF Rulebook | +| Production | Process of combining various inputs, both material (such as metal, wood, glass, or plastics) and immaterial (such as plans, or knowledge) in order to create output. | Production (economics) - Wikipedia | +| Production Waste | Waste generated in different industries in connection with production and the opposite to consumption waste, which primarily comprise municipal waste and waste comparable to it. | Production waste Concepts Statistics Finland | +| Raw Material | Primary or secondary material, that is used for production of a product. | Pathfinder / PCF Rulebook | +| Recoverability | The ability of components and/or materials to be directed to a recovery process from the waste stream. | ISO 22628:2002-02 | +| Recoverability quote | The percentage of the mass of the new vehicle that can potentially be recovered and/or reused. | ISO 22628:2002-02 | +| Recovered Material | Material that would have otherwise been disposed of as waste or used for energy recovery, but has instead been collected and recovered [reclaimed] as a material input, in lieu of new primary material, for a recycling or a manufacturing process. | DIN ISO 14021 | +| Recyclate | Secondary raw materials that have been generated by means of the recovery of waste or are generated in the disposal of waste and are suitable for the production of products. | KrWG, Framework Waste Directive | +| Recyclability quote | The percentage of the mass of the new vehicle that can potentially be recycled and/or reused. | ISO 22628:2002-02 | +| Recycled Content | Proportion, by mass, of recycled material in a product or packaging. The recycled content is the sum of pre-consumer material and post-consumer material. | DIN ISO 14021 | +| Recycled Material | Material, that has been reprocessed from (reclaimed) material by means of a manufacturing process and made into a final product or into a component for incorporation into a product. | DIN ISO 14021 | +| Recycling | Recycling is the process of collecting, sorting, and processing waste to release materials that can be reused for their original purpose or other purposes, except for the energy recovery. Energy recovery is the use of combustible waste for energy production by direct combustion with or without other types of waste, but with the recovery of heat. | DIRECTIVE 2002/96/EC | +| Reduce | Increase efficiency in product manufacture or use by consuming fewer natural resources and materials | European Commission, Categorization System for the Circular Economy, doi:10.2777/172131, p. 7 | +| Refurbish | Restore an old product and bring it up to date (to specified quality level) | European Commission, Categorization System for the Circular Economy, doi:10.2777/172131, p. 7 | +| Refurbishment | Includes the same process steps as remanufacturing, that is repairing, restoring, rebuilding and/or replacing. A refurbished product is not comparable to a new one but has been updated to a specific quality level and should be fully functional. | Refurbishing – Wikipedia | +| Refuse | Make product redundant by abandoning its function or by offering the same function by a radically different (e.g. digital) product or service | European Commission, Categorization System for the Circular Economy, doi:10.2777/172131, p. 7 | +| Remanufacture | Use parts of a discarded product in a new product with the same function (and as-new-condition) | European Commission, Categorization System for the Circular Economy, doi:10.2777/172131, p. 7 | +| Remanufacturing | Remanufacturing is a standardized industrial process that restores used products to their original performance level or better, with a warranty equivalent to or surpassing that of newly manufactured products. The remanufacturing effort includes dismantling the product, restoring and replacing components, and testing individual parts and the whole product to ensure it meets its original design and performance specifications, as seen from the customer’s perspective. | BS 8887-2:2009 | +| Repair | Repair is the process of returning a faulty or broken product or component to a usable state. The effort put into the repair is minimal and only addresses the specified fault to ensure the useability of the product; however, the performance of the repaired part may not be guaranteed. The warranty for a repaired product is generally less than that of a new or remanufactured product and may only apply to the replaced or repaired component | BS 8887-2:2009 | +| Repurpose | Use a redundant product or its parts in a new product with different function | European Commission, Categorization System for the Circular Economy, doi:10.2777/172131, p. 7 | +| Resource (Rohstoff) | Resource that is used or can be used in a process. A resource can be of a material or immaterial nature. When the term "resource" is used in the context of environmental science, it refers to a "natural resource". Unlike here, the term resource is often used very narrowly in the sense of raw materials. | | +| Resource Protection | Economical use of natural resources with the aim of preserving their quantity and function. | | +| Rethink | Make product use more intensive (e.g. through product-as-a service, reuse and sharing models or by putting multi-functional products on the market) | European Commission, Categorization System for the Circular Economy, doi:10.2777/172131, p. 7 | +| R-Strategies | R-Strategies, as part of circular economy, encompass a range of sustainable resource management approaches that prioritize actions such as reuse, remanufacturing, recycling, and recovery. These strategies aim to extend the life of products and materials, reduce waste generation, and minimize environmental impacts by promoting the efficient and responsible use of resources throughout their life cycle, thus contributing to the implementation of the circular economy model. | Inspired by Potting et al.: Potting, J.; Hekkert, M.P.; Worrell, E.; Hanemaaijer, A. Circular Economy: Measuring Innovation in the Product Chain; Planbureau voor de Leefomgeving: Hague, The Netherlands, 2017. | +| Re-use | Re-use of a product which is still in good condition and fulfils its original function (and is not waste) for the same purpose for which it was conceived | European Commission, Categorization System for the Circular Economy, doi:10.2777/172131, p. 7 | +| Reusability | The ability of components to be diverted from the waste stream and reused. | ISO 22628:2002-02 | +| Reutilization | Reutilization of materials such as rework, regrind, or scrap materials generated within the process and capable of being reused within the same process that generated it. | Adapted from ISO 14021 | +| Scrap | Iron and steel material in metallic form that is recovered in multiple life cycle stages, including steel production processes, the manufacturing processes of final products and the end of life of final products | Adapted from ISO 20915:2018 | +| Secondary Raw Material | Secondary materials are any materials that are not the primary products from manufacturing and other industrial sectors. These materials can include scrap and residuals from production processes and products that have been recovered at the end of their useful life. | [US EPA, 17.08.2023](https://www.epa.gov/smm/sustainable-management-industrial-non-hazardous-secondary-materials#:~:text=Secondary%20materials%20are%20any%20materials,end%20of%20their%20useful%20life) | +| Shredder | Any facility that is used to crush or shred end-of-life vehicles, including for the purpose of recovering directly reusable metal scrap. | Guideline 2000/53/EG | +| Treatment | Activities carried out after the end-of-life vehicle is handed over to a facility for the elimination of pollutants, dismantling, coarse crushing, shredding, recycling or preparation for disposal of shredder waste, as well as other activities related to the recycling and/or disposal of end-of-life vehicles and end-of-life vehicle components. | Guideline 2000/53/EG | +| Vehicle | Vehicles of classes M1 or N1 according to Annex II Section A of Directive 70/156/EC and three-wheeled vehicles according to Directive 92/61/EC, however excluding three-wheeled motorcycles. | Article 2 Definitions 200053EG | +| Vehicle mass | Unladen mass of the operational vehicle (code: ISO-M06), according to DIN ISO 1176, term 4.6: unladen mass of the dry vehicle (term 4.5) plus the mass of lubricants, coolant (if required), washing fluids, fuel (tank filled to at least 90% of the manufacturer's specified capacity), spare wheel(s), fire extinguisher, standard spare parts, wheel chocks, standard tool ship. | ISO 22628:2002-02 | +| Waste | Materials, co-products, products, or emissions without economic value that the holder intends or is required to dispose of. | DIN EN ISO 14067, PCF Rulebook, Pathfinder | +| Waste Prevention | Waste prevention is any measure taken to ensure that a substance, material or article does not become a waste. It is used to reduce the amount of waste, the harmful effects of the waste on people and the environment, or the content of harmful substances in materials and articles. | Closed Substance Cycle Waste Management Act | +| Weight | In science and engineering, the weight of an object is the _force_ acting on the object due to gravity. For disambiguation see definition of "Mass" above | Mass - Wikipedia | +| | + +## NOTICE + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- Copyright (c) 2023,2024 BMW AG +- Copyright (c) 2023,2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) +- Copyright (c) 2023,2024 BASF SE +- Copyright (c) 2023,2024 SAP Deutschland SE & Co.KG +- Copyright (c) 2023,2024 T-Systems International GmbH +- Copyright (c) 2023,2024 LRP Auto-Recycling Leipzig GmbH +- Copyright (c) 2023,2024 Robert Bosch GmbH +- Copyright (c) 2023,2024 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023,2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/page-software-development-view.md b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/page-software-development-view.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/page-software-development-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/page-software-development-view.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/page-software-operation-view.md b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/page-software-operation-view.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/page-software-operation-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/page-software-operation-view.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/page_changelog.md b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/page_changelog.md similarity index 67% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/page_changelog.md rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/page_changelog.md index 91148e83b7d..ff8bbee334b 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/page_changelog.md +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/page_changelog.md @@ -5,9 +5,31 @@ description: "Circularity KIT" sidebar_position: 1 --- -![Circulairty kit banner](/img/kit-icons/circularity-kit-icon.svg) +![Circularity kit banner](/img/kit-icons/circularity-kit-icon.svg) All notable changes to this Kit will be documented in this file. +## [1.3.0] - 17.09.2024 + +### Added + +- add definition of Core to glossary + +## [1.2.0] - 23.07.2024 + +### Added + +- add new figures +- add license files for new figures + +### Changed + +- change structure of the contents. Same content chapters are in different order +- change wording + +### Removed + +- ./. + ## [1.1.0] - 15.05.2024 ### Added diff --git a/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/CE_assistant_architecture_view.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/CE_assistant_architecture_view.svg new file mode 100644 index 00000000000..035619e60d8 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/CE_assistant_architecture_view.svg @@ -0,0 +1 @@ +CE Assistant ArchitectureDATA CONSUMERClient, Supplier, etc…Discovery FinderDATA PROVIDEROEMs, etc.CATENA-X OPERATOREDC DiscoveryBPN DiscoveryPortal IAMManagedIdentityWalletsCEAssistantEDCVaultVaultEDCData ServiceDigital TwinRegistryDescriptionCommunications inscopeEncryptedApplicationsinscopeData planeproxycommunicationsDataproviderspecificAsset ID publish \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/CE_assistant_architecture_view.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/CE_assistant_architecture_view.svg.license new file mode 100644 index 00000000000..086356bd4e6 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/CE_assistant_architecture_view.svg.license @@ -0,0 +1,14 @@ +## NOTICE + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- Copyright (c) 2023 BMW AG +- Copyright (c) 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) +- Copyright (c) 2023 BASF SE +- Copyright (c) 2023 SAP Deutschland SE & Co.KG +- Copyright (c) 2023 T-Systems International GmbH +- Copyright (c) 2023 LRP Auto-Recycling Leipzig GmbH +- Copyright (c) 2023 Robert Bosch GmbH +- Copyright (c) 2023 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Circularity_KIT/resources/adoption-view diff --git a/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/CE_assistant_environmental_assessment.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/CE_assistant_environmental_assessment.svg new file mode 100644 index 00000000000..28d7aa3b539 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/CE_assistant_environmental_assessment.svg @@ -0,0 +1,2261 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Szenario_4R + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Teilsystem + + + + + + + + + + + + + + + + Tabelle.2 + + Tabelle.3 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.4 + User (Dismantling Lead) + + Tabelle.5 + + + + + + + + + + + + + + + + + + + + + + + User (Dismantling Lead) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Teilsystem.54 + + + + + + + + + + + + + + + + Tabelle.7 + + Tabelle.8 + Remanufacturing + + + + + + + + + + + + + + + + Remanufacturing + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.9 + CE-Strategy Assistant + + Tabelle.10 + + + + + + + + + + + + + + + + + + + + + + + CE-Strategy Assistant + + + + Anfangsknoten + + + + + + + Aktion.1001 + Technical feasible R-Strategy + + + + + + + Technical feasible R-Strategy + + Tabelle.29 + + Anfangsknoten.1406 + + + + + + + Anfangsknoten.1409 + + + + + + + Tabelle.32 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.33 + 1 + + + + 1 + + + Antwortnachricht.1429 + + + + + + + + + + Aktion.1563 + Show technical feasible R-Strategy + + + + + + + Show technical feasible R-Strategy + + Aktion.1676 + Weight Environmental Indicators/Impacts (set preference on LC... + + + + + + + Weight Environmental Indicators/Impacts (set preference on LCIA impact category) + + Aktion.1680 + Collect environmental data for disassembly and determine proc... + + + + + + + Collect environmental data for disassembly and determine process Inventory + + Aktion.1871 + If necessary: Enter the way of disassembly and process-relate... + + + + + + + If necessary: Enter the way of disassembly and process-related information (Equipment, Sequence, Location) + + Verzweigungsknoten + + + + + + + Antwortnachricht.1991 + + + + + + + + + + Antwortnachricht.226 + + + + + + + + + + Aktion.228 + Calculate Material consumption for disassembly + + + + + + + Calculate Material consumption for disassembly + + Tabelle.229 + Total Material consumption disassembly + + + + Total Material consumption disassembly + + Antwortnachricht.230 + + + + + + + + + + Antwortnachricht.455 + + + + + + + + + + Aktion.462 + Calculate Energy consumption (power) for disassembly + + + + + + + Calculate Energy consumption (power) for disassembly + + Tabelle.471 + Total Energy consumption (power) disassembly + + + + Total Energy consumption (power) disassembly + + Antwortnachricht.472 + + + + + + + + + + Antwortnachricht.480 + + + + + + + + + + Antwortnachricht.481 + + + + + + + + + + Antwortnachricht.482 + + + + + + + + + + Aktion.487 + Calculate Energy consumption (fuel) for disassembly + + + + + + + Calculate Energy consumption (fuel) for disassembly + + Tabelle.495 + Total Energy consumption (fuel) disassembly + + + + Total Energy consumption (fuel) disassembly + + Antwortnachricht.496 + + + + + + + + + + Aktion.501 + Calculate emissions for disassembly + + + + + + + Calculate emissions for disassembly + + Tabelle.504 + Total Emissions consumption (fuel) disassembly + + + + Total Emissions consumption (fuel) disassembly + + Antwortnachricht.505 + + + + + + + + + + Antwortnachricht.509 + + + + + + + + + + Antwortnachricht.510 + + + + + + + + + + Aktion.511 + Calculate relative environmental impact for Remanufacturing-S... + + + + + + + Calculate relative environmental impact for Remanufacturing-Strategy (EoL only) + + Aktion.513 + Collect environmental data for Reuse + + + + + + + Collect environmental data for Reuse + + Antwortnachricht.514 + + + + + + + + + + Antwortnachricht.520 + + + + + + + + + + Aktion.573 + Collect environmental data for Remanufacturing + + + + + + + Collect environmental data for Remanufacturing + + Antwortnachricht.574 + + + + + + + + + + Antwortnachricht.614 + + + + + + + + + + Antwortnachricht.630 + + + + + + + + + + Antwortnachricht.633 + + + + + + + + + + Antwortnachricht.637 + + + + + + + + + + Aktion.643 + Collect environmental data for Recycling + + + + + + + Collect environmental data for Recycling + + Antwortnachricht.663 + + + + + + + + + + Antwortnachricht.670 + + + + + + + + + + Antwortnachricht.674 + + + + + + + + + + Aktion.702 + Collect environmental data for Recover + + + + + + + Collect environmental data for Recover + + Antwortnachricht.712 + + + + + + + + + + Antwortnachricht.713 + + + + + + + + + + Antwortnachricht.714 + + + + + + + + + + Antwortnachricht.722 + + + + + + + + + + Antwortnachricht.730 + + + + + + + + + + Antwortnachricht.742 + + + + + + + + + + Antwortnachricht.754 + + + + + + + + + + Antwortnachricht.757 + + + + + + + + + + Antwortnachricht.759 + + + + + + + + + + Verzweigungsknoten.760 + + + + + + + Antwortnachricht.763 + + + + + + + + + + Antwortnachricht.764 + + + + + + + + + + Aktion.1061 + Collect data for R-Strategies and calculate Inventory + + + + + + + Collect data for R-Strategies and calculate Inventory + + Antwortnachricht.1065 + + + + + + + + + + Verzweigungsknoten.1066 + + + + + + + Antwortnachricht.1068 + + + + + + + + + + Antwortnachricht.1069 + + + + + + + + + + Antwortnachricht.1070 + + + + + + + + + + Antwortnachricht.1071 + + + + + + + + + + Aktion.1089 + Calculate relative total environmental impact for Recycling-S... + + + + + + + Calculate relative total environmental impact for Recycling-Strategy (EoL only) + + Aktion.1097 + Calculate relative total environmental impact for Recover-Str... + + + + + + + Calculate relative total environmental impact for Recover-Strategy (EoL only) + + Aktion.1099 + Calculate relative environmental impact for Reuse-Strategy (E... + + + + + + + Calculate relative environmental impact for Reuse-Strategy (EoL only) + + Tabelle.1101 + Relative Total environmental impact Reuse + + + + Relative Total environmental impact Reuse + + Antwortnachricht.1102 + + + + + + + + + + Tabelle.1105 + Relative Total environmental impact Recycling + + + + Relative Total environmental impact Recycling + + Tabelle.1106 + Relative Total environmental impact Recover + + + + Relative Total environmental impact Recover + + Antwortnachricht.1108 + + + + + + + + + + Antwortnachricht.1109 + + + + + + + + + + Aktion.1110 + Calculate difference between new production and Remanufacturi... + + + + + + + Calculate difference between new production and Remanufacturing-Strategy + + Aktion.1112 + Consider environmental impact of Remanufacturing in compariso... + + + + + + + Consider environmental impact of Remanufacturing in comparison to new production + + Aktion.1113 + Recommend R-Strategy with lowest environmental impact (=most ... + + + + + + + Recommend R-Strategy with lowest environmental impact (=most ecological) + + Verzweigungsknoten.1117 + + + + + + + Antwortnachricht.1118 + + + + + + + + + + Antwortnachricht.1119 + + + + + + + + + + Antwortnachricht.1120 + + + + + + + + + + Antwortnachricht.1121 + + + + + + + + + + Verzweigungsknoten.1122 + + + + + + + Antwortnachricht.1123 + + + + + + + + + + Antwortnachricht.1124 + + + + + + + + + + Antwortnachricht.1129 + + + + + + + + + + Antwortnachricht.1131 + + + + + + + + + + Tabelle.1132 + Absolute Total environmental impact Remanufacturing + + + + Absolute Total environmental impact Remanufacturing + + Antwortnachricht.1133 + + + + + + + + + + Aktion.1134 + Calculate difference between new production and Reuse-Strategy + + + + + + + Calculate difference between new production and Reuse-Strategy + + Aktion.1135 + Consider environmental impact of Reuse in comparison to new p... + + + + + + + Consider environmental impact of Reuse in comparison to new production + + Tabelle.1136 + Remaining lifetime through Reuse + + + + Remaining lifetime through Reuse + + Tabelle.1137 + OEM Lifetime (new production) + + + + OEM Lifetime (new production) + + Tabelle.1138 + Environmental impact new production of component + + + + Environmental impact new production of component + + Verzweigungsknoten.1139 + + + + + + + Antwortnachricht.1140 + + + + + + + + + + Antwortnachricht.1141 + + + + + + + + + + Antwortnachricht.1142 + + + + + + + + + + Antwortnachricht.1143 + + + + + + + + + + Verzweigungsknoten.1144 + + + + + + + Antwortnachricht.1145 + + + + + + + + + + Antwortnachricht.1146 + + + + + + + + + + Antwortnachricht.1147 + + + + + + + + + + Antwortnachricht.1148 + + + + + + + + + + Tabelle.1149 + Absolute Total environmental impact Reuse + + + + Absolute Total environmental impact Reuse + + Antwortnachricht.1150 + + + + + + + + + + Antwortnachricht.1151 + + + + + + + + + + Aktion.1152 + Calculate difference between new production and Recycling-Str... + + + + + + + Calculate difference between new production and Recycling-Strategy + + Aktion.1153 + Consider environmental impact of Recycling comparison to new ... + + + + + + + Consider environmental impact of Recycling comparison to new production + + Tabelle.1167 + Absolute Total environmental impact Recycling + + + + Absolute Total environmental impact Recycling + + Antwortnachricht.1168 + + + + + + + + + + Antwortnachricht.1169 + + + + + + + + + + Aktion.1187 + Calculate difference between new production and Recover-Strat... + + + + + + + Calculate difference between new production and Recover-Strategy + + Aktion.1188 + Consider environmental impact of Recover in comparison to new... + + + + + + + Consider environmental impact of Recover in comparison to new production + + Tabelle.1190 + Energy recovery + + + + Energy recovery + + Tabelle.1191 + Environmental impact new production energy + + + + Environmental impact new production energy + + Antwortnachricht.1193 + + + + + + + + + + Antwortnachricht.1196 + + + + + + + + + + Verzweigungsknoten.1197 + + + + + + + Antwortnachricht.1201 + + + + + + + + + + Tabelle.1202 + Absolute Total environmental impact Recover + + + + Absolute Total environmental impact Recover + + Antwortnachricht.1203 + + + + + + + + + + Antwortnachricht.1205 + + + + + + + + + + Verzweigungsknoten.1206 + + + + + + + Antwortnachricht.1212 + + + + + + + + + + Antwortnachricht.1213 + + + + + + + + + + Antwortnachricht.1214 + + + + + + + + + + Antwortnachricht.1216 + + + + + + + + + + Antwortnachricht.1217 + + + + + + + + + + Antwortnachricht.1221 + + + + + + + + + + Tabelle.1222 + + Anfangsknoten.1406 + + + + + + + Anfangsknoten.1409 + + + + + + + Tabelle.231 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.1225 + 2 + + + + 2 + + + Antwortnachricht.1229 + + + + + + + + + + Antwortnachricht.1230 + + + + + + + + + + Antwortnachricht.1231 + + + + + + + + + + Antwortnachricht.1232 + + + + + + + + + + Verzweigungsknoten.1192 + + + + + + + Antwortnachricht.1235 + + + + + + + + + + Antwortnachricht.1237 + + + + + + + + + + Antwortnachricht.1239 + + + + + + + + + + Antwortnachricht.1240 + + + + + + + + + + Antwortnachricht.1241 + + + + + + + + + + Antwortnachricht.1248 + + + + + + + + + + Antwortnachricht.1257 + + + + + + + + + + Antwortnachricht.1258 + + + + + + + + + + Antwortnachricht.1259 + + + + + + + + + + Tabelle.1260 + + Tabelle.1114 + Extended Lifetime through Remanufacturing + + + + Extended Lifetime through Remanufacturing + + Tabelle.1115 + OEM Lifetime (new production) + + + + OEM Lifetime (new production) + + Tabelle.1116 + Environmental impact new production of component + + + + Environmental impact new production of component + + + Tabelle.1265 + Relative Total environmental impact Remanufacturing + + + + Relative Total environmental impact Remanufacturing + + Antwortnachricht.1267 + + + + + + + + + + Antwortnachricht.1268 + + + + + + + + + + Verzweigungsknoten.1270 + + + + + + + Antwortnachricht.1271 + + + + + + + + + + Tabelle.1272 + + Tabelle.1156 + Environmental impact material new production + + + + Environmental impact material new production + + Tabelle.1228 + Environmental impact new production of component + + + + Environmental impact new production of component + + + Verzweigungsknoten.1273 + + + + + + + Antwortnachricht.1274 + + + + + + + + + + Antwortnachricht.1275 + + + + + + + + + + Antwortnachricht.1285 + + + + + + + + + + Antwortnachricht.1287 + + + + + + + + + + Feld + + + + + + + Feld.1446 + + + + + + + Feld.1447 + + + + + + + Feld.1632 + + + + + + + Feld.1637 + Activity data collection (LCI) - Dismantling - + + + + + + + Activity data collection (LCI) - Dismantling - + + Feld.1638 + Activity data collection (LCI) - R-Strategies - + + + + + + + Activity data collection (LCI) - R-Strategies - + + Feld.1641 + Relative environmental impact of R-Strategies (LCIA - EoL only) + + + + + + + Relative environmental impact of R-Strategies (LCIA - EoL only) + + Feld.1644 + Absolute environmental impact of R-Strategies (LCIA - EoL plu... + + + + + + + Absolute environmental impact ofR-Strategies (LCIA - EoL plus lifetime credit) + + Tabelle.1646 + + Abschlussknoten + + + + + + + + + Aktion.1000 + Implement R-Strategy + + + + + + + Implement R-Strategy + + Antwortnachricht.1057 + + + + + + + + + + + Antwortnachricht.1647 + + + + + + + + + + Antwortnachricht.1648 + + + + + + + + + + diff --git a/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/CE_assistant_environmental_assessment.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/CE_assistant_environmental_assessment.svg.license new file mode 100644 index 00000000000..086356bd4e6 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/CE_assistant_environmental_assessment.svg.license @@ -0,0 +1,14 @@ +## NOTICE + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- Copyright (c) 2023 BMW AG +- Copyright (c) 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) +- Copyright (c) 2023 BASF SE +- Copyright (c) 2023 SAP Deutschland SE & Co.KG +- Copyright (c) 2023 T-Systems International GmbH +- Copyright (c) 2023 LRP Auto-Recycling Leipzig GmbH +- Copyright (c) 2023 Robert Bosch GmbH +- Copyright (c) 2023 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Circularity_KIT/resources/adoption-view diff --git a/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/CE_assistant_technical_feasibility_logic.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/CE_assistant_technical_feasibility_logic.svg new file mode 100644 index 00000000000..d2e1f3f21b1 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/CE_assistant_technical_feasibility_logic.svg @@ -0,0 +1,1402 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Technische Machbarkeit + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Teilsystem + + + + + + + + + + + + + + + + Tabelle.50 + + Tabelle.51 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.52 + User (Dismantling Lead) + + Tabelle.53 + + + + + + + + + + + + + + + + + + + + + + User (Dismantling Lead) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Teilsystem.54 + + + + + + + + + + + + + + + + Tabelle.1046 + + Tabelle.1047 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.1048 + R-Strategy Assistant / Digital Twin + + Tabelle.1049 + + + + + + + + + + + + + + + + + + + + + + R-Strategy Assistant / Digital Twin + + + + Anfangsknoten + + + + + + + Antwortnachricht.45 + + + + + + + + + + Abschlussknoten + + + + + + + + + Aktion.1000 + Implement R-Strategy + + + + + + + Implement R-Strategy + + Aktion.1001 + Enter VIN + + + + + + + Enter VIN + + Aktion.47 + Show vehicle and component information (Digital Twin data) (S... + + + + + + + Show vehicle and component information (Digital Twin data) (State of Health, mileage, material contained…) + + Aktion.1004 + Check possible R-Strategies (exclusion criteria) + + + + + + + Check possible R-Strategies (exclusion criteria) + + Antwortnachricht.1010 + + + + + + + + + + Zusammenführungsknoten.1011 + + + + + + + Aktion.1038 + Carry out the visual inspection and or functional check (dama... + + + + + + + Carry out the visual inspection and or functional check (damage, corrosion...) + + Aktion.1043 + Enter result of the visual inspection + + + + + + + Enter result of the visual inspection + + Antwortnachricht.1044 + + + + + + + + + + Antwortnachricht.1050 + + + + + + + + + + Antwortnachricht.1057 + + + + + + + + + + Tabelle.1069 + Basic Reuse Potential = 0 + + + + Basic Reuse Potential = 0 + + Tabelle.1284 + Quality ≥ Categorie of quality b component-specific threshold1 + + + + Quality ≥ Categorie of quality b component-specific threshold1 + + Tabelle.1321 + Possible R-Strategy: Reuse, Recycle, Recover + + + + Possible R-Strategy: Reuse, Recycle, Recover + + Tabelle.1322 + Possible R-Strategy: Remanufacture, Recycle, Recover + + + + Possible R-Strategy: Remanufacture, Recycle, Recover + + Tabelle.1325 + Possible R-Strategy: Recycle, Recover + + + + Possible R-Strategy: Recycle, Recover + + Antwortnachricht.1327 + + + + + + + + + + + Antwortnachricht.1335 + + + + + + + + + + Antwortnachricht.1336 + + + + + + + + + + Antwortnachricht.1337 + + + + + + + + + + Antwortnachricht.1346 + + + + + + + + + + Aktion.1371 + Select component + + + + + + + Select component + + Antwortnachricht.1379 + + + + + + + + + + Antwortnachricht.1380 + + + + + + + + + + Antwortnachricht.1372 + + + + + + + + + + Antwortnachricht.1422 + + + + + + + + + + Tabelle.1424 + + Anfangsknoten.1406 + + + + + + + Anfangsknoten.1409 + + + + + + + Tabelle.54 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.1411 + 1 + + + + 1 + + + Tabelle.1425 + + Anfangsknoten.1406 + + + + + + + Anfangsknoten.1409 + + + + + + + Tabelle.56 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.1428 + 2 + + + + 2 + + + Antwortnachricht.1429 + + + + + + + + + + Tabelle.1430 + + Anfangsknoten.1406 + + + + + + + Anfangsknoten.1409 + + + + + + + Tabelle.57 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.1433 + 3 + + + + 3 + + + Antwortnachricht.1437 + + + + + + + + + + Zusammenführungsknoten.1445 + + + + + + + Zusammenführungsknoten.1446 + + + + + + + Zusammenführungsknoten.1447 + + + + + + + Antwortnachricht.1448 + + + + + + + + + + Antwortnachricht.1449 + + + + + + + + + + Antwortnachricht.1450 + + + + + + + + + + Tabelle.1451 + Material Composition = 1 + + + + Material Composition = 1 + + Tabelle.1452 + Remaining Lifetime < Component-specific threshold + + + + Remaining Lifetime < Component-specific threshold + + Tabelle.1453 + Disassembly Capability = 0 + + + + Disassembly Capability = 0 + + Tabelle.1454 + Basic Reuse Potential = 1 + + + + Basic Reuse Potential = 1 + + Tabelle.1455 + Material Composition = 0 + + + + Material Composition = 0 + + Tabelle.1456 + Remaining Lifetime ≥ Component-specific threshold + + + + Remaining Lifetime ≥ Component-specific threshold + + Tabelle.1457 + Disassembly Capability = 1 + + + + Disassembly Capability = 1 + + Antwortnachricht.1458 + + + + + + + + + + Antwortnachricht.1459 + + + + + + + + + + Antwortnachricht.1460 + + + + + + + + + + Antwortnachricht.1461 + + + + + + + + + + Zusammenführungsknoten.1482 + + + + + + + Tabelle.1483 + Quality < Categorie of quality b component-specific threshold2 + + + + Quality < Categorie of quality b component-specific threshold2 + + Zusammenführungsknoten.1485 + + + + + + + Zusammenführungsknoten.1486 + + + + + + + Zusammenführungsknoten.1487 + + + + + + + Antwortnachricht.1488 + + + + + + + + + + Antwortnachricht.1489 + + + + + + + + + + Antwortnachricht.1490 + + + + + + + + + + Tabelle.1491 + Assemblability = 0 + + + + Assemblability = 0 + + Tabelle.1492 + Cleanability = 0 + + + + Cleanability = 0 + + Tabelle.1493 + Restorability/Upgradability = 0 + + + + Restorability/Upgradability = 0 + + Tabelle.1495 + Assemblability = 1 + + + + Assemblability = 1 + + Tabelle.1496 + Cleanability = 1 + + + + Cleanability = 1 + + Tabelle.1497 + Restorability/Upgradability = 1 + + + + Restorability/Upgradability = 1 + + Antwortnachricht.1498 + + + + + + + + + + Antwortnachricht.1499 + + + + + + + + + + Antwortnachricht.1500 + + + + + + + + + + Antwortnachricht.1502 + + + + + + + + + + Tabelle.1505 + Quality < Categorie of quality b component-specific threshold... + + + + Quality < Categorie of quality b component-specific threshold1 and Quality ≥ Categorie of quality b component-specific threshold2 + + Antwortnachricht.1613 + + + + + + + + + + Antwortnachricht.1614 + + + + + + + + + + Tabelle.1615 + + Aktion + Recommend identified R-Strategy to use + + + + + + + Recommend identified R-Strategy to use + + Antwortnachricht.1444 + + + + + + + + + + Verbindungsknoten + + + + + + + + diff --git a/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/CE_assistant_technical_feasibility_logic.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/CE_assistant_technical_feasibility_logic.svg.license new file mode 100644 index 00000000000..086356bd4e6 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/CE_assistant_technical_feasibility_logic.svg.license @@ -0,0 +1,14 @@ +## NOTICE + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- Copyright (c) 2023 BMW AG +- Copyright (c) 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) +- Copyright (c) 2023 BASF SE +- Copyright (c) 2023 SAP Deutschland SE & Co.KG +- Copyright (c) 2023 T-Systems International GmbH +- Copyright (c) 2023 LRP Auto-Recycling Leipzig GmbH +- Copyright (c) 2023 Robert Bosch GmbH +- Copyright (c) 2023 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Circularity_KIT/resources/adoption-view diff --git a/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/CE_assistant_user_journey.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/CE_assistant_user_journey.svg new file mode 100644 index 00000000000..ce2735a430c --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/CE_assistant_user_journey.svg @@ -0,0 +1 @@ +Vehiclelookupfor dismantling in Catena-X networkDismantler requests general information about the individual vehicle and its components via VINComponentselectionforanalysisDismantler selects one component for detailed information and analysisData request of component and materialCE Assistant requests detailed information about the component and contained materials in a vehicleTechnicalassessmentofR-StrategiesCEAssistantcalculates the technical feasibility of different R-Strategies for the component based on standardized decision logicEnvironmentalassessmentofR-StrategiesCE Assistant calculates the environmental impact of different (technically feasible) R-Strategies based on an LCA of subsequentprocesses and recommends an optimalR-StrategyCE Assistant User Journey–R-Strategy decision-makingUpdateofDigital TwinCE Assistant updates Digital Twin of component with calculation result and selected R-strategy to allow for further monitoring,and digital traceability for second lifeFeedback-to-​designCE Assistant enables feedback-to-design updates regarding dismantling and circular economy capabilities to manufacturer of the vehicle / component \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/CE_assistant_user_journey.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/CE_assistant_user_journey.svg.license new file mode 100644 index 00000000000..086356bd4e6 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/CE_assistant_user_journey.svg.license @@ -0,0 +1,14 @@ +## NOTICE + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- Copyright (c) 2023 BMW AG +- Copyright (c) 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) +- Copyright (c) 2023 BASF SE +- Copyright (c) 2023 SAP Deutschland SE & Co.KG +- Copyright (c) 2023 T-Systems International GmbH +- Copyright (c) 2023 LRP Auto-Recycling Leipzig GmbH +- Copyright (c) 2023 Robert Bosch GmbH +- Copyright (c) 2023 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Circularity_KIT/resources/adoption-view diff --git a/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/Circularity_KIT_user_journey.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/Circularity_KIT_user_journey.svg new file mode 100644 index 00000000000..7eb0093877c --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/Circularity_KIT_user_journey.svg @@ -0,0 +1 @@ +1. Vehicleuse-phase2. Vehicle ​reachesEnd-of-Life (EoL)3.TransferofEnd-of-Life Vehicle (ELV)todismantler•Evaluation of ​vehicle value•Vehicle acceptance and change in ownership•Issue of certificate of decommissioning4.Determining the best CE-Strategy using Catena-X​•Vehicle and digital twin (DT) ​lookup for dismantling in Catena-X•Component​selectionforanalysis•Request of data on vehicle fromCatena-X on selectedcomponents and material•Technical assessment ​of CE-Strategies•Environmental assessment ​of CE-Strategies•Decision-making for the best CE-Strategy•Update of vehicle / component digital twin•Feedback-to-​DesignCircularityKIT–E2E User Journey5.Dismantling of mandatory and valuable components•DismantlingoftheHigh-Voltage-Battery(HVB)•Draining•Neutralizingpyrotechnics•Mandatorydismantling•Maindisassembly•Storagingcomponents and vehicles with residual value•Transferring​ secondary componentsto aftermarket (e.g.repairment)7.Dismantling vehicle scrap on material level•Core scrap ​removal•Vehicle ​compaction•Transferring scrap ​to ​recycler•IssueofEoLcertificate for waste​8.Material recycling•Material pre-treatment•Shredding•Separation and sorting•Purifying•Recycling•Refinement•Creation of secondary material•Transferring secondary material ​to component manufacturer•Issue ofEoLcertificate for recycled material​9.Manufacturing of components with secondary material•Processing secondary ​material•Usage of secondary material for production•Transferring ​components and material ​to OEM10.Vehicle Assembly with secondary material componentsReuseofcomponentsFeaturesClosed loops ofsecondary materialsEoLServicesSecondaryMarketplaceCE AssistentSecondaryMaterial ContentMaterial AccountingEoLServicesELV6. Refurbishment/Remanufacturingofcomponents•Usage of secondary components in vechicle manufacturing / assembly•IssueofEoLcertificatesMaterialrecoveryWastestreamSecondaryMarketplaceCEAssistantSecondaryMarketplaceEoLServicesSecondaryMarketplaceEoLServicesMaterial AccountingSecondaryMaterial ContentSecondaryMarketplace \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/Circularity_KIT_user_journey.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/Circularity_KIT_user_journey.svg.license new file mode 100644 index 00000000000..086356bd4e6 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/Circularity_KIT_user_journey.svg.license @@ -0,0 +1,14 @@ +## NOTICE + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- Copyright (c) 2023 BMW AG +- Copyright (c) 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) +- Copyright (c) 2023 BASF SE +- Copyright (c) 2023 SAP Deutschland SE & Co.KG +- Copyright (c) 2023 T-Systems International GmbH +- Copyright (c) 2023 LRP Auto-Recycling Leipzig GmbH +- Copyright (c) 2023 Robert Bosch GmbH +- Copyright (c) 2023 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Circularity_KIT/resources/adoption-view diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/Relationship_between_Material_Characteristics.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/Relationship_between_Material_Characteristics.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/Relationship_between_Material_Characteristics.svg rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/Relationship_between_Material_Characteristics.svg diff --git a/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/Relationship_between_Material_Characteristics.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/Relationship_between_Material_Characteristics.svg.license new file mode 100644 index 00000000000..086356bd4e6 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/Relationship_between_Material_Characteristics.svg.license @@ -0,0 +1,14 @@ +## NOTICE + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- Copyright (c) 2023 BMW AG +- Copyright (c) 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) +- Copyright (c) 2023 BASF SE +- Copyright (c) 2023 SAP Deutschland SE & Co.KG +- Copyright (c) 2023 T-Systems International GmbH +- Copyright (c) 2023 LRP Auto-Recycling Leipzig GmbH +- Copyright (c) 2023 Robert Bosch GmbH +- Copyright (c) 2023 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Circularity_KIT/resources/adoption-view diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/circularity_kit_wheel.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/circularity_kit_wheel.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/circularity_kit_wheel.svg rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/circularity_kit_wheel.svg diff --git a/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/circularity_kit_wheel.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/circularity_kit_wheel.svg.license new file mode 100644 index 00000000000..086356bd4e6 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/circularity_kit_wheel.svg.license @@ -0,0 +1,14 @@ +## NOTICE + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- Copyright (c) 2023 BMW AG +- Copyright (c) 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) +- Copyright (c) 2023 BASF SE +- Copyright (c) 2023 SAP Deutschland SE & Co.KG +- Copyright (c) 2023 T-Systems International GmbH +- Copyright (c) 2023 LRP Auto-Recycling Leipzig GmbH +- Copyright (c) 2023 Robert Bosch GmbH +- Copyright (c) 2023 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Circularity_KIT/resources/adoption-view diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/communication_architecture.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/communication_architecture.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/communication_architecture.svg rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/communication_architecture.svg diff --git a/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/communication_architecture.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/communication_architecture.svg.license new file mode 100644 index 00000000000..086356bd4e6 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/communication_architecture.svg.license @@ -0,0 +1,14 @@ +## NOTICE + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- Copyright (c) 2023 BMW AG +- Copyright (c) 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) +- Copyright (c) 2023 BASF SE +- Copyright (c) 2023 SAP Deutschland SE & Co.KG +- Copyright (c) 2023 T-Systems International GmbH +- Copyright (c) 2023 LRP Auto-Recycling Leipzig GmbH +- Copyright (c) 2023 Robert Bosch GmbH +- Copyright (c) 2023 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Circularity_KIT/resources/adoption-view diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/custody_models.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/custody_models.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/custody_models.svg rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/custody_models.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/custody_models.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/custody_models.svg.license similarity index 80% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/custody_models.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/custody_models.svg.license index 9ffcef3ef98..086356bd4e6 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/custody_models.svg.license +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/custody_models.svg.license @@ -11,3 +11,4 @@ This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses - Copyright (c) 2023 Robert Bosch GmbH - Copyright (c) 2023 tec4U-Ingenieurgesellschaft mbH - Copyright (c) 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Circularity_KIT/resources/adoption-view diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/datapoints_along_valuechain.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/datapoints_along_valuechain.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/datapoints_along_valuechain.svg rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/datapoints_along_valuechain.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/datapoints_along_valuechain.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/datapoints_along_valuechain.svg.license similarity index 80% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/datapoints_along_valuechain.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/datapoints_along_valuechain.svg.license index 9ffcef3ef98..086356bd4e6 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/datapoints_along_valuechain.svg.license +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/datapoints_along_valuechain.svg.license @@ -11,3 +11,4 @@ This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses - Copyright (c) 2023 Robert Bosch GmbH - Copyright (c) 2023 tec4U-Ingenieurgesellschaft mbH - Copyright (c) 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Circularity_KIT/resources/adoption-view diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/depiction_of_smc_data_models.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/depiction_of_smc_data_models.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/depiction_of_smc_data_models.svg rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/depiction_of_smc_data_models.svg diff --git a/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/depiction_of_smc_data_models.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/depiction_of_smc_data_models.svg.license new file mode 100644 index 00000000000..086356bd4e6 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/depiction_of_smc_data_models.svg.license @@ -0,0 +1,14 @@ +## NOTICE + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- Copyright (c) 2023 BMW AG +- Copyright (c) 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) +- Copyright (c) 2023 BASF SE +- Copyright (c) 2023 SAP Deutschland SE & Co.KG +- Copyright (c) 2023 T-Systems International GmbH +- Copyright (c) 2023 LRP Auto-Recycling Leipzig GmbH +- Copyright (c) 2023 Robert Bosch GmbH +- Copyright (c) 2023 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Circularity_KIT/resources/adoption-view diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/eq_post_consumer_material_content.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/eq_post_consumer_material_content.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/eq_post_consumer_material_content.svg rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/eq_post_consumer_material_content.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/eq_pre_consumer_material_content.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/eq_pre_consumer_material_content.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/eq_pre_consumer_material_content.svg rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/eq_pre_consumer_material_content.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/equation_Reutilization_content.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/equation_Reutilization_content.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/equation_Reutilization_content.svg rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/equation_Reutilization_content.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/equation_SMC.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/equation_SMC.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/equation_SMC.svg rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/equation_SMC.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/equation_SMQ.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/equation_SMQ.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/equation_SMQ.svg rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/equation_SMQ.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/figure11.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure11.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/figure11.svg rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure11.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/figure7.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure11.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/figure7.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure11.svg.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/figure7.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure7.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/figure7.svg rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure7.svg diff --git a/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure7.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure7.svg.license new file mode 100644 index 00000000000..7c4b5318016 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure7.svg.license @@ -0,0 +1,13 @@ +## NOTICE + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- Copyright (c) 2023,2024 BMW AG +- Copyright (c) 2023,2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) +- Copyright (c) 2023,2024 BASF SE +- Copyright (c) 2023,2024 SAP Deutschland SE & Co.KG +- Copyright (c) 2023,2024 T-Systems International GmbH +- Copyright (c) 2023,2024 LRP Auto-Recycling Leipzig GmbH +- Copyright (c) 2023,2024 Robert Bosch GmbH +- Copyright (c) 2023,2024 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023,2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF.svg rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF.svg.license diff --git a/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF1.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF1.svg new file mode 100644 index 00000000000..372695112a1 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF1.svg @@ -0,0 +1 @@ +© 2023 Catena-X or a Catena-X affiliate company. All rights reserved.1Data Journey–End of Life1.Evaluation ofvehiclevalue1.1Readvehicleparameters1.2Visual inspection2.Vehicle acceptanceVehiclearrival2.1Vehicle reception and registration in the system3.Vehicle detectionAcceptance and dismantling order creation3.1Vehicle acceptance3.2Decomissioningcertificatecreation3.3Vehicle dismantling strategydefinition3.4Dismantlingordercreation4.Dismantling HVB (optional)HV batterydismantling4.1HV Battery state of health analysis4.2HV battery dismounting from vehicle4.3Battery shipment for recyclingCX-0038Fleet Diagnostic dataCX-0035Marketplace OfferCX-0059RemainingUseful LifeCX-0033Return requestCX-0039Fleet Claim DataCX-0126Industry Core: PartType (PartTypeInformation, SingleLevelBomAsPlanned,SingleLevelUsageAsPlanned)CX-0149 Verified Company IdentityCX-0037 Vehicle Product descriptionCX-0034 BatteryPassCX-0127 Industry Core: Part Instance (SerialPart, Batch, JustInSequencePart,SingleLevelBomAsBuilt, SingleLevelUsageAsBuilt)CX-0149 Verified Company IdentityCX-0038 Fleet Diagnostic DataCX-0039 Fleet Claim DataCX-0099 Decomissioning CertificateCX-0066 End of Life Of Vehicle ComplianceCX-0035 Marketplace OfferCX-0037 VehicleProduct DescriptionCX-0059 Remaining Useful LifeCX-0032 PartAsSpecifiedCX-0034Battery passCX-0038Fleet Diagnostic Data \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF1.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF1.svg.license new file mode 100644 index 00000000000..7c4b5318016 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF1.svg.license @@ -0,0 +1,13 @@ +## NOTICE + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- Copyright (c) 2023,2024 BMW AG +- Copyright (c) 2023,2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) +- Copyright (c) 2023,2024 BASF SE +- Copyright (c) 2023,2024 SAP Deutschland SE & Co.KG +- Copyright (c) 2023,2024 T-Systems International GmbH +- Copyright (c) 2023,2024 LRP Auto-Recycling Leipzig GmbH +- Copyright (c) 2023,2024 Robert Bosch GmbH +- Copyright (c) 2023,2024 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023,2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF2.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF2.svg new file mode 100644 index 00000000000..e9323cfa00d --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF2.svg @@ -0,0 +1 @@ +© 2023 Catena-X or a Catena-X affiliate company. All rights reserved.2Data Journey–EoL5.NeutralizingpyrotechnicsAirbagsneutralization5.1Vehicle parameters read5.2Neutralizing pyrotechnics (all or partial)6.Draining6.1Vehicle liquids strategy definition6.2Draining7. Main disassembly7.1Predefined parts disassembly (re-use, re-manufacture)7.2Parts quality evaluation7.3Parts registration in thesystem8. Further mandatory dismantling8.1Further mandatory dismantling(due to legal requirements some partsneed to be removedbeforeshredding and treated in a different way)8.2Registration in the systemCX-0127 Part Instance (SerialPart, Batch, JustInSequencePart, SingleLevelBomAsBuilt,SingleLevelUsageAsBuilt)CX-0127PartInstanceCX-0127PartInstance \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF2.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF2.svg.license new file mode 100644 index 00000000000..7c4b5318016 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF2.svg.license @@ -0,0 +1,13 @@ +## NOTICE + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- Copyright (c) 2023,2024 BMW AG +- Copyright (c) 2023,2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) +- Copyright (c) 2023,2024 BASF SE +- Copyright (c) 2023,2024 SAP Deutschland SE & Co.KG +- Copyright (c) 2023,2024 T-Systems International GmbH +- Copyright (c) 2023,2024 LRP Auto-Recycling Leipzig GmbH +- Copyright (c) 2023,2024 Robert Bosch GmbH +- Copyright (c) 2023,2024 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023,2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF3.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF3.svg new file mode 100644 index 00000000000..0bf69c223b1 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF3.svg @@ -0,0 +1 @@ +© 2023 Catena-X or a Catena-X affiliate company. All rights reserved.39. Core scrap removal9.1Core scrap removal9.2Registration inthesystem10. Vehiclecompaction10.1Vehicle pressing10.2Registration in the system11. Shredding11.1 Shredding11.2 Material separation11.3 Material quality/parameters check11.4 Registration in the system12. Material recycling12.1 Material recycling12.2 Recycled material registration in the systemData Journey–EoLCX-0127PartInstanceCX-0066 End of life of vehicle complianceCX-0034 Battery PassCX-0034 Battery Pass \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF3.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF3.svg.license new file mode 100644 index 00000000000..7c4b5318016 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF3.svg.license @@ -0,0 +1,13 @@ +## NOTICE + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- Copyright (c) 2023,2024 BMW AG +- Copyright (c) 2023,2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) +- Copyright (c) 2023,2024 BASF SE +- Copyright (c) 2023,2024 SAP Deutschland SE & Co.KG +- Copyright (c) 2023,2024 T-Systems International GmbH +- Copyright (c) 2023,2024 LRP Auto-Recycling Leipzig GmbH +- Copyright (c) 2023,2024 Robert Bosch GmbH +- Copyright (c) 2023,2024 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023,2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF4.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF4.svg new file mode 100644 index 00000000000..1c97ca70061 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF4.svg @@ -0,0 +1 @@ +© 2023 Catena-X or a Catena-X affiliate company. All rights reserved.413. Marketplace & Sales13.1Sales offer creation13.2Price negotiations13.3Sales13.4DeliveryMissing data modelsBom asmaintainedDemand requestCompability of components / Design changes historyQuality issue historyTechnical drawings & specificationsID ConversionPhysical dimensionsPCF InformationMandatory DismantlingCX-0035 Marketplace offerCX-0032 Part as specifiedCX-0037 Vehicle Product descriptionCX-0059 Remaining useful lifeData Journey–EoL \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF4.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF4.svg.license new file mode 100644 index 00000000000..7c4b5318016 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF4.svg.license @@ -0,0 +1,13 @@ +## NOTICE + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- Copyright (c) 2023,2024 BMW AG +- Copyright (c) 2023,2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer IPK) +- Copyright (c) 2023,2024 BASF SE +- Copyright (c) 2023,2024 SAP Deutschland SE & Co.KG +- Copyright (c) 2023,2024 T-Systems International GmbH +- Copyright (c) 2023,2024 LRP Auto-Recycling Leipzig GmbH +- Copyright (c) 2023,2024 Robert Bosch GmbH +- Copyright (c) 2023,2024 tec4U-Ingenieurgesellschaft mbH +- Copyright (c) 2023,2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/figure_user_journey_codm.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_user_journey_codm.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/figure_user_journey_codm.svg rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_user_journey_codm.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/figure_user_journey_codm.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_user_journey_codm.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/figure_user_journey_codm.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_user_journey_codm.svg.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/figure_userstory_ce_assistant.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_userstory_ce_assistant.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/figure_userstory_ce_assistant.svg rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_userstory_ce_assistant.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/figure_userstory_ce_assistant.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_userstory_ce_assistant.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/figure_userstory_ce_assistant.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/figure_userstory_ce_assistant.svg.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/material_charactersitics.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/material_charactersitics.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/material_charactersitics.svg rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/material_charactersitics.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/material_charactersitics.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/material_charactersitics.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/material_charactersitics.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/material_charactersitics.svg.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/overview_material_flow.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/overview_material_flow.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/overview_material_flow.svg rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/overview_material_flow.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/overview_material_flow.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/overview_material_flow.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/overview_material_flow.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/overview_material_flow.svg.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/userJourney_smc.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/userJourney_smc.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/userJourney_smc.svg rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/userJourney_smc.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/userJourney_smc.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/userJourney_smc.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/userJourney_smc.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/userJourney_smc.svg.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/user_journey_secondary_marketplace.svg b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/user_journey_secondary_marketplace.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/user_journey_secondary_marketplace.svg rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/user_journey_secondary_marketplace.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/user_journey_secondary_marketplace.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/user_journey_secondary_marketplace.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Circularity_KIT/resources/adoption-view/user_journey_secondary_marketplace.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Circularity_KIT/resources/adoption-view/user_journey_secondary_marketplace.svg.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Connector Kit/Adoption View/adoption-view.md b/docs-kits_versioned_docs/version-24.12/kits/Connector Kit/Adoption View/adoption-view.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Connector Kit/Adoption View/adoption-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Connector Kit/Adoption View/adoption-view.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Connector Kit/Adoption View/policies-in-catena.md b/docs-kits_versioned_docs/version-24.12/kits/Connector Kit/Adoption View/policies-in-catena.md similarity index 87% rename from docs-kits_versioned_docs/version-24.05/kits/Connector Kit/Adoption View/policies-in-catena.md rename to docs-kits_versioned_docs/version-24.12/kits/Connector Kit/Adoption View/policies-in-catena.md index 53b9cfa4768..603fcfe3a37 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Connector Kit/Adoption View/policies-in-catena.md +++ b/docs-kits_versioned_docs/version-24.12/kits/Connector Kit/Adoption View/policies-in-catena.md @@ -37,22 +37,22 @@ they are described by them in their associated KITs and only general elements ar Here's a non-normative overview of these extensions: -### Use Case Framework Constraints +### Data Exchange Governance -Use Case Framework Constraints are references to legally binding documents set up by the Catena-X association. They -govern the _"who, with whom, what, where from and where to, why, how, and when"_ of Data Sharing in Catena-X Use-Cases +The FrameworkAgreement references the legally binding Data Exchange Governance document set up by the Catena-X association. It +governs the _"who, with whom, what, where from and where to, why, how, and when"_ of Data Sharing in Catena-X ([Source](https://catena-x.net/en/catena-x-introduce-implement/governance-framework-for-data-space-operations)). -Use Case Frameworks are roughly structured along the lines of business scenarios under which a set of business partners +It is roughly structured along the lines of business scenarios under which a set of business partners want to exchange data. -Each Participant commits to a set of Use Case Frameworks during Onboarding. They are granted a set of VCs as proof of -that commitment. Consequently, Use Case Framework Constraints belong to the kind of `odrl:Constraint`s that have to be +Each Participant commits to the Data Exchange Governance during Onboarding. They are granted a set of VCs as proof of +that commitment. Consequently, the FrameworkAgreement Constraint belongs to the kind of `odrl:Constraint`s that have to be [checked against a VP](working-with-policies.md#provider-side-checking-a-consumers-verifiable-presentation). The -complete set is listed in the most current version of standard +details are listed in the most current version of standard [CX-0050 Framework Credential](https://catena-x.net/de/standard-library). -Use Case Frameworks are referred to in a machine-readable way in a Provider's Offers. When a Consumer starts the -negotiation for said offer, not only will the Policy in the `ContractRequestMessage` be checked but also his -Credentials. Here's an example of an `odrl:Constraint` referencing a Use Case Framework and invoking the VC-check: +The Governance Framwork is referred to in a machine-readable way in a Provider's Offers. When a Consumer starts the +negotiation for said offer, not only will the Policy in the `ContractRequestMessage` be checked but also their +Credentials. Here's an example of an `odrl:Constraint` referencing the Data Exchange Governance and invoking the VC-check: ```json { @@ -63,20 +63,18 @@ Credentials. Here's an example of an `odrl:Constraint` referencing a Use Case Fr "odrl:operator": { "@id": "odrl:eq" }, - "odrl:rightOperand": "traceability:1.0" + "odrl:rightOperand": "DataExchangeGovernance:1.0" } ``` ### Usage Purposes -Purposes are usually part of a Use Case Framework and restrict the purpose the Consumer is privileged to use the +Purposes are published in [CX ODRL Profile](https://github.com/catenax-eV/cx-odrl-profile) and restrict the purpose the Consumer is privileged to use the obtained data for. Unlike a Use Case Framework Constraint, the purposes are NOT checked against VCs, thus necessary for a successful negotiation mechanism is only [the Consumer's consent to the Offer](working-with-policies.md#consumer-side-odrloffer-in-a-contractrequestmessage). -Versions for UsagePurpose `rightOperand`s are typically 1-digit. The complete list of usage purposes in Catena-X is -publicly available in the [CX ODRL Profile](https://github.com/catenax-eV/cx-odrl-profile). The corresponding documents -are linked on -the [Catena-X e.V. homepage](https://catena-x.net/en/catena-x-introduce-implement/governance-framework-for-data-space-operations). +Versions for UsagePurpose `rightOperand`s are typically 1-digit. + Here's an example from the Use Case Framework Traceability: | Predefined Policy | Typically used where? | Predefined Purpose | @@ -166,7 +164,7 @@ property): "odrl:operator": { "@id": "odrl:eq" }, - "odrl:rightOperand": "traceability:1.0" + "odrl:rightOperand": "DataExchangeGovernance:1.0" }, { "odrl:leftOperand": "https://w3id.org/catenax/policy/UsagePurpose", @@ -194,7 +192,7 @@ property): "odrl:operator": { "@id": "odrl:eq" }, - "odrl:rightOperand": "traceability:1.0" + "odrl:rightOperand": "DataExchangeGovernance:1.0" }, { "odrl:leftOperand": "https://w3id.org/catenax/policy/ContractReference", diff --git a/docs-kits_versioned_docs/version-24.05/kits/Connector Kit/Adoption View/working-with-policies.md b/docs-kits_versioned_docs/version-24.12/kits/Connector Kit/Adoption View/working-with-policies.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Connector Kit/Adoption View/working-with-policies.md rename to docs-kits_versioned_docs/version-24.12/kits/Connector Kit/Adoption View/working-with-policies.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Connector Kit/Development View/architecture.md b/docs-kits_versioned_docs/version-24.12/kits/Connector Kit/Development View/architecture.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Connector Kit/Development View/architecture.md rename to docs-kits_versioned_docs/version-24.12/kits/Connector Kit/Development View/architecture.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Connector Kit/Development View/specifications.md b/docs-kits_versioned_docs/version-24.12/kits/Connector Kit/Development View/specifications.md similarity index 93% rename from docs-kits_versioned_docs/version-24.05/kits/Connector Kit/Development View/specifications.md rename to docs-kits_versioned_docs/version-24.12/kits/Connector Kit/Development View/specifications.md index 71b3abe90e6..32b468e39e4 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Connector Kit/Development View/specifications.md +++ b/docs-kits_versioned_docs/version-24.12/kits/Connector Kit/Development View/specifications.md @@ -27,7 +27,7 @@ its way into the IDSA and international standardization bodies. ## Catena X Standard Library The other guiding documentation is the [Catena X Standard Library](https://catena-x.net/en/standard-library). -In particular, Framework Agreement CX-0018 describes the Eclipse Dataspace Connector, the reference implementation of the Connector Kit. +In particular, Dataspace Connectivity CX-0018 describes a Dataspace Connector. ## Notice diff --git a/docs-kits_versioned_docs/version-24.05/kits/Connector Kit/Operation View/operation-view.md b/docs-kits_versioned_docs/version-24.12/kits/Connector Kit/Operation View/operation-view.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Connector Kit/Operation View/operation-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Connector Kit/Operation View/operation-view.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Connector Kit/assets/domain-model.png b/docs-kits_versioned_docs/version-24.12/kits/Connector Kit/assets/domain-model.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Connector Kit/assets/domain-model.png rename to docs-kits_versioned_docs/version-24.12/kits/Connector Kit/assets/domain-model.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Connector Kit/assets/edc_architecture.png b/docs-kits_versioned_docs/version-24.12/kits/Connector Kit/assets/edc_architecture.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Connector Kit/assets/edc_architecture.png rename to docs-kits_versioned_docs/version-24.12/kits/Connector Kit/assets/edc_architecture.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Connector Kit/page_changelog.md b/docs-kits_versioned_docs/version-24.12/kits/Connector Kit/page_changelog.md similarity index 92% rename from docs-kits_versioned_docs/version-24.05/kits/Connector Kit/page_changelog.md rename to docs-kits_versioned_docs/version-24.12/kits/Connector Kit/page_changelog.md index 7fe14223b01..72d1562b569 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Connector Kit/page_changelog.md +++ b/docs-kits_versioned_docs/version-24.12/kits/Connector Kit/page_changelog.md @@ -6,6 +6,10 @@ All notable changes to this Kit will be documented in this file. +## [3.0.0] - 2024-06-07 + +- Replace use case specific FrameworkAgreement rightOperand with the new, consolidated DataExchangeGovernance released with 2408 + ## [2.1.0] - 2024-05-29 - Added new page on policies in general diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/Documentation/admin_guide.md b/docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/Documentation/admin_guide.md similarity index 99% rename from docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/Documentation/admin_guide.md rename to docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/Documentation/admin_guide.md index 46e450ada88..b630ff3b73a 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/Documentation/admin_guide.md +++ b/docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/Documentation/admin_guide.md @@ -5,7 +5,7 @@ description: 'Administration Guide' sidebar_position: 3 --- -![Datachain kit banner](@site/static/img/kits/data-chain/DataChainKitIcon.png) +![Datachain kit banner](@site/static/img/kits/data-chain/data-chain-kit-logo.drawio.svg) ### Data Chain KIT diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/Documentation/arc42.md b/docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/Documentation/arc42.md similarity index 99% rename from docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/Documentation/arc42.md rename to docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/Documentation/arc42.md index 447eff0c41f..ae1f0014752 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/Documentation/arc42.md +++ b/docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/Documentation/arc42.md @@ -7,7 +7,7 @@ sidebar_position: 3 --- -![Datachain kit banner](@site/static/img/kits/data-chain/DataChainKitIcon.png) +![Datachain kit banner](@site/static/img/kits/data-chain/data-chain-kit-logo.drawio.svg) ### Data Chain KIT diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/Software Development View/Job Api/irs-api.info.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/Software Development View/Job Api/irs-api.info.mdx similarity index 72% rename from docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/Software Development View/Job Api/irs-api.info.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/Software Development View/Job Api/irs-api.info.mdx index 9cdbf433797..d662b0f7fbe 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/Software Development View/Job Api/irs-api.info.mdx +++ b/docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/Software Development View/Job Api/irs-api.info.mdx @@ -21,4 +21,4 @@ import Export from "@theme/ApiDemoPanel/Export"; The API of the Item Relationship Service (IRS) for retrieving item graphs along the value chain of CATENA-X partners. - + diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/Software Development View/Job Api/sidebar.js b/docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/Software Development View/Job Api/sidebar.js similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/Software Development View/Job Api/sidebar.js rename to docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/Software Development View/Job Api/sidebar.js diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/Software Development View/_category_.json b/docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/Software Development View/_category_.json similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/Software Development View/_category_.json rename to docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/Software Development View/_category_.json diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/Software Development View/page_software-development-view.md b/docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/Software Development View/page_software-development-view.md similarity index 84% rename from docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/Software Development View/page_software-development-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/Software Development View/page_software-development-view.md index 8c463f4f18c..4b443af5267 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/Software Development View/page_software-development-view.md +++ b/docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/Software Development View/page_software-development-view.md @@ -4,7 +4,7 @@ title: Specification sidebar_position: 2 --- -![Datachain kit banner](@site/static/img/kits/data-chain/DataChainKitIcon.png) +![Datachain kit banner](@site/static/img/kits/data-chain/data-chain-kit-logo.drawio.svg) ### Data Chain KIT diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/arc/page_documentation.md b/docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/arc/page_documentation.md similarity index 77% rename from docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/arc/page_documentation.md rename to docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/arc/page_documentation.md index 3502407f2fd..c3769ed0518 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/arc/page_documentation.md +++ b/docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/arc/page_documentation.md @@ -5,7 +5,7 @@ description: 'Data Chain Kit' sidebar_position: 3 --- -![Datachain kit banner](@site/static/img/doc-datachain_header-minified.png) +![Datachain kit banner](@site/static/img/kits/data-chain/data-chain-kit-logo.drawio.svg) ## INCLUDE diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/page_adoption-view.md similarity index 99% rename from docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/page_adoption-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/page_adoption-view.md index 6543aad944d..929d9a36a45 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/page_adoption-view.md +++ b/docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/page_adoption-view.md @@ -5,7 +5,7 @@ description: 'Data Chain Kit' sidebar_position: 1 --- -![Datachain kit banner](@site/static/img/kits/data-chain/DataChainKitIcon.png) +![Datachain kit banner](@site/static/img/kits/data-chain/data-chain-kit-logo.drawio.svg) ### Data Chain Kit @@ -435,9 +435,9 @@ companies (one level down approach) is known. (Relationship: Customer - Supplier This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). * SPDX-License-Identifier: CC-BY-4.0 -* SPDX-FileCopyrightText: 2021, 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +* SPDX-FileCopyrightText: 2021, 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) * SPDX-FileCopyrightText: 2022, 2023 BOSCH AG * SPDX-FileCopyrightText: 2021, 2022 ZF Friedrichshafen AG * SPDX-FileCopyrightText: 2022 ISTOS GmbH -* SPDX-FileCopyrightText: 2021, 2023 Contributors to the Eclipse Foundation +* SPDX-FileCopyrightText: 2021, 2024 Contributors to the Eclipse Foundation * Source URL: diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/page_changelog.md b/docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/page_changelog.md similarity index 94% rename from docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/page_changelog.md rename to docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/page_changelog.md index 1bb450b657b..a67f4cabfee 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/page_changelog.md +++ b/docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/page_changelog.md @@ -5,13 +5,13 @@ description: 'Data Chain Kit Changelog' sidebar_position: 10 --- -![Datachain kit banner](@site/static/img/kits/data-chain/DataChainKitIcon.png) +![Datachain kit banner](@site/static/img/kits/data-chain/data-chain-kit-logo.drawio.svg) ### Data Chain KIT All notable changes to this Kit will be documented in this file. -## [4.0.0] - unreleased +## [3.0.1] - unreleased ### Added diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/page_software-operation-view.md b/docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/page_software-operation-view.md similarity index 50% rename from docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/page_software-operation-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/page_software-operation-view.md index f3cafa79cb2..70897320dd2 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Data Chain Kit/page_software-operation-view.md +++ b/docs-kits_versioned_docs/version-24.12/kits/Data Chain Kit/page_software-operation-view.md @@ -5,47 +5,26 @@ description: 'Data Chain Kit' sidebar_position: 2 --- -![Datachain kit banner](@site/static/img/kits/data-chain/DataChainKitIcon.png) +![Datachain kit banner](@site/static/img/kits/data-chain/data-chain-kit-logo.drawio.svg) ### Data Chain KIT ## Local deployment of IRS with minimum dependencies setup -> **Please note that this demo is currently based on IRS version 4.5.0** +> **Please note that this demo is currently based on IRS version 5.4.0** ### Step 1: Prerequisites -1. [Docker](https://docs.docker.com/get-docker/) is installed and the Docker deamon is running with at least 8GB of memory +1. [Docker](https://docs.docker.com/get-docker/) is installed and the Docker deamon is running with at least 8GB of + memory 2. [helm](https://helm.sh/docs/intro/install/) is installed 3. Any Kubernetes cluster is installed and running, eg. [Minikube](https://minikube.sigs.k8s.io/docs/start/) 4. [kubectl](https://kubernetes.io/docs/tasks/tools/) is installed -### Step 2: Update and build the irs-helm chart +### Step 2: Add the IRS helm repository ```bash ->$ helm dependency build -``` - -You should see console output with messages like below: - -```bash -Hang tight while we grab the latest from your chart repositories... -...Successfully got an update from the "irs" chart repository -...Successfully got an update from the "tractusx-dev" chart repository -...Successfully got an update from the "prometheus-community" chart repository -Update Complete. ⎈Happy Helming!⎈ -Saving 1 charts -Downloading irs-helm from repo https://eclipse-tractusx.github.io/item-relationship-service -Deleting outdated charts -``` - -Please note that irs repository has to be added to helm repo list - -```bash ->$ helm repo add irs https://eclipse-tractusx.github.io/item-relationship-service ->$ helm repo list -NAME URL -irs https://eclipse-tractusx.github.io/item-relationship-service +helm repo add irs https://eclipse-tractusx.github.io/item-relationship-service ``` ### Step 3: Installing the IRS @@ -55,7 +34,7 @@ irs https://eclipse-tractusx.github.io/item-relationship-ser To deploy IRS on kubernetes with helm run ```bash ->$ helm install irs-local . +helm install irs-local irs/item-relationship-service -f your-values.yaml ``` ##### 1.1 Get the Status of the deployment @@ -63,19 +42,25 @@ To deploy IRS on kubernetes with helm run Helm can give you feedback on the release status: ```bash ->$ helm list -NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION -irs-local default 1 2024-02-26 11:36:46.399546 +0100 CET deployed irs-helm-local-6.14.0 4.5.0 +helm list +``` + +```bash +NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION +irs-local default 1 2024-08-01 10:24:46.8811785 +0200 CEST deployed item-relationship-service-7.4.0 5.4.0 ``` -Kubectl can give you feedback on how the status of the deployment currently is, there should be two pods deployed - IRS and Minio: +Kubectl can give you feedback on how the status of the deployment currently is, there should be two pods deployed - IRS +and Minio: ```bash ->$ kubectl get pods -NAME READY STATUS RESTARTS AGE -irs-local-minio-7cc78d8985-qggrx 1/1 Running 0 10m -irs-local-irs-helm-c84f98ffb-zg59z 1/1 Running 0 10m +kubectl get pods +``` +```bash +NAME READY STATUS RESTARTS AGE +irs-local-item-relationship-service-5bdcd5854d-gq976 1/1 Running 0 47s +irs-local-minio-6f6c58cfbd-j8jkg 1/1 Running 0 47s ``` #### 2. Forward Ports @@ -83,7 +68,7 @@ irs-local-irs-helm-c84f98ffb-zg59z 1/1 Running 0 10m When the deployment has been finished please use the command to forward the port: ```bash ->$ kubectl port-forward svc/irs-local-irs-helm 8080:8080 +kubectl port-forward svc/irs-local-item-relationship-service 8080:8080 ``` After that you can access the Swagger UI page: @@ -92,11 +77,14 @@ After that you can access the Swagger UI page: ## Testing the Item Relationship Service -You can use any approach to access exposed by IRS API endpoints, for example mentioned above Swagger UI page. There is also prepared Insomnia collection with example calls to IRS, see [IRS_Request_Collection.json](../../testing/IRS_Request_Collection.json) +You can use any approach to access exposed by IRS API endpoints, for example mentioned above Swagger UI page. There is +also prepared Insomnia collection with example calls to IRS, +see [IRS_Request_Collection.json](https://github.com/eclipse-tractusx/item-relationship-service/blob/5.4.0/local/testing/request-collection/IRS_Request_Collection.json) ### Valid Global Asset Ids for testing -IRS is loading with mocked data from Testdata file, see [CX_Testdata.json](../../../irs-models/src/main/resources/test_data/CX_Testdata.json) +IRS is loading with mocked data from Testdata file, +see [CX_Testdata.json](https://github.com/eclipse-tractusx/item-relationship-service/blob/5.4.0/irs-models/src/main/resources/test_data/CX_Testdata.json) ### Valid test requests for testing @@ -105,7 +93,6 @@ You can use these snippets for testing purposes. ```json { "bomLifecycle": "asBuilt", - "lookupBPNs": true, "direction": "downward", "depth": 10, "auditContractNegotiation": false, @@ -119,7 +106,7 @@ You can use these snippets for testing purposes. ```json { "aspects": [ - "SerialPart" + "urn:samm:io.catenax.serial_part:3.0.0#SerialPart" ], "depth": 1, "key": { diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/Software Development View/page_software-development-view.md b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/Software Development View/page_software-development-view.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/Software Development View/page_software-development-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/Software Development View/page_software-development-view.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/page_adoption-view.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/page_adoption-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/page_adoption-view.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/page_changelog.md b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/page_changelog.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/page_changelog.md rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/page_changelog.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/DGK Overview.png b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/DGK Overview.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/DGK Overview.png rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/DGK Overview.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/Data Governance KIT_ Big Picture.png b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/Data Governance KIT_ Big Picture.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/Data Governance KIT_ Big Picture.png rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/Data Governance KIT_ Big Picture.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/create-asset-1.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/create-asset-1.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/create-asset-1.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/create-asset-1.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/create-asset.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/create-asset.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/create-asset.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/create-asset.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/create-contract-definition.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/create-contract-definition.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/create-contract-definition.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/create-contract-definition.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/create-policy.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/create-policy.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/create-policy.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/create-policy.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/create-publication.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/create-publication.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/create-publication.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/create-publication.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/data-governance-kit.info.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/data-governance-kit.info.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/data-governance-kit.info.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/data-governance-kit.info.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/delete-asset-by-id-1.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/delete-asset-by-id-1.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/delete-asset-by-id-1.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/delete-asset-by-id-1.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/delete-asset-by-id.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/delete-asset-by-id.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/delete-asset-by-id.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/delete-asset-by-id.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/delete-connector-by-id.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/delete-connector-by-id.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/delete-connector-by-id.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/delete-connector-by-id.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/delete-contract-definition-by-id.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/delete-contract-definition-by-id.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/delete-contract-definition-by-id.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/delete-contract-definition-by-id.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/delete-policy-by-id.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/delete-policy-by-id.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/delete-policy-by-id.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/delete-policy-by-id.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/generate-token.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/generate-token.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/generate-token.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/generate-token.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-asset-by-id-1.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-asset-by-id-1.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-asset-by-id-1.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-asset-by-id-1.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-asset-by-id.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-asset-by-id.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-asset-by-id.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-asset-by-id.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-assets-1.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-assets-1.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-assets-1.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-assets-1.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-assets-by-ids.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-assets-by-ids.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-assets-by-ids.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-assets-by-ids.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-assets.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-assets.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-assets.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-assets.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-by-resource-data-and-connector-id.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-by-resource-data-and-connector-id.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-by-resource-data-and-connector-id.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-by-resource-data-and-connector-id.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-connector-info-list-by-id-list.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-connector-info-list-by-id-list.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-connector-info-list-by-id-list.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-connector-info-list-by-id-list.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-connector-info-list.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-connector-info-list.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-connector-info-list.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-connector-info-list.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-connector-info.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-connector-info.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-connector-info.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-connector-info.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-contract-definition-by-id.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-contract-definition-by-id.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-contract-definition-by-id.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-contract-definition-by-id.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-contract-definitions-by-ids.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-contract-definitions-by-ids.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-contract-definitions-by-ids.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-contract-definitions-by-ids.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-contract-definitions.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-contract-definitions.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-contract-definitions.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-contract-definitions.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-data-address-by-asset-id.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-data-address-by-asset-id.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-data-address-by-asset-id.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-data-address-by-asset-id.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-policies-by-id-list.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-policies-by-id-list.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-policies-by-id-list.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-policies-by-id-list.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-policies.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-policies.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-policies.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-policies.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-policy-by-id.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-policy-by-id.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-policy-by-id.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-policy-by-id.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-publication-by-resource-id.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-publication-by-resource-id.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-publication-by-resource-id.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-publication-by-resource-id.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-resource-connectors-by-connector-id.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-resource-connectors-by-connector-id.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-resource-connectors-by-connector-id.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-resource-connectors-by-connector-id.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-resource-connectors-by-resource-data.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-resource-connectors-by-resource-data.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/get-resource-connectors-by-resource-data.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/get-resource-connectors-by-resource-data.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/save-connector-info.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/save-connector-info.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/save-connector-info.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/save-connector-info.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/sidebar.js b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/sidebar.js similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/sidebar.js rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/sidebar.js diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/update-asset-1.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/update-asset-1.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/update-asset-1.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/update-asset-1.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/update-asset.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/update-asset.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/update-asset.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/update-asset.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/update-connector-info.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/update-connector-info.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/update-connector-info.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/update-connector-info.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/update-contract-definition.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/update-contract-definition.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/update-contract-definition.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/update-contract-definition.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/update-data-address-by-asset-id.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/update-data-address-by-asset-id.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/update-data-address-by-asset-id.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/update-data-address-by-asset-id.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/update-policy.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/update-policy.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/MDX Files/update-policy.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/MDX Files/update-policy.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/openAPI.yaml b/docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/openAPI.yaml similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Data Governance Kit/resources/openAPI.yaml rename to docs-kits_versioned_docs/version-24.12/kits/Data Governance Kit/resources/openAPI.yaml diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/foss-app.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/foss-app.md new file mode 100644 index 00000000000..f3a62ee8fb2 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/foss-app.md @@ -0,0 +1,19 @@ +--- +id: foss-app +title: FOSS - Application +description: FOSS - Application +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## DCM FOSS Application + +A free and open source software (FOSS) implementing the Catena-X standard CX-0128 is under development. Feel free to contribute to this community effort and visit the corresponding [GitHub repository](https://github.com/eclipse-tractusx/demand-capacity-mgmt) and [GitHub project](https://github.com/orgs/eclipse-tractusx/projects/66) + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/glossary.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/glossary.md new file mode 100644 index 00000000000..23b8523954e --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/glossary.md @@ -0,0 +1,64 @@ +--- +id: glossary +title: Glossary +description: Glossary +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## DCM Glossary + +|Term|Description| +|----|-----------| +|Actual Capacity|This is the capacity a supplier realistically plans to have available to satisfy the demand of a certain material per week for a specific customer. It considers the supplier’s own assessment of their capabilities, inventory and existing commitments.| +|Agreed Capacity|This is a capacity value coordinated between customer and supplier and it may refer e.g. to capacity values defined in mutually agreed contracts. Using the agreed capacity is optional, it has purely informative character and therefore does not constitute a legal obligation to deliver. The agreed capacity may be greater than, less than or equal to the actual or Maximum Capacity. It may be used for a time frame different than the whole time series.| +|API|Application Programming Interface is a set of rules, protocols, and tools for building software and applications. Examples for DCM can be found here: [Development View - APIs utilized by a DCM application](../development-view/overview.md#apis-utilized-by-a-dcm-application)| +|Aspect Model|See: [CX-0002 Digital Twins in Catena-X][StandardLibrary]| +|Bottleneck|A facility, function, department, or resource whose capacity is less than the demand placed upon it. For example, a bottleneck machine or work center exists where jobs are processed at a slower rate than they are demanded (Source: ASCM Supply Chain Dictionary, 17th edition).| +|Business Application Provider|Typically, it is a third party that offers tools to data consumers and data providers for demand and capacity management purposes that conform to the core business logic, data models and APIs described in the Catena-X DCM standard.| +|Business Partner Number Legal Entity (BPNL)|See: [CX-0010 Business Partner Number][StandardLibrary]| +|Business Partner Number Site (BPNS)|See: [CX-0010 Business Partner Number][StandardLibrary]| +|Calendar Week|A week consisting of seven days, typically numbered according to the week containing the year’s first Thursday. For example, if the first Thursday of the year is on January 1st, that week is considered Week 1.| +|Capacity|1. The capability of a system to perform its expected function. 2. The capability of a worker, machine, work center, plant, or organization to produce output per time period. (Source: ASCM Supply Chain Dictionary, 17th edition).| +|Capacity Group|A capacity group is a virtual entity that contains capacity information, which depend on production capabilities (based e.g. on grouping of one or more machines, plants, production lines or similar), as well as the material demands linked to it. The capacity group is the place where demand and capacity information come together and are compared, in order to recognize production bottlenecks and/or surplus. When written as WeekBasedCapacityGroup, it refers to a specific data model within this standard.| +|Comments|A feature that allows two business partners to exchange messages about material demand and capacity, facilitating direct collaboration and quick issue resolution.| +|Customer|A role within the DCM use case, which represents a company that receives goods from its suppliers. Participating companies can have multiple roles at the same time: in this context, a customer provides consistent and up-to-date demand forecast to and receives capacity data from suppliers. Synonym: one-up.| +|Data Consumer|A data consumer refers to any entity that retrieves and uses data from a source. This can be an individual, application, or system that accesses and processes data for various purposes or simply in context of Catena-X receiving data from a business partner.| +|Data Provider|A data provider is an entity that supplies or makes data available to others. In case of Catena-X, this can be a business partner supplying information. In the context of information technology and data management, a data provider can be a database, a web service, an API, a file system, or any other system that allows data to be accessed by data consumers.| +|(Simulated) Delta-Production|This is an optional feature that allows suppliers to manage capacity bottlenecks by simulating changes in production without altering actual or Maximum Capacity values published to customers. See also pre-/post-production.| +|Demand Deviation|This is an optional metric that allows suppliers to monitor changes in customer demands and to identify significant changes that can collaboratively be addressed by suppliers and customers.| +|Demand Volatility|Demand Volatility help suppliers to identify and measure volatility in demands. It allows them to address demand volatility directly to their customers, increasing transparency for a more effective collaborative capacity planning. Demand deviation is the first metric for measuring demand volatility.| +|Digital Twin|See: [CX-0002 Digital Twins in Catena-X][StandardLibrary].| +|Flexible Capacity|The difference between maximum and Actual Capacity, which represents the measures to potentially increase capacity without further agreements between partners, such as extending the utilization of production resources within a week.| +|JSON|The JavaScript Object Notation (JSON) is a standard text-based format for representing structured data based on JavaScript object syntax. It is commonly used for transmitting data in web applications (e.g. sending some data from the server to the client, so it can be displayed on a web page, or vice versa).| +|Linking Material Demand|Material demands can be linked directly to a capacity group or indirectly through another capacity group, which is known as “Nesting.”| +|Load Factor|An optional feature of a capacity group that adds individual numerical material load factors to WeekBasedMaterialDemand linked by the WeekBasedCapacityGroup. It adds flexibility to the unit of measure of the capacity group.| +|Material|The elements, constituents, or substances of which something is composed or can be made of. Usually referred to by a material number.| +|(Material) Demand|A need for a particular product or component. The demand could come from any number of sources (e.g. a customer order or forecast, an interplant requirement, a branch warehouse request for a service part, or the manufacturing of another product). At the finished goods level, demand data is usually different from sales data, because demand does not necessarily result in sales (e.g. if there is no stock, there will be no sale (Source: ASCM Supply Chain Dictionary, 17th edition)). Material demand may comprise multiple demand series by location and demand categories. When the term is written as one word (WeekBasedMaterialDemand), the term refers specifically to the respective aspect model.| +|Maximum Capacity|This is the highest achievable production capacity of a supplier within a given calendar week, in a certain unit of measure, for a specific customer. The Maximum Capacity is equal or higher than the Actual Capacity. It considers further capacity-increasing measures that have been planned upfront between the parties involved and can be activated whenever needed. Capacity-increasing measures can be, e.g. a longer utilization of the available production resources, a shift extension or additional shifts. Secondarily, additional resources can also be activated.| +|Nesting|A method by which a capacity group links to another capacity group (instead to material demand series), allowing for dynamic changes and centralized data management. See also: linking material demand. Synonym: indirect linking| +|One-down|Synonym: “supplier”| +|One-up|Synonym: “customer”| +|Planning Horizon|The planning horizon is the amount of time a plan extends into the future (definition: ASCM Dictionary, 17th edition).| +|Post-production|Post-production means goods are produced LATER than the requested calendar week. This feature may be optionally applied by a supplier in the WeekBasedCapacityGroup. See also (Simulated) Delta-Production.| +|Pre-production|Pre-production means goods are produced BEFORE the requested calendar week. This feature may be optionally applied by a supplier in the WeekBasedCapacityGroup. See also (Simulated) Delta-Production.| +|Semantic Model|The semantic model is a conceptual model that represents the meaning of information within a specific context. It goes beyond the structure and syntax of data to define the relationships and rules that govern the properties of entities and the interactions between them. The goal of a semantic model is to capture the intended meaning of data so that it can be unambiguously understood, processed, and shared.| +|Supplier|A role within the DCM use case, which represents a company that supplies goods to its customers. Participating companies can have multiple roles at the same time. Suppliers provide consistent and up-to-date capacity data and receive demands from customers. Synonym: one-down.| +|Surplus|A surplus is a situation in which an oversupply exists. In the DCM context, it is often used to indicate a situation in which unutilized capacity exists. It is the contrary of a bottleneck. Synonym: idle capacity, excess capacity.| +|UUID|A UUID, which stands for Universally Unique Identifier, is a 128-bit number used to uniquely identify information in computer systems. The primary purpose of a UUID is to enable distributed systems to uniquely identify information without significant central coordination. In this way, anyone can create a UUID and use it to identify something with reasonable confidence that the identifier does not duplicate one that has already been, or will be, created to identify something else.| +|WeekBasedCapacityGroup|This term refers to the specific WeekBasedCapacityGroup object defined in the DCM standard.| +|WeekBasedMaterialDemand|This term refers to the specific WeekBasedMaterialDemand object defined in the DCM standard.| + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 BASF SE +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2024 SAP SE +- SPDX-FileCopyrightText: 2024 SupplyOn AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation + +[StandardLibrary]: https://catenax-ev.github.io/docs/next/standards/overview diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/onboarding.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/onboarding.md new file mode 100644 index 00000000000..5c6826bc6d6 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/onboarding.md @@ -0,0 +1,73 @@ +--- +id: onboarding +title: Onboarding +description: Onboarding +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +You can participate in the Catena-X data ecosystem in various roles. Become acquainted with the foundational building blocks of Catena-X and how all participants collaborate within a global ecosystem by reading the [Whitepaper describing the Catena-X operating model](https://catena-x.net/fileadmin/_online_media_/CX_Operating_Modelv2.1_final.pdf). + +Actors willing to use the Catena-X DCM standard, and start a collaboration with other supply chain partners enabled by an interoperable solution, can prepare asking the IT colleagues to check the following [End-to-End Adopter Journey](https://eclipse-tractusx.github.io/docs/tutorials/e2e/). + +## Roles + +Within DCM customer and supplier both act as data provider and data consumer. In order to execute the DCM process they utilize an application from the Catena-X marketplace, provided by a business application provider or they use their own custom in-house solution. + +### Data Providers and Data Consumers + +#### Onboarding + +![DCM_Onboarding](./resources/onboarding.svg) + +Figure: *DCM Onboarding* + +|#|Requirement|Further details| +|-|-|-| +|1|Subscribe to an Operating Company and get required credentials| [Cofinity-X Onboarding](https://www.cofinity-x.com/onboarding/)| +|2|Deploy a Catena-X certified dataspace connector|Depending on your adoption strategy you will buy the connector or you might have to develop and certify it yourself| +|3|Sign DCM Data Exchange Governance|Signed Data Exchange Governance with Operating Company is required to participate in the Catena-X Dataspace| +|4|Deploy a Catena-X certified business application|See adoption strategy table below| + +#### Adoption Strategy + +If you are interested in utilizing DCM within the Catena-X dataspace you can follow one of the following three approaches. + +|#|Approach|Details| +|-|-|-| +|A|CUSTOM|Adopt and integrate the business logic, aspect models and APIs, as described in the [DCM standard][StandardLibrary], yourself | +|B|FOSS|Adopt, customize and deploy an existing **F**ree and **O**pen **S**ource **S**oftware **S**olution| +|C|COTS|Purchase a certified **C**ommercial **O**ff **T**he **S**helf solution via the Catena-X marketplace, accessible through your operating company (e.g. [Cofinity-X Marketplace](https://www.cofinity-x.com/app-marketplace/))| + +### Business Application Providers + +#### Onboarding + +Business Application Providers that want to enable their commercial software for Catena-X DCM need to register for the Catena-X Ecosystem following the specific information described in [Offering a Catena-X Solution](https://catena-x.net/en/catena-x-introduce-implement/offering-a-catena-x-solution) (including next steps & contacts). + +Please refer to the [Catena-X Library][StandardLibrary] for the newest version of the DCM as well as other standards. + +### Software Developers + + + + + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 BearingPoint Holding B.V +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation + +[StandardLibrary]: https://catenax-ev.github.io/docs/next/standards/CX-0128-DemandandCapacityManagementDataExchange diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/overview.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/overview.md new file mode 100644 index 00000000000..55074691d55 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/overview.md @@ -0,0 +1,175 @@ +--- +id: overview +title: Adoption View +description: 'A first impression' +toc_min_heading_level: 2 +toc_max_heading_level: 2 +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## Vision & Mission + +The Catena-X-Standards for Demand- and Capacity-Management enable participants of the automotive supply chain to become more resilient and to increase the degree of collaboration aimed at avoiding or solving production bottlenecks as well as surplus situations in a tactical horizon of 1-2 years. + +Thereby the standards empower participants to share data in a secure and sovereign way while ensuring the interoperability of the different applications involved in the process. + +## Status Quo + +### Today's challenge for automotive companies + +Resilience has become imperative within Supply Chain Management, especially over the past years. With the growing complexity of supply chains and a rising number of global and local crises, small and medium enterprises (SMEs) as well as large enterprises (LEs) are facing an increased risk of serious disruptions in their supply chains, bullwhip effects and in the worst case even temporary production shutdowns with a high effort and costs of replanning. + +Inside the volatile and highly complex surroundings of the automotive industry nowadays, mostly tailor-made, proprietary and often fully manual IT solutions support the demand and capacity management processes along the value chain. On the one side there is no common understanding of these processes among the participants. On the other side, different data formats as well as application programming interfaces are used, which is increasing the complexity in the data exchange and which is leading to transfer problems, inconsistencies, or even loss of data. + +## Business Value + +### Why DCM KIT? + +The purpose and focus of Demand and Capacity Management (DCM) KIT is twofold: + +- Define a common understanding of the DCM process thus paving the way for more proactive and efficient collaboration. +- Establish process and application interoperability with the help of common semantics and unified interfaces for data exchange while ensuring the data sovereignty of data providers. + +Implementing the DCM standards will add the following core capabilities to business applications: + +- Provisioning and consumption of material demands data in a sovereign manner. +- Provisioning and consumption of capacity data in a sovereign manner. +- Discovery of bottlenecks and surplus capacity situations by employing a unified calculation logic. + +### POWER of STANDARD + +Standards create trust. Customer and Supplier can form new partnerships confidently. Knowing that integration in the network will be dramatically simplified. Standardization can help reduce costs by eliminating redundancies and streamlining processes. By adopting a common set of practices and technologies, businesses can avoid the need to develop their own proprietary systems, which can be expensive and time-consuming. + +### DATA SOVEREIGNTY in FOCUS + +DCM KIT keeps up with Catena X commitment to data sovereignty. This KIT has the goal to always comply with the data sovereignty principle implemented by the Eclipse Dataspace Connector. That enables all participants in the supply chain to always stay in full control of their own data. + +This is how sharing data is fun. + +### INTEROPERABILITY at its BEST + +Application and Service Provider can reduce investments to integrate DCM data models/API specification from DCM KIT. + +The Kit enables the offering of value-add services and innovation based on process description of the core business logic and how a collaborative approach is a win-win-situation for customer and supplier. + +### COLLABORATION is KEY + +The DCM KIT enables better and faster issue resolution. We believe that collaboration is the key to creating and maintaining strong partnerships between customers and suppliers and, at the same time, enhancing problem solving to reach a more balanced and efficient supply and demand management. + +Of course, by realizing efficiency through improved collaboration all involved partners will gain a competitive advantage over those that do not collaborate. + +## Semantic Models + +| Semantic Model | Link to GitHub Repository | +| ------------- | ------------- | +| WeekBasedCapacityGroup | | +| WeekBasedMaterialDemand | | +| IdBasedRequestForUpdate | | +| IdBasedComment | | + +## Logic / Schema + +The core of the DCM business process is about exchanging demand and capacity information, identifying problems and solving those problems. + +```mermaid +sequenceDiagram +autonumber +actor c as Customer +actor s as Supplier +rect rgb(221,130,0) +activate c +note left of c: Exchange demand information +c->>c: Manage own material demands +c->>s: Provide supplier with WeekBasedMaterialDemand +deactivate c +activate s +s->>s: Consume WeekBasedMaterialDemand +end +rect rgb(128,149,00) +note left of c: Exchange capacity information +s->>s: Manage own capacities +s->>s: Link consumed material demands to capacities within a WeekBasedCapacityGroup +s->>c: Provide Customer with WeekBasedCapacityGroup +activate c +c->>c: Consume WeekBasedCapacityGroup +end +rect rgb(04,107,153) +note left of c: Compare demands to capacity +autonumber 8 +c->>c: Compare WeekBasedMaterialDemand to WeekBasedCapacityGroup +autonumber 8 +s->>s: Compare WeekBasedMaterialDemand to WeekBasedCapacityGroup +autonumber 9 +c->>c: Identify bottlenecks +autonumber 9 +s->>s: Identify bottlenecks +autonumber 10 +c->>s: Resolve bottlenecks +autonumber 10 +s->>c: Resolve bottlenecks +deactivate c +deactivate s +end +``` + +Figure: *Core business process* + +## Business Process + +### Business Architecture + +![Supply network](./resources/business-architecture_network.svg) + +Figure: *Supply network* + +A supply network can be divided into a multitude of interlinking supply chains. Every supply chain consists of multiple chain links. Individual business partner relationships are these chain links. Data exchange conforming to [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary] always happens within such a chain link, ensuring that every company has full control over which data they provide. Demand information travels from one end of the supply chain to the other. For capacity information the situation is reversed. + +![Supply chain](./resources/business-architecture_chain.svg) + +Figure: *Supply chain* + +DCM allows for demand and capacity information to be exchanged only within the individual business relationship. However, because within a supply chain mist companies act as a "one-up" in one business relationship, while acting as a "one-down" withing the next business relationship, the impact of increasing or decreasing demand or capacity anywhere in the supply chain can safely travel through the chain, reaching every single impacted company. This is how DCM builds chains, while at the same time ensuring data sovereignty. + +### Access and Usage Policies + +Because of the way that communication within CX-0128 is defined companies are not exposing data but rather API endpoints for their business partners to push data to. These API endpoints are registered as EDC data assets. This means that from an information protection perspective data has to be actively provided, further ensuring data sovereignty. + + Conforming to [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary] the following policies have to be applied. + +| Category | Policy Name | Description |Usage recommendation| +|:---------|:------------|:------------|:-------------------| +| **Access Policy** | BPN-restricted Data Usage | Limit access to the data offered to a list of specified BPNs (to the connectors with the BPN attribute listed in the policy) |Limit access to assets to all your known business partners.| +| **Access Policy** | Membership Credential | Limit access to data offered to Catena-X participants |Use as is.| +| **Usage Policy** | DCM Framework Agreement Credential | Limit access to data offered to participants who have signed the DCM Framework Agreement |Use as is.| + +### Standards + +|Content|Standard|Version|Section|Description| +|-|-|-|-|-| +|DCM Business Logic|[CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]|2.1.0|5|Focuses on a common understanding of the DCM processes among participants.| +|DCM Aspect Models|[CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]|2.1.0|3|Aligns the structure of the shared information and enables the adoption of the core business logic without misinterpretation.| +|DCM APIs|[CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]|2.1.0|4|Ensures that data is provided and consumed properly as well as identically interpreted across companies.| +|Notification Process, Aspect Model and API|[CX-0146 Supply Chain Disruption Notifications][StandardLibrary]|1.0.0|*|Optional capability referenced in Section 5.10 of CX-0128. Focuses on quickly informing business partners of impactful events, where the impact cannot be precisely quantified yet.| + +## Frequently asked Questions + +In case of further questions, feel free to visit our [FAQ](./qna.md). + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation + +[StandardLibrary]: https://catenax-ev.github.io/docs/next/standards/CX-0128-DemandandCapacityManagementDataExchange diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/qna.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/qna.md new file mode 100644 index 00000000000..0a355266f4f --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/qna.md @@ -0,0 +1,115 @@ +--- +id: qna +title: Questions and Answers +description: Questions and Answers +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## General + +|#|Question|Answer| +|--|--|--| +|1|What is DCM?| DCM stands for Demand and Capacity Management. The Catena-X DCM standard describes a process for exchanging demand and capacity information as well as definition on how to exchange demand and capacity data electronically between companies.| +|2|Where can I read about DCM?|[This library][StandardLibrary] contains the released standards. The DCM standard has the ID CX-0128.| +|3|Are there translations of the DCM standard?|There are no official translations. Only the original standard, written in English, is normative.| +|4|Is there a standard “easy to read” DCM presentation available?|No, however the standard contains an abstract, which provides a management overview. The KIT itself is receiving regular updates.| +|5|What is the benefit of using DCM within the Catena-X dataspace instead of using my individual own process?| Adopting DCM, as defined by Catena-X, has the unique benefit of eliminating the need for defining process and technical interfaces individually with every one of your business partners. This allows you to execute demand and capacity management with every single one of your business partners in an identical manner, greatly reducing overhead.| +|6|Is there any step-by-step onboarding instruction?|Please have a look at [Catena-X: How to join us](https://catena-x.net/en/participate)| +|7|What are the needed steps for onboarding regarding the DCM standard?| Before beginning data exchange, the following conditions must be met:
- Customer and supplier must register with a Catena-X operational company and conform to the Catena-X guidelines
- Customer and supplier must have entered into a contract with each other
- Customer and supplier must sign framework agreements required by Catena-X
- Customer and supplier must have the technical capability to engage in the DCM process with their business applications. You can either enable and certify your IT-system to be Catena-X compliant, or use a certified DCM application.

You can receive onboarding support by Consultancy Services or Business Application Provider. The operating company has dedicated marketplaces for [certified services](https://www.cofinity-x.com/service-marketplace/) and [certified business applications](https://www.cofinity-x.com/app-marketplace/).| +|8|Do I need to be the part of Catena-X if I only want to use DCM?|Yes, joining the Catena-X dataspace (not the Catena-X Association) via an operating company is a prerequisite for participating in any Catena-X usecase.| +|9|Is Cofinity-X required for DCM? Or are there other possibilities?| Currently, Cofinity-X is the only operating company of the Catena-X dataspace and therefore registration at Cofinity-X is a prerequisite for data exchange.| +|10|Where can I get Catena-X related consultancy services|You can find Catena-X related consultancy services within the Cofinity-X [service marketplace](https://www.cofinity-x.com/service-marketplace/).| +|11|Who can support me with my onboarding?|The operating company provides [service](https://www.cofinity-x.com/service-marketplace/) and [application](https://www.cofinity-x.com/app-marketplace/) marketplaces where support is offered in form of certified services and certified business applications respectively.| +|12|How much does it cost to use DCM?|In order to evaluate the actual cost of participating in the DCM use case you have to compare cost vs gain.

Consider the following gains:
- Increased capacity utilization rate
- Reduced round trip times for information exchange
- Emerging network effects
- Common technical and business semantics
- Increased resiliency in the supply network

Consider the following costs:
- Onboarding with an operating company
- Reoccurring fees
- Adopting the DCM processes
- Adopting a DCM compatible application
- Adopting Catena-X dataspace compatible core infrastructure

The [Catena-X FAQ](https://catena-x.net/en/faq) has some insights into this as well.| + +



+ +## Accessibility + +|#|Question|Answer| +|--|--|--| +|1|What do I need to exchange data within DCM?|You need a Catena-X certified DCM solution, interfacing with an Eclipse Dataspace Connector (EDC) and a registration with an operating company, such as Cofinity-X.| +|2|Is EDC the same as EDI (Electronic Data Interchange)? Will I send the same messages via the same EDI portal?|EDC and EDI are completely different and not interoperable. You will have to exchange data via a Catena-X certified solution.| +|3|Do I need to connect my internal systems to the Catena-X dataspace?|It is not required to connect your internal systems to the Catena-X dataspace. The EDC acts as a gateway for all your communication to and from the dataspace.| +|4|How is my data protected when I utilize DCM via the Catena-X dataspace?|From a business perspective:
Shared data is protected, because companies and business applications participating in the dataspace have to be certified. As part of the on-boarding process companies do sign framework agreements providing a basis for legal protection.

From a technical perspective: The EDC enforces this legal basis, via policy enforcement and contract negotiation, ultimately leading to data sovereignty.| +|5|I participate in another Catena-X use case, will it simplify my access to the DCM use case and maybe even reduce my onboarding costs?|Yes, it will. Nearly all Catena-X use cases share a common infrastructure. Having an EDC in place and being already registered with an operating company,having assigned BPNL and BPNS, as well as a working wallet will reduce the on-boarding time and cost for DCM| +|6|How often are Catena-X standards and in particular the DCM standard updated?|Catena-X standards can be updated on a quarterly basis, with breaking changes being allowed once a year. The DCM expert group is committed to introducing new features to the DCM standard without incurring breaking changes. Additionally Catena-X is committed to ensuring backwards compatibility of the two most recent major releases. This means that a particular standard version will be valid for at least two years.| +|7|When a new version of the DCM standard is released, do I as a user need to re-install anything or implement any technical changes?|Usually standards are released six months before they are rolled out into the Catena-X dataspace. Within those six months infrastructure, applications etc. need to be updated, if a breaking change was introduced. However this is not handled by individual users, but rather by IT-departments and applications providers.| + +



+ +## Practical - General + +|#|Question|Answer| +|--|--|--| +|1|Which time granularity and horizon is used within DCM?|Demand and capacity data within DCM is distributed into weekly buckets. There is no technical limitation when it comes to the horizon. Typically data is shared starting from two weeks up to two years into the future.| +|2|I own a small company and do my planning in an Excel spreadsheet, can I still use the DCM Standard?|Yes, you can. While there are certain pre-requisites to DCM it does not restrict you to a specific planning tool.| +|3|Can I directly send my data from Excel into the Catena-X dataspace?|No, you either require a business application that supports Excel upload or use the open source [Simple Data Exchanger](https://github.com/eclipse-tractusx/managed-simple-data-exchanger), as soon as it supports DCM.| +|4|I run my MRP (Material Requirements Planning) only once a month, can I still use DCM?|Yes, you can. DCM relies mainly on PUSH communication. Just PUSH your data to your partners after you have done your MRP. In addition DCM supports request for update, allowing you or your partners to request an update on demand and capacity data at any time. (e.g. before and after counting all your stock)| +|5|Is there any industry DCM isn´t suitable for?|The standard was primarily developed by the automotive industry, but is not restricted to it. The core business process of DCM applies to most industries.| +|6|Does DCM support sharing capacity and demand data between companies that are not direct business partners? (e.g. tier 5 and OEM)| The standard restricts data exchange to companies that are in a direct business relationship as customer and supplier (One-up one-down). By solving or reducing potential bottlenecks within those one-up one-down relationships, the problems that are forwarded to your further-ups and further-downs get smaller and smaller, with every tier-level. In order for everyone to benefit the most from this setup you should encourage your tier-n business partners to join the Catena-X dataspace as well.| +|7|Will there be any alarm or notification if data entered is incorrectly or incompletely?|From a technical perspective:
Certified applications implementing the DCM standard are required to do payload validation, checking the semantics and technical completeness of the data. However this does not protect from users entering a demand quantity that is comically high.

From a business perspective:
Yes, but the degree of protection depends on the business application you use and on how it handles user input validation. The DCM standard only defines basic payload validation.| +|8|Does DCM automatically keep historical data?|The dataspace itself does not historicise data for you. Neither does the DCM standard define how to historicise data. If you want to keep historic records your chosen DCM application needs to support this. Please be aware that, for data sovereignty reasons, you must not blindly historicise all data, but have to comply with the data exchange contracts and policies negotiated via EDC.| +|9|Am I allowed to store demand and capacity data shared via the Catena-X dataspace in my local backend systems and am I allowed to work with the data?|You can store, forward and transform the data as long as you ensure enforcement of the attached policies and contracts, guaranteeing data sovereignty within Catena-X.| +|10|How does DCM ensure data quality?|The standard defines mandatory properties and payload validation for `WeekBasedMaterialDemand` and `WeekBasedCapacityGroup` as well as an aligned business process that pushes for quality. In combination with framework agreements and only allowing certified companies as well solutions into the Catena-X dataspace data quality can be considered a given. In addition suppliers can make use of the feature demand volatility metric to educate twitchy customers.| + +



+ +## Practical - Customer specific + +|#|Question|Answer| +|--|--|--| +|1|Can I receive capacity data for a whole family of materials (All screws) instead of a single material (Screw P6766000001140000) |The material number of the customer is one aspect that makes the material demand unique. As a customer you will always receive capacity data referencing your material number. If your material number does not represent a single part, but rather a part family, you will receive capacity data related to that.

Alternatively your supplier can link all material demands that relate to a part family to one capacity group and than provide you with a capacity for all linked materials.| +|2|I do have multiple assembly locations utilizing the same part. Will my supplier be able to provide capacity information for each individual assembly location?|Yes, he will. Suppliers structure capacity groups at their own discretion and the customer location is one aspect that makes a material demand unique. This means the supplier can provide you with one capacity group for all your locations, one capacity group for each location or anything in between, depending on your business needs.| +|3|Do I have to share my demands part by part or is some kind of batch upload possible?|From a business perspective:
As a customer you share your material demands on a material number basis, meaning that if you want to communicate the demand for twelve material numbers you need to provide your supplier with twelve `WeekBasedMaterialDemand` objects. However this is just what happens under the hood. If you utilize a business application tailored to your needs, batch processing is feasible, especially if you ensure that there are no gaps in the demand time series.

From a technical perspective:
A single data transfer can contain multiple information objects of the same type, such as `WeekBasedMaterialDemand`. Interfacing DCM with your demand planning software should allow for a highly automated data exchange pipeline, greatly reducing the amount of manual data interaction, business has to execute.| +|4|My suppliers are only willing to share customer specific capacity data such as allocations. Can I still use DCM?| From a business perspective:
Yes, you can. Within DCM data is exchanged only within direct business relationships and only between two companies anyways. If your demand is higher than the capacity allocated by your suppliers this is considered a bottleneck and should result in collaboration.

From a technical perspective:
Suppliers can share actual, maximum and agreed capacity with their customers. The shared values are always customer specific.

| + +



+ +## Practical - Material Demand specific + +|#|Question|Answer| +|--|--|--| +|1|How often do I need to share my demand data?|It is recommended to provide your suppliers with an updated `WeekBasedMaterialDemand` every time your demand changes. How often that is entirely depends on your internal processes, but the standards recommends to send an updated `WeekBasedMaterialDemand` at least monthly, even if the demand quantities themselves did not change.| +|2|Do I have to include a demand category?|Demand category is a mandatory property and needs to be included with every `WeekBasedMaterialDemand`. However you can simply set it to the value `default` without further elaboration. | + +



+ +## Practical - Supplier specific + +|#|Question|Answer| +|--|--|--| +|1|If I receive a demand forecast where some materials (parts) have no demand quantity or a demand quantity of zero, will I still be able to share my available capacity for those materials?|Yes, as long as you are aware of a material (part) you can share your capacity in regards to the material, completely independent of what the actual demand values of your customer are.| +|2|Do I have to share my capacities part by part or is some kind of batch upload possible?|From a business perspective:
As a supplier you can link multiple material demands to a single capacity group. Of course you should only do this, if those materials share a common capacity. If all material demands of a specific customer share a capacity, then only one data transfer to that customer is required. This means you need at least one data transfer per customer to share all your capacities.

From a technical perspective:
A single data transfer can contain multiple information objects of the same type, such as `WeekBasedCapacityGroup`. Interfacing DCM with your capacity planning software should allow for a highly automated data exchange pipeline, greatly reducing the amount of manual data interaction, business has to execute.| +|3|If I do receive material demands for 100 different parts, do I have to also provide capacity data for all 100 parts? |From a business perspective it is certainly wise to provide capacity data for every material that is part of existing contractual obligations with the customer that did send you the material demand. | +|4|Some materials I am producing for my customer load my production line differently than other materials, can I still include them in the same capacity group?|Yes, DCM supports load factors that can address this issue by expressing how much a particular material loads your production line compared to another material. It also allows you to convert all calculations to cycles or seconds, which is useful if materials using different unit of measures have to be part of the same capacity group.| +|5|Some of my customers demand data is highly volatile, can DCM help me with this issue? |Yes, DCM supports demand volatility metrics, which allow you to communicate to your customer that you are measuring volatility as well as define acceptable deviations.| +|6|Sometimes I produce materials in advance to use them later on to fulfill my customers demand. Can DCM reflect this?|Yes DCM supports simulated delta production, allowing you to close the demand-capacity gap via post- and pre-production.| +|7|I am going to add another production line, expanding my output. How should I reflect this within DCM?| This increase in potential output should lead to an increase in maximum capacity, starting from the date the increased output is available. It may as well be reflected in the actual capacity, if the demand justifies to utilize this newly increased potential output.| +|8|Does the standard allow me to submit structured action plans to my customers? | The standard allows for the exchange of capacity data as well as comments. By combining both you can for example introduce pre-production as well as a weekend-shifts and comment into the specific weeks the remaining details. Actual action plans are considered mostly customer specific and are more likely to be managed in a customer specific portal.| +|9|Some of my customers are direct competitors. How should this situation be reflected in DCM?|From a legal perspective:
Ask a corporate lawyer familiar with every jurisdiction that applies to your specific case.

From a business perspective:
Data exchanged within DCM is always happening in a direct one to one business relationship. There is no situation, where more than two companies share the same information objects (`WeekBasedCapacityGroup`, `WeekBasedMaterialDemand`). As a supplier you provide your customer A the capacity data he needs within the business relationship `You - Customer A` and customer B with the data needs within the business relationship `You - Customer B`, meaning you keep them completely separate.| + +



+ +## Practical - Capacity Group specific + +|#|Question|Answer| +|--|--|--| +|1|How often do I need to share my capacity data?|It is recommended to provide your customers with an updated `WeekBasedCapacityGroup` every time your capacity changes. How often that is entirely depends on your internal processes.| +|2|Should there be one capacity group for every individual material demand?|The supplier has full flexibility when it comes to linking material demands to capacity groups. If the supplier has one dedicated assembly line per part, than the most likely scenario is one capacity group per part. However even then, logistics might be a common bottleneck for all assembly lines and therefore parts, resulting in one capacity group for all parts. Suppliers should structure capacity groups to reflect their real life bottleneck situation for the greatest benefit.| +|3|Should there be one capacity group with all material demands linked to it?|The supplier has full flexibility when it comes to linking material demands to capacity groups. If all parts manufactured by the supplier share a common bottleneck (e.g. the painting station), then the most likely scenario is one capacity group for all parts. However, even then, the painting station might have a throughout so high, that it is no bottleneck at all, resulting in a different capacity group makeup. Suppliers should structure capacity groups to reflect their real life bottleneck situation for the greatest benefit.| + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 CatX Service GmbH +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 Stellantis N.V. +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation + +[StandardLibrary]: https://catenax-ev.github.io/docs/next/standards/CX-0128-DemandandCapacityManagementDataExchange diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/resources/business-architecture_chain.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/resources/business-architecture_chain.svg new file mode 100644 index 00000000000..95953059c67 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/resources/business-architecture_chain.svg @@ -0,0 +1,2490 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Zeichenblatt-1 + + + + + + + Hauptsitz + OEM + + Tabelle.4 + + + + Tabelle.5 + + + + Tabelle.6 + + + + Tabelle.7 + + + + Tabelle.8 + + + + Tabelle.9 + + + + Tabelle.10 + + + + Tabelle.11 + + + + Tabelle.12 + + + + Tabelle.13 + + + + Tabelle.14 + + + + Tabelle.15 + + Tabelle.16 + + + + Tabelle.17 + + + + Tabelle.18 + + + + Tabelle.19 + + + + Tabelle.20 + + + + Tabelle.21 + + + + Tabelle.22 + + + + + Tabelle.23 + + + + Tabelle.24 + + + + Tabelle.25 + + Tabelle.26 + + + + Tabelle.27 + + + + Tabelle.28 + + + + Tabelle.29 + + + + Tabelle.30 + + + + Tabelle.31 + + + + Tabelle.32 + + + + Tabelle.33 + + + + Tabelle.34 + + + + + Tabelle.35 + + + + Tabelle.36 + + + + Tabelle.37 + + + + Tabelle.38 + + + + Tabelle.39 + + + + Tabelle.40 + + + + Tabelle.41 + + + + Tabelle.42 + + + + Tabelle.43 + + + + Tabelle.44 + + + + Tabelle.45 + + + + Tabelle.46 + + + + Tabelle.47 + + + + Tabelle.48 + + + + Tabelle.49 + + + + + + OEM + + + + + + Hauptsitz.95 + Tier 1 + + Tabelle.96 + + + + Tabelle.97 + + + + Tabelle.98 + + + + Tabelle.99 + + + + Tabelle.100 + + + + Tabelle.101 + + + + Tabelle.102 + + + + Tabelle.103 + + + + Tabelle.104 + + + + Tabelle.105 + + + + Tabelle.106 + + + + Tabelle.107 + + Tabelle.108 + + + + Tabelle.109 + + + + Tabelle.110 + + + + Tabelle.111 + + + + Tabelle.112 + + + + Tabelle.113 + + + + Tabelle.114 + + + + + Tabelle.115 + + + + Tabelle.116 + + + + Tabelle.117 + + Tabelle.118 + + + + Tabelle.119 + + + + Tabelle.120 + + + + Tabelle.121 + + + + Tabelle.122 + + + + Tabelle.123 + + + + Tabelle.124 + + + + Tabelle.125 + + + + Tabelle.126 + + + + + Tabelle.127 + + + + Tabelle.128 + + + + Tabelle.129 + + + + Tabelle.130 + + + + Tabelle.131 + + + + Tabelle.132 + + + + Tabelle.133 + + + + Tabelle.134 + + + + Tabelle.135 + + + + Tabelle.136 + + + + Tabelle.137 + + + + Tabelle.138 + + + + Tabelle.139 + + + + Tabelle.140 + + + + Tabelle.141 + + + + + + Tier 1 + + + + + + Hauptsitz.142 + Tier 2 + + Tabelle.143 + + + + Tabelle.144 + + + + Tabelle.145 + + + + Tabelle.146 + + + + Tabelle.147 + + + + Tabelle.148 + + + + Tabelle.149 + + + + Tabelle.150 + + + + Tabelle.151 + + + + Tabelle.152 + + + + Tabelle.153 + + + + Tabelle.154 + + Tabelle.155 + + + + Tabelle.156 + + + + Tabelle.157 + + + + Tabelle.158 + + + + Tabelle.159 + + + + Tabelle.160 + + + + Tabelle.161 + + + + + Tabelle.162 + + + + Tabelle.163 + + + + Tabelle.164 + + Tabelle.165 + + + + Tabelle.166 + + + + Tabelle.167 + + + + Tabelle.168 + + + + Tabelle.169 + + + + Tabelle.170 + + + + Tabelle.171 + + + + Tabelle.172 + + + + Tabelle.173 + + + + + Tabelle.174 + + + + Tabelle.175 + + + + Tabelle.176 + + + + Tabelle.177 + + + + Tabelle.178 + + + + Tabelle.179 + + + + Tabelle.180 + + + + Tabelle.181 + + + + Tabelle.182 + + + + Tabelle.183 + + + + Tabelle.184 + + + + Tabelle.185 + + + + Tabelle.186 + + + + Tabelle.187 + + + + Tabelle.188 + + + + + + Tier 2 + + + + + + Hauptsitz.189 + Tier 3 + + Tabelle.190 + + + + Tabelle.191 + + + + Tabelle.192 + + + + Tabelle.193 + + + + Tabelle.194 + + + + Tabelle.195 + + + + Tabelle.196 + + + + Tabelle.197 + + + + Tabelle.198 + + + + Tabelle.199 + + + + Tabelle.200 + + + + Tabelle.201 + + Tabelle.202 + + + + Tabelle.203 + + + + Tabelle.204 + + + + Tabelle.205 + + + + Tabelle.206 + + + + Tabelle.207 + + + + Tabelle.208 + + + + + Tabelle.209 + + + + Tabelle.210 + + + + Tabelle.211 + + Tabelle.212 + + + + Tabelle.213 + + + + Tabelle.214 + + + + Tabelle.215 + + + + Tabelle.216 + + + + Tabelle.217 + + + + Tabelle.218 + + + + Tabelle.219 + + + + Tabelle.220 + + + + + Tabelle.221 + + + + Tabelle.222 + + + + Tabelle.223 + + + + Tabelle.224 + + + + Tabelle.225 + + + + Tabelle.226 + + + + Tabelle.227 + + + + Tabelle.228 + + + + Tabelle.229 + + + + Tabelle.230 + + + + Tabelle.231 + + + + Tabelle.232 + + + + Tabelle.233 + + + + Tabelle.234 + + + + Tabelle.235 + + + + + + Tier 3 + + + Dynamischer Verbinder + Demand + + + + + Demand + + Dynamischer Verbinder.237 + Capacity + + + + + Capacity + + Dynamischer Verbinder.238 + Demand + + + + + Demand + + Dynamischer Verbinder.239 + Capacity + + + + + Capacity + + Dynamischer Verbinder.240 + Demand + + + + + Demand + + Dynamischer Verbinder.241 + Capacity + + + + + Capacity + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Geschweifte Klammern-Intervall + + Tabelle.249 + + + Tabelle.250 + + + + Tabelle.251 + + + + Tabelle.252 + + + + + + + + + + + + + + + + + Tabelle.253 + + + + + + + + + + + + + + + Tabelle.254 + + + + + + + + + Tabelle.255 + + + + Tabelle.256 + + + Tabelle.257 + - + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.258 + Relationship A + + + + + + + + + + + + + + + + + + + + + + + Relationship A + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Geschweifte Klammern-Intervall.270 + + Tabelle.271 + + + Tabelle.272 + + + + Tabelle.273 + + + + Tabelle.274 + + + + + + + + + + + + + + + + + Tabelle.275 + + + + + + + + + + + + + + + Tabelle.276 + + + + + + + + + Tabelle.277 + + + + Tabelle.278 + + + Tabelle.279 + - + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.280 + Relationship B + + + + + + + + + + + + + + + + + + + + + + + Relationship B + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Geschweifte Klammern-Intervall.281 + + Tabelle.282 + + + Tabelle.283 + + + + Tabelle.284 + + + + Tabelle.285 + + + + + + + + + + + + + + + + + Tabelle.286 + + + + + + + + + + + + + + + Tabelle.287 + + + + + + + + + Tabelle.288 + + + + Tabelle.289 + + + Tabelle.290 + - + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.291 + Relationship C + + + + + + + + + + + + + + + + + + + + + + + Relationship C + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Geschweifte Klammern-Intervall.296 + + Tabelle.297 + + + Tabelle.298 + + + + Tabelle.299 + + + + Tabelle.300 + + + + + + + + + + + + + + + + + + + + + Tabelle.301 + + + + + + + + + + + + + + + + + + + Tabelle.302 + + + + + + + + + Tabelle.303 + + + + Tabelle.304 + + + Tabelle.305 + - + + + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.306 + Demand dA1 .. dA(n) Capacity cA1.. cA(n) + + + + + + + + + + + + + + + + + + + + + + + + + Demand dA1 .. dA(n)Capacity cA1.. cA(n) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Geschweifte Klammern-Intervall.308 + + Tabelle.309 + + + Tabelle.310 + + + + Tabelle.311 + + + + Tabelle.312 + + + + + + + + + + + + + + + + + + + + + Tabelle.313 + + + + + + + + + + + + + + + + + + + Tabelle.314 + + + + + + + + + Tabelle.315 + + + + Tabelle.316 + + + Tabelle.317 + - + + + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.318 + Demand dB1 .. dB(n) Capacity cB1.. cB(n) + + + + + + + + + + + + + + + + + + + + + + + + + Demand dB1 .. dB(n)Capacity cB1.. cB(n) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Geschweifte Klammern-Intervall.319 + + Tabelle.320 + + + Tabelle.321 + + + + Tabelle.322 + + + + Tabelle.323 + + + + + + + + + + + + + + + + + + + + + Tabelle.324 + + + + + + + + + + + + + + + + + + + Tabelle.325 + + + + + + + + + Tabelle.326 + + + + Tabelle.327 + + + Tabelle.328 + - + + + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.329 + Demand dC1 .. dC(n) Capacity cC1.. cC(n) + + + + + + + + + + + + + + + + + + + + + + + + + Demand dC1 .. dC(n)Capacity cC1.. cC(n) + + + diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/resources/business-architecture_chain.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/resources/business-architecture_chain.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/resources/business-architecture_chain.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/resources/business-architecture_network.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/resources/business-architecture_network.svg new file mode 100644 index 00000000000..3e2e9d7d65f --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/resources/business-architecture_network.svg @@ -0,0 +1,2853 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Zeichenblatt-1 + + + + + + + Hauptsitz + OEM + + Tabelle.4 + + + + Tabelle.5 + + + + Tabelle.6 + + + + Tabelle.7 + + + + Tabelle.8 + + + + Tabelle.9 + + + + Tabelle.10 + + + + Tabelle.11 + + + + Tabelle.12 + + + + Tabelle.13 + + + + Tabelle.14 + + + + Tabelle.15 + + Tabelle.16 + + + + Tabelle.17 + + + + Tabelle.18 + + + + Tabelle.19 + + + + Tabelle.20 + + + + Tabelle.21 + + + + Tabelle.22 + + + + + Tabelle.23 + + + + Tabelle.24 + + + + Tabelle.25 + + Tabelle.26 + + + + Tabelle.27 + + + + Tabelle.28 + + + + Tabelle.29 + + + + Tabelle.30 + + + + Tabelle.31 + + + + Tabelle.32 + + + + Tabelle.33 + + + + Tabelle.34 + + + + + Tabelle.35 + + + + Tabelle.36 + + + + Tabelle.37 + + + + Tabelle.38 + + + + Tabelle.39 + + + + Tabelle.40 + + + + Tabelle.41 + + + + Tabelle.42 + + + + Tabelle.43 + + + + Tabelle.44 + + + + Tabelle.45 + + + + Tabelle.46 + + + + Tabelle.47 + + + + Tabelle.48 + + + + Tabelle.49 + + + + + + OEM + + + + + + Hauptsitz.95 + Tier 1 + + Tabelle.96 + + + + Tabelle.97 + + + + Tabelle.98 + + + + Tabelle.99 + + + + Tabelle.100 + + + + Tabelle.101 + + + + Tabelle.102 + + + + Tabelle.103 + + + + Tabelle.104 + + + + Tabelle.105 + + + + Tabelle.106 + + + + Tabelle.107 + + Tabelle.108 + + + + Tabelle.109 + + + + Tabelle.110 + + + + Tabelle.111 + + + + Tabelle.112 + + + + Tabelle.113 + + + + Tabelle.114 + + + + + Tabelle.115 + + + + Tabelle.116 + + + + Tabelle.117 + + Tabelle.118 + + + + Tabelle.119 + + + + Tabelle.120 + + + + Tabelle.121 + + + + Tabelle.122 + + + + Tabelle.123 + + + + Tabelle.124 + + + + Tabelle.125 + + + + Tabelle.126 + + + + + Tabelle.127 + + + + Tabelle.128 + + + + Tabelle.129 + + + + Tabelle.130 + + + + Tabelle.131 + + + + Tabelle.132 + + + + Tabelle.133 + + + + Tabelle.134 + + + + Tabelle.135 + + + + Tabelle.136 + + + + Tabelle.137 + + + + Tabelle.138 + + + + Tabelle.139 + + + + Tabelle.140 + + + + Tabelle.141 + + + + + + Tier 1 + + + + + + Hauptsitz.142 + Tier 2 + + Tabelle.143 + + + + Tabelle.144 + + + + Tabelle.145 + + + + Tabelle.146 + + + + Tabelle.147 + + + + Tabelle.148 + + + + Tabelle.149 + + + + Tabelle.150 + + + + Tabelle.151 + + + + Tabelle.152 + + + + Tabelle.153 + + + + Tabelle.154 + + Tabelle.155 + + + + Tabelle.156 + + + + Tabelle.157 + + + + Tabelle.158 + + + + Tabelle.159 + + + + Tabelle.160 + + + + Tabelle.161 + + + + + Tabelle.162 + + + + Tabelle.163 + + + + Tabelle.164 + + Tabelle.165 + + + + Tabelle.166 + + + + Tabelle.167 + + + + Tabelle.168 + + + + Tabelle.169 + + + + Tabelle.170 + + + + Tabelle.171 + + + + Tabelle.172 + + + + Tabelle.173 + + + + + Tabelle.174 + + + + Tabelle.175 + + + + Tabelle.176 + + + + Tabelle.177 + + + + Tabelle.178 + + + + Tabelle.179 + + + + Tabelle.180 + + + + Tabelle.181 + + + + Tabelle.182 + + + + Tabelle.183 + + + + Tabelle.184 + + + + Tabelle.185 + + + + Tabelle.186 + + + + Tabelle.187 + + + + Tabelle.188 + + + + + + Tier 2 + + + + + + Hauptsitz.189 + Tier 3 + + Tabelle.190 + + + + Tabelle.191 + + + + Tabelle.192 + + + + Tabelle.193 + + + + Tabelle.194 + + + + Tabelle.195 + + + + Tabelle.196 + + + + Tabelle.197 + + + + Tabelle.198 + + + + Tabelle.199 + + + + Tabelle.200 + + + + Tabelle.201 + + Tabelle.202 + + + + Tabelle.203 + + + + Tabelle.204 + + + + Tabelle.205 + + + + Tabelle.206 + + + + Tabelle.207 + + + + Tabelle.208 + + + + + Tabelle.209 + + + + Tabelle.210 + + + + Tabelle.211 + + Tabelle.212 + + + + Tabelle.213 + + + + Tabelle.214 + + + + Tabelle.215 + + + + Tabelle.216 + + + + Tabelle.217 + + + + Tabelle.218 + + + + Tabelle.219 + + + + Tabelle.220 + + + + + Tabelle.221 + + + + Tabelle.222 + + + + Tabelle.223 + + + + Tabelle.224 + + + + Tabelle.225 + + + + Tabelle.226 + + + + Tabelle.227 + + + + Tabelle.228 + + + + Tabelle.229 + + + + Tabelle.230 + + + + Tabelle.231 + + + + Tabelle.232 + + + + Tabelle.233 + + + + Tabelle.234 + + + + Tabelle.235 + + + + + + Tier 3 + + + Dynamischer Verbinder.237 + + + + Dynamischer Verbinder.239 + + + + Dynamischer Verbinder.241 + + + + + + + Hauptsitz.242 + + Tabelle.243 + + + + Tabelle.244 + + + + Tabelle.245 + + + + Tabelle.246 + + + + Tabelle.247 + + + + Tabelle.248 + + + + Tabelle.249 + + + + Tabelle.250 + + + + Tabelle.251 + + + + Tabelle.252 + + + + Tabelle.253 + + + + Tabelle.254 + + Tabelle.255 + + + + Tabelle.256 + + + + Tabelle.257 + + + + Tabelle.258 + + + + Tabelle.259 + + + + Tabelle.260 + + + + Tabelle.261 + + + + + Tabelle.262 + + + + Tabelle.263 + + + + Tabelle.264 + + Tabelle.265 + + + + Tabelle.266 + + + + Tabelle.267 + + + + Tabelle.268 + + + + Tabelle.269 + + + + Tabelle.270 + + + + Tabelle.271 + + + + Tabelle.272 + + + + Tabelle.273 + + + + + Tabelle.274 + + + + Tabelle.275 + + + + Tabelle.276 + + + + Tabelle.277 + + + + Tabelle.278 + + + + Tabelle.279 + + + + Tabelle.280 + + + + Tabelle.281 + + + + Tabelle.282 + + + + Tabelle.283 + + + + Tabelle.284 + + + + Tabelle.285 + + + + Tabelle.286 + + + + Tabelle.287 + + + + Tabelle.288 + + + + + + + + Hauptsitz.289 + + Tabelle.290 + + + + Tabelle.291 + + + + Tabelle.292 + + + + Tabelle.293 + + + + Tabelle.294 + + + + Tabelle.295 + + + + Tabelle.296 + + + + Tabelle.297 + + + + Tabelle.298 + + + + Tabelle.299 + + + + Tabelle.300 + + + + Tabelle.301 + + Tabelle.302 + + + + Tabelle.303 + + + + Tabelle.304 + + + + Tabelle.305 + + + + Tabelle.306 + + + + Tabelle.307 + + + + Tabelle.308 + + + + + Tabelle.309 + + + + Tabelle.310 + + + + Tabelle.311 + + Tabelle.312 + + + + Tabelle.313 + + + + Tabelle.314 + + + + Tabelle.315 + + + + Tabelle.316 + + + + Tabelle.317 + + + + Tabelle.318 + + + + Tabelle.319 + + + + Tabelle.320 + + + + + Tabelle.321 + + + + Tabelle.322 + + + + Tabelle.323 + + + + Tabelle.324 + + + + Tabelle.325 + + + + Tabelle.326 + + + + Tabelle.327 + + + + Tabelle.328 + + + + Tabelle.329 + + + + Tabelle.330 + + + + Tabelle.331 + + + + Tabelle.332 + + + + Tabelle.333 + + + + Tabelle.334 + + + + Tabelle.335 + + + + + + + + Hauptsitz.336 + + Tabelle.337 + + + + Tabelle.338 + + + + Tabelle.339 + + + + Tabelle.340 + + + + Tabelle.341 + + + + Tabelle.342 + + + + Tabelle.343 + + + + Tabelle.344 + + + + Tabelle.345 + + + + Tabelle.346 + + + + Tabelle.347 + + + + Tabelle.348 + + Tabelle.349 + + + + Tabelle.350 + + + + Tabelle.351 + + + + Tabelle.352 + + + + Tabelle.353 + + + + Tabelle.354 + + + + Tabelle.355 + + + + + Tabelle.356 + + + + Tabelle.357 + + + + Tabelle.358 + + Tabelle.359 + + + + Tabelle.360 + + + + Tabelle.361 + + + + Tabelle.362 + + + + Tabelle.363 + + + + Tabelle.364 + + + + Tabelle.365 + + + + Tabelle.366 + + + + Tabelle.367 + + + + + Tabelle.368 + + + + Tabelle.369 + + + + Tabelle.370 + + + + Tabelle.371 + + + + Tabelle.372 + + + + Tabelle.373 + + + + Tabelle.374 + + + + Tabelle.375 + + + + Tabelle.376 + + + + Tabelle.377 + + + + Tabelle.378 + + + + Tabelle.379 + + + + Tabelle.380 + + + + Tabelle.381 + + + + Tabelle.382 + + + + + + + + Hauptsitz.383 + + Tabelle.384 + + + + Tabelle.385 + + + + Tabelle.386 + + + + Tabelle.387 + + + + Tabelle.388 + + + + Tabelle.389 + + + + Tabelle.390 + + + + Tabelle.391 + + + + Tabelle.392 + + + + Tabelle.393 + + + + Tabelle.394 + + + + Tabelle.395 + + Tabelle.396 + + + + Tabelle.397 + + + + Tabelle.398 + + + + Tabelle.399 + + + + Tabelle.400 + + + + Tabelle.401 + + + + Tabelle.402 + + + + + Tabelle.403 + + + + Tabelle.404 + + + + Tabelle.405 + + Tabelle.406 + + + + Tabelle.407 + + + + Tabelle.408 + + + + Tabelle.409 + + + + Tabelle.410 + + + + Tabelle.411 + + + + Tabelle.412 + + + + Tabelle.413 + + + + Tabelle.414 + + + + + Tabelle.415 + + + + Tabelle.416 + + + + Tabelle.417 + + + + Tabelle.418 + + + + Tabelle.419 + + + + Tabelle.420 + + + + Tabelle.421 + + + + Tabelle.422 + + + + Tabelle.423 + + + + Tabelle.424 + + + + Tabelle.425 + + + + Tabelle.426 + + + + Tabelle.427 + + + + Tabelle.428 + + + + Tabelle.429 + + + + + + + + Hauptsitz.430 + + Tabelle.431 + + + + Tabelle.432 + + + + Tabelle.433 + + + + Tabelle.434 + + + + Tabelle.435 + + + + Tabelle.436 + + + + Tabelle.437 + + + + Tabelle.438 + + + + Tabelle.439 + + + + Tabelle.440 + + + + Tabelle.441 + + + + Tabelle.442 + + Tabelle.443 + + + + Tabelle.444 + + + + Tabelle.445 + + + + Tabelle.446 + + + + Tabelle.447 + + + + Tabelle.448 + + + + Tabelle.449 + + + + + Tabelle.450 + + + + Tabelle.451 + + + + Tabelle.452 + + Tabelle.453 + + + + Tabelle.454 + + + + Tabelle.455 + + + + Tabelle.456 + + + + Tabelle.457 + + + + Tabelle.458 + + + + Tabelle.459 + + + + Tabelle.460 + + + + Tabelle.461 + + + + + Tabelle.462 + + + + Tabelle.463 + + + + Tabelle.464 + + + + Tabelle.465 + + + + Tabelle.466 + + + + Tabelle.467 + + + + Tabelle.468 + + + + Tabelle.469 + + + + Tabelle.470 + + + + Tabelle.471 + + + + Tabelle.472 + + + + Tabelle.473 + + + + Tabelle.474 + + + + Tabelle.475 + + + + Tabelle.476 + + + + + Dynamischer Verbinder.477 + + + + Dynamischer Verbinder.478 + + + + Dynamischer Verbinder.479 + + + + Dynamischer Verbinder.480 + + + + Dynamischer Verbinder.481 + + + + Dynamischer Verbinder.482 + + + + Dynamischer Verbinder.483 + + + + Dynamischer Verbinder.484 + + + + Dynamischer Verbinder.485 + + + + diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/resources/business-architecture_network.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/resources/business-architecture_network.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/resources/business-architecture_network.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/resources/compare-md-cg.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/resources/compare-md-cg.svg new file mode 100644 index 00000000000..14620ec2fef --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/resources/compare-md-cg.svg @@ -0,0 +1,3 @@ + + +Example: Demand and Capacity Data Matching and Comparison within Capacity GroupWeek1Week2Week3Week4Week5Week6Week7Week8600055005000450040003500300025002000150010005000. \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/resources/compare-md-cg.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/resources/compare-md-cg.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/resources/compare-md-cg.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/resources/onboarding.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/resources/onboarding.svg new file mode 100644 index 00000000000..870c6b749c9 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/resources/onboarding.svg @@ -0,0 +1 @@ +Operating Company (e.g.Cofinity-X)BusinessApplicationProviderRegister at operating company(e.g.Cofinity-X)My CompanyRequest BPNL (& BPNS if required),where needed (1 or 2)Create & send BPNL(& BPNS if required) and SSI WalletDevelop own EDC (CUSTOM)Use EDC (COTS) as SaaSCOnboard Company to NetworkSign DCM Data Exchange Governance withOperating CompanyReceive DCM Data Exchange GovernanceGet DCM application (COTS)1234AGet EDC (FOSS)Deploy a Catena-X certified Data spaceconnectorDeploy a Catena-X certified businessapplicationDevelop own application(CUSTOM)CABGet DCM application (FOSS)B \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/resources/onboarding.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/resources/onboarding.svg.license new file mode 100644 index 00000000000..f19735e6804 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/resources/onboarding.svg.license @@ -0,0 +1,10 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 BASF SE +- SPDX-FileCopyrightText: 2024 BearingPoint Holding B.V +- SPDX-FileCopyrightText: 2024 SAP SE +- SPDX-FileCopyrightText: 2024 SupplyOn AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/business-process.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/business-process.md new file mode 100644 index 00000000000..392dae2b32c --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/business-process.md @@ -0,0 +1,1166 @@ +--- +id: business-process +title: Core Business Process +description: Exchange Demand and Capacity information to solve bottlenecks. +sidebar_position: 1 +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## TABLE OF CONTENTS + +- [Business Roles and Functions](#business-roles-and-functions) +- [Material Demand](#material-demand) +- [Capacity Group](#capacity-group) +- [Match and Comparison of Demand and Capacity](#match-and-comparison-of-demand-and-capacity) +- [Collaboration](#collaboration) +- [User Journey](#user-journey) + +## Business Roles and Functions + +The core DCM business process is executed by two roles and uses two APIs as well as two aspect models. The customer is responsible for `WeekBasedMaterialDemand`, the supplier for `WeekBasedCapacityGroup`. Within `WeekBasedCapacityGroup` the supplier has to link material demands. + +|Function / Role|Customer|Supplier| +|-|-|-| +|Manage demand data|X|| +|Inform supplier about demand|X|| +|Manage capacity data||X| +|Link demand and capacity||X| +|Inform customer about capacity||X| +|Compare demand to capacity|X|X| +|Collaborate to resolve bottlenecks|X|X| + +## User Journey + +![User Journey](./resources/business-process_UserJourney.svg) + +Figure: *Basic DCM user journey* + + +### Personas + +The basic DCM user journey encompasses two key personas, each with distinct roles and responsibilities that highlight their value within the supply chain. + +#### Customer + + Individuals that act as this persona may hold various titles within their organization, but share the common responsibility of managing material demand and ensuring that supply aligns with their forecasted needs. The value of DCM for the customer lies in the capability to provide clear visibility into future demand and to facilitate efficient communication and alignment with suppliers. + +The responsibilities of the customer include: + +- safeguarding sufficient capacity of his suppliers for required materials and prevent bottleneck situations +- allocation of production capacity on customer side +- production rough cut capacity planning +- material allocation + +#### Supplier + +Individuals that act as this persona may hold various titles within their organization, but share the common responsibility of providing capacity data in response to the customer's material demand. The value of DCM for the supplier lies in the capability to receive material demand data, which enables them to plan and allocate resources effectively, ensuring they can meet the customer's demands. + +The responsibilities of the supplier include: + +- allocation of production capacity +- production rough cut capacity planning +- material allocation +- communication to a Customer business partner regarding capacity figures in a mid to - long term horizon +- resolving bottleneck situations + +### User Journey Description + +The starting point within the DCM user journey is the exchange of demand data, which is provided by the Customer and consumed by the supplier as WeekBasedMaterialDemand. For an effective demand and capacity management the data needs to be of a certain quality. This includes sorting the demand into weekly buckets, extending the demand data 24 months into the future and subsequently keeping it up to date. Whether the Customer has to manually prepare the demand data or it gets automatically generated and updated from existing systems, is not restricted by the Catena-X standards. + +The exchange of demand data is followed by the exchange of capacity data, which is provided by the supplier und consumed by the customer. For an effective demand and capacity management the data needs to be of a certain quality. This included linking material demands to the capacity group, providing a capacity quantity for every calendar week the customer provided demand quantities for, matching unit of measures correctly and utilizing advanced features like load factors and delta production in order to model demand and capacity management as closely to real life as possible. Whether the supplier has to manually prepare the capacity data or it gets automatically generated and updated from existing systems, is not restricted by the Catena-X standards. However matching material numbers and linking material demands to capacity groups will most likely required human intervention at some point. + +After exchanging demand and capacity data both, customer and supplier, do have the same view of the current situation and can begin matching and comparing the data. This is something that usually happens locally within the respective DCM application. Ideally the whole process of finding problems (bottleneck or surplus) is automated. + +If either customer or supplier identify a problem they can collaborate by exchanging comments as described by the DCM standard or by communicating outside the Catena-X dataspace using email or online-meetings. Regardless of how communication is initiated and maintained solving an identified problem is always the result of proposing, evaluating and simulating potential solutions. Customers and supplier discuss potential measures, modify their demand and capacity respectively and exchange the modified data until a solution that works for both sides has been found. + +Tools available to the Customer for solving problems are fairly limited. They can increase or decrease demand quantities. + +The supplier on the other hand has more options to solve problems. They can not only increase and decrease capacity quantities, but also use flexible capacity, load factors and delta production. + +## Material Demand + +![Guide Demand](./resources/business-process_guide_demand.svg) + +Figure: *Basic DCM process with demand part highlighted* + + + +A material demand represents the need for a particular product, part, component or material over a certain time period in a specified quantity. Demand quantities must refer to a time period of one calendar week (weekly buckets). + +The customer is responsible for publishing material demand to their supplier for upcoming time periods and it is strongly recommended to: + +- Minimize any data gaps to the greatest extent possible by maintaining continuity and establishing consistency. +- Provide material demand data for at least nine months into the future to ensure that DCM participants have sufficient information to work with. +- Implement a rolling demand plan by continuously updating the planning horizon with recent data. +- Refresh the data at a minimum of once every four weeks. +- Align, ideally within a contract, the unit of measure for demand quantities (e.g., pieces, kilograms, metric tons) with the supplier before providing the demand. + +The supplier must have the capability to consume the material demand data from the customer. + +### Material Demand Structure + +![Material Demand Structure](./resources/business-process_MDstructure.svg) +![Material Demand Structure Legend](./resources/business-process_MDstructure_Legend.svg) + +Figure: *Material demand structure* + + +### Visualization Example + +![Demand Example](./resources/business-process_ExampleDemand.svg) + +Figure: *Visualizing demand quantities as bars* + + +## Capacity Group + +![Guide Capacity](./resources/business-process_guide_capacity.svg) + +Figure: *Basic DCM process with capacity part highlighted* + + +A capacity group represents the answer to one or more material demands. It contains the information on how a supplier intends to fulfill customer needs, by contrasting demands with capacities over a certain time period in a specified quantity. Capacity quantities must refer to a time period of one calendar week (weekly buckets). + +The customer is responsible for publishing capacity groups to their customer and it is strongly recommended to: + +- Minimize any data gaps to the greatest extent possible by maintaining continuity and establishing consistency. +- Provide capacity data for every calendar week that has associated demand data. +- Refresh the data at a minimum of once every four weeks. +- Align, ideally within a contract, the unit of measure for capacity quantities (e.g., pieces, kilograms, metric tons) with the Customer and utilize lead factors as conversion factors, if applicable. + +The supplier must provide capacity data to the customer, corresponding to the material demand data previously shared. Thereby, the supplier is acting as a data provider and the customer as a data consumer of the exchanged capacity group.  + +The customer must have the capability to consume the capacity group data from the supplier. + +### Capacity Group Structure + +The capacity group is the entity where material demand and capacity information are matched and compared for the purpose of a collaborative DCM. Thereby, the capacity group builds the common view on the data exchanged between a customer and a supplier. + +The entity capacity group may be used, i.e. to combine capacities related to one or more machines, facilities or plants. + +![Capacity Group Structure](./resources/business-process_CGstructure.svg) +![Capacity Group Structure Legend](./resources/business-process_CGstructure_Legend.svg) + +Figure: *Capacity group structure* + + +### Visualization Example + +![Capacity Example](./resources/business-process_ExampleCapacity.svg) + +Figure: *Visualizing capacity quantities as lines* + + + + +### Capacity Types + +Embedded into the WeekBasedCapacityGroup are + +- **Actual Capacity** as the planned available capacity of a supplier +- **Maximum Capacity** as the maximum releasable capacity of a supplier +- **Agreed Capacity** as the understanding between Customer and supplier, regardless of contractual obligations. It is optional. + +In addition the difference between actual capacity and maximum capacity is commonly understood as flexible capacity. + +The following examples illustrate how to use the "capacity" properties. + +#### Example 1: Simple Case + +![Capacity Example](./resources/business-process_capacity-types_example1.svg) + + + +![Capacity Example](./resources/business-process_capacity-types_example_legend.svg) + + +Figure: *Visualizing capacity and demand on a simple case with sufficient capacity* + +We are in Week01, and we focus on a mid-term horizon starting in Week14, for a certain capacity group. +The current capacity plan at the supplier for this horizon is + +- 1000 units per week from Week14 (10 shifts per week) to Week20 +- 1500 units per week from Week22 onwards (15 shifts per week), with a ramp up step in Week21 + +This plan is reflected in the actual capacity of DCM. + +When matching demand to capacity, one will see that + +- Actual capacity is sufficient to cover demand. +- Maximum capacity can be available to cover potential increase of the demand up until 1800 + +#### Example 2: Imbalance + +![Capacity Example](./resources/business-process_capacity-types_example2.svg) + +![Capacity Example](./resources/business-process_capacity-types_example_legend.svg) + +Figure: *Visualizing capacity and demand in a case of imbalance* + +We are, here again, in Week01, considering the horizon from Week14 onwards. +Demand has increased in the period between Week15 and Week20, and now exceeds actual capacity. + +On supplier side: Supplier should detect that actual capacity is insufficient, using its DCM software, and conclude that measures should be activated to cover demand. As demand is below maximum capacity, supplier knows that it is feasible. Eventually, supplier should update its actual capacity to reflect those measures. + +On customer side: when validating its own production plan, customer may consider utilizing the supplier’s flexibility up to the maximum capacity and conclude that feasibility is given. + +#### Example 3: No Flexible Capacity + +![Capacity Example](./resources/business-process_capacity-types_example3.svg) + +![Capacity Example](./resources/business-process_capacity-types_example_legend.svg) + +Figure: *Visualizing capacity and demand in case without flexible capacity* + +Actual capacity is equal to maximum capacity, and demand is very close. +Though no proper imbalance is detected, even a slight increase of demand could not be managed. Both, supplier and customer, can conclude, that it may be relevant to collaborate to identify measures to mitigate risk. + +#### Example 4: Solving a Capacity Bottleneck + + +![Capacity Example](./resources/business-process_capacity-types_example4a.svg) +![Capacity Example](./resources/business-process_capacity-types_example_legend.svg) + +Figure: *Visualizing capacity and demand in a case of bottleneck* + +Imbalance is detected in Week19 to Week21: Demand exceeds maximum capacity. +Supplier and customer collaborate and agree on a measure to solve imbalance, e.g. increasing production capacity from Week19 to Week21 +If so, Actual and Maximum Capacity must be updated to reflect the result of the collaboration. As a result, the bottleneck disappears, as exemplified in example 4b below. + + +![Capacity Example](./resources/business-process_capacity-types_example4b.svg) +![Capacity Example](./resources/business-process_capacity-types_example_legend.svg) + +Figure: *Visualizing capacity and demand* + +### WeekBasedCapacityGroup Properties + +A capacity group dataset comprises the following basic components: + +| Main Parameters | Required? | Description | +|-|-|-| +| Supplier | Yes |The Business Partner Number Legal (BPNL) of the party providing materials to a customer| +| Customer | Yes |The Business Partner Number Legal (BPNL) of the party requesting material from a supplier| +| Capacity Group ID | Yes |The capacity group ID uniquely identifies the capacity group within the business relationship between a supplier and its customer| +| Changed At | Yes |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| +| Capacity Group Name | Yes |Name of the capacity group| +| Capacity Group is Inactive | Yes |Indicates that this capacity Group is currently not in use/maintained by the Supplier| +| Unit of Measure | No |Unit of Measurement (UoM) for capacity quantities| +| Linked Demand Series | No |Set of demand series assigned to this capacity group| +| Capacities | No |A time series with week-based granularity along a given time period containing the capacity values| +| Unit of Measure is Omitted | Yes |Explicit indicator of whether the unit of measure is left out of the payload intentionally. If “true” it means the sending application sends the 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| + +Further properties are added at lower level below the “Capacities” property. A capacity time series contains the following components. + +| Main Parameters | Required? | Description | +|-|-|-| +| Actual Capacity | Yes |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| +| Agreed Capacity | No |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.| +| Maximum Capacity | Yes |The supplier's 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| +| Point in Time | Yes |ISO calendar week of the given time series entry. It must be given as a date of the Monday in the week.| + +### Linking Capacity Groups to Material Demands + +For a functional capacity group, the supplier must link it directly or indirectly to a material demand: + +- **Direct linking** means that the capacity group links at least one material demand. +- **Indirect linking** means that the capacity group links to another capacity group which links at least one material demand. This is also referred to as **nesting**. + +#### Direct Linking + +![Direct Linking](./resources/business-process_DirectLinking.svg) +![Direct Linking Legend](./resources/business-process_DirectLinking_Legend.svg) + +Figure: *Capacity group structure with linked material demand* + + +For the technical representation of a capacity group the aspect model WeekBasedCapacityGroup is utilized. + +The aspect model WeekBasedCapacityGroup must be used by a supplier to provide capacity information to the Customer. + +For further details refer to the semantic model in Chapter 3.2 and to the APIs in Chapter 4.2. + +A partner acting as a supplier sends a capacity group to its customer. In order to link demand series in the capacity group between customer and supplier, the following properties must be filled-in: + +- Supplier +- Customer +- materialNumberCustomer +- CustomerLocation +- demandCategory + +If there’s no complete match between supplier and customer data, it’s recommended to initiate collaboration (i.e. see chapter “Comments”) + +The supplier has the option to mark a WeekBasedCapacityGroup as inactive (i.e. the capacity is obsolete), in this case the capacity will not be considered in the demand-capacity matching. However, the WeekBasedCapacityGroup can be reactivated again. + +### Building N-Tier Chains via Capacity Groups + +Building supply chain via capacity groups is crucial to improve resiliency, transparency and efficiency along the value chain. Using the individual one-to-one capacity groups between one-ups and one-downs step by step builds the whole supply network. This enables all partners to collaborate along the whole value chain and navigate through complex and dynamic market conditions. + +The following figure illustrates how plastic granulate ends up being used in the housing of a control unit and how this would be viewed from a birds eye perspective. + +```mermaid +flowchart BT + subgraph CG1["Capacity Group 1                     (OEM - Tier1)"] + cg11UP[One-Up] + cg1Material[Control Unit] + cg11DOWN[One-Down] + end + subgraph CG2["Capacity Group 2                     (Tier1 - Tier2)"] + cg21UP[One-Up] + cg2Material[Case] + cg21DOWN[One-Down] + end + subgraph CG3["Capacity Group 3                     (Tier2 - Tier3)"] + cg31UP[One-Up] + cg3Material[Granulate] + cg31DOWN[One-Down] + end +cg3Material-->cg2Material +cg2Material-->cg1Material +style cg11UP fill:#707070,color:#ffffff +style cg1Material fill:#FFFFFF,color:#707070 +style cg11DOWN fill:#046b99,color:#ffffff +style cg21UP fill:#046b99,color:#ffffff +style cg2Material fill:#FFFFFF,color:#707070 +style cg21DOWN fill:#219dd4,color:#000000 +style cg31UP fill:#219dd4,color:#000000 +style cg3Material fill:#FFFFFF,color:#707070 +style cg31DOWN fill:#575757,color:#ffffff +``` + +Figure: *A small supply chain built by three capacity groups* + +The following figure illustrates the flow of demand and capacity data through the supply network. Capacity and demand blocks are placed according to responsibility. Data exchange that is happening within the Catena-X dataspace is denoted by arrows with "Provide" written on them. + +```mermaid +flowchart LR + subgraph t0[OEM] + car + t0a[Demand] + t0b[Demand] + end + subgraph t1[Tier 1] + t1a[Capacity] + t1b[Capacity] + t1c[Demand] + end + subgraph t2[Tier 2] + subgraph t2py[Plant Y] + t2pya[Capacity] + t2pyb[Demand] + t2pyc[Demand] + end + subgraph t2pz[Plant Z] + t2pza[Demand] + t2pzb[Demand] + t2pzc[Capacity] + end + end + subgraph t3a[Tier 3] + t3aa[Capacity] + end + subgraph t3b[Tier 3] + t3ba[Capacity] + t3bb[Capacity] + end +t0a-->car +t0b-->car +t1a--"Provide"-->t0a +t0a--"Provide"-->t1a +t1b--"Provide"-->t0b +t0b--"Provide"-->t1b +t1c-->t1a +t1c-->t1b +t2pzc--"Provide"-->t1c +t1c--"Provide"-->t2pzc +t2pza-->t2pzc +t2pzb-->t2pzc +t2pya--"Provide"-->t2pza +t2pza--"Provide"-->t2pya +t3bb--"Provide"-->t2pzb +t2pzb--"Provide"-->t3bb +t2pyb-->t2pya +t2pyc-->t2pya +t3ba--"Provide"-->t2pyc +t2pyc--"Provide"-->t3ba +t3aa--"Provide"-->t2pyb +t2pyb--"Provide"-->t3aa +classDef Demand fill:#FFA600,stroke:#FFFFFF,color:#000000 +classDef Capacity fill:#B3CB2D,stroke:#FFFFFF,color:#000000 +classDef CG1 fill:#B3CB2D,color:#000000 +classDef CG2 fill:#a0b626,color:#000000 +classDef CG3 fill:#8da01e,color:#000000 +classDef CG4 fill:#7a8b17,color:#FFFFFF +classDef CG5 fill:#66750f,color:#FFFFFF +classDef CG6 fill:#536008,color:#FFFFFF +classDef CG7 fill:#404a00,color:#FFFFFF +classDef Car fill:#219DD4,color:#000000 +class t1a,t0a CG1 +class t1b,t0b CG6 +class t3aa,t2pyb CG2 +class t3ba,t2pyc CG3 +class t2pzb,t3bb CG4 +class t2pya,t2pza CG7 +class t2pzc,t1c CG5 +class car Car +``` + +![N-Tier Linking Legend Legend](./resources/business-process_nTierLinking_Legend.svg) + +Figure: *A small supply network built by seven capacity groups* + + +## Match and Comparison of Demand and Capacity + +![Guide Match](./resources/business-process_guide_match.svg) + +Figure: *Basic DCM process with match and comparison part highlighted* + + +Both, customer and supplier, need to apply the same logic when comparing demand and capacity data in order to get the same results and come to identical conclusions. + +The standard describes exactly which scenario leads to the three possible matching results: + +- Zero deviation +- Surplus +- Bottleneck + +Within a DCM application those three matching results are commonly represented as a traffic light status, with zero deviation and surplus being green and bottleneck being orange or red, depending on whether demand is higher than maximum capacity or just actual capacity. + +While customers might not feel impacted by a surplus, because the demand is matched, it still represents capacity that the supplier could better utilize. + +For ease of use demand and capacity data should be shown on the same graph and colored in appropriately, within a DCM application. + +![Capacity Match and Compare](./resources/business-process_ExampleMatchCompare.svg) + +Figure: *Visualizing the comparison of demand and capacity quantities* + + + + + +## Collaboration + +![Guide Collaboration ](./resources/business-process_guide_collab.svg) + +Figure: *Basic DCM process with collaboration part highlighted* + + + +Collaboration is key within the DCM process. It is the final part of the DCM user journey, where actual solutions for problems (surplus and bottlenecks) are proposed, discussed and finally deployed. + +In order to facilitate collaboration with the Catena-X dataspace the DCM standards describes the exchange of comments, using an own aspect model and API. Communication features outside the Catena-X dataspace, such as eMail, phone calls, online meetings, etc. are not prohibited and should be used as the individual customers and suppliers see fit. + +For further details, please refer to [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 BearingPoint Holding B.V +- SPDX-FileCopyrightText: 2024 Capgemini SE +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2024 Renault SA +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2024 Volvo Car Corporation +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation + +[StandardLibrary]: https://catenax-ev.github.io/docs/next/standards/CX-0128-andCapacityManagementDataExchange diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/comments.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/comments.md new file mode 100644 index 00000000000..86352f242d2 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/comments.md @@ -0,0 +1,108 @@ +--- +id: comments +title: Comments +description: Share comments to further help solving bottlenecks. +sidebar_position: 6 +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## Business Roles and Functions + +Comments use their own aspect model and API. Comments are provided and consumed by both customer and supplier. + +|Function / Role|Customer|Supplier| +|-|-|-| +|Comment on demand or capacity data|X|X| +|Inform business partner about comment|X|X| + +## Sequence Diagram + +```mermaid + +sequenceDiagram +autonumber +Participant c as Customer +Participant s as Supplier +rect rgb(4,107,153) +s->>c: The demand in weeks 23 and 24 seems extraordinarily high. Can you please have a look at it. +end +rect rgb(4,107,153) +c->>s: This is not an error. My demand actually is that high. +end +rect rgb(4,107,153) +c->>s: Could you try meeting my demand by going into pre-production for week 10 to 20? +end +rect rgb(64,74,0) +s->>c: Provide WeekBasedCapacityGroup containing pre production for weeks 10 to 20 +end +rect rgb(4,107,153) +s->>c: I updated the capacity data to include pre production, lets discuss this in an online meeting. +end +``` + +Figure: *Utilizing comments to solve a production problem* + +## Details + +Collaboration is a critical element in Demand and Capacity Management. It enables alignment and cooperation between customers and suppliers within their respective business relationships. This interaction is facilitated by the exchange of comments, which are messages or texts related to data objects – either Material Demand or Capacity Group. These objects are identified by an "ObjectID," which matches the UUID of either a WeekBasedMaterialDemand or a WeekBasedCapacityGroup. + +Each comment, formally known as an IdBasedComment, within the business relationship is uniquely identified by a CommentID. + +This functionality allows users to integrate all data, including communications with their business partners, into the core process. This integration fosters a unified source of truth within the DCM process and enhances efficient decision-making. Comments can also be directed toward specific periods within the exchanged time series data to improve the precision of collaboration. + +Comments consist solely of text exchanges, without the transfer of documents or attachments. + +Comments must be formatted according to the Catena-X data standards and processed through the specified API. + +Both customers and suppliers must be able to send and receive comments regarding a capacity group object. Similarly, exchanging comments on a material demand object is strongly advised to enhance collaborative efforts in Demand and Capacity Management. + +To aid in the interpretation of received comments, a comment type must be specified during its creation. Each comment must align with one of the defined types in the standard. The consumer of the comment is responsible for determining the appropriate actions in response to the comment type. + +The provider of a comment can freely write their message in a designated text field, as outlined in the corresponding data model. Any editing of comments, such as changes to content, date, or time, does not alter the CommentID. + +Additionally, comments may include references to specific calendar weeks of the time series data for clarity. + +### Enriching comments + +Every comment should have the following data embedded into it: + +- The identity of the comment creator, which could be their first and last name, email address, or the Business Partner Number of their company (BPNL). + - Adherence to the General Data Protection Regulation (GDPR) must be ensured, especially regarding the treatment of comments and user data following the withdrawal of the individual or their company. This includes compliance with decisions agreed upon by partner companies. + - The comment creator should have the option to remain anonymous if desired, utilizing only the BPNL. +- The data and time when the comment was created. + +As a general guideline, the ability to modify an existing comment should be restricted solely to the individual who originally authored the comment. This ensures that the integrity of the comment is maintained and that any changes reflect the creator's current views or corrections. + +### Linking comments + +It should be possible to create comments in the following manner: + +- Pertaining to a specific capacity group + - General comments, detached from specific calendar weeks + - Comments attached to one or multiple calendar weeks +- Pertaining to a specific material demand + - General comments, detached from specific calendar weeks + - Comments attached to one or multiple calendar weeks + +Since users will typically interact with a graphical user interface (UI) that displays an aggregation of a specific capacity group along with all its associated material demands and other capacity groups, it is logical to aggregate comments in a corresponding manner. This approach would allow users to view comments in the context of the specific data they are associated with, streamlining the user experience and enhancing the relevance of the comments in relation to the aggregated data being reviewed. + +For further details, please refer to [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation + +[StandardLibrary]: https://catenax-ev.github.io/docs/next/standards/CX-0128-DemandandCapacityManagementDataExchange diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/delta-production.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/delta-production.md new file mode 100644 index 00000000000..82c56d1d093 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/delta-production.md @@ -0,0 +1,157 @@ +--- +id: delta-production +title: Simulated Delta Production +description: Solve bottlenecks using pre- and post production +sidebar_position: 3 +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## Business Roles and Functions + +Delta-Production data is embedded into the WeekBasedCapacityGroup aspect model. This means that only suppliers provide Delta-Production related data and customers consume it. + +|Function / Role|Customer|Supplier| +|-|-|-| +|Solve bottleneck via pre-/post production||X| +|Inform customer||X| +|Acknowledge that bottleneck has been solved|X|| + +## Business value + +Simulated Delta-Production is a feature that helps suppliers to manage their production capacity more effectively. It allows them to address and balance capacity shortages without having to increase their actual or maximum capacity. Suppliers can choose to use this feature, but it is not mandatory. + +The main advantage of using simulated Delta-Production is that it gives suppliers a way to manage small capacity shortfalls. This can be done manually or automatically, which saves time and effort that would otherwise be spent on frequent capacity adjustments, particularly when demand is unpredictable. + +### Advantages + +- Solve minor bottlenecks via pre-production/post-production +- Optimize utilization +- Smoothen demand and capacity peaks +- No frequent alerting for minor bottlenecks which can be solved by the supplier (within its actual or maximum capacity) + +Simulated Delta-Production enables suppliers to add extra detail to their capacity information. This helps illustrate solutions for capacity issues or times when production resources might be offline. Only the end results of simulated Delta-Production are shared with the customer. Suppliers may input a simulated Delta-Production value for each week as needed, which shows an increase or decrease in planned demand without actually changing the real figures. + +## Functional description + +![DCM_DeltaProduction](./resources/business-process_DeltaProduction_functional.svg) +![DCM_DeltaProduction_Legend](./resources/business-process_DeltaProduction_functional_legend.svg) + +Figure: *Capacity group structure with linked material demand including simulated Delta-Production Result* + + + + +Simulated Delta-Production may be used within a capacity group to indicate how production can be adjusted to meet demand. It helps cover potential shortfalls by showing where goods could be produced earlier or later than currently demanded. Therefore simulated Delta-Production covers both pre-production and post-production activities. + +Suppliers can provide these values on a weekly basis alongside their regular capacity data via parameter: + +| Main Parameters | Required? | Description | Example | +|-|-|-|-| +| Delta Production Result | No | 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.| Decimal value (e.g. "400"). A value of 400 means that in the respective week 400 units of the material will be pre-produced.| + +There's no need to give details about the duration of these adjustments, as this can be inferred from the number of weeks for which the simulated data is provided. +When comparing demand and capacity data, the simulated values are considered without altering the actual data. If a simulated Delta-Production value is provided, it must be included in the weekly demand and capacity comparison. A positive value indicates a virtual increase in planned demand, while a negative value indicates a virtual decrease. + +### Considerations + +- The standard does not define individual calculation logic for simulated Delta-Production, only the results may be submitted +- Suppliers should apply appropriate smoothing algorithms, depending on their planning requirements and toolchains +- Consideration of e.g. stock levels, storage capacity, transport capacity, product or part versioning, perishability, storing or handling requirements is subject to suppliers individual planning and product requirements + +Simulated Delta-Production must not change the material demand. It's strictly a simulation feature. +Suppliers can use comments to provide customers with additional information about the simulated Delta-Production. For more details on this communication feature, see Chapter 5.9 of [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. + +## Example + +### Sequence Diagram + +```mermaid +sequenceDiagram +autonumber +Participant c as Customer +Participant s as Supplier +rect rgb(157,93,00) + c->>s: I need 100 blue toys each in weeks 47, 48, 49 and 50 +end +s->>s: Manage Capacities +s->>s: There is a bottleneck in week 50 +s->>s: It is solvable via pre-production in weeks 48 and 49 +rect rgb(4,107,153) + s-->>c: I can produce 100 in week 47, 0 in week 50 and 150 in weeks 48 and 49 + autonumber off + s->>c: 50 each in weeks 48 und 49 are pre-produced to cover the demand in week 50 +end +``` + +Figure: *Utilizing simulated delta-production to solve a production problem* + +![DCM_DeltaProduction](./resources/business-process_DeltaProduction_example_diagram.svg) + +Figure: *Visualized example of results of simulated Delta-Production (with pre-production)* + +For further details, please refer to [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. + +### Sample Data + +For sample data please refer to [Aspect Model - WeekBasedCapacityGroup](../../development-view/model-capacity-group.md). + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 Capgemini SE +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation + +[StandardLibrary]: https://catenax-ev.github.io/docs/next/standards/CX-0128-DemandandCapacityManagementDataExchange diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/demand-volatility.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/demand-volatility.md new file mode 100644 index 00000000000..6ff6a8e3937 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/demand-volatility.md @@ -0,0 +1,155 @@ +--- +id: demand-volatility +title: Demand Volatility Metrics +description: Create transparency regarding data volatility and strife for a solution +sidebar_position: 2 +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## Business Roles and Functions + +Demand Volatility data is embedded into the WeekBasedCapacityGroup aspect model. This means that only suppliers provide Demand Volatility related data and customers consume it. + +|Function / Role|Customer|Supplier| +|-|-|-| +|Define parameters for calculating Demand Volatility||X| +|Calculate Demand Volatility||X| +|Inform business partner about parameters for calculating Demand Volatility||X| +|Inform business partner about calculated Demand Volatility||X| +|Acknowledge Demand Volatility calculation|X|| +|Reproduce Demand Volatility calculation|X|| + +## Business Value + +Demand Volatility metrics help suppliers to identify and measure volatility in demands. It allows them to address Demand Volatility directly to their customers, increasing transparency for a more effective collaborative capacity planning. Demand Deviation is the first metric for measuring Demand Volatility in the [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary] (see chapter 5.11 Demand Volatility Metrics). + +The exchange of measurements of the demand deviation metric between business partners in the automotive supply chain leads to the following advantages: + +- stabilize supply chain by introducing Demand Volatility measures +- making fluctuations in customer demands transparent +- facilitating collaboration between business partners regarding demand patterns +- taking action to stabilize demand levels in the supply chain over time +- improving the balance between demands and capacity +- reducing the costs of supply chain operations + +## Functional Description Demand Volatility + +Supply chains in the automotive industry are characterized by a dynamic operating environment that manifests itself in regular changes in delivery and production requirements. This leads to varying degrees of Demand Volatility that customers communicate to their suppliers, in short term as well as long term planning horizons. + +Empirical analyses prove that high levels of Demand Volatility lead to high levels of unplanned supply chain efforts and costs mostly linked to readjustments of supply chain plans and to increased inventories across all tiers of the automotive supply chain. + +An effective approach to address the negative consequences of Demand Volatility is to systematically measure them and thus make them transparent. This facilitates collaborative alignments between supply chain partners in order to reduce Demand Volatility and increase the stability of supply plans. Therefore, the [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary] includes a simple Demand Volatility metric: “Demand Deviation”. Figure 1 shows that the parameters and metrics that are processed for Demand Deviation form part of the dataset of the capacity group, which is also handled by suppliers. The metric is generally based on the comparison of the current aggregated demand measured for a defined capacity group with a previous aggregated demand. It is recommended to measure Demand Deviation on a monthly basis. Hence, a 4-week offset between measurements of current and previous demands is recommended. + + + +![Demand Volatility CG](./resources/business-process_demand_volatility_CG.svg) +![Demand Volatility CG Legend](./resources/business-process_demand_volatility_CG_legend.svg) + +Figure: *Demand Volatility within capacity group* + +Feature Demand Volatility is to be used optional but if it is used certain parameters are required to be filled. + +__Parameters of the Demand Volatility metric are as follows:__ + +| Main Parameters | Required? | Description | Example | +|-|-|-|-| +| Start Reference Date Time | Yes | Point in time when the measurement is initiated on suppliers side. It needs to be a point in time after receiving the active flag. It also marks the beginning of the first reporting interval/subhorizon| A value of 2024-08-01 indicates the measurement will start as of August 1st 2024. | +| Measurement Interval | Yes | Indicates the length in weeks between two measurements. First interval start with the *Start Reference Date Time*. Second interval starts the mentioned weeks after this date and so on | A value of 4 indicates a measurement will be taken each 4 weeks, starting with the *Start Reference Date Time*. | +| Sequence Number | Yes | Sequence Number of the respective subhorizon. The time frame can be divided into any positive number of individual subhorizons | A value of 2 indicates that this specific subhorizon is subhorizon number 2.| +| Subhorizon Lengths | Yes | Length of an individual subhorizon. Minimum length is always one week per individual subhorizon due to the DCM granularity | In the example having a *Sequence Number* set as 2, a value of 6 indicates that subhorizon 2 has a length of 6 weeks. | +| Absolute Negative Deviation | No | Absolute negative deviation threshold which triggers an alert | E.g. -100 units (value 100) means an alert is triggered if the absolute negative deviation between two measurement intervals for a respective calendar week decrease by 100 or more units. | +| Absolute Positive Deviation | No | Absolute positive deviation threshold which triggers an alert | E.g. 100 units (value 100) means an alert is triggered if the absolute positive deviation between two measurement intervals for a respective calendar week increases by 100 or more units. | +| Relative Negative Deviation | No | Relative negative deviation threshold which triggers an alert | E.g. -30% (value 0,3) means an alert is triggered if the relative negative deviation between two measurement intervals for a respective calendar week decrease by 30% or more. Value can be set between 0 and 1. | +| Relative Positive Deviation | No | Absolute negative deviation threshold which triggers an alert | E.g. 20% (value 0,2) means an alert is triggered if the relative positive deviation between two measurement intervals for a respective calendar week increase by 20% or more. Value can be set between 0 and 1. | + +For further details please refer to [Aspect Model WeekBasedCapacityGroup](../../development-view/model-capacity-group.md). + +## Example of Demand Volatility Measurements + +```mermaid +sequenceDiagram +autonumber +Participant c as Customer +Participant s as Supplier +rect rgb(157,93,00) + c->>s: I need 1000 red toys in week 19 +end +c->>c: Wait 4 weeks +rect rgb(157,93,00) + c->>s: I need 100 red toys in week 19 +end +s->>s: I should really start measuring the volatility of my customers demands +c->>c: Wait 4 weeks +rect rgb(157,93,00) + c->>s: I need 75 red toys in week 19 +end +s->>s: I start transferring the volatility of my customers demands +rect rgb(64,74,00) + s->>c: I started measuring Demand Deviation, using the following parameters: + autonumber off + s-->>c: Measurement Interval is set to 4 weeks + s-->>c: Increase limited to max. 20% in subhorizon 3 + s-->>c: Decrease limited to max. -20% in subhorizon 3 + s-->>c: Measurement starts in week 0, using 4 subhorizons of length (2,11,39,52) +end +``` + +Figure: *Utilizing demand volatility metrics to address data consistency issues* + +For further details, please refer to [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation + +[StandardLibrary]: https://catenax-ev.github.io/docs/next/standards/CX-0128-DemandandCapacityManagementDataExchange diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/disruption-notification.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/disruption-notification.md new file mode 100644 index 00000000000..0e078624ba0 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/disruption-notification.md @@ -0,0 +1,58 @@ +--- +id: disruption-notification +title: Supply Chain Disruption Notification +description: Inform the supply chain about urgent issues, that connect be quantified yet. +sidebar_position: 7 +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## Business Roles and Functions + +Supply chain disruption notifications use their own aspect model and API. Supply chain disruption notifications are provided and consumed by both customer and supplier. + +|Function / Role|Customer|Supplier| +|-|-|-| +|Inform business partner about disruption|X|X| +|Detail pre-existing disruption notification|X|X| +|Resolve disruption|X|X| + +## Sequence Diagram + +```mermaid +sequenceDiagram +autonumber +Participant c as Customer / Supplier +Participant s as Supplier / Customer +rect rgb(4,107,153) + c->>s: One of my production plants is negatively impacted by a strike + autonumber off + c-->>s: This affects the demand of the following materials: {Toy 1, Toy2, Toy3} +end +rect rgb(4,107,153) + autonumber 2 + c->>s: The disruption (strike) has ended +end +``` + +Figure: *Utilizing supply chain disruption notification* + +For further details, please refer to [CX-0146 Supply Chain Disruption Notifications][StandardLibrary]. + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation + +[StandardLibrary]: https://catenax-ev.github.io/docs/next/standards/CX-0146-SupplyChainDisruptionNotifications diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/load-factors.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/load-factors.md new file mode 100644 index 00000000000..36864403975 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/load-factors.md @@ -0,0 +1,140 @@ +--- +id: load-factors +title: Load Factors +description: Detail capacities by defining how much of a strain a material is on your capacities, compared to other materials. +sidebar_position: 4 +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## Business Roles and Functions + +Load Factors are advanced parameters of a Capacity Group structure and therefore used optionally by suppliers. The application of Load Factors is embedded into the WeekBasedCapacityGroup aspect model. This means that only suppliers may apply Load Factors and customers consume it. + +|Function / Role|Customer|Supplier| +|-|-|-| +|Define Load Factors for materials||X| +|Define conversion factor for unit of measure||X| +|Inform business partners about factors||X| +|Acknowledge factors|X|| +|Recalculate demands in user interface, based on factors |X|X| + +## Business value + +The feature “Load Factors” allows suppliers to model and represent otherwise impossible capacity occurrences, by introducing a numerical multiplication factor, that changes the demand volume interpretation of a capacity group. + +Load Factors should be used to solve the following two problems: + +- Processing of non-homogeneous material variants within a capacity group, resulting in diverging capacity utilization. + +- Requirement for having a different unit of measure within a WeekBasedCapacityGroup, in relation to its linked WeekBasedMaterialDemand. + +Load Factors solve these problems by: + +- Scaling the weekly demand linearly if a material variant causes higher or lower than normal load within the capacity group. Load Factors can, for example, express a reduction to 90% or an increase to 150%. + +- Acting as conversion factors, converting the unit of measure of a WeekBasedMaterialDemand into the unit of measure of the WeekBasedCapacityGroup. This leads to a conversion into either “time” (unit:secondUnitOfTime) or “cycle” (unit:cycle), expressing that, for example, a piece of material takes 12 seconds, or a set of material takes half a cycle to manufacture. + +### Advantages + +- Possible differentiation of capacity utilization for product variants within a capacity group +- Possible conversion of different units of measure +- Better reflection of actual production environment + +## Functional description + +![Loadfactor](./resources/business-process_LoadFactor_functional.svg) +![LoadfactorLegend](./resources/business-process_FunctionalBlockDiagram_Legend.svg) + +Figure: *Capacity group structure with linked material demand incl. Load Factors* + +Suppliers may apply Load Factors within WeekBasedCapacityGroup aspect model via the parameter: + +| Main Parameters | Required? | Description | Example | +|-|-|-|-| +| Load Factor | No | If applied, a Load Factor indicates that in order to produce the required material demand, more (or less) production resources are required.| Decimal value (e.g. "3.5"). A value of 3.5 means that in the respective week the demand value is multiplied by 3,5 in order to reflect the required capacity needed to fulfil the demand. | + +Suppliers can apply Load Factors within the WeekBasedCapacityGroup model via a parameter. If they choose to do so, a Load Factor must be assigned to every WeekBasedMaterialDemand linked to the WeekBasedCapacityGroup. + +A Load Factor of 1 is neutral and does not change the linked WeekBasedMaterialDemand. Since Load Factors are applied via the WeekBasedCapacityGroup, a WeekBasedMaterialDemand can have multiple, differing Load Factors. + +Without Load Factors, the units of measure of a WeekBasedCapacityGroup and its linked WeekBasedMaterialDemand should be identical. With Load Factors, they may differ. + +### Considerations + +- The standard does not specify individual calculation logic for applying a Load Factor (e.g., converting capacity in pieces to production cycles). This logic depends on the suppliers’ individual planning requirements and tools. Indicating a Load Factor informs the customer that a conversion has taken place but does not affect the transferred demand or capacity values. +- Lot size restrictions, especially lot size = 1, are not considered when using Load Factors. +- To maintain consistency in demand-capacity comparison, rounding of fractional conversion results should be avoided. +- If a WeekBasedCapacityGroup links several WeekBasedMaterialDemand containing the same material, the Load Factors applied to these WeekBasedMaterialDemand should be identical. + +Suppliers can use comments to provide customers with additional information about the applied Load Factors. For more details on this communication feature, see Chapter 5.9 of [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary] + +## Example + +The supplier produces two toys colored red and chrome on its line for the customer. +Both materials pass through the same station within the coloring process. + +Red toy needs 1 cycle at this station. Chrome toy needs 2 cycles because it needs to be painted twice. The supplier can effectively produce 250 cycles per week at this station. + +### Sequence Diagram + +```mermaid +sequenceDiagram +autonumber +Participant c as Customer +Participant s as Supplier +rect rgb(157,93,00) + c->>s: I need 100 red and 100 chrome toys +end +s->>s: Chrome toys strain my capacities twice as much as red toys +rect rgb(4,107,153) + s-->>c: Your demand and my capacities need to be expressed as production cycles. + autonumber off + s-->>c: Red toys are loaded with factor 1 + s-->>c: Chrome toys are loaded with factor 2 + s->>c: My overall capacity is 250 cycles +end +autonumber 4 +c->>c: My demands are 100 red cycles plus 200 chrome cycles equals 300 cycles +c->>c: Their capacity for both toys is 250 cycles +c->>c: Reduce demand for chrome toys to 75 so total demand equals 250 cycles +``` + +Figure: *Utilizing load factors* + +The supplier has created a capacity group "Red and Chrome Toys" with the unit “cycle” (unit:cycle). A processing time per piece of 1 cycle is set for red toys and 2 cycles for chrome toys. The maximum available process time is set to 250 cycles. + +The customer requires 100 pieces of red toys and 100 pieces of chrome toys in the respective week. The supplier calculates the required process time to be 300 cycles, i.e. 100(red)\*1 + 100(chrome)\*2 = 100 + 200 = 300 cycles. + +Without the Load Factor applied, it would not have been transparent for the customer, that the required amount of red and chrome toys is not possible to be fulfilled and it is necessary to decrease the volume in the respective week. + +One possible solution would be to reduce the chrome toys by 25 pieces to 75 pieces. New required process time would add up to 100(red)\*1 + 75(chrome)\*2 = 100 + 150 = 250 cycles. + +![Loadfactor](./resources/business-process_LoadFactor_example_diagram.svg) + +Figure: *Example for application of Load Factor within WeekBasedCapacityGroup* + +For further details, please refer to [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. + +### Sample Data + +For sample data please refer to [Aspect Model - WeekBasedCapacityGroup](../../development-view/model-capacity-group.md). + +### Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 Capgemini SE +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation + +[StandardLibrary]: https://catenax-ev.github.io/docs/next/standards/CX-0128-DemandandCapacityManagementDataExchange diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/nesting.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/nesting.md new file mode 100644 index 00000000000..fa0973626bb --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/nesting.md @@ -0,0 +1,254 @@ +--- +id: nesting +title: Nesting +description: Nest material demands and capacity groups into other capacity groups +sidebar_position: 8 +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## Business Roles and Functions + +Nesting is a feature defined in the DCM standard [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary] and includes an advanced property of the Capacity Group structure and therefore may be used optionally by suppliers. The Nesting feature is embedded into the WeekBasedCapacityGroup aspect model. This means that only suppliers may apply Nesting and customers consume it. + +|Function / Role|Customer|Supplier| +|-|-|-| +|Define Nesting in a Capacity Group||X| +|Inform business partners about Nesting via data transfer||X| +|Receive Nesting information|X|| + +## Business Value + +Nesting may be used by suppliers for the following purposes (but not limited to): + +- To simplify the maintenance of Capacity Groups +- To enable the bundling of several smaller Capacity Groups to reflect a (virtual, internal) company structure + +### Advantages + +- Avoid increased maintenance efforts if same Material Demands may be required for another Capacity Group +- Allows to provide additional transparency to customers + +## Functional Description + +Nesting is an indirect linking of Material Demand information to a Capacity Group done by a supplier. It involves connecting the WeekBasedCapacityGroup to another WeekBasedCapacityGroup that is already linked to a WeekBasedMaterialDemand. +Suppliers may apply Nesting within WeekBasedCapacityGroup aspect model via the parameter `linkedCapacityGroups`. + +For more transparent collaboration, a supplier may also aggregate two or more Capacity Groups and share this aggregated Capacity Group with its customer, if all aggregated Capacity Groups refer to the same customer (BPNL). +Nesting helps suppliers for example to map the internal production sequence in the Capacity Groups, e.g. the combination of two production lines into one final assembly line can be mapped by linking the two Capacity Groups of the preceding lines into another Capacity Group (see [Example](#example)). +The same applies to multiple production plants representing a customer's total allocated capacity for materials. + +The supplier is able to put the desired Capacity Groups with their respective demands and capacities together and then share it with the customer. + +Consolidation is performed only on the demand and not on the capacity side when Nesting is used: all related capacity information is fully independent, i.e. the capacity data in the Capacity Group must be maintained individually. If a Capacity Group contains linked Capacity Groups, then the Material Demands of these linked Capacity Groups are summed up and used as aggregated demand. The supplier must either link individual Material Demands or link existing Capacity Groups in the Capacity Group. + +The following figure shows that:  + +- Capacity Group 1 and 2 are linked to Capacity Group 3 (i.e. Nesting or indirect linking).  +- Material Demand 1 and 2 are linked to Capacity Group 1 (i.e. direct linking). +- Material Demand 3 and 4 are linked to Capacity Group 2 (i.e. direct linking). +- Capacity Group 3 considers the Material Demands 1, 2, 3 and 4 because they are indirectly linked via the nested Capacity Group. + + + + + +![Simple nesting example](./resources/business-process_nesting_example-basic.svg) +![Simple nesting example legend](./resources/business-process_nesting_example_legend.svg) + +Figure: *Capacity Group with directly linked Material Demands or nested Capacity Groups (indirectly linked Material Demands)* + +Capacity Group 3 is the result of the indirect way of linking Material Demand, therefore it must not contain any additional directly linked Material Demands. + +If a linked Capacity Group contains further linked Capacity Groups (dark green in figure below), the Nesting is recurrent and must go further until referenced Capacity Groups contain only linked demand series (orange in figure below) ("domino effect"). + +![Recurrent nested Capacity Groups](./resources/business-process_nesting_example-recurrent.svg) + +Figure: *Recurrent nested Capacity Groups* + +### Considerations + +- It must not be possible to have a combination of directly linked Material Demand series and linked Capacity Groups (Nesting) within the same Capacity Group. +- Suppliers can use comments to provide customers with additional information about the Nesting. For more details on this communication feature, see chapter 5.9 in [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary] or [Comments](comments.md) page in DCM Kit of Tractus-X. +- Suppliers should be carefully applying recurring linked Capacity Groups ("domino effect"), because of the complexity of keeping track on changes and in maintenance. It is more difficult to identify and understand demand changes and where they are originating from (e.g. which part). + +Feature Nesting is to be used optional but if it is used certain parameters are required to be filled. + +**Parameters of the Nesting are as follows:** + +| Main Parameters | Required? | Description | Example | +|-|-|-|-| +| linkedCapacityGroups | No | UUID of the linked Capacity Group | 0157ba42-d2a8-4e28-8565-7b07830c1110 | + +For further details please refer to [Aspect Model - WeekBasedCapacityGroup](../../development-view/model-capacity-group.md). + +## Sequence Diagram + +```mermaid +sequenceDiagram +autonumber +Participant c as Customer +Participant s as Supplier +rect rgb(191,113,00) + c->>s: I need 60 pieces of toy 1, 40 pieces of toy 2 and 50 pieces of toy 3 + c->>s: I need 100 pieces of toy 4 and 70 pieces of toy 5 +end +s->>s: Toys 1, 2 and 3 are produced on line 1, toys 4 and 5 on line 2 and all toys have to pass through paint shop +rect rgb(64,74,00) + autonumber off + s-->>c: Your demand and my capacities need to be assigned to 3 different capacity groups. + autonumber 4 + s->>c: Toys 1, 2 and 3 are part of capacity group "Production Line 1" + s->>c: Toys 4 and 5 are part of capacity group "Production Line 2" + autonumber off + s-->>c: All toys have to be colored in the paint shop + autonumber 6 + s->>c: Nesting "Production Line 1" and "Production Line 2" in "Paint Shop" instead of linking each Material Demand separately again +end +c->>c: My demands for all 5 toys are interlinked and transparent that they affect same capacity together +``` + +Figure: *Utilizing nesting to structure demand and capacity data* + +For further details, please refer to [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. + +## Example + +The supplier produces five different toys on two different production lines for the customer. Afterwards the produced toys of both production lines are colored in the same paint shop. +All five toys pass through the same paint shop within the coloring process. + +- Production line 1 is used to produce toys 1, 2 and 3 for the customer. +- Production line 2 is used to produce toys 4 and 5 for the customer. +- The supplier has created a Capacity Group "Production Line 1" with the directly linked Material Demands of toys 1, 2 and 3. +- The supplier has also created a Capacity Group "Production Line 2" with the directly linked Material Demands of toys 4 and 5. +- For the paint shop the supplier has created another Capacity Group "Paint Shop", but without directly linked Material Demands. Instead, the supplier linked the Capacity Groups "Production Line 1" and "Production Line 2". +- The customer requires 60 pieces of toy 1, 40 pieces of toy 2 and 50 pieces of toy 3 in the respective week. Therefore the Capacity Group "Production Line 1" has an aggregated Material Demand of 150 pieces per week. +- Of toy 4, the customer wants 100 pieces and of toy 5 70 pieces in the respective week. Accordingly the related Capacity Group "Production Line 2" shows an aggregated Material Demand of 170 pieces per week. + +With the Nesting, the supplier achieves that the latest Material Demands that are linked to "Production Line 1" and "Production Line 2" are automatically available and considered in his Capacity Group "Paint Shop" without any further activities. Also in case a new toy 6 would be requested by same customer and produced on e.g. "Production Line 2", the supplier would only need to add it to that Capacity Group and automatically its Material Demand would also be considered in the Capacity Group "Paint Shop", thus also avoiding time-consuming additional maintenance on the demand side for "Paint Shop" Capacity Group. + + + + + +![Advanced Nesting example](./resources/business-process_nesting_example-basic.svg) +![Advanced Nesting example Legend](./resources/business-process_nesting_example_legend.svg) + +Figure: *Example for application of Nesting* + +For further details, please refer to [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 BearingPoint Holding B.V +- SPDX-FileCopyrightText: 2024 SAP SE +- SPDX-FileCopyrightText: 2024 Volvo Car Corporation +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation + +[StandardLibrary]: https://catenax-ev.github.io/docs/next/standards/CX-0128-DemandandCapacityManagementDataExchange diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-architecture.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-architecture.svg new file mode 100644 index 00000000000..1cda8f760cc --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-architecture.svg @@ -0,0 +1,2493 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Zeichenblatt-1 + + + + + + + Hauptsitz + OEM + + Tabelle.4 + + + + Tabelle.5 + + + + Tabelle.6 + + + + Tabelle.7 + + + + Tabelle.8 + + + + Tabelle.9 + + + + Tabelle.10 + + + + Tabelle.11 + + + + Tabelle.12 + + + + Tabelle.13 + + + + Tabelle.14 + + + + Tabelle.15 + + Tabelle.16 + + + + Tabelle.17 + + + + Tabelle.18 + + + + Tabelle.19 + + + + Tabelle.20 + + + + Tabelle.21 + + + + Tabelle.22 + + + + + Tabelle.23 + + + + Tabelle.24 + + + + Tabelle.25 + + Tabelle.26 + + + + Tabelle.27 + + + + Tabelle.28 + + + + Tabelle.29 + + + + Tabelle.30 + + + + Tabelle.31 + + + + Tabelle.32 + + + + Tabelle.33 + + + + Tabelle.34 + + + + + Tabelle.35 + + + + Tabelle.36 + + + + Tabelle.37 + + + + Tabelle.38 + + + + Tabelle.39 + + + + Tabelle.40 + + + + Tabelle.41 + + + + Tabelle.42 + + + + Tabelle.43 + + + + Tabelle.44 + + + + Tabelle.45 + + + + Tabelle.46 + + + + Tabelle.47 + + + + Tabelle.48 + + + + Tabelle.49 + + + + + + OEM + + + + + + Hauptsitz.95 + Tier 1 + + Tabelle.96 + + + + Tabelle.97 + + + + Tabelle.98 + + + + Tabelle.99 + + + + Tabelle.100 + + + + Tabelle.101 + + + + Tabelle.102 + + + + Tabelle.103 + + + + Tabelle.104 + + + + Tabelle.105 + + + + Tabelle.106 + + + + Tabelle.107 + + Tabelle.108 + + + + Tabelle.109 + + + + Tabelle.110 + + + + Tabelle.111 + + + + Tabelle.112 + + + + Tabelle.113 + + + + Tabelle.114 + + + + + Tabelle.115 + + + + Tabelle.116 + + + + Tabelle.117 + + Tabelle.118 + + + + Tabelle.119 + + + + Tabelle.120 + + + + Tabelle.121 + + + + Tabelle.122 + + + + Tabelle.123 + + + + Tabelle.124 + + + + Tabelle.125 + + + + Tabelle.126 + + + + + Tabelle.127 + + + + Tabelle.128 + + + + Tabelle.129 + + + + Tabelle.130 + + + + Tabelle.131 + + + + Tabelle.132 + + + + Tabelle.133 + + + + Tabelle.134 + + + + Tabelle.135 + + + + Tabelle.136 + + + + Tabelle.137 + + + + Tabelle.138 + + + + Tabelle.139 + + + + Tabelle.140 + + + + Tabelle.141 + + + + + + Tier 1 + + + + + + Hauptsitz.142 + Tier 2 + + Tabelle.143 + + + + Tabelle.144 + + + + Tabelle.145 + + + + Tabelle.146 + + + + Tabelle.147 + + + + Tabelle.148 + + + + Tabelle.149 + + + + Tabelle.150 + + + + Tabelle.151 + + + + Tabelle.152 + + + + Tabelle.153 + + + + Tabelle.154 + + Tabelle.155 + + + + Tabelle.156 + + + + Tabelle.157 + + + + Tabelle.158 + + + + Tabelle.159 + + + + Tabelle.160 + + + + Tabelle.161 + + + + + Tabelle.162 + + + + Tabelle.163 + + + + Tabelle.164 + + Tabelle.165 + + + + Tabelle.166 + + + + Tabelle.167 + + + + Tabelle.168 + + + + Tabelle.169 + + + + Tabelle.170 + + + + Tabelle.171 + + + + Tabelle.172 + + + + Tabelle.173 + + + + + Tabelle.174 + + + + Tabelle.175 + + + + Tabelle.176 + + + + Tabelle.177 + + + + Tabelle.178 + + + + Tabelle.179 + + + + Tabelle.180 + + + + Tabelle.181 + + + + Tabelle.182 + + + + Tabelle.183 + + + + Tabelle.184 + + + + Tabelle.185 + + + + Tabelle.186 + + + + Tabelle.187 + + + + Tabelle.188 + + + + + + Tier 2 + + + + + + Hauptsitz.189 + Tier 3 + + Tabelle.190 + + + + Tabelle.191 + + + + Tabelle.192 + + + + Tabelle.193 + + + + Tabelle.194 + + + + Tabelle.195 + + + + Tabelle.196 + + + + Tabelle.197 + + + + Tabelle.198 + + + + Tabelle.199 + + + + Tabelle.200 + + + + Tabelle.201 + + Tabelle.202 + + + + Tabelle.203 + + + + Tabelle.204 + + + + Tabelle.205 + + + + Tabelle.206 + + + + Tabelle.207 + + + + Tabelle.208 + + + + + Tabelle.209 + + + + Tabelle.210 + + + + Tabelle.211 + + Tabelle.212 + + + + Tabelle.213 + + + + Tabelle.214 + + + + Tabelle.215 + + + + Tabelle.216 + + + + Tabelle.217 + + + + Tabelle.218 + + + + Tabelle.219 + + + + Tabelle.220 + + + + + Tabelle.221 + + + + Tabelle.222 + + + + Tabelle.223 + + + + Tabelle.224 + + + + Tabelle.225 + + + + Tabelle.226 + + + + Tabelle.227 + + + + Tabelle.228 + + + + Tabelle.229 + + + + Tabelle.230 + + + + Tabelle.231 + + + + Tabelle.232 + + + + Tabelle.233 + + + + Tabelle.234 + + + + Tabelle.235 + + + + + + Tier 3 + + + Dynamischer Verbinder + Demand + + + + + Demand + + Dynamischer Verbinder.237 + Capacity + + + + + Capacity + + Dynamischer Verbinder.238 + Demand + + + + + Demand + + Dynamischer Verbinder.239 + Capacity + + + + + Capacity + + Dynamischer Verbinder.240 + Demand + + + + + Demand + + Dynamischer Verbinder.241 + Capacity + + + + + Capacity + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Geschweifte Klammern-Intervall + + Tabelle.249 + + + Tabelle.250 + + + + Tabelle.251 + + + + Tabelle.252 + + + + + + + + + + + + + + + + + Tabelle.253 + + + + + + + + + + + + + + + Tabelle.254 + + + + + + + + + Tabelle.255 + + + + Tabelle.256 + + + Tabelle.257 + - + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.258 + Relationship A + + + + + + + + + + + + + + + + + + + + + + + Relationship A + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Geschweifte Klammern-Intervall.270 + + Tabelle.271 + + + Tabelle.272 + + + + Tabelle.273 + + + + Tabelle.274 + + + + + + + + + + + + + + + + + Tabelle.275 + + + + + + + + + + + + + + + Tabelle.276 + + + + + + + + + Tabelle.277 + + + + Tabelle.278 + + + Tabelle.279 + - + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.280 + Relationship B + + + + + + + + + + + + + + + + + + + + + + + Relationship B + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Geschweifte Klammern-Intervall.281 + + Tabelle.282 + + + Tabelle.283 + + + + Tabelle.284 + + + + Tabelle.285 + + + + + + + + + + + + + + + + + Tabelle.286 + + + + + + + + + + + + + + + Tabelle.287 + + + + + + + + + Tabelle.288 + + + + Tabelle.289 + + + Tabelle.290 + - + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.291 + Relationship C + + + + + + + + + + + + + + + + + + + + + + + Relationship C + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Geschweifte Klammern-Intervall.296 + + Tabelle.297 + + + Tabelle.298 + + + + Tabelle.299 + + + + Tabelle.300 + + + + + + + + + + + + + + + + + + + + + Tabelle.301 + + + + + + + + + + + + + + + + + + + Tabelle.302 + + + + + + + + + Tabelle.303 + + + + Tabelle.304 + + + Tabelle.305 + - + + + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.306 + Demand A1 .. An Capacity A1.. An + + + + + + + + + + + + + + + + + + + + + + + + + Demand A1 .. AnCapacity A1.. An + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Geschweifte Klammern-Intervall.308 + + Tabelle.309 + + + Tabelle.310 + + + + Tabelle.311 + + + + Tabelle.312 + + + + + + + + + + + + + + + + + + + + + Tabelle.313 + + + + + + + + + + + + + + + + + + + Tabelle.314 + + + + + + + + + Tabelle.315 + + + + Tabelle.316 + + + Tabelle.317 + - + + + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.318 + Demand B1 .. An Capacity B1.. An + + + + + + + + + + + + + + + + + + + + + + + + + Demand B1 .. AnCapacity B1.. An + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Geschweifte Klammern-Intervall.319 + + Tabelle.320 + + + Tabelle.321 + + + + Tabelle.322 + + + + Tabelle.323 + + + + + + + + + + + + + + + + + + + + + Tabelle.324 + + + + + + + + + + + + + + + + + + + Tabelle.325 + + + + + + + + + Tabelle.326 + + + + Tabelle.327 + + + Tabelle.328 + - + + + + + + + + + + + + + + + + + + + + + + + + + + + Tabelle.329 + Demand C1 .. An Capacity C1.. An + + + + + + + + + + + + + + + + + + + + + + + + + Demand C1 .. AnCapacity C1.. An + + + diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-architecture.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-architecture.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-architecture.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_CGstructure.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_CGstructure.svg new file mode 100644 index 00000000000..57d5c86e8e7 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_CGstructure.svg @@ -0,0 +1,3 @@ + + +
WeekBasedCapacityGroup
Supplier
Customer
CapacityGroupID
changedAt
Calendar Week
Inactive flag
UnitOfMeasure
CapacityGroupName
ActualCapacity
MaximumCapacity
AgreedCapacity
quantity
quantity
quantity
 \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_CGstructure.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_CGstructure.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_CGstructure.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_CGstructure_Legend.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_CGstructure_Legend.svg new file mode 100644 index 00000000000..0641dc51fe2 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_CGstructure_Legend.svg @@ -0,0 +1,3 @@ + + +
Capacity data (MUST)
Capacity data (optional)
 \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_CGstructure_Legend.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_CGstructure_Legend.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_CGstructure_Legend.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DeltaProduction_example_diagram.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DeltaProduction_example_diagram.svg new file mode 100644 index 00000000000..9d2d2d9e7e2 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DeltaProduction_example_diagram.svg @@ -0,0 +1 @@ +020406080100120140160week 46week 47week 48week 49week 50week 51Demand within actual capacityDemand over actual capacityDelta ProductionActual CapacityΔ+50Δ+50Δ-100 \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DeltaProduction_example_diagram.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DeltaProduction_example_diagram.svg.license new file mode 100644 index 00000000000..d90a88f6ee7 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DeltaProduction_example_diagram.svg.license @@ -0,0 +1,10 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 Capgemini SE +- SPDX-FileCopyrightText: 2024 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2024 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DeltaProduction_functional.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DeltaProduction_functional.svg new file mode 100644 index 00000000000..8a3c7bbf396 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DeltaProduction_functional.svg @@ -0,0 +1,3 @@ + + +
WeekBasedCapacityGroup
Supplier
Customer
CapacityGroupID
changedAt
Calendar Week
DemandSeries
Inactive flag
UnitOfMeasure
CapacityGroupName
ActualCapacity
MaximumCapacity
AgreedCapacity
MaterialNumberCustomer
DemandCategory
CustomerLocation
DeltaProductionResult
PointInTime
Quantity
 \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DeltaProduction_functional.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DeltaProduction_functional.svg.license new file mode 100644 index 00000000000..d90a88f6ee7 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DeltaProduction_functional.svg.license @@ -0,0 +1,10 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 Capgemini SE +- SPDX-FileCopyrightText: 2024 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2024 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DeltaProduction_functional_legend.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DeltaProduction_functional_legend.svg new file mode 100644 index 00000000000..5b5570a6a42 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DeltaProduction_functional_legend.svg @@ -0,0 +1,3 @@ + + +
Demand data (MUST)
Demand data (optional)
Capacity data (MUST)
Capacity data (optional)
 diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DeltaProduction_functional_legend.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DeltaProduction_functional_legend.svg.license new file mode 100644 index 00000000000..d90a88f6ee7 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DeltaProduction_functional_legend.svg.license @@ -0,0 +1,10 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 Capgemini SE +- SPDX-FileCopyrightText: 2024 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2024 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DirectLinking.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DirectLinking.svg new file mode 100644 index 00000000000..5519a56000b --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DirectLinking.svg @@ -0,0 +1,3 @@ + + +
WeekBasedCapacityGroup
Supplier
Customer
CapacityGroupID
changedAt
Calendar Week
DemandSeries
Inactive flag
UnitOfMeasure
CapacityGroupName
ActualCapacity
MaximumCapacity
AgreedCapacity
MaterialNumberCustomer
DemandCategory
CustomerLocation
quantity
quantity
quantity
PointInTime
quantity
 \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DirectLinking.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DirectLinking.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DirectLinking.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DirectLinking_Legend.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DirectLinking_Legend.svg new file mode 100644 index 00000000000..881818edf30 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DirectLinking_Legend.svg @@ -0,0 +1,3 @@ + + +
Demand data (MUST)
Demand data (optional)
Capacity data (MUST)
Capacity data (optional)
 \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DirectLinking_Legend.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DirectLinking_Legend.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_DirectLinking_Legend.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_ExampleCapacity.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_ExampleCapacity.svg new file mode 100644 index 00000000000..4212548db47 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_ExampleCapacity.svg @@ -0,0 +1 @@ +0100020003000400050006000Week 1Week 2Week 3Week 4Week 5Week 6Week 7Week 8Example: Capacity DataActual CapacityMaximum CapacityAgreed Capacity \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_ExampleCapacity.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_ExampleCapacity.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_ExampleCapacity.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_ExampleDemand.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_ExampleDemand.svg new file mode 100644 index 00000000000..d4899a05c34 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_ExampleDemand.svg @@ -0,0 +1 @@ +0100020003000400050006000Week 1Week 2Week 3Week 4Week 5Week 6Week 7Week 8Example: Demand DataDemand \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_ExampleDemand.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_ExampleDemand.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_ExampleDemand.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_ExampleMatchCompare.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_ExampleMatchCompare.svg new file mode 100644 index 00000000000..adbe420ccd0 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_ExampleMatchCompare.svg @@ -0,0 +1 @@ +0100020003000400050006000Week 1Week 2Week 3Week 4Week 5Week 6Week 7Week 8Example: Demand and Capacity Data Matching and Comparison within Capacity GroupDemand over actual capacityDemand within actual capacityDemand over actual but within maximum capacityActual capacityMaximum capacityAgreed capacity \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_ExampleMatchCompare.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_ExampleMatchCompare.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_ExampleMatchCompare.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_FunctionalBlockDiagram_Legend.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_FunctionalBlockDiagram_Legend.svg new file mode 100644 index 00000000000..3798e71d51b --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_FunctionalBlockDiagram_Legend.svg @@ -0,0 +1 @@ +
Demand data (MUST)
Demand data (optional)
Capacity data (MUST)
Capacity data (optional)
 \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_FunctionalBlockDiagram_Legend.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_FunctionalBlockDiagram_Legend.svg.license new file mode 100644 index 00000000000..0a9faa1647f --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_FunctionalBlockDiagram_Legend.svg.license @@ -0,0 +1,10 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 Capgemini SE +- SPDX-FileCopyrightText: 2024 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2024 Volkswagen AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_LoadFactor_example_diagram.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_LoadFactor_example_diagram.svg new file mode 100644 index 00000000000..1ae3e7dd1d3 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_LoadFactor_example_diagram.svg @@ -0,0 +1 @@ +CapacityGroup "Redand Chrome Toys"Machine1Variant “Red“ (PartNo. 1)Machine2Variant „Chrome“ (PartNo. 2)Machine3Variant „Red“+“Chrome“ (PartNo. 1+2)Actualweeklycapacity: 250 cycles*Weekly capacityin pcsWeekly capacityin cyclesWeekly demandin cyclesLoad factorWeekly demandin pcs1001001001.0100Variant„Red“751502002.0100Variant „Chrome“175250300200Variants„Red“+“Chrome“* e.g.productioncycles, minutesper unitproduced= Actualcapacityin unit“cycle” (unit:cycle) \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_LoadFactor_example_diagram.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_LoadFactor_example_diagram.svg.license new file mode 100644 index 00000000000..0a9faa1647f --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_LoadFactor_example_diagram.svg.license @@ -0,0 +1,10 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 Capgemini SE +- SPDX-FileCopyrightText: 2024 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2024 Volkswagen AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_LoadFactor_functional.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_LoadFactor_functional.svg new file mode 100644 index 00000000000..74c1ce93e12 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_LoadFactor_functional.svg @@ -0,0 +1 @@ +
WeekBasedCapacityGroup
Supplier
Customer
CapacityGroupID
changedAt
Calendar Week
DemandSeries
Inactive flag
UnitOfMeasure
CapacityGroupName
ActualCapacity
MaximumCapacity
AgreedCapacity
MaterialNumberCustomer
DemandCategory
CustomerLocation
PointInTime
quantity
Load Factor
 \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_LoadFactor_functional.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_LoadFactor_functional.svg.license new file mode 100644 index 00000000000..0a9faa1647f --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_LoadFactor_functional.svg.license @@ -0,0 +1,10 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 Capgemini SE +- SPDX-FileCopyrightText: 2024 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2024 Volkswagen AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_LoadFactor_functional_legend.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_LoadFactor_functional_legend.svg new file mode 100644 index 00000000000..3b596ea01c8 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_LoadFactor_functional_legend.svg @@ -0,0 +1,3 @@ + + +
Capacity data (MUST)
Capacity data (optional)
 \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_LoadFactor_functional_legend.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_LoadFactor_functional_legend.svg.license new file mode 100644 index 00000000000..0a9faa1647f --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_LoadFactor_functional_legend.svg.license @@ -0,0 +1,10 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 Capgemini SE +- SPDX-FileCopyrightText: 2024 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2024 Volkswagen AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_MDstructure.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_MDstructure.svg new file mode 100644 index 00000000000..bd8f29a776b --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_MDstructure.svg @@ -0,0 +1,3 @@ + + +
WeekBasedMaterialDemand
Supplier
Customer
changedAt
DemandSeries
MaterialDescriptionCustomer
MaterialNumberCustomer
MaterialDemandID
MaterialNumberCustomer
DemandCategory
CustomerLocation
InactiveFlag
UnitOfMeasure
PointInTime
DemandQuantity
 \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_MDstructure.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_MDstructure.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_MDstructure.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_MDstructure_Legend.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_MDstructure_Legend.svg new file mode 100644 index 00000000000..3f31748deb2 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_MDstructure_Legend.svg @@ -0,0 +1,3 @@ + + +
Demand data (MUST)
Demand data (optional)
 \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_MDstructure_Legend.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_MDstructure_Legend.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_MDstructure_Legend.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_UserJourney.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_UserJourney.svg new file mode 100644 index 00000000000..d151096f50f --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_UserJourney.svg @@ -0,0 +1,3 @@ + + +CustomerSupplier
Exchange demand
Exchange demandCustomer
Manage demand
Manage demandCustomer
Provide demand data
Provide demand dataSupplier
Consume demand data
Consume demand data
Exchange capacities
Exchange capacitiesSupplier
Manage capacity
Manage capacitySupplier
Link demand and capacity
Link demand and capacitySupplier
Provide capacity data
Provide capacity dataCustomer
Consume capacity data
Consume capacity data
Match and Compare
Match and CompareCustomerSupplier
Match and compare demand and capacity
Match and compare demand and capacityCustomerSupplier
Identifiy problems
Identifiy problems
Collaborate
CollaborateCustomerSupplier
Propose sulutions
Propose sulutionsCustomerSupplier
Evaluate solutions
Evaluate solutionsCustomerSupplier
Simulate solutions
Simulate solutionsCustomerSupplier
Decide on Measures
Decide on MeasuresCustomerSupplier
Solve problems
Solve problemsBasic DCM User Journey \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_UserJourney.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_UserJourney.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_UserJourney.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example1.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example1.svg new file mode 100644 index 00000000000..f7895becc3c --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example1.svg @@ -0,0 +1,3 @@ + + +Example 1Week14Week15Week16Week17Week18Week19Week20Week21Week22Week232000180016001400120010008006004002000. \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example1.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example1.svg.license new file mode 100644 index 00000000000..4f222eaf9b0 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example1.svg.license @@ -0,0 +1,9 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 BearingPoint Holding B.V +- SPDX-FileCopyrightText: 2024 Capgemini SE +- SPDX-FileCopyrightText: 2024 Renault SA +- SPDX-FileCopyrightText: 2024 Volvo Car Corporation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example2.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example2.svg new file mode 100644 index 00000000000..7f7d94ff117 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example2.svg @@ -0,0 +1 @@ +Example 2Week14Week15Week16Week17Week18Week19Week20Week21Week22Week232000180016001400120010008006004002000. \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example2.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example2.svg.license new file mode 100644 index 00000000000..4f222eaf9b0 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example2.svg.license @@ -0,0 +1,9 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 BearingPoint Holding B.V +- SPDX-FileCopyrightText: 2024 Capgemini SE +- SPDX-FileCopyrightText: 2024 Renault SA +- SPDX-FileCopyrightText: 2024 Volvo Car Corporation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example3.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example3.svg new file mode 100644 index 00000000000..72a939b7f53 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example3.svg @@ -0,0 +1 @@ +Example 3Week14Week15Week16Week17Week18Week19Week20Week21Week22Week232000180016001400120010008006004002000. \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example3.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example3.svg.license new file mode 100644 index 00000000000..4f222eaf9b0 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example3.svg.license @@ -0,0 +1,9 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 BearingPoint Holding B.V +- SPDX-FileCopyrightText: 2024 Capgemini SE +- SPDX-FileCopyrightText: 2024 Renault SA +- SPDX-FileCopyrightText: 2024 Volvo Car Corporation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example4a.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example4a.svg new file mode 100644 index 00000000000..280a1ba30fe --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example4a.svg @@ -0,0 +1 @@ +Example 4aWeek14Week15Week16Week17Week18Week19Week20Week21Week22Week2322002000180016001400120010008006004002000. \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example4a.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example4a.svg.license new file mode 100644 index 00000000000..4f222eaf9b0 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example4a.svg.license @@ -0,0 +1,9 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 BearingPoint Holding B.V +- SPDX-FileCopyrightText: 2024 Capgemini SE +- SPDX-FileCopyrightText: 2024 Renault SA +- SPDX-FileCopyrightText: 2024 Volvo Car Corporation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example4b.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example4b.svg new file mode 100644 index 00000000000..b69a7b85739 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example4b.svg @@ -0,0 +1,3 @@ + + +Example 4bWeek14Week15Week16Week17Week18Week19Week20Week21Week22Week2322002000180016001400120010008006004002000. \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example4b.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example4b.svg.license new file mode 100644 index 00000000000..4f222eaf9b0 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example4b.svg.license @@ -0,0 +1,9 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 BearingPoint Holding B.V +- SPDX-FileCopyrightText: 2024 Capgemini SE +- SPDX-FileCopyrightText: 2024 Renault SA +- SPDX-FileCopyrightText: 2024 Volvo Car Corporation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example_legend.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example_legend.svg new file mode 100644 index 00000000000..b60fb5dade4 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example_legend.svg @@ -0,0 +1,3 @@ + + +
Demand over Actual Capacity
Demand over Actual but within Maximum Capacity
Demand within Actual Capacity
Actual Capacity
Maximum Capacity
 \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example_legend.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example_legend.svg.license new file mode 100644 index 00000000000..4f222eaf9b0 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_capacity-types_example_legend.svg.license @@ -0,0 +1,9 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 BearingPoint Holding B.V +- SPDX-FileCopyrightText: 2024 Capgemini SE +- SPDX-FileCopyrightText: 2024 Renault SA +- SPDX-FileCopyrightText: 2024 Volvo Car Corporation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_demand_volatility_CG.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_demand_volatility_CG.svg new file mode 100644 index 00000000000..ea3e163af1e --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_demand_volatility_CG.svg @@ -0,0 +1 @@ +
WeekBasedCapacityGroup
Supplier
Customer
CapacityGroupID
changedAt
Calendar Week
Inactive flag
UnitOfMeasure
Demand Volatility
CapacityGroupName
ActualCapacity
MaximumCapacity
AgreedCapacity
quantity
quantity
quantity
 \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_demand_volatility_CG.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_demand_volatility_CG.svg.license new file mode 100644 index 00000000000..0b0a50d4396 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_demand_volatility_CG.svg.license @@ -0,0 +1,11 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2024 SAP SE +- SPDX-FileCopyrightText: 2024 SupplyOn AG +- SPDX-FileCopyrightText: 2024 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_demand_volatility_CG_legend.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_demand_volatility_CG_legend.svg new file mode 100644 index 00000000000..3b596ea01c8 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_demand_volatility_CG_legend.svg @@ -0,0 +1,3 @@ + + +
Capacity data (MUST)
Capacity data (optional)
 \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_demand_volatility_CG_legend.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_demand_volatility_CG_legend.svg.license new file mode 100644 index 00000000000..0b0a50d4396 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_demand_volatility_CG_legend.svg.license @@ -0,0 +1,11 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2024 SAP SE +- SPDX-FileCopyrightText: 2024 SupplyOn AG +- SPDX-FileCopyrightText: 2024 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_guide_capacity.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_guide_capacity.svg new file mode 100644 index 00000000000..078861867fc --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_guide_capacity.svg @@ -0,0 +1,3 @@ + + +
One-Up (Customer)
One-Down(Supplier)
Manage
Manage
Demand
Capacity
Match & Comparison
Collaboration
 \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_guide_capacity.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_guide_capacity.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_guide_capacity.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_guide_collab.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_guide_collab.svg new file mode 100644 index 00000000000..df50320bc53 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_guide_collab.svg @@ -0,0 +1,3 @@ + + +
One-Up (Customer)
One-Down(Supplier)
Manage
Manage
Demand
Capacity
Match & Comparison
Collaboration
 \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_guide_collab.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_guide_collab.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_guide_collab.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_guide_demand.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_guide_demand.svg new file mode 100644 index 00000000000..12227df12b6 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_guide_demand.svg @@ -0,0 +1,3 @@ + + +
One-Up (Customer)
One-Down(Supplier)
Manage
Manage
Demand
Capacity
Match & Comparison
Collaboration
 \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_guide_demand.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_guide_demand.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_guide_demand.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_guide_match.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_guide_match.svg new file mode 100644 index 00000000000..ffc951efc3d --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_guide_match.svg @@ -0,0 +1,3 @@ + + +
One-Up (Customer)
One-Down(Supplier)
Manage
Manage
Demand
Capacity
Match & Comparison
Collaboration
 \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_guide_match.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_guide_match.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_guide_match.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nTierLinking_Legend.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nTierLinking_Legend.svg new file mode 100644 index 00000000000..4bf629b12fe --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nTierLinking_Legend.svg @@ -0,0 +1,3 @@ + + +
CapacityGroup 1
CapacityGroup 2
CapacityGroup 3
CapacityGroup 4
CapacityGroup 5
CapacityGroup 6
CapacityGroup 7
 \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nTierLinking_Legend.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nTierLinking_Legend.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nTierLinking_Legend.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nesting_example-adv.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nesting_example-adv.svg new file mode 100644 index 00000000000..5d6f8feba51 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nesting_example-adv.svg @@ -0,0 +1 @@ +Capacity Group “Paint Shop”Capacity Group “Production Line 1”Capacity Group “Production Line 2”Material Demand “Toy 4”Material Demand “Toy 5”Capacity Group “Production Line 1”Material Demand “Toy 1”Capacity Group “Production Line 2”Material Demand “Toy 4”Material Demand “Toy 5”170 pieces100 pieces70 piecesMaterial Demand “Toy 1”Material Demand “Toy 2”Material Demand “Toy 3”150 piecesMaterial Demand “Toy 2”Material Demand “Toy 3”60 pieces40 pieces50 pieces \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nesting_example-adv.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nesting_example-adv.svg.license new file mode 100644 index 00000000000..720f8276cf0 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nesting_example-adv.svg.license @@ -0,0 +1,9 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 BearingPoint Holding B.V +- SPDX-FileCopyrightText: 2024 SAP SE +- SPDX-FileCopyrightText: 2024 Volvo Car Corporation +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nesting_example-basic.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nesting_example-basic.svg new file mode 100644 index 00000000000..d0cc643b192 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nesting_example-basic.svg @@ -0,0 +1 @@ +Capacity Group 3Capacity Group 1Material Demand 1Material Demand 2Capacity Group 2Material Demand 3Material Demand 4Capacity Group 1Material Demand 1Material Demand 2Capacity Group 2Material Demand 3Material Demand 4 \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nesting_example-basic.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nesting_example-basic.svg.license new file mode 100644 index 00000000000..720f8276cf0 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nesting_example-basic.svg.license @@ -0,0 +1,9 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 BearingPoint Holding B.V +- SPDX-FileCopyrightText: 2024 SAP SE +- SPDX-FileCopyrightText: 2024 Volvo Car Corporation +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nesting_example-recurrent.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nesting_example-recurrent.svg new file mode 100644 index 00000000000..e816e4a2b43 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nesting_example-recurrent.svg @@ -0,0 +1 @@ +CapacityGroup -1SupplierInactiveFlagCustomerUnit ofMeasureCapacityGroup IDNameChangedAtCalendarWeekActualCapacityQuantityMaximum CapacityQuantityAgreedCapacityQuantityDelta ProductionQuantityLinkedCapacityGroupsCapacityGroup -2CapacityGroup -3SupplierInactiveFlagCustomerUnit ofMeasureCapacityGroup IDNameChangedAtCalendarWeekActualCapacityQuantityMaximum CapacityQuantityAgreedCapacityQuantityDelta ProductionQuantityLinkedDemand SeriesCustomer Material NumberDemand CategoryCustomer LocationLoad FactorCapacityGroup -2SupplierInactiveFlagCustomerUnit ofMeasureCapacityGroup IDNameChangedAtCalendarWeekActualCapacityQuantityMaximum CapacityQuantityAgreedCapacityQuantityDelta ProductionQuantityLinkedCapacityGroupsCapacityGroup -3LegendCapacityGroup -mandatoryCapacityGroup -optionalMaterial Demand -mandatoryMaterial Demand -optional \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nesting_example-recurrent.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nesting_example-recurrent.svg.license new file mode 100644 index 00000000000..720f8276cf0 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nesting_example-recurrent.svg.license @@ -0,0 +1,9 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 BearingPoint Holding B.V +- SPDX-FileCopyrightText: 2024 SAP SE +- SPDX-FileCopyrightText: 2024 Volvo Car Corporation +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nesting_example_legend.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nesting_example_legend.svg new file mode 100644 index 00000000000..8e5c8e4ce74 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nesting_example_legend.svg @@ -0,0 +1 @@ +Demand data (directly linked)Demand data (indirectly linked)Capacity dataCapacity data (linked or nested) \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nesting_example_legend.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nesting_example_legend.svg.license new file mode 100644 index 00000000000..720f8276cf0 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/business-process_nesting_example_legend.svg.license @@ -0,0 +1,9 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 BearingPoint Holding B.V +- SPDX-FileCopyrightText: 2024 SAP SE +- SPDX-FileCopyrightText: 2024 Volvo Car Corporation +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/compare-md-cg.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/compare-md-cg.svg new file mode 100644 index 00000000000..14620ec2fef --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/compare-md-cg.svg @@ -0,0 +1,3 @@ + + +Example: Demand and Capacity Data Matching and Comparison within Capacity GroupWeek1Week2Week3Week4Week5Week6Week7Week8600055005000450040003500300025002000150010005000. \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/compare-md-cg.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/compare-md-cg.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/resources/compare-md-cg.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/rfu.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/rfu.md new file mode 100644 index 00000000000..dff7ada86ed --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/adoption-view/use-case/rfu.md @@ -0,0 +1,63 @@ +--- +id: rfu +title: Request for Update +description: Request updates from your partner +sidebar_position: 5 +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## Business Roles and Functions + +Request for update uses its own aspect model and API. Request for update is provided and consumed by both customer and supplier. + +|Function / Role|Customer|Supplier| +|-|-|-| +|Identify demand or capacity data that is not recent|X|X| +|Inform business partner about data that needs updating|X|X| +|Provide business partner with fresh data|X|X| +|Show users how fresh the data is |X|X| + +## Sequence Diagram + +```mermaid +sequenceDiagram +autonumber +Participant c as Customer / Supplier +Participant s as Supplier / Customer +c->>c: One of my users is viewing some data +c->>c: This data from my partner is 6 months old and I received the last update 2 months ago. +rect rgb(4,107,153) + c->>s: I have data known by ID e03ac75f with timestamp 2023.12.12 do you have a more recent version? +end +c->>c: Inform user that I am synchronizing the data +alt Data not in sync + s->>c: Here is a more recent version of data e03ac75f +else Data still in sync + autonumber 5 + s->>c: You already have the most recent version of data e03ac75f +end +c->>c: Show user how old the data is and when it was last synchronized. +``` + +Figure: *Utilizing request for update* + +For further details, please refer to [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation + +[StandardLibrary]: https://catenax-ev.github.io/docs/next/standards/CX-0128-DemandandCapacityManagementDataExchange diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/architecture-view/dependencies.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/architecture-view/dependencies.md new file mode 100644 index 00000000000..54e9fda024f --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/architecture-view/dependencies.md @@ -0,0 +1,91 @@ +--- +id: dependencies +title: Dependencies +description: Dependencies +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## Standard Dependencies + +Designing an implementing an application that conforms to CX-0128 - DEMAND AND CAPACITY MANAGEMENT DATA EXCHANGE V.2.1.0, means not only conforming to CX-0128 but also to all standards that CX-0128 depends upon. + +### Dependency Graph + +In order to keep things orderly some restrictions to this graph apply: + +- The first first mention of a standard is marked by using the standards name in addition to its ID (e.g. CX-0011 ISSUING AGENCY). +- Further mentions are denoted by using only the standards ID (e.g. CX-0011). +- To avoid visual loops, only the first mention of a standard is resolved further for standard dependencies. +- Catena-X standards can be identified by their ID (e.g. CX-0011). +- Non Catena-X standards are never resolved further. + +![Dependency Graph](./resources/dependencies_dependency-graph.svg) + +Figure: *Dependencies* + + + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/architecture-view/overview.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/architecture-view/overview.md new file mode 100644 index 00000000000..dfb7f91d750 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/architecture-view/overview.md @@ -0,0 +1,202 @@ +--- +id: overview +title: Architecture View +description: The view from above +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## Why​ + +This page is relevant for you, if one of the following cases applies: + +1. You want to participate in the demand and capacity usecase as either a customer or a supplier and intend to adapt your existing custom application landscape to Catena-X DCM. +2. You want to offer business solutions to the aforementioned customers and suppliers by adapting your commercial software product for Catena-X DCM. + +If none of this applies to you or you are unsure, please refer to [Operation View](../operation-view.md) first. + +> Note: If you purchase commercial software from a software vendor, the vendor needs to adopt their software for you. Please refer your vendor to this page. + +## Prerequisites + +In order to participate in the Catena-X network an Eclipse Dataspace Connector (EDC), or a similar connector fulfilling the Dataspace Protocol, is required, as the endpoints must not be called directly but only through a Data Asset/Contract Offer. + +In addition use case participants need to be boarded onto the Catena-X network. + +Participants intending to act as a customer require at least one BPNL for their company as well as one BPNS for every site they intend to integrate into the Catena-X network. + +Participants intending to act as a supplier require at least one BPNL for their company. + +## How + +If you want to adapt your custom or commercial applications to work with the Catena-X DCM usecase you will have to + +1. Modify the source code of your application +2. Enable your software to offer multiple REST API endpoints in order to receive data +3. Enable your software to call multiple REST API endpoints in order to send data +4. Enable your software to communicate through an Eclipse Dataspace Connector (EDC), or a similar solution, which is to be setup separately + +For details, please refer to the Catena-X DCM standard [CX-0128][StandardLibrary]. This page provides a non-normative overview only. + +## Solution Overview + +For the exchange of the demand and capacity information required by the process, five REST APIs are used: + +- WeekBasedMaterialDemand API - used for the exchange of demand information +- WeekBasedCapacityGroup API - used for the exchange of capacity information +- RequestForUpdate API - used for requesting an update of WeekBasedMaterialDemand or WeekBasedCapacityGroup +- IdBasedComment API - used for the exchange of additional comments regarding WeekBasedMaterialDemand or WeekBasedCapacityGroup +- Asset Administration Shell (AAS) API - used when using DCM in combination with a Digital Twin Registry + +All those APIs are REST-based APIs. + +Implementing all endpoints is mandatory, except the AAS API endpoint, which is optional. + +Note that the software solutions used as well as the business process should be enabled in order to receive WeekBasedMaterialDemand information from customers and send WeekBasedCapacityGroup information back to those customers. Also, it needs to be possible to send the own WeekBasedMaterialDemand information to the suppliers and receive their WeekBasedCapacityGroup information in return. Therefore, the software tools used need to be able to send/receive these information and the users need to be able to work with the information in the planning processes. + +When implementing the API endpoints, it is important to follow the DCM standard closely in order to ensure compatibility with other solutions. This is not limited to technical aspects, but also extends to the business definition of demand and capacity. + +### Architecture Constraints + +| Constraint ID | Constraint | +| ------------- | ------------- | +| C-1 | Software and third party software must be compliant to the Catena-X and Eclipse Foundation Guidelines/Policies [eclipse_foundation](https://www.eclipse.org/projects/dev_process/) | +| C-2 | [Eclipse Dataspace Connector](https://github.com/eclipse-tractusx/tractusx-edc/tree/main) (EDC), or a similar solution, must be used for data transfer between different legal entities; e.g. the API endpoints listed above may only be called through a Data Asset/Contract Offer | + +## Sequence Diagram + +The overall interaction between partners is illustrated by the following sequence diagram: + +```mermaid +sequenceDiagram + box rgb(97,97,97) Customer + actor Customer + participant CustomerApp as Customer App + participant CustomerConnector as Customer connector + end + box rgb(97,97,97) Core Services + participant CoreBpnlDiscovery as Core BPNL Discovery + participant CoreEdcDiscovery as Core EDC discovery + end + box rgb(97,97,97) Supplier + participant SupplierConnector as Supplier connector + participant SupplierApp as Supplier App + actor Supplier + end + rect rgb(221,130,0) + note right of Customer: Customer creates MaterialDemand locally + Customer ->> CustomerApp: Create MaterialDemand + activate CustomerApp + CustomerApp -->> Customer: MaterialDemand created + deactivate CustomerApp + Customer ->> CustomerApp: Finalize MaterialDemand + end + rect rgb(4,107,153) + note right of CustomerApp: Customer App finds endpoint of Supplier + activate CustomerApp + CustomerApp ->> CoreBpnlDiscovery: Resolve Supplier Base Data into BPNL + activate CoreBpnlDiscovery + CoreBpnlDiscovery -->> CustomerApp: Supplier BPNL + deactivate CoreBpnlDiscovery + CustomerApp ->> CoreEdcDiscovery: Resolve Supplier BPNL into connector URL catalogue + activate CoreEdcDiscovery + CoreEdcDiscovery -->> CustomerApp: Connector URL catalogue + deactivate CoreEdcDiscovery + CustomerApp ->> CustomerApp: Find correct connector via URL catalogue inspection + activate CustomerConnector + CustomerConnector ->> SupplierConnector: Resolve connector Endpoint and connector service catalogue into MaterialDemand API URL + activate SupplierConnector + SupplierConnector ->> CustomerConnector: Framework & Contract Negotiation + CustomerConnector -->> SupplierConnector: Framework & Contract Negotiation + SupplierConnector -->> CustomerConnector: MaterialDemand API URL + end + rect rgb(221,130,0) + note right of Customer: Exchange Material Demand + CustomerApp ->> CustomerConnector: Transmit MaterialDemand + CustomerConnector ->> SupplierConnector: Transmit MaterialDemand + SupplierConnector ->> SupplierApp: Transmit MaterialDemand + activate SupplierApp + SupplierApp ->> Supplier: Transmit MaterialDemand + Supplier -->> SupplierApp: MaterialDemand received + SupplierApp -->> SupplierConnector: MaterialDemand received + deactivate SupplierApp + SupplierConnector -->> CustomerConnector: MaterialDemand received + deactivate SupplierConnector + CustomerConnector -->> CustomerApp: MaterialDemand received + deactivate CustomerConnector + CustomerApp -->> Customer: MaterialDemand finalized & synchronized + deactivate CustomerApp + end + rect rgb(128,149,0) + note left of Supplier: Supplier creates CapacityGroup locally + Supplier ->> SupplierApp: Create CapacityGroup + activate SupplierApp + SupplierApp -->> Supplier: CapacityGroup created + deactivate SupplierApp + Supplier ->> SupplierApp: Link Demands to CapacityGroup + activate SupplierApp + SupplierApp -->> Supplier: Demands Linked + deactivate SupplierApp + Supplier ->> SupplierApp: Finalize CapacityGroup + end + rect rgb(4,107,153) + note left of SupplierApp: Supplier App finds endpoint of Customer + activate SupplierApp + SupplierApp ->> CoreBpnlDiscovery: Resolve Customer Base Data into BPNL + activate CoreBpnlDiscovery + CoreBpnlDiscovery -->> SupplierApp: Customer BPNL + deactivate CoreBpnlDiscovery + SupplierApp ->> CoreEdcDiscovery: Resolve Customer BPNL into connector URL catalogue + activate CoreEdcDiscovery + CoreEdcDiscovery -->> SupplierApp: connector URL catalogue + deactivate CoreEdcDiscovery + SupplierApp ->> SupplierApp: Find correct connector via URL catalogue inspection + SupplierApp ->> SupplierConnector: Transmit CapacityGroup + activate SupplierConnector + SupplierConnector ->> CustomerConnector: Resolve connector Endpoint and connector service catalogue into CapacityGroup API URL + activate CustomerConnector + CustomerConnector ->> SupplierConnector: Framework & Contract Negotiation + SupplierConnector -->> CustomerConnector: Framework & Contract Negotiation + CustomerConnector -->> SupplierConnector: CapacityGroup API Endpoint + end + rect rgb(128,149,0) + note left of Supplier: Exchange Capacity Group + SupplierConnector ->> CustomerConnector: Transmit CapacityGroup + CustomerConnector ->> CustomerApp: Transmit CapacityGroup + activate CustomerApp + CustomerApp ->> Customer: Transmit CapacityGroup + Customer -->> CustomerApp: CapacityGroup received + CustomerApp -->> CustomerConnector: CapacityGroup received + deactivate CustomerApp + CustomerConnector -->> SupplierConnector: CapacityGroup received + deactivate CustomerConnector + SupplierConnector -->> SupplierApp: CapacityGroup received + deactivate SupplierConnector + SupplierApp -->> Supplier: CapacityGroup finalized & synchronized + deactivate SupplierApp + end +``` + +Figure: *Core business process* + +Note that the supplier does not need to immediately reply with capacity group after receiving demand information, although a timely reply is appreciated, there can be a considerable time in between instead. + +Digital Twins can also be used to reference parts, but are not shown in the sequence diagram for simplicity. + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation + +[StandardLibrary]: https://catenax-ev.github.io/docs/next/standards/CX-0128-DemandandCapacityManagementDataExchange diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/architecture-view/resources/dependencies_dependency-graph.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/architecture-view/resources/dependencies_dependency-graph.svg new file mode 100644 index 00000000000..32cf4902ea4 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/architecture-view/resources/dependencies_dependency-graph.svg @@ -0,0 +1,3 @@ + + +CX-0128 - DEMAND ANDCAPACITY MANAGEMENTDATA EXCHANGE V.2.1.0CX-0001 EDC Discovery APICX-0006 Registration andinitial onboardingCX-0009 CATENA-XREGISTRATION APICX-0010CX-0011 ISSUING AGENCYCX-0010ISO/IEC 15459CX-0013 IDENTITY OFMEMBER COMPANIESCX-0049 DID DocumentSchemaCX-0149CX-0010CX-0002 Digital Twins inCatena-XCX-0003CX-0018CX-0001CX-0053 BPN DiscoveryService APIsCX-0010CX-0044 ECLASSECLASS HomepageCX-0003 SAMM Aspect MetaModelSAMM Semantic AspectMeta ModelCX-0002Catena-X Operating ModelWhitepaperCX-0010 Business PartnerNumberCX-0018 DataspaceConnectivityIDSA Dataspace ProtocolIdentity And Trust ProtocolCX-0050 FrameworkAgreement CredentialCX-0149 Verfied CompanyIdentityCX-0010CX-0011CX-0015 IAM & AccessControl ParadigmINCITS 565-2020CX-0050Identity TrustCredential PresentationProtocolTractus-X ProfilesCX-0126 Industry Core: PartTypeCX-0001CX-0002CX-0003CX-0018CX-0146 Supply ChainDisruption Notifications \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/architecture-view/resources/dependencies_dependency-graph.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/architecture-view/resources/dependencies_dependency-graph.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/architecture-view/resources/dependencies_dependency-graph.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/changelog.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/changelog.md new file mode 100644 index 00000000000..9d9347d7827 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/changelog.md @@ -0,0 +1,124 @@ +--- +id: changelog +title: Changelog +description: 'What has changed recently?' +toc_min_heading_level: 2 +toc_max_heading_level: 2 +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## DCM KIT Changelog + +All notable changes to this Kit will be documented in this file. + +## [1.2.0] - 2024-12-02 + +### Added + +- Added E2E Tests to [Development View](./development-view/overview.md) +- Added Glossary to [Adoption View](./adoption-view/overview.md) +- Added Delta Production to [Adoption View](./adoption-view/overview.md) +- Added Demand Volatility to [Adoption View](./adoption-view/overview.md) +- Added Load Factors to [Adoption View](./adoption-view/overview.md) +- Added Nesting to [Adoption View](./adoption-view/overview.md) + +### Changed + +- Updated [Core Business Process](./adoption-view/use-case/business-process.md) with assorted examples of capacity groups and material demands +- Updated [Onboarding](./adoption-view/onboarding.md) to include an onboarding journey + +## [1.1.0] - 2024-08-05 + +### Added + +- Added multiple diagrams to [Development View](./development-view/overview.md) +- Added APIs to [Development View](./development-view/overview.md) +- Added Use Case to [Adoption View](./adoption-view/overview.md) +- Added Q&A to [Adoption View](./adoption-view/overview.md) + +### Changed + +- Restructured [Development View](./development-view/overview.md) +- Restructured [Adoption View](./adoption-view/overview.md) +- Recolored sequence diagram in [Architecture View](./architecture-view/overview.md) +- Moved onboarding content from [Operation View](./operation-view.md) to [Adoption View](./adoption-view/overview.md) + +## [1.0.0] - 2024-05-24 + +### Added + +- Added [DCM Operation View](./operation-view.md) + +### Changed + +- Changed banner image file location and converted .png image to .svg +- Updated aspect models in [Architecture View](./architecture-view/overview.md) to new versions +- Updated aspect models and API definitions in [Development View](./development-view/overview.md) to new versions +- Updated WeekBasedMaterialDemand data model and API chapters to new data model (Replaced MaterialDemand with WeekBasedMaterialDemand aspect model) +- Updated choice of words and writing pattern throughout the documentation + +### Removed + +- ./. + +## [0.2.0] - 2024-03-08 + +### Added + +- Added Architecture View +- Added IdBasedRequestForUpdate data model reference to Adoption View +- Added IdBasedComment data model reference to Adoption View +- Added IdBasedRequestForUpdate data model chapter to Development View +- Added IdBasedComment data model chapter to Development View +- Added IdBasedRequestForUpdate API chapter to Development View +- Added IdBasedComment API chapter to Development View + +### Changed + +- Updated DCM standard references in Adoption View (Merged CX-0046, CX-0047 and CX-0048 into CX-0128) +- Updated data model references in Adoption View +- Updated MaterialDemand data model chapter to new data models and versions (Replaced WeekBasedMaterialDemand with MaterialDemand aspect model) +- Updated WeekBasedCapacityGroup data model chapter to new data models and versions +- Updated MaterialDemand API chapter to new API definitions +- Updated WeekBasedCapacityGroup API chapter to new API definitions + +### Removed + +n/a + +## [0.1.0] - 2023-03-01 + +### Added + +- Adoption View +- Development View + +### Changed + +n/a + +### Removed + +n/a + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 BearingPoint Holding B.V +- SPDX-FileCopyrightText: 2024 Capgemini SE +- SPDX-FileCopyrightText: 2024 CatX Service GmbH +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2024 Renault SA +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2024 Volvo Car Corporation +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/api-aas.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/api-aas.md new file mode 100644 index 00000000000..4c6f15da6e6 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/api-aas.md @@ -0,0 +1,36 @@ +--- +id: api-aas +title: API - AAS +description: API - AAS +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## DCM Asset Administration Shell API (AAS API) + +### Roles and Functions + +|Role / Function|API Owner|POST to API| +|-|-|-| +|Customer|X|X| +|Supplier|X|X| + +For further details, please refer to [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. + +[StandardLibrary]: https://catenax-ev.github.io/docs/next/standards/CX-0128-DemandandCapacityManagementDataExchange + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/api-capacity-group.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/api-capacity-group.md new file mode 100644 index 00000000000..922eb36a774 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/api-capacity-group.md @@ -0,0 +1,77 @@ +--- +id: api-WeekBasedCapacityGroup +title: API - WeekBasedCapacityGroup +description: API - WeekBasedCapacityGroup +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## WeekBasedCapacityGroup API + +The WeekBasedCapacityGroup API is owned and registered as an EDC asset by the supplier. The customer provides capacity group data to the API via POST request. + +### Roles and Functions + +|Role / Function|API Owner|POST to API| +|-|-|-| +|Customer||X| +|Supplier|X|| + +### Data Exchange + +```mermaid +sequenceDiagram +autonumber + actor c as Customer + participant ce as Customer EDC + participant se as Supplier EDC + participant a as WeekBasedCapacityGroup API + actor s as Supplier + + rect rgb(217,24,24) + s->>+se: Register API as Asset + se->>-s: API registered + end + rect rgb(128,149,00) + c->>+ce: Provide WeekBasedCapacityGroup + rect rgb(179,203,45) + ce->>+se: Initiate Handshake + se->>ce: Complete Handshake + end + ce->>se: Provide WeekBasedCapacityGroup + se->>+a: Provide WeekBasedCapacityGroup + a->>-se: WeekBasedCapacityGroup consumed + se->>-ce: WeekBasedCapacityGroup consumed + ce->>-c: WeekBasedCapacityGroup consumed + + end + +``` + +Figure: *Exchanging WeekBasedCapacityGroup via API* + +### Open API documentation + +|API|Link| +|-|-| +|WeekBasedCapacityGroup|[Find here](./plugin-generated-capacity-group-api/post-week-based-capacity-group.api.mdx)| + +For further details, please refer to [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. + +[StandardLibrary]: https://catenax-ev.github.io/docs/next/standards/CX-0128-DemandandCapacityManagementDataExchange + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/api-comment.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/api-comment.md new file mode 100644 index 00000000000..85b2bae348e --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/api-comment.md @@ -0,0 +1,98 @@ +--- +id: api-IdBasedComment +title: API - IdBasedComment +description: API - IdBasedComment +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## IdBasedComment API + +The IdBasedComment API is owned and registered as an EDC asset by both customer and supplier. The corresponding business partner (supplier and customer) provides comment data to the API via POST request. + +### Roles and Functions + +|Role / Function|API Owner|POST to API| +|-|-|-| +|Customer|X|X| +|Supplier|X|X| + +### Data Exchanges + +```mermaid +sequenceDiagram + actor c as Customer + participant ca as Comment API + participant ce as Customer EDC + participant se as Supplier EDC + participant sa as Comment API + actor s as Supplier + + rect rgb(217,24,24) + autonumber 1 + c->>+ce: Register API as Asset + ce->>-c: API registered + end + rect rgb(217,24,24) + autonumber 1 + s->>+se: Register API as Asset + se->>-s: API registered + end +autonumber 1 + rect rgb(04,107,153) + c->>+ce: Provide IdBasedComment + rect rgb(33,157,212) + ce->>+se: Initiate Handshake + se->>ce: Complete Handshake + end + ce->>se: Provide IdBasedComment + se->>+sa: Provide IdBasedComment + sa->>-se: IdBasedComment consumed + se->>-ce: IdBasedComment consumed + ce->>-c: IdBasedComment consumed + + end + + rect rgb(04,107,153) + s->>+se: Provide IdBasedComment + rect rgb(33,157,212) + se->>+ce: Initiate Handshake + ce->>se: Complete Handshake + end + se->>ce: Provide IdBasedComment + ce->>+ca: Provide IdBasedComment + ca->>-ce: IdBasedComment consumed + ce->>-se: IdBasedComment consumed + se->>-s: IdBasedComment consumed + + end + +``` + +Figure: *Exchanging IdBasedComment via API* + +### Open API documentation + +|API|Link| +|-|-| +|IdBasedComment|[Find here](./plugin-generated-comment-api/post-id-based-comment.api.mdx)| + +For further details, please refer to [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. + +[StandardLibrary]: https://catenax-ev.github.io/docs/next/standards/CX-0128-DemandandCapacityManagementDataExchange + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/api-material-demand.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/api-material-demand.md new file mode 100644 index 00000000000..59e17dbdb0c --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/api-material-demand.md @@ -0,0 +1,77 @@ +--- +id: api-WeekBasedMaterialDemand +title: API - WeekBasedMaterialDemand +description: API - WeekBasedMaterialDemand +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## WeekBasedMaterialDemand API + +The WeekBasedMaterialDemand API is owned and registered as an EDC asset by the customer. The supplier provides material demand data to the API via POST request. + +### Roles and Functions + +|Role / Function|API Owner|POST to API| +|-|-|-| +|Customer|X|| +|Supplier||X| + +### Data Exchange + +```mermaid +sequenceDiagram + actor c as Customer + participant a as WeekBasedMaterialDemand API + participant ce as Customer EDC + participant se as Supplier EDC + actor s as Supplier + + rect rgb(217,24,24) + autonumber 1 + c->>+ce: Register API as Asset + ce->>-c: API registered + end + rect rgb(221,130,0) + autonumber 1 + s->>+se: Provide WeekBasedMaterialDemand + rect rgb(255,166,0) + se->>+ce: Initiate Handshake + ce->>se: Complete Handshake + end + se->>ce: Provide WeekBasedMaterialDemand + ce->>+a: Provide WeekBasedMaterialDemand + a->>-ce: WeekBasedMaterialDemand consumed + ce->>-se: WeekBasedMaterialDemand consumed + se->>-s: WeekBasedMaterialDemand consumed + + end +``` + +Figure: *Exchanging WeekBasedMaterialDemand via API* + +### Open API documentation + +|API|Link| +|-|-| +|WeekBasedMaterialDemand|[Find here](./plugin-generated-material-demand-api/post-week-based-material-demand.api.mdx)| + +For further details, please refer to [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation + +[StandardLibrary]: https://catenax-ev.github.io/docs/next/standards/CX-0128-DemandandCapacityManagementDataExchange diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/api-rfu.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/api-rfu.md new file mode 100644 index 00000000000..d4c17bfa5ad --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/api-rfu.md @@ -0,0 +1,94 @@ +--- +id: api-IdBasedRequestForUpdate +title: API - IdBasedRequestForUpdate +description: API - IdBasedRequestForUpdate +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## IdBasedRequestForUpdate API + +The RequestForUpdate API is owned and registered as an EDC asset by both customer and supplier. The corresponding business partner (supplier and customer) provides request for update data to the API via POST request. + +### Roles and Functions + +|Role / Function|API Owner|POST to API| +|-|-|-| +|Customer|X|X| +|Supplier|X|X| + +### Data Exchange + +```mermaid +sequenceDiagram + actor c as Customer + participant ca as Request for Update API + participant ce as Customer EDC + participant se as Supplier EDC + participant sa as Request for Update API + actor s as Supplier + rect rgb(217,24,24) + autonumber 1 + c->>+ce: Register API as Asset + ce->>-c: API registered + end + rect rgb(217,24,24) + autonumber 1 + s->>+se: Register API as Asset + se->>-s: API registered + end + rect rgb(04,107,153) + autonumber 1 + c->>+ce: Provide IdBasedRequestForUpdate + rect rgb(33,157,212) + ce->>+se: Initiate Handshake + se->>ce: Complete Handshake + end + ce->>se: Provide IdBasedRequestForUpdate + se->>+sa: Provide IdBasedRequestForUpdate + sa->>-se: IdBasedRequestForUpdate consumed + se->>-ce: IdBasedRequestForUpdate consumed + ce->>-c: IdBasedRequestForUpdate consumed + end + rect rgb(04,107,153) + s->>+se: Provide IdBasedRequestForUpdate + rect rgb(33,157,212) + se->>+ce: Initiate Handshake + ce->>se: Complete Handshake + end + se->>ce: Provide IdBasedRequestForUpdate + ce->>+ca: Provide IdBasedRequestForUpdate + ca->>-ce: IdBasedRequestForUpdate consumed + ce->>-se: IdBasedRequestForUpdate consumed + se->>-s: IdBasedRequestForUpdate consumed + end + +``` + +Figure: *Exchanging IdBasedRequestForUpdate via API* + +### Open API documentation + +|API|Link| +|-|-| +|IdBasedRequestForUpdate|[Find here](./plugin-generated-rfu-api/post-id-based-request-for-update.api.mdx)| + +For further details, please refer to [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation + +[StandardLibrary]: https://catenax-ev.github.io/docs/next/standards/CX-0128-DemandandCapacityManagementDataExchange diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/model-capacity-group.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/model-capacity-group.md new file mode 100644 index 00000000000..bdcd398b242 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/model-capacity-group.md @@ -0,0 +1,131 @@ +--- +id: model-WeekBasedCapacityGroup +title: Aspect Model - WeekBasedCapacityGroup +description: Aspect Model - WeekBasedCapacityGroup +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## Aspect Model "WeekBasedCapacityGroup" + +Suppliers provide customers capacity data as `WeekBasedCapacityGroup` aspect models. Suppliers also link demand data to `WeekBasedCapacityGroup` aspect models. + +### Roles and Rights + +|Role / Right|Create|Change|Read| +|-|-|-|-| +|Customer|||X| +|Supplier|X|X|X| + +### Structure of a WeekBasedCapacityGroup + +![WeekBasedCapacityGroup Structure](./resources/model-capacity-group_structure.svg) +![WeekBasedCapacityGroup Structure Legend](./resources/model-capacity-group_legend.svg) + +Figure: *WeekBasedCapacityGroup structure* + + + +### Example data + +```json +{ + "unitOfMeasure" : "unit:piece", + "linkedDemandSeries" : [ { + "loadFactor" : 3.5, + "materialNumberCustomer" : "MNR-7307-AU340474.002", + "materialNumberSupplier" : "MNR-8101-ID146955.001", + "customerLocation" : "{{CATENAX-CUSTOMER-BPNS}}", + "demandCategory" : { + "demandCategoryCode" : "0001" + } + } ], + "linkedCapacityGroups" : [ "be4d8470-2de6-43d2-b5f8-2e5d3eebf3fd" ], + "unitOfMeasureIsOmitted" : false, + "capacityGroupIsInactive" : true, + "demandVolatilityParameters" : { + "rollingHorizonAlertThresholds" : [ { + "sequenceNumber" : 1, + "absoluteNegativeDeviation" : 100.0, + "subhorizonLength" : 4, + "relativeNegativeDeviation" : 0.3, + "absolutePositiveDeviation" : 100.0, + "relativePositiveDeviation" : 0.2 + } ], + "measurementInterval" : 4, + "startReferenceDateTime" : "2024-01-10T12:00:00.320Z" + }, + "supplier" : "{{CATENAX-SUPPLIER-BPNL}}", + "name" : "Spark Plugs on drilling machine for car model XYZ", + "supplierLocations" : [ "{{CATENAX-SUPPLIER-BPNS}}" ], + "capacities" : [ { + "pointInTime" : "2022-08-01", + "agreedCapacity" : 1800, + "actualCapacity" : 1000, + "maximumCapacity" : 2000, + "deltaProductionResult" : 400 + } ], + "changedAt" : "2023-03-10T12:27:11.320Z", + "capacityGroupId" : "0157ba42-d2a8-4e28-8565-7b07830c1110", + "customer" : "{{CATENAX-CUSTOMER-BPNL}}" +} +``` + +All file formats and serializations are derived from a RDF turtle file. It is the source for the Semantic Aspect Meta Model. You can access the RDF turtle file at the following URL: + +```text +https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.week_based_capacity_group/3.0.0/WeekBasedCapacityGroup.ttl +``` + +For further details, please refer to [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation + +[StandardLibrary]: https://catenax-ev.github.io/docs/next/standards/CX-0128-DemandandCapacityManagementDataExchange diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/model-comment.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/model-comment.md new file mode 100644 index 00000000000..40d62702451 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/model-comment.md @@ -0,0 +1,94 @@ +--- +id: model-IdBasedComment +title: Aspect Model - IdBasedComment +description: Aspect Model - IdBasedComment +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## Aspect Model "IdBasedComment" + +Customer and suppliers provide each other `IdBasedComment` aspect models in order to exchange additional information on `WeekBasedCapacityGroup` and `WeekBasedMaterialDemand`. + +### Roles and Rights + +|Role / Right|Create|Change|Read| +|-|-|-|-| +|Customer|X|X|X| +|Supplier|X|X|X| + +### Structure of a IdBasedComment + +![IdBasedComment Structure](./resources/model-comment_structure.svg) +![IdBasedComment Structure Legend](./resources/model-comment_legend.svg) + +Figure: *IdBasedComment structure* + + + +### Example data + +```json +{ + "postedAt" : "2023-03-10T12:27:11.320Z", + "listOfReferenceDates" : [ "2023-11-05" ], + "author" : "someone@company.com", + "supplier" : "{{CATENAX-SUPPLIER-BPNL}}", + "commentType" : "information", + "commentId" : "f5c151e4-30b5-4456-94fd-2a7b559b6121", + "changedAt" : "2023-03-10T12:27:11.320Z", + "commentText" : "Hello, this is a comment!", + "requestDelete" : true, + "objectId" : "dfeb1334-497e-4dab-97c1-4e6f4e1c0320", + "objectType" : "urn:samm:io.catenax.week_based_capacity_group", + "customer" : "{{CATENAX-CUSTOMER-BPNL}}" +} +``` + +All formats and serializations are derived from a RDF turtle file. It is the source for the Semantic Aspect Meta Model. You can access the RDF turtle file at the following URL: + +```text +https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.id_based_comment/1.0.0/IdBasedComment.ttl +``` + +For further details, please refer to [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation + +[StandardLibrary]: https://catenax-ev.github.io/docs/next/standards/CX-0128-DemandandCapacityManagementDataExchange diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/model-material-demand.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/model-material-demand.md new file mode 100644 index 00000000000..b640bb4d949 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/model-material-demand.md @@ -0,0 +1,117 @@ +--- +id: model-WeekBasedMaterialDemand +title: Aspect Model - WeekBasedMaterialDemand +description: Aspect Model - WeekBasedMaterialDemand +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## Aspect Model "WeekBasedMaterialDemand" + +Customer provide suppliers demand data as `WeekBasedMaterialDemand` aspect models. + +### Roles and Rights + +|Role / Right|Create|Change|Read| +|-|-|-|-| +|Customer|X|X|X| +|Supplier|||X| + +### Structure of a WeekBasedMaterialDemand + +![WeekBasedMaterialDemand Structure](./resources/model-material-demand_structure.svg) +![WeekBasedMaterialDemand Structure Legend](./resources/model-material-demand_legend.svg) + +Figure: *WeekBasedMaterialDemand structure* + + +### Example data + +```json +{ + "unitOfMeasureIsOmitted" : false, + "unitOfMeasure" : "unit:piece", + "materialDescriptionCustomer" : "Spark Plug", + "materialGlobalAssetId" : "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df", + "materialDemandId" : "0157ba42-d2a8-4e28-8565-7b07830c1110", + "materialNumberSupplier" : "MNR-8101-ID146955.001", + "supplier" : "{{CATENAX-SUPPLIER-BPNL}}", + "changedAt" : "2023-11-05T08:15:30.123-05:00", + "demandSeries" : [ { + "expectedSupplierLocation" : "{{CATENAX-SUPPLIER-BPNS}}", + "demands" : [ { + "demand" : 1000, + "pointInTime" : "2023-10-09" + } ], + "customerLocation" : "{{CATENAX-CUSTOMER-BPNS}}", + "demandCategory" : { + "demandCategoryCode" : "0001" + } + } ], + "materialDemandIsInactive" : true, + "materialNumberCustomer" : "MNR-7307-AU340474.002", + "customer" : "{{CATENAX-CUSTOMER-BPNL}}" +} +``` + +All file formats and serializations are derived from a RDF turtle file. It is the source for the Semantic Aspect Meta Model. You can access the RDF turtle file at the following URL: + +```text +https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.week_based_material_demand/3.0.0/WeekBasedMaterialDemand.ttl +``` + +For further details, please refer to [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation + +[StandardLibrary]: https://catenax-ev.github.io/docs/next/standards/CX-0128-DemandandCapacityManagementDataExchange diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/model-rfu.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/model-rfu.md new file mode 100644 index 00000000000..fce9084c533 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/model-rfu.md @@ -0,0 +1,105 @@ +--- +id: model-IdBasedRequestForUpdate +title: Aspect Model - IdBasedRequestForUpdate +description: Aspect Model - IdBasedRequestForUpdate +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## Aspect Model "IdBasedRequestForUpdate" + +Customer and suppliers provide each other `IdBasedRequestForUpdate` aspect models to facilitate and ensure data synchronicity. They only contain transitive information, meaning it is not required to store them, after a `IdBasedRequestForUpdate` has been correctly reacted to. + +### Roles and Rights + +|Role / Right|Create|Change|Read| +|-|-|-|-| +|Customer|X||X| +|Supplier|X||X| + +### Structure of a IdBasedRequestForUpdate + +![IdBasedRequestForUpdate Structure](./resources/model-rfu_structure.svg) +![IdBasedRequestForUpdate Structure Legend](./resources/model-rfu_legend.svg) + +Figure: *IdBasedRequestForUpdate structure* + + + +### Example data + +```json +{ + "weekBasedMaterialDemand" : [ { + "materialDemandId" : "0157ba42-d2a8-4e28-8565-7b07830c3456", + "changedAt" : "2023-03-10T12:27:11.320Z" + } ], + "weekBasedCapacityGroup" : [ { + "capacityGroupId" : "0157ba42-d2a8-4e28-8565-7b07830c1110", + "changedAt" : "2023-03-10T12:27:11.320Z" + } ] +} +``` + +All file formats and serializations are derived from a RDF turtle file. It is the source for the Semantic Aspect Meta Model. You can access the RDF turtle file at the following URL: + +```text +https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.id_based_request_for_update/3.0.0/IdBasedRequestForUpdate.ttl +``` + +For further details, please refer to [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation + +[StandardLibrary]: https://catenax-ev.github.io/docs/next/standards/CX-0128-DemandandCapacityManagementDataExchange diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/overview.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/overview.md new file mode 100644 index 00000000000..1575f376135 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/overview.md @@ -0,0 +1,266 @@ +--- +id: overview +title: Development View +description: 'What do I have to implement?' +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +This page describes the most important parts for the software implementation of the DCM standards. For the full +technical specification, please refer to the +standard [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary]. + +## Introduction + +This document provides developers with resources to accelerate the development of apps and services. + +## Capabilities of a DCM application + +[CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary] describes the following capabilities: + +|Capability|Category|Related Aspect Models|Related APIs| +|-|-|-|-| +|Providing and consuming demand data|Core|WeekBasedMaterialDemand|WeekBasedMaterialDemand API| +|Providing and consuming capacity data|Core|WeekBasedCapacityGroup|WeekBasedCapacityGroup API| +|Comparing demand and capacity data|Core|WeekBasedMaterialDemand
WeekBasedCapacityGroup|N/A| +|Demand volatility metrics|Outer Core|WeekBasedCapacityGroup|WeekBasedCapacityGroup API| +|Simulated delta production|Outer Core|WeekBasedCapacityGroup|WeekBasedCapacityGroup API| +|Load factors|Outer Core|WeekBasedCapacityGroup|WeekBasedCapacityGroup API| +|Digital twins|Extended|WeekBasedMaterialDemand
WeekBasedCapacity Group|DCM Asset Administration Shell API| +|Request for update|Extended|IdBasedRequestForUpdate|IdBasedRequestForUpdate AP| +|Comments|Extended|IdBasedComment|IdBasedComment API| +|Supply chain disruption notifications|Extended|demandAndCapacityNotification|DemandAndCapacityNotification API| + +- Core capabilities are mandatory within the standard. +- Outer core capabilities share APIs and aspect models with core capabilities, but are optional. +- Extended capabilities introduce aspect models or APIs beyond the core and are optional. + +A MVP approach can be followed when developing software, implementing CX-0128, by taking care of core capabilities first, followed by outer core and finishing with extended capabilities. + +## Roles and rights of a DCM application + +[CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary] describes the business roles customer and supplier. In addition an admin role might be a sensible addition to any application. Most companies within a supply chain will have need of both business roles. Individual users within a company might need access to both business roles. + +|Role|Capabilities| +|-|-| +|Customer| - Modify WeekBasedMaterialDemand
- Compare WeekBasedMaterialDemand to WeekBasedCapacityGroup
- Utilize comments
- Utilize supply chain disruption notification| +|Supplier| - Modify WeekBasedCapacityGroup
- Compare WeekBasedMaterialDemand to WeekBasedCapacityGroup
- Link WeekBasedMaterialDemand to WeekBasedCapacityGroup
- Utilize comments
- Utilize supply chain disruption notification| +|Admin| - Configure Request for update| + +## Aspect models utilized by a DCM application + +- [WeekBasedMaterialDemand](./model-material-demand.md) +- [WeekBasedCapacityGroup](./model-capacity-group.md) +- [IdBasedRequestForUpdate](./model-rfu.md) +- [IdBasedComment](./model-comment.md) + +## Application Programming Interfaces + +### APIs as data assets + +The data consumer registers one data-asset per API with its own EDC. Those data-assets need a `dataAddress` with a `baseURL` pointing to the URI of the API endpoint. The same `dataAddress` needs to be setup to use the consumers EDC as a proxy, utilizing the different proxy related properties within the `dataAddress` object. + +#### Asset example + +```json +{ + "@id": "capacitygroup-prod", + "@type": "Asset", + "properties": { + "http://purl.org/dc/terms/type": { + "@id": "https://w3id.org/catenax/taxonomy#DcmWeekBasedCapacityGroup" + }, + "https://w3id.org/catenax/ontology/common#version": "2.0", + "id": "capacitygroup-prod" + }, + "dataAddress": { + "@type": "DataAddress", + "proxyPath": "false", + "oauth2:clientId": {{clientID}}, + "oauth2:tokenUrl": {{tokenUrl}}, + "type": "HttpData", + "proxyMethod": "true", + "oauth2:clientSecretKey": "dcm-api-client-secret", + "oauth2:scope": "roles", + "proxyQueryParams": "true", + "proxyBody": "true", + "baseUrl": "https://myDCMapp.mycompany.com/catx/apis/weekbasedcapacitygroup" + }, +``` + +### Data exchange + +The data provider is required to use HTTP POST to call the API in order to transfer the data. The POST request has to contain a messageHeader and can contain multiple information objects, with information objects being the different aspect models. Because one API is dedicated to one aspect models mixing different aspect models into the same payload as information objects will result in a malformed payload. + +#### Payload structure + +```json +{ + "messageHeader": + , + + "content":{ + "informationObject":[ + , + + ] + } +} +``` + +This format ensures that the header, which contains metadata about the message, is kept separate from the content, which includes the actual data being exchanged. The content section can hold multiple `informationObject` entries. These objects can be one of the following types: `WeekBasedMaterialDemand`, `WeekBasedCapacityGroup`, `IdBasedComment` or `IdBasedRequestForUpdate`. + +The master reference for generating additional file formats and serializations is the RDF turtle file, which is an instance of the Semantic Aspect Meta Model. The RDF turtle file for the `messageHeaderObject` is defined in a centralized shared aspect model and can be accessed at the following URL: + +```text +https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.shared.message_header/3.0.0/MessageHeaderAspect.ttl +``` + +Within the RDF turtle file, you will find detailed descriptions for how to use the message header. + +For further information on the APIs and how to use them in order to facilitate data exchange, please refer to [CX-0128 Demand and Capacity Management Data Exchange][StandardLibrary] and [CX-0018 Dataspace Connectivity][StandardLibrary] + +## APIs utilized by a DCM application + +- [WeekBasedMaterialDemand API](./api-material-demand.md) +- [WeekBasedCapacityGroup API](./api-capacity-group.md) +- [RequestForUpdate API](./api-rfu.md) +- [IdBasedComment API](./api-comment.md) +- [DCM Asset Administration Shell API (AAS API)](./api-aas.md) + +[StandardLibrary]: https://catenax-ev.github.io/docs/next/standards/CX-0128-DemandandCapacityManagementDataExchange + +## Testing a DCM application + +Having a well organized and documented testing of a DCM application is advantageous not only for the whole development process, but especially because test-runs can be used as proof for required certification of the application. + +It is recommended to compartmentalize tests into test-sets from which different user journeys can be built, depending on which specific capabilities are supposed to be tested by the user journey. Below you will find tests, test-sets and user journeys. Please be aware that they do not provide full coverage of the standard and depending on how you build your application you will need to expand on them. + +### List of Test-Sets + +|Test-Set|Description|Tests in test-set| +|--|--|--| +|[Customer: Prepare yourself](./test-customer#customer-prepare-yourself)|Prepares customer for the user journey, by setting up EDC, data assets, wallet, certificates etc.|- Setup EDC
- Register APIs as assets
- Check wallet for certificates
- Prepare variables for other tests
- User journey specific preparation| +|[Supplier: Prepare yourself](./test-supplier#supplier-prepare-yourself)|Prepares supplier for the user journey, by setting up EDC, data assets, wallet, certificates etc.|- Setup EDC
- Register APIs as assets
- Check wallet for certificates
- Prepare variables for other tests
- User journey specific preparation| +|[Customer: Create WeekBasedMaterialDemand](./test-customer#customer-create-weekbasedmaterialdemand)|Tests the implementation of the aspect model|- Create valid aspect model
- Create invalid aspect model
- Create user journey specific aspect model| +|[Customer: Provide WeekBasedMaterialDemand](./test-customer#customer-provide-weekbasedmaterialdemand)|Tests communication via EDC|- Provide valid payload
- Provide invalid payload
- Provide user journey specific payload| +|[Supplier: Consume WeekBasedMaterialDemand](./test-supplier#supplier-consume-weekbasedmaterialdemand)|Tests the implementation of the API and the aspect model|- Consume valid payload
- Consume invalid payload
- Consume user journey specific payload| +|[Supplier: Create WeekBasedCapacityGroup](./test-supplier#supplier-create-weekbasedcapacitygroup)|Tests the implementation of the aspect model|- Create valid aspect model
- Create invalid aspect model
- Create user journey specific aspect model| +|[Supplier: Provide WeekBasedCapacityGroup](./test-supplier#supplier-provide-weekbasedcapacitygroup)|Tests communication via EDC|- Provide valid payload
- Provide invalid payload
- Provide user journey specific payload| +|[Customer: Consume WeekBasedCapacityGroup](./test-customer#customer-consume-weekbasedcapacitygroup)|Tests the implementation of the API and the aspect model|- Consume valid payload
- Consume invalid payload
- Consume user journey specific payload| +|[Customer: Visualize CapacityGroup together with MaterialDemand](./test-customer#customer-visualize-capacitygroup-together-with-materialdemand)|Minor user acceptance test|- Bottleneck calculation
- Surplus calculation
- Zero deviation calculation
- User journey specific calculation| +|[Supplier: Visualize CapacityGroup together with MaterialDemand](./test-supplier#supplier-visualize-capacitygroup-together-with-materialdemand)|Minor user acceptance test|- Bottleneck calculation
- Surplus calculation
- Zero deviation calculation
- User journey specific calculation| +|[Customer: Create IdBasedRequestForUpdate](./test-customer#customer-create-idbasedrequestforupdate)|Tests the implementation of the aspect model|- Create valid aspect model
- Create invalid aspect model
- Create user journey specific aspect model| +|[Customer: Provide IdBasedRequestForUpdate](./test-customer#customer-provide-idbasedrequestforupdate)|Tests communication via EDC|- Provide valid payload
- Provide invalid payload
- Provide user journey specific payload| +|[Supplier: Consume IdBasedRequestForUpdate](./test-supplier#supplier-consume-idbasedrequestforupdate)|Tests the implementation of the API and the aspect model|- Consume valid payload
- Consume invalid payload
- Consume user journey specific payload| +|[Supplier: Create IdBasedRequestForUpdate](./test-supplier#supplier-create-idbasedrequestforupdate)|Tests the implementation of the aspect model|- Create valid aspect model
- Create invalid aspect model
- Create user journey specific aspect model| +|[Supplier: Provide IdBasedRequestForUpdate](./test-supplier#supplier-provide-idbasedrequestforupdate)|Tests communication via EDC|- Provide valid payload
- Provide invalid payload
- Provide user journey specific payload| +|[Customer: Consume IdBasedRequestForUpdate](./test-customer#customer-consume-idbasedrequestforupdate)|Tests the implementation of the API and the aspect model|- Consume valid payload
- Consume invalid payload
- Consume user journey specific payload| +|[Customer: Create IdBasedComment](./test-customer#customer-create-idbasedcomment)|Tests the implementation of the aspect model|- Create valid aspect model
- Create invalid aspect model
- Create user journey specific aspect model| +|[Customer: Provide IdBasedComment](./test-customer#customer-provide-idbasedcomment)|Tests communication via EDC|- Provide valid payload
- Provide invalid payload
- Provide user journey specific payload| +|[Supplier: Consume IdBasedComment](./test-supplier#supplier-consume-idbasedcomment)|Tests the implementation of the API and the aspect model|- Consume valid payload
- Consume invalid payload
- Consume user journey specific payload| +|[Supplier: Create IdBasedComment](./test-supplier#supplier-create-idbasedcomment)|Tests the implementation of the aspect model|- Create valid aspect model
- Create invalid aspect model
- Create user journey specific aspect model| +|[Supplier: Provide IdBasedComment](./test-supplier#supplier-provide-idbasedcomment)|Tests communication via EDC|- Provide valid payload
- Provide invalid payload
- Provide user journey specific payload| +|[Customer: Consume IdBasedComment](./test-customer#customer-consume-idbasedcomment)|Tests the implementation of the API and the aspect model|- Consume valid payload
- Consume invalid payload
- Consume user journey specific payload| +|[Customer: Visualize IdBasedComment together with CapacityGroup and MaterialDemand](./test-customer#customer-visualize-idbasedcomment-together-with-capacitygroup-and-materialdemand)|Minor user acceptance test|- Comment linked to WeekbasedCapacityGroup
- Comment linked to WeekbasedMaterialGroup
- Comment linked to IdBasedComment| +|[Supplier: Visualize IdBasedComment together with CapacityGroup and MaterialDemand](./test-supplier#supplier-visualize-idbasedcomment-together-with-capacitygroup-and-materialdemand)|Minor user acceptance test|- Comment linked to WeekbasedCapacityGroup
- Comment linked to WeekbasedMaterialGroup
- Comment linked to IdBasedComment| + +### List of User-Journeys + +|#|User Journey|Test-Sets|Tested Capabilities| +|--|--|--|--| +|1|Base journey|- Customer: Prepare yourself
- Supplier: Prepare yourself
- Customer: Create WeekBasedMaterialDemand
- Customer: Provide WeekBasedMaterialDemand
- Supplier: Consume WeekBasedMaterialDemand
- Supplier: Create WeekBasedCapacityGroup
- Supplier: Provide WeekBasedCapacityGroup
- Customer: Consume WeekBasedCapacityGroup
- Customer: Visualize CapacityGroup together with MaterialDemand
- Supplier: Visualize CapacityGroup together with MaterialDemand
- Customer: Provide IdBasedRequestForUpdate
- Supplier: Consume IdBasedRequestForUpdate
- Supplier: Provide IdBasedRequestForUpdate
- Customer: Consume IdBasedRequestForUpdate
- Customer: Create IdBasedComment
- Customer: Provide IdBasedComment
- Supplier: Consume IdBasedComment
- Supplier: Create IdBasedComment
- Supplier: Provide IdBasedComment
- Customer: Consume IdBasedComment
- Customer: Visualize IdBasedComment together with CapacityGroup and MaterialDemand
- Supplier: Visualize IdBasedComment together with CapacityGroup and MaterialDemand|- Providing and consuming demand data
- Providing and consuming capacity data
- Comparing demand and capacity data
- Request for update
- Comments| +|2|Demand volatility metrics journey|- Customer: Prepare yourself
- Supplier: Prepare yourself
- Customer: Create WeekBasedMaterialDemand
- Customer: Provide WeekBasedMaterialDemand
- Supplier: Consume WeekBasedMaterialDemand
- Supplier: Create WeekBasedCapacityGroup
- Supplier: Provide WeekBasedCapacityGroup
- Customer: Consume WeekBasedCapacityGroup
- Customer: Visualize CapacityGroup together with MaterialDemand
- Supplier: Visualize CapacityGroup together with MaterialDemand|- Providing and consuming demand data
- Providing and consuming capacity data
- Comparing demand and capacity data
- Demand volatility metrics| +|3|Simulated delta production journey|- Customer: Prepare yourself
- Supplier: Prepare yourself
- Customer: Create WeekBasedMaterialDemand
- Customer: Provide WeekBasedMaterialDemand
- Supplier: Consume WeekBasedMaterialDemand
- Supplier: Create WeekBasedCapacityGroup
- Supplier: Provide WeekBasedCapacityGroup
- Customer: Consume WeekBasedCapacityGroup
- Customer: Visualize CapacityGroup together with MaterialDemand
- Supplier: Visualize CapacityGroup together with MaterialDemand|- Providing and consuming demand data
- Providing and consuming capacity data
- Comparing demand and capacity data
- Simulated delta production| +|4|Load factors journey|- Customer: Prepare yourself
- Supplier: Prepare yourself
- Customer: Create WeekBasedMaterialDemand
- Customer: Provide WeekBasedMaterialDemand
- Supplier: Consume WeekBasedMaterialDemand
- Supplier: Create WeekBasedCapacityGroup
- Supplier: Provide WeekBasedCapacityGroup
- Customer: Consume WeekBasedCapacityGroup
- Customer: Visualize CapacityGroup together with MaterialDemand
- Supplier: Visualize CapacityGroup together with MaterialDemand|- Providing and consuming demand data
- Providing and consuming capacity data
- Comparing demand and capacity data
- Load factors| + +#### Base Journey + +``` mermaid +sequenceDiagram +actor c as Customer +actor s as Supplier +rect rgb(57,57,57) + note right of c: Prepare for E2E test + c->>c: Check EDC + c->>c: Check Data Assets + c->>c: Check Wallet + s->>s: Check EDC + s->>s: Check Data Assets + s->>s: Check Wallet +end +rect rgb(221,130,0) +autonumber 1 + note right of c: Transfer WeekBasedMaterialDemand + c->>s: FileTransfer ALPHA containing MaterialDemand ALPHA,BETA and GAMMA + s->>c: HTTP 200 OK + c->>s: FileTransfer BETA containing MaterialDemand DELTA + s->>c: HTTP 200 OK +end +rect rgb(128,149,0) + note right of c: Transfer WeekBasedCapacityGroup + s->>c: FileTransfer GAMMA containing CapacityGroup ALPHA and BETA + c->>s: HTTP 200 OK + s->>c: FileTransfer DELTA containing CapacityGroup GAMMA and DELTA + c->>s: HTTP 200 OK +end +rect rgb(57,57,57) + note right of c: GUI test + c->>c: Visualize bottleneck calculation + autonumber 9 + s->>s: Visualize bottleneck calculation +end +rect rgb(4,107,153) + note right of c: Transfer IdBasedRequestForUpdate + c->>s: FileTransfer EPSILON containing RequestForUpdate ALPHA + s->>c: HTTP 200 OK +end +rect rgb(128,149,0) + note right of c: React to Request for Update + s->>c: FileTransfer ETA containing CapacityGroup ALPHA + c->>s: HTTP 200 OK +end +rect rgb(4,107,153) + note right of c: Transfer IdBasedRequestForUpdate + s->>c: FileTransfer ZETA containing RequestForUpdate BETA + c->>s: HTTP 200 OK +end +rect rgb(221,130,0) + note right of c: React to Request for Update + c->>s: FileTransfer THETA containing MaterialDemand GAMMA + s->>c: HTTP 200 OK +end +rect rgb(4,107,153) + note right of c: Transfer IdBasedComment +c->>s: Filetransfer IOTA containing Comment ALPHA and BETA +s->>c: HTTP 200 OK +end +rect rgb(4,107,153) + note right of c: Transfer IdBasedComment +s->>c: Filetransfer KAPPA containing Comment GAMMA and DELTA +c->>s: HTTP 200 OK +end +rect rgb(57,57,57) + note right of c: GUI test + c->>c: Visualize Comment + autonumber 22 + s->>s: Visualize Comment +end +``` + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 CatX Service GmbH +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Cleaning Dummy Api/business-partner-data-management-cleaning-service-dummy.info.mdx b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-capacity-group-api/catena-x-dcm-week-based-capacity-group.info.mdx similarity index 50% rename from docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Cleaning Dummy Api/business-partner-data-management-cleaning-service-dummy.info.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-capacity-group-api/catena-x-dcm-week-based-capacity-group.info.mdx index 5613220e45f..678cb668e4b 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Cleaning Dummy Api/business-partner-data-management-cleaning-service-dummy.info.mdx +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-capacity-group-api/catena-x-dcm-week-based-capacity-group.info.mdx @@ -1,7 +1,7 @@ --- -id: business-partner-data-management-cleaning-service-dummy -title: "Business Partner Data Management Cleaning Service Dummy" -description: "Place holder for the cleaning service provider" +id: catena-x-dcm-week-based-capacity-group +title: "Catena-X DCM Week Based Capacity Group" +description: "Open API documentation for the Catena-X DCM Week Based Capacity Group" sidebar_label: Introduction sidebar_position: 0 hide_title: true @@ -13,13 +13,13 @@ import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiDemoPanel/Export"; -Version: 4.1.0-SNAPSHOT +Version: 3.0.0 -# Business Partner Data Management Cleaning Service Dummy +# Catena-X DCM Week Based Capacity Group -Place holder for the cleaning service provider +Open API documentation for the Catena-X DCM Week Based Capacity Group \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-capacity-group-api/post-week-based-capacity-group.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-capacity-group-api/post-week-based-capacity-group.api.mdx new file mode 100644 index 00000000000..2f24861c876 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-capacity-group-api/post-week-based-capacity-group.api.mdx @@ -0,0 +1,99 @@ +--- +id: post-week-based-capacity-group +title: "postWeekBasedCapacityGroup" +description: "Endpoint to receive a Week Based Capacity Group with header information from a Catena-X DCM partner." +sidebar_label: "postWeekBasedCapacityGroup" +hide_title: true +hide_table_of_contents: true +api: {"tags":["WeekBasedCapacityGroup"],"operationId":"postWeekBasedCapacityGroup","description":"Endpoint to receive a Week Based Capacity Group with header information from a Catena-X DCM partner.","requestBody":{"content":{"application/json":{"schema":{"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.","type":"object","properties":{"header":{"description":"Contains standardized attributes for message processing common across several use cases.","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.","type":"string","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}$)"},"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.","type":"string"},"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","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))?"},"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","type":"string","pattern":"^BPNL[a-zA-Z0-9]{12}$"},"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.","type":"string","pattern":"^BPNL[a-zA-Z0-9]{12}$"},"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","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))?"},"relatedMessageId":{"description":"Unique ID identifying a message somehow related to the current one","type":"string","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}$)"},"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.","type":"string","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-]+)*)?$"}},"required":["messageId","context","sentDateTime","senderBpn","receiverBpn","version"]}},"required":["header"]},"content":{"description":"Bundles all business objects in this property.","type":"object","properties":{"informationObject":{"description":"Property to collect all transferred business objects.","type":"array","items":{"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.","type":"string","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}$)"},"name":{"description":"Name of the capacity group.","type":"string"},"supplierLocations":{"description":"Set of BPNS indicating the supplier sites that will be fulfilling the demands associated with this capacity group.","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},"customer":{"description":"The Business Partner Number (BPNL) of the party requesting materials from a supplier.","type":"string","pattern":"^BPNL[a-zA-Z0-9]{12}$"},"supplier":{"description":"The Business Partner Number (BPNL) of the party providing materials to a customer.","type":"string","pattern":"^BPNL[a-zA-Z0-9]{12}$"},"unitOfMeasure":{"description":"Unit of measurement for capacity quantities.","type":"string","pattern":"[a-zA-Z]*:[a-zA-Z]+","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"]},"linkedDemandSeries":{"description":"Set of demand series assigned to this capacity group.","type":"array","items":{"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.","type":"string"},"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.","type":"string"},"customerLocation":{"description":"The BPNS number of the site at which the customer needs the specified material for the referenced demand series.","type":"string","pattern":"^BPNS[a-zA-Z0-9]{12}$"},"demandCategory":{"description":"Type of demand of the referenced demand series.","type":"object","oneOf":[{"type":"object","properties":{"demandCategoryCode":{"description":"The code identifying a demand category.","type":"string","enum":["0001"]}},"required":["demandCategoryCode"]},{"type":"object","properties":{"demandCategoryCode":{"description":"The code identifying a demand category.","type":"string","enum":["A1S1"]}},"required":["demandCategoryCode"]},{"type":"object","properties":{"demandCategoryCode":{"description":"The code identifying a demand category.","type":"string","enum":["SR99"]}},"required":["demandCategoryCode"]},{"type":"object","properties":{"demandCategoryCode":{"description":"The code identifying a demand category.","type":"string","enum":["PI01"]}},"required":["demandCategoryCode"]},{"type":"object","properties":{"demandCategoryCode":{"description":"The code identifying a demand category.","type":"string","enum":["OS01"]}},"required":["demandCategoryCode"]},{"type":"object","properties":{"demandCategoryCode":{"description":"The code identifying a demand category.","type":"string","enum":["OI01"]}},"required":["demandCategoryCode"]},{"type":"object","properties":{"demandCategoryCode":{"description":"The code identifying a demand category.","type":"string","enum":["ED01"]}},"required":["demandCategoryCode"]},{"type":"object","properties":{"demandCategoryCode":{"description":"The code identifying a demand category.","type":"string","enum":["PO01"]}},"required":["demandCategoryCode"]}]},"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.","type":"number"}},"required":["materialNumberCustomer","customerLocation","demandCategory"]},"uniqueItems":true},"capacities":{"description":"A time series with week-based granularity along a given time period containing the capacity values.","type":"array","items":{"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.","type":"string","format":"date"},"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.","type":"number","maximum":1000000000000000000,"exclusiveMaximum":false,"minimum":0,"exclusiveMinimum":false},"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.","type":"number","maximum":1000000000000000000,"exclusiveMaximum":false,"minimum":0,"exclusiveMinimum":false},"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.","type":"number"},"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.","type":"number","maximum":1000000000000000000,"exclusiveMaximum":false,"minimum":0,"exclusiveMinimum":false}},"required":["pointInTime","actualCapacity","maximumCapacity"]},"uniqueItems":true},"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.","type":"string","format":"date-time"},"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.","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},"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.","type":"boolean"},"demandVolatilityParameters":{"description":"The parameters to calibrate the measuring of demand volatility.","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.\nThis 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.","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))?"},"measurementInterval":{"description":"Indicates the length of intervals in weeks.\nThe first interval starts with the point in time given by the “startReferenceDateTime”. The second interval starts [Value] week (s) after this. And so on.","type":"number","maximum":999,"minimum":1,"exclusiveMaximum":false,"exclusiveMinimum":false},"rollingHorizonAlertThresholds":{"description":"Contains the Parameters that define subhorizons in sequence and length to enable different alert thresholds (per week) over time.\nThe total length of the DCM horizon is 104 weeks. It can be split into subhorizons.","type":"array","items":{"description":"Encapsulation of the rolling horizons thresholds parameters.","type":"object","properties":{"sequenceNumber":{"description":"Sequence number of the subhorizon \n(positive int values)","type":"number","maximum":999,"minimum":1,"exclusiveMaximum":false,"exclusiveMinimum":false},"subhorizonLength":{"description":"Length of the subhorizon in weeks. (Value must be >= 1) As a subhorizon can not be shorter than one week.","type":"number","maximum":999,"minimum":1,"exclusiveMaximum":false,"exclusiveMinimum":false},"relativePositiveDeviation":{"description":"Relative positive deviation threshold which triggers an alert; 20% = 0,2","type":"number"},"relativeNegativeDeviation":{"description":"Relative negative deviation threshold which triggers an alert; -30% = 0,3","type":"number","maximum":1,"exclusiveMaximum":false,"minimum":0,"exclusiveMinimum":false},"absolutePositiveDeviation":{"description":"Absolute positive deviation threshold which triggers an alert; 100 (units) = 100","type":"number"},"absoluteNegativeDeviation":{"description":"Absolute negative deviation threshold which triggers an alert; 100 (units) = 100","type":"number"}},"required":["sequenceNumber","subhorizonLength"]},"uniqueItems":true}},"required":["startReferenceDateTime","measurementInterval"]},"capacityGroupIsInactive":{"description":"Indicates that this capacity group is currently not in use/maintained by the supplier.","type":"boolean"}},"required":["capacityGroupId","name","customer","supplier","changedAt","unitOfMeasureIsOmitted","capacityGroupIsInactive"]},"uniqueItems":true}}}}}}}},"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"}},"method":"post","path":"/internal-dcm-application-week-based-capacity-group-post-endpoint","jsonRequestBodyExample":{"messageHeader":{"header":{"messageId":"string","context":"string","sentDateTime":"string","senderBpn":"string","receiverBpn":"string","expectedResponseBy":"string","relatedMessageId":"string","version":"string"}},"content":{"informationObject":[{"capacityGroupId":"string","name":"string","supplierLocations":["string"],"customer":"string","supplier":"string","unitOfMeasure":"unit:piece","linkedDemandSeries":[{"materialNumberCustomer":"string","materialNumberSupplier":"string","customerLocation":"string","demandCategory":{"demandCategoryCode":"0001"},"loadFactor":0}],"capacities":[{"pointInTime":"2024-07-08","actualCapacity":0,"maximumCapacity":0,"deltaProductionResult":0,"agreedCapacity":0}],"changedAt":"2024-07-08","linkedCapacityGroups":["string"],"unitOfMeasureIsOmitted":true,"demandVolatilityParameters":{"startReferenceDateTime":"string","measurementInterval":0,"rollingHorizonAlertThresholds":[{"sequenceNumber":0,"subhorizonLength":0,"relativePositiveDeviation":0,"relativeNegativeDeviation":0,"absolutePositiveDeviation":0,"absoluteNegativeDeviation":0}]},"capacityGroupIsInactive":true}]}},"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"},"postman":{"name":"post Week Based Capacity Group","description":{"content":"Endpoint to receive a Week Based Capacity Group with header information from a Catena-X DCM partner.","type":"text/plain"},"url":{"path":["internal-dcm-application-week-based-capacity-group-post-endpoint"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: docs-kits/kits/Demand and Capacity Management Kit/development-view/plugin-generated-capacity-group-api/catena-x-dcm-week-based-capacity-group +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## postWeekBasedCapacityGroup + + + +Endpoint to receive a Week Based Capacity Group 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. + +
    :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."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}>
    content object
    + +Bundles all business objects in this property. + +
    informationObject object[]
    + +Property to collect all transferred business objects. + +
    linkedDemandSeries object[]
    + +Set of demand series assigned to this capacity group. + +
    demandCategory object required
    + +Type of demand of the referenced demand series. + +
    oneOf
    capacities object[]
    + +A time series with week-based granularity along a given time period containing the capacity values. + +
    demandVolatilityParameters object
    + +The parameters to calibrate the measuring of demand volatility. + +
    = 1` and `<= 999`"} defaultValue={undefined}>
    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. + +
    = 1` and `<= 999`"} defaultValue={undefined}>= 1) As a subhorizon can not be shorter than one week."} schemaName={"number"} qualifierMessage={"**Possible values:** `>= 1` and `<= 999`"} defaultValue={undefined}>
    + +OK + +
    + +Created + +
    + +Bad request + +
    + +Unauthorized + +
    + +Forbidden + +
    + +Method not allowed + +
    + +Unprocessable Entity + +
    + +Service Unavailable + +
    + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-capacity-group-api/sidebar.js b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-capacity-group-api/sidebar.js new file mode 100644 index 00000000000..74803bfdf48 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-capacity-group-api/sidebar.js @@ -0,0 +1 @@ +module.exports = [{"type":"doc","id":"kits/Demand and Capacity Management Kit/development-view/plugin-generated-capacity-group-api/catena-x-dcm-week-based-capacity-group"},{"type":"category","label":"WeekBasedCapacityGroup","link":{"type":"generated-index","title":"WeekBasedCapacityGroup","slug":"/category/kits/Demand and Capacity Management Kit/development-view/plugin-generated-capacity-group-api/week-based-capacity-group"},"items":[{"type":"doc","id":"kits/Demand and Capacity Management Kit/development-view/plugin-generated-capacity-group-api/post-week-based-capacity-group","label":"postWeekBasedCapacityGroup","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate.info.mdx b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-comment-api/catena-x-dcm-id-based-comment.info.mdx similarity index 52% rename from docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate.info.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-comment-api/catena-x-dcm-id-based-comment.info.mdx index 3651ab7437b..5480a071086 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate.info.mdx +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-comment-api/catena-x-dcm-id-based-comment.info.mdx @@ -1,7 +1,7 @@ --- -id: business-partner-data-management-gate -title: "Business Partner Data Management Gate" -description: "A gate for a member to share business partner data with CatenaX" +id: catena-x-dcm-id-based-comment +title: "Catena-X DCM Id Based Comment" +description: "Open API documentation for the Catena-X DCM Id Based Comment" sidebar_label: Introduction sidebar_position: 0 hide_title: true @@ -13,13 +13,13 @@ import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiDemoPanel/Export"; -Version: 6.0.0 +Version: 1.0.0 -# Business Partner Data Management Gate +# Catena-X DCM Id Based Comment -A gate for a member to share business partner data with CatenaX +Open API documentation for the Catena-X DCM Id Based Comment \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-comment-api/post-id-based-comment.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-comment-api/post-id-based-comment.api.mdx new file mode 100644 index 00000000000..46490b27ba2 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-comment-api/post-id-based-comment.api.mdx @@ -0,0 +1,82 @@ +--- +id: post-id-based-comment +title: "postIdBasedComment" +description: "Endpoint to receive an Id Based Comment with header information from a Catena-X DCM partner." +sidebar_label: "postIdBasedComment" +hide_title: true +hide_table_of_contents: true +api: {"tags":["IdBasedComment"],"operationId":"postIdBasedComment","description":"Endpoint to receive an Id Based Comment with header information from a Catena-X DCM partner.","requestBody":{"content":{"application/json":{"schema":{"description":"An entity that combines the IdBasedComment with the message header data model in order to be compliant with the DCM standard for the exchange of a comment.","type":"object","properties":{"messageHeader":{"description":"The Capacity Group ID uniquely identifies the capacity group within the business relationship between a supplier and its customer.","type":"object","properties":{"header":{"description":"Contains standardized attributes for message processing common across several use cases.","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.","type":"string","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}$)"},"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.","type":"string"},"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","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))?"},"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","type":"string","pattern":"^BPNL[a-zA-Z0-9]{12}$"},"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.","type":"string","pattern":"^BPNL[a-zA-Z0-9]{12}$"},"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","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))?"},"relatedMessageId":{"description":"Unique ID identifying a message somehow related to the current one","type":"string","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}$)"},"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.","type":"string","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-]+)*)?$"}},"required":["messageId","context","sentDateTime","senderBpn","receiverBpn","version"]}},"required":["header"]},"content":{"description":"Bundles all business objects in this property.","type":"object","properties":{"informationObject":{"description":"Property to collect all transferred business objects.","type":"array","items":{"description":"Aspect model for an exchange of comment belonging to a entity.","type":"object","properties":{"commentId":{"description":"The Comment ID uniquely identifies the entity within the business relationship between a customer and its supplier.","type":"string","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}$)"},"objectId":{"description":"The ID of the object to which the comment belongs.","type":"string","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}$)"},"author":{"description":"The E-Mail address of the creator who wrote the comment. In case comment creator wants to stay anonymous, show BPNL in app which is sent the comment along.","type":"string"},"postedAt":{"description":"Point in time when the comment was created.","type":"string","format":"date-time"},"changedAt":{"description":"Point in time when the comment was last changed.","type":"string","format":"date-time"},"commentText":{"description":"Text up to 5.000 characters in format \"UTF-8\" will be shared.","type":"string","pattern":"^[\\s\\S]{0,5000}$"},"commentType":{"description":"Type of a comment to indicate a priority.","type":"string","enum":["information","warning","default","actionRequired"]},"requestDelete":{"description":"Indicates that the deletion of the comment is requested by sender incl. all of it's history.","type":"boolean"},"listOfReferenceDates":{"description":"Point in time the comment belongs to.","type":"array","items":{"type":"string","format":"date"},"uniqueItems":true},"objectType":{"description":"Aspect Model which the comment refers to. The value MUST consist of the Catena-X aspect model unique identifier of the referenced data model without a version.","type":"string"},"customer":{"description":"The Business Partner Number Legal Entity (BPNL) of the party requesting materials from a supplier.","type":"string","pattern":"^BPNL[0-9]{8}[a-zA-Z0-9]{4}$"},"supplier":{"description":"The Business Partner Number Legal Entity (BPNL) of the party providing materials to a customer.","type":"string","pattern":"^BPNL[0-9]{8}[a-zA-Z0-9]{4}$"}},"required":["commentId","objectId","objectType","customer","supplier"]},"uniqueItems":true}}}}}}}},"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"},"501":{"description":"Not Implemented"},"503":{"description":"Service Unavailable"}},"method":"post","path":"/internal-dcm-application-id-based-comment-post-endpoint","jsonRequestBodyExample":{"messageHeader":{"header":{"messageId":"string","context":"string","sentDateTime":"string","senderBpn":"string","receiverBpn":"string","expectedResponseBy":"string","relatedMessageId":"string","version":"string"}},"content":{"informationObject":[{"commentId":"string","objectId":"string","author":"string","postedAt":"2024-07-08","changedAt":"2024-07-08","commentText":"string","commentType":"information","requestDelete":true,"listOfReferenceDates":["2024-07-08"],"objectType":"string","customer":"string","supplier":"string"}]}},"info":{"title":"Catena-X DCM Id Based Comment","description":"Open API documentation for the Catena-X DCM Id Based Comment","version":"1.0.0"},"postman":{"name":"post Id Based Comment","description":{"content":"Endpoint to receive an Id Based Comment with header information from a Catena-X DCM partner.","type":"text/plain"},"url":{"path":["internal-dcm-application-id-based-comment-post-endpoint"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: docs-kits/kits/Demand and Capacity Management Kit/development-view/plugin-generated-comment-api/catena-x-dcm-id-based-comment +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## postIdBasedComment + + + +Endpoint to receive an Id Based Comment 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. + +
      :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."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}>
      content object
      + +Bundles all business objects in this property. + +
      informationObject object[]
      + +Property to collect all transferred business objects. + +
      + +OK + +
      + +Created + +
      + +Bad request + +
      + +Unauthorized + +
      + +Forbidden + +
      + +Method not allowed + +
      + +Unprocessable Entity + +
      + +Not Implemented + +
      + +Service Unavailable + +
      + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-comment-api/sidebar.js b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-comment-api/sidebar.js new file mode 100644 index 00000000000..1a307acd439 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-comment-api/sidebar.js @@ -0,0 +1 @@ +module.exports = [{"type":"doc","id":"kits/Demand and Capacity Management Kit/development-view/plugin-generated-comment-api/catena-x-dcm-id-based-comment"},{"type":"category","label":"IdBasedComment","link":{"type":"generated-index","title":"IdBasedComment","slug":"/category/kits/Demand and Capacity Management Kit/development-view/plugin-generated-comment-api/id-based-comment"},"items":[{"type":"doc","id":"kits/Demand and Capacity Management Kit/development-view/plugin-generated-comment-api/post-id-based-comment","label":"postIdBasedComment","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-material-demand-api/catena-x-dcm-week-based-material-demand.info.mdx b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-material-demand-api/catena-x-dcm-week-based-material-demand.info.mdx new file mode 100644 index 00000000000..a74f9aaadfc --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-material-demand-api/catena-x-dcm-week-based-material-demand.info.mdx @@ -0,0 +1,25 @@ +--- +id: catena-x-dcm-week-based-material-demand +title: "Catena-X DCM Week Based Material Demand" +description: "Open API documentation for the Catena-X DCM Week Based Material Demand" +sidebar_label: Introduction +sidebar_position: 0 +hide_title: true +custom_edit_url: null +--- + +import ApiLogo from "@theme/ApiLogo"; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import Export from "@theme/ApiDemoPanel/Export"; + +Version: 3.0.0 + +# Catena-X DCM Week Based Material Demand + + + +Open API documentation for the Catena-X DCM Week Based Material Demand + + + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-material-demand-api/post-week-based-material-demand.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-material-demand-api/post-week-based-material-demand.api.mdx new file mode 100644 index 00000000000..192fa5ef30f --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-material-demand-api/post-week-based-material-demand.api.mdx @@ -0,0 +1,90 @@ +--- +id: post-week-based-material-demand +title: "postWeekBasedMaterialDemand" +description: "Endpoint to receive a Week Based Material Demand with header information from a Catena-X DCM partner." +sidebar_label: "postWeekBasedMaterialDemand" +hide_title: true +hide_table_of_contents: true +api: {"tags":["WeekBasedMaterialDemand"],"operationId":"postWeekBasedMaterialDemand","description":"Endpoint to receive a Week Based Material Demand with header information from a Catena-X DCM partner.","requestBody":{"content":{"application/json":{"schema":{"description":"An entity that combines the WeekBasedMaterialDemand with the message header data model in order to be compliant with the DCM standard for the exchange of a material demand.","type":"object","properties":{"messageHeader":{"description":"The Capacity Group ID uniquely identifies the capacity group within the business relationship between a supplier and its customer.","type":"object","properties":{"header":{"description":"Contains standardized attributes for message processing common across several use cases.","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.","type":"string","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}$)"},"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.","type":"string"},"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","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))?"},"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","type":"string","pattern":"^BPNL[a-zA-Z0-9]{12}$"},"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.","type":"string","pattern":"^BPNL[a-zA-Z0-9]{12}$"},"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","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))?"},"relatedMessageId":{"description":"Unique ID identifying a message somehow related to the current one","type":"string","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}$)"},"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.","type":"string","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-]+)*)?$"}},"required":["messageId","context","sentDateTime","senderBpn","receiverBpn","version"]}},"required":["header"]},"content":{"description":"Bundles all business objects in this property.","type":"object","properties":{"informationObject":{"description":"Property to collect all transferred business objects.","type":"array","items":{"description":"The requirements of a customer towards a specific supplier for a specific material. Each material demand is unique by its Customer, Supplier and Material Number.","type":"object","properties":{"materialDemandId":{"description":"The Material Demand ID uniquely identifies the material demand within the business relationship between a customer and its supplier.","type":"string","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}$)"},"demandSeries":{"description":"The demands for a dedicated material in a given time period of a given demand rate, distinguished by their demand location and demand category.","type":"array","items":{"description":"Encapsulates the demand series related information.","type":"object","properties":{"customerLocation":{"description":"The Business Partner Number Site (BPNS) of the site at which the customer needs the specified material for this demand series.","type":"string","pattern":"^BPNS[a-zA-Z0-9]{12}$"},"demandCategory":{"description":"Type of demand for this demand series.","type":"object","oneOf":[{"type":"object","properties":{"demandCategoryCode":{"description":"The code identifying a demand category.","type":"string","enum":["0001"]}},"required":["demandCategoryCode"]},{"type":"object","properties":{"demandCategoryCode":{"description":"The code identifying a demand category.","type":"string","enum":["A1S1"]}},"required":["demandCategoryCode"]},{"type":"object","properties":{"demandCategoryCode":{"description":"The code identifying a demand category.","type":"string","enum":["SR99"]}},"required":["demandCategoryCode"]},{"type":"object","properties":{"demandCategoryCode":{"description":"The code identifying a demand category.","type":"string","enum":["PI01"]}},"required":["demandCategoryCode"]},{"type":"object","properties":{"demandCategoryCode":{"description":"The code identifying a demand category.","type":"string","enum":["OS01"]}},"required":["demandCategoryCode"]},{"type":"object","properties":{"demandCategoryCode":{"description":"The code identifying a demand category.","type":"string","enum":["OI01"]}},"required":["demandCategoryCode"]},{"type":"object","properties":{"demandCategoryCode":{"description":"The code identifying a demand category.","type":"string","enum":["ED01"]}},"required":["demandCategoryCode"]},{"type":"object","properties":{"demandCategoryCode":{"description":"The code identifying a demand category.","type":"string","enum":["PO01"]}},"required":["demandCategoryCode"]}]},"demands":{"description":"A time series with a specified demand rate along a given time period to describe the demand values for this demand series.","type":"array","items":{"description":"A single demand for a given point in time according to the demand rate.","type":"object","properties":{"demand":{"description":" 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.","type":"number","maximum":1000000000000000000,"exclusiveMaximum":false,"minimum":0,"exclusiveMinimum":false},"pointInTime":{"description":"Defines the start of the demand rate as a point in time. The point in time must be interpreted according to the demand rate.","type":"string","format":"date"}},"required":["demand","pointInTime"]},"uniqueItems":true},"expectedSupplierLocation":{"description":"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.","type":"string","pattern":"^BPNS[a-zA-Z0-9]{12}$"}},"required":["customerLocation","demandCategory","demands"]},"uniqueItems":true},"customer":{"description":"The Business Partner Number Legal Entity (BPNL) of the party requesting materials from a supplier.","type":"string","pattern":"^BPNL[a-zA-Z0-9]{12}$"},"supplier":{"description":"The Business Partner Number Legal Entity (BPNL) of the party providing materials to a customer.","type":"string","pattern":"^BPNL[a-zA-Z0-9]{12}$"},"unitOfMeasure":{"description":"Unit of measurement for demand quantities.","type":"string","pattern":"[a-zA-Z]*:[a-zA-Z]+","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"]},"materialNumberCustomer":{"description":"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.","type":"string"},"materialNumberSupplier":{"description":"Material identifier as assigned by supplier. This material number identifies the material (as planned) in supplier's database.","type":"string"},"materialDescriptionCustomer":{"description":"Description of the material.","type":"string"},"changedAt":{"description":"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.","type":"string","format":"date-time"},"materialGlobalAssetId":{"description":"Identifier used uniquely to identify part type twin.","type":"string","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}$)"},"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.","type":"boolean"},"materialDemandIsInactive":{"description":"Indicates that this material demand is currently not in use/maintained by the supplier.","type":"boolean"}},"required":["materialDemandId","demandSeries","customer","supplier","materialNumberCustomer","materialDescriptionCustomer","changedAt","unitOfMeasureIsOmitted","materialDemandIsInactive"]},"uniqueItems":true}}}}}}}},"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"}},"method":"post","path":"/internal-dcm-application-week-based-material-demand-post-endpoint","jsonRequestBodyExample":{"messageHeader":{"header":{"messageId":"string","context":"string","sentDateTime":"string","senderBpn":"string","receiverBpn":"string","expectedResponseBy":"string","relatedMessageId":"string","version":"string"}},"content":{"informationObject":[{"materialDemandId":"string","demandSeries":[{"customerLocation":"string","demandCategory":{"demandCategoryCode":"0001"},"demands":[{"demand":0,"pointInTime":"2024-07-08"}],"expectedSupplierLocation":"string"}],"customer":"string","supplier":"string","unitOfMeasure":"unit:piece","materialNumberCustomer":"string","materialNumberSupplier":"string","materialDescriptionCustomer":"string","changedAt":"2024-07-08","materialGlobalAssetId":"string","unitOfMeasureIsOmitted":true,"materialDemandIsInactive":true}]}},"info":{"title":"Catena-X DCM Week Based Material Demand","description":"Open API documentation for the Catena-X DCM Week Based Material Demand","version":"3.0.0"},"postman":{"name":"post Week Based Material Demand","description":{"content":"Endpoint to receive a Week Based Material Demand with header information from a Catena-X DCM partner.","type":"text/plain"},"url":{"path":["internal-dcm-application-week-based-material-demand-post-endpoint"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: docs-kits/kits/Demand and Capacity Management Kit/development-view/plugin-generated-material-demand-api/catena-x-dcm-week-based-material-demand +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## postWeekBasedMaterialDemand + + + +Endpoint to receive a Week Based Material Demand 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. + +
        :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."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}>
        content object
        + +Bundles all business objects in this property. + +
        informationObject object[]
        + +Property to collect all transferred business objects. + +
        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. + +
        demandCategory object required
        + +Type of demand for this demand series. + +
        oneOf
        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. + +
        + +OK + +
        + +Created + +
        + +Bad request + +
        + +Unauthorized + +
        + +Forbidden + +
        + +Method not allowed + +
        + +Unprocessable Entity + +
        + +Service Unavailable + +
        + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-material-demand-api/sidebar.js b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-material-demand-api/sidebar.js new file mode 100644 index 00000000000..e13f56ff04b --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-material-demand-api/sidebar.js @@ -0,0 +1 @@ +module.exports = [{"type":"doc","id":"kits/Demand and Capacity Management Kit/development-view/plugin-generated-material-demand-api/catena-x-dcm-week-based-material-demand"},{"type":"category","label":"WeekBasedMaterialDemand","link":{"type":"generated-index","title":"WeekBasedMaterialDemand","slug":"/category/kits/Demand and Capacity Management Kit/development-view/plugin-generated-material-demand-api/week-based-material-demand"},"items":[{"type":"doc","id":"kits/Demand and Capacity Management Kit/development-view/plugin-generated-material-demand-api/post-week-based-material-demand","label":"postWeekBasedMaterialDemand","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-rfu-api/catena-x-dcm-id-based-request-for-update.info.mdx b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-rfu-api/catena-x-dcm-id-based-request-for-update.info.mdx new file mode 100644 index 00000000000..226288017c8 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-rfu-api/catena-x-dcm-id-based-request-for-update.info.mdx @@ -0,0 +1,25 @@ +--- +id: catena-x-dcm-id-based-request-for-update +title: "Catena-X DCM ID Based Request For Update" +description: "Open API documentation for the Catena-X DCM ID Based Request For Update" +sidebar_label: Introduction +sidebar_position: 0 +hide_title: true +custom_edit_url: null +--- + +import ApiLogo from "@theme/ApiLogo"; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import Export from "@theme/ApiDemoPanel/Export"; + +Version: 3.0.0 + +# Catena-X DCM ID Based Request For Update + + + +Open API documentation for the Catena-X DCM ID Based Request For Update + + + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-rfu-api/post-id-based-request-for-update.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-rfu-api/post-id-based-request-for-update.api.mdx new file mode 100644 index 00000000000..29729a6006f --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-rfu-api/post-id-based-request-for-update.api.mdx @@ -0,0 +1,84 @@ +--- +id: post-id-based-request-for-update +title: "postIdBasedRequestForUpdate" +description: "Endpoint to receive an Id Based Request for Update with header information from a Catena-X DCM partner." +sidebar_label: "postIdBasedRequestForUpdate" +hide_title: true +hide_table_of_contents: true +api: {"tags":["IdBasedRequestForUpdate"],"operationId":"postIdBasedRequestForUpdate","description":"Endpoint to receive an Id Based Request for Update with header information from a Catena-X DCM partner.","requestBody":{"content":{"application/json":{"schema":{"description":"An entity that combines the IdBasedRequestForUpdate with the message header data model in order to be compliant with the DCM standard for the exchange of a request for update.","type":"object","properties":{"messageHeader":{"description":"The Capacity Group ID uniquely identifies the capacity group within the business relationship between a supplier and its customer.","type":"object","properties":{"header":{"description":"Contains standardized attributes for message processing common across several use cases.","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.","type":"string","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}$)"},"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.","type":"string"},"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","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))?"},"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","type":"string","pattern":"^BPNL[a-zA-Z0-9]{12}$"},"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.","type":"string","pattern":"^BPNL[a-zA-Z0-9]{12}$"},"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","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))?"},"relatedMessageId":{"description":"Unique ID identifying a message somehow related to the current one","type":"string","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}$)"},"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.","type":"string","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-]+)*)?$"}},"required":["messageId","context","sentDateTime","senderBpn","receiverBpn","version"]}},"required":["header"]},"content":{"description":"Bundles all business objects in this property.","type":"object","properties":{"informationObject":{"description":"Property to collect all transferred business objects.","type":"array","items":{"description":"The requirements for a request for update from another Catena-X Partner of a specific entity.\nIf within the payload, no specific object type is defined (Payload empty), than an update of all objects within the sender receiver relation is requested).","type":"object","properties":{"weekBasedMaterialDemand":{"description":"Material demands the supplier requests an update for.\nIf within the array, no specific ID (array empty), than an update of all IDs is requested).","type":"array","items":{"description":"Encapsulates the information that is necessary for an update request.","type":"object","properties":{"materialDemandId":{"description":"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.","type":"string","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}$)"},"changedAt":{"description":"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.","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))?"}},"required":["materialDemandId"]},"uniqueItems":true},"weekBasedCapacityGroup":{"description":"Capacity groups the customer requests an update for.\nIf within the array, no specific ID (array empty), than an update of all IDs is requested).","type":"array","items":{"description":"Encapsulates the information that is necessary for an update request.","type":"object","properties":{"capacityGroupId":{"description":"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.","type":"string","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}$)"},"changedAt":{"description":"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.","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))?"}},"required":["capacityGroupId"]},"uniqueItems":true}}},"uniqueItems":true}}}}}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"405":{"description":"Method not allowed"},"422":{"description":"Unprocessable Entity"},"503":{"description":"Service Unavailable"}},"method":"post","path":"/internal-dcm-application-id-based-request-for-update-post-endpoint","jsonRequestBodyExample":{"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"}]}]}},"info":{"title":"Catena-X DCM ID Based Request For Update","description":"Open API documentation for the Catena-X DCM ID Based Request For Update","version":"3.0.0"},"postman":{"name":"post Id Based Request For Update","description":{"content":"Endpoint to receive an Id Based Request for Update with header information from a Catena-X DCM partner.","type":"text/plain"},"url":{"path":["internal-dcm-application-id-based-request-for-update-post-endpoint"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: docs-kits/kits/Demand and Capacity Management Kit/development-view/plugin-generated-rfu-api/catena-x-dcm-id-based-request-for-update +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## 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. + +
          :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."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}>
          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). + +
          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). + +
          + +OK + +
          + +Bad request + +
          + +Unauthorized + +
          + +Forbidden + +
          + +Method not allowed + +
          + +Unprocessable Entity + +
          + +Service Unavailable + +
          + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-rfu-api/sidebar.js b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-rfu-api/sidebar.js new file mode 100644 index 00000000000..4355d7abfd0 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/plugin-generated-rfu-api/sidebar.js @@ -0,0 +1 @@ +module.exports = [{"type":"doc","id":"kits/Demand and Capacity Management Kit/development-view/plugin-generated-rfu-api/catena-x-dcm-id-based-request-for-update"},{"type":"category","label":"IdBasedRequestForUpdate","link":{"type":"generated-index","title":"IdBasedRequestForUpdate","slug":"/category/kits/Demand and Capacity Management Kit/development-view/plugin-generated-rfu-api/id-based-request-for-update"},"items":[{"type":"doc","id":"kits/Demand and Capacity Management Kit/development-view/plugin-generated-rfu-api/post-id-based-request-for-update","label":"postIdBasedRequestForUpdate","className":"api-method post"}]}]; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-capacity-group_legend.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-capacity-group_legend.svg new file mode 100644 index 00000000000..6b019f02fc6 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-capacity-group_legend.svg @@ -0,0 +1,3 @@ + + +
          Capacity data (mandatory)
          Capacity data (optional)
           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-capacity-group_legend.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-capacity-group_legend.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-capacity-group_legend.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-capacity-group_structure.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-capacity-group_structure.svg new file mode 100644 index 00000000000..415ce5ec62b --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-capacity-group_structure.svg @@ -0,0 +1,3 @@ + + +
          WeekBasedCapacityGroup
          Supplier
          Customer
          CapacityGroupID
          changedAt
          Calendar Week
          Inactive flag
          UnitOfMeasure
          CapacityGroupName
          ActualCapacity
          MaximumCapacity
          AgreedCapacity
          quantity
          quantity
          quantity
           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-capacity-group_structure.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-capacity-group_structure.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-capacity-group_structure.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-comment_legend.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-comment_legend.svg new file mode 100644 index 00000000000..dcf7090ef1d --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-comment_legend.svg @@ -0,0 +1,3 @@ + + +
          Comment data (mandatory)
          Comment data (optional)
           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-comment_legend.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-comment_legend.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-comment_legend.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-comment_structure.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-comment_structure.svg new file mode 100644 index 00000000000..c17c417a662 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-comment_structure.svg @@ -0,0 +1,3 @@ + + +
          IdBasedComment
          listOfReferenceDates
          commentType
          commentText
          requestDelete
          objectId
          objectType
           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-comment_structure.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-comment_structure.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-comment_structure.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-material-demand_legend.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-material-demand_legend.svg new file mode 100644 index 00000000000..2c2ecc0f6c0 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-material-demand_legend.svg @@ -0,0 +1,3 @@ + + +
          Demand data (mandatory)
          Demand data (optional)
           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-material-demand_legend.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-material-demand_legend.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-material-demand_legend.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-material-demand_structure.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-material-demand_structure.svg new file mode 100644 index 00000000000..6af1f5d1520 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-material-demand_structure.svg @@ -0,0 +1,3 @@ + + +
          WeekBasedMaterialDemand
          Supplier
          Customer
          changedAt
          DemandSeries
          MaterialDescriptionCustomer
          MaterialNumberCustomer
          MaterialDemandID
          MaterialNumberCustomer
          DemandCategory
          CustomerLocation
          InactiveFlag
          UnitOfMeasure
          PointInTime
          DemandQuantity
           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-material-demand_structure.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-material-demand_structure.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-material-demand_structure.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-rfu_legend.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-rfu_legend.svg new file mode 100644 index 00000000000..d15b733b626 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-rfu_legend.svg @@ -0,0 +1,3 @@ + + +
          Request for Update data (mandatory)
          Request for Update data (optional)
           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-rfu_legend.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-rfu_legend.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-rfu_legend.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-rfu_structure.svg b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-rfu_structure.svg new file mode 100644 index 00000000000..5141acd8fb4 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-rfu_structure.svg @@ -0,0 +1,3 @@ + + +
          RequestforUpdate
          WeekBasedMaterialDemand
          WeekBasedCapacityGroup
          changedAt
          MaterialDemandID
          changedAt
          CapacityGroupID
           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-rfu_structure.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-rfu_structure.svg.license new file mode 100644 index 00000000000..1dae35e9e20 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/resources/model-rfu_structure.svg.license @@ -0,0 +1,15 @@ +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/test-customer.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/test-customer.md new file mode 100644 index 00000000000..85a89215d69 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/test-customer.md @@ -0,0 +1,972 @@ +--- +id: test-customer +title: Test - Customer +description: 'Tests relevant for the business role customer.' +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## Introduction + +This page lists tests that can be executed by the business role customer. + +They are written in [Gherkin](https://cucumber.io/docs/gherkin/). + +For an overview of these tests you should visit [Testing a DCM application](./overview.md#testing-a-dcm-application) within the Development View of this KIT. + +## Customer: Prepare yourself + +### Setup EDC + +This test ensures that the customer sets up its EDC. + +```cucumber +Feature: Customer: Prepare yourself + +Scenario: Setup EDC + Given I have joined the Catena-X dataspace and want to execute DCM tests + When I check whether I have setup my EDC or not + Then I should confirm that I have setup my EDC in the correct version successfully +``` + +### Register APIs as assets + +This test ensures that the customer registers its API endpoints as data assets with its own EDC. + +```cucumber +Feature: Customer: Prepare yourself + +Scenario Outline: Register APIs as assets + Given my EDC has been setup correctly + When I check the asset catalog of my own EDC + Then I should find an asset for the with the correct and + +Examples: +| API | taxonomy | version | +| WeekBasedCapacityGroup API | cx-taxo:DcmWeekBasedCapacityGroup | 2.0 | +| RequestForUpdate API | cx-taxo:DcmIdBasedRequestForUpdate | 2.0 | +| IdBasedComment API | cx-taxo:DcmIdBasedComment | 2.0 | +``` + +### Check wallet for certificates + +This test ensures that the customer has the necessary credentials in its wallet. + +```cucumber +Feature: Customer: Prepare yourself + +Scenario Outline: Check wallet for certificates + Given I have been successfully onboarded into the Catena-X dataspace + When I check my wallet + Then I should find a that corresponds to a + +Examples: +| credential | policy | +| BPN-restricted Data Usage | BPN-restricted Data Usage | +| Membership Credential | Membership Credential | +| DataExchangeGovernance:1.0 | DataExchangeGovernance:1.0 | +``` + +### Prepare variables for other tests + +This test ensures that the customer is aware of the fact that some tests contain variables that need to be filled in with the correct values before executing the tests. + +```cucumber +Feature: Customer: Prepare yourself + + Scenario Outline: Prepare variables for other tests + Given I want to execute a that uses a I need to have a assigned to that makes sense in the context of the and use the value of the variable instead of its name when testing. + When the test gets executed + Then it should work as intended + +Examples: +| test | variable | value | +| Customer: Create WeekBasedMaterialDemand, Customer: Create IdBasedComment | BPNL_SUP | {Business Partner Number Legal (BPNL) of the company that acts as the business role Supplier in the context of the test execution e.g. BPNL00000000052O } | +| Customer: Create WeekBasedMaterialDemand, Customer: Create IdBasedComment | BPNL_CUS | {Use your own Business Partner Number Legal (BPNL) e.g. BPNL000000000JS9} | +| Customer: Create WeekBasedMaterialDemand | BPNS_SUP1 | {A Business Partner Number Site (BPNS) of the company that acts as the business role Supplier in the context of the test execution } | +| Customer: Create WeekBasedMaterialDemand | BPNS_CUS1 | {Use one of your own Business Partner Number Site (BPNS)} | +| Customer: Create WeekBasedMaterialDemand | BPNS_CUS2 | {Use one of your own Business Partner Number Site (BPNS)} | +| Customer: Create WeekBasedMaterialDemand | BPNS_CUS3 | {Use one of your own Business Partner Number Site (BPNS)} | +| Customer: Create WeekBasedMaterialDemand | DSC_MAT1 | {Description of the material e.g. spark plug} | +| Customer: Create WeekBasedMaterialDemand | DSC_MAT2 | {Description of the material e.g. spark plug} | +| Customer: Create WeekBasedMaterialDemand | DSC_MAT3 | {Description of the material e.g. spark plug} | +| Customer: Create WeekBasedMaterialDemand | UUID_MD1 | {UUIDv4 that needs to be generated during the creation of the corresponding aspect model and uniquely identifies it e.g. 4914cc91-5725-4268-9cd8-b8f6d72c525e} | +| Customer: Create WeekBasedMaterialDemand, Customer: Create IdBasedComment | UUID_MD2 | {UUIDv4 that needs to be generated during the creation of the corresponding aspect model and uniquely identifies it e.g. 4914cc91-5725-4268-9cd8-b8f6d72c525e} | +| Customer: Create WeekBasedMaterialDemand, Customer: Create IdBasedComment | UUID_MD3 | {UUIDv4 that needs to be generated during the creation of the corresponding aspect model and uniquely identifies it e.g. 4914cc91-5725-4268-9cd8-b8f6d72c525e} | +| Customer: Create WeekBasedMaterialDemand | UUID_GA1 | {UUIDv4 that needs to be generated during the creation of the corresponding aspect model and uniquely identifies it e.g. 4914cc91-5725-4268-9cd8-b8f6d72c525e} | +| Customer: Create WeekBasedMaterialDemand | UUID_GA2 | {UUIDv4 that needs to be generated during the creation of the corresponding aspect model and uniquely identifies it e.g. 4914cc91-5725-4268-9cd8-b8f6d72c525e} | +| Customer: Create WeekBasedMaterialDemand | UUID_GA3 | {UUIDv4 that needs to be generated during the creation of the corresponding aspect model and uniquely identifies it e.g. 4914cc91-5725-4268-9cd8-b8f6d72c525e} | +| Customer: Create WeekBasedMaterialDemand | UUID_GA4 | {UUIDv4 that needs to be generated during the creation of the corresponding aspect model and uniquely identifies it e.g. 4914cc91-5725-4268-9cd8-b8f6d72c525e} | +| Customer: Create IdBasedComment | UUID_COM1 | {UUIDv4 that needs to be generated during the creation of the corresponding aspect model and uniquely identifies it e.g. 4914cc91-5725-4268-9cd8-b8f6d72c525e} | +| Customer: Create IdBasedComment | UUID_COM3 | {UUIDv4 that needs to be generated during the creation of the corresponding aspect model and uniquely identifies it e.g. 4914cc91-5725-4268-9cd8-b8f6d72c525e} | +| Customer: Create IdBasedRequestForUpdate | UUID_CG1 | {UUIDv4 that gets generated by the supplier. Known to the customer as soon as consuming the corresponding WeekBasedCapacityGroup.} | +| Customer: Create WeekBasedMaterialDemand, Customer: Create IdBasedComment | TS_NOW | {Timestamp that represents the system time when the corresponding aspect model gets created e.g. 2023-11-05T08:15:30.123-05:00} | +| Customer: Create WeekBasedMaterialDemand, Customer: Create IdBasedComment, Customer: Create IdBasedRequestForUpdate | OMITTED | {Special case where you do not include the property in the data at all. You do not even mention it.} | +``` + +### Prepare for base journey + +This test ensures that the customer is aware of the sequence of communication and naming conventions within the base journey. + +```cucumber +Feature: Customer: Prepare yourself + + Scenario Outline: Prepare for base journey + Given I want to execute the base journey which uses in to fulfill a certain that I need to be aware of in order to execute my part of the base journey successfully + When the test gets executed + Then it should work as intended + +Examples: +| object | function | test | +| MD_alpha | A WeekBasedMaterialDemand created by the customer and transmitted via Filetransfer Alpha | Create WeekBasedMaterialDemand for base journey, Provide WeekBasedMaterialDemand for base journey | +| MD_beta | A WeekBasedMaterialDemand created by the customer and transmitted via Filetransfer Alpha | Create WeekBasedMaterialDemand for base journey, Provide WeekBasedMaterialDemand for base journey, Calculation for base journey | +| MD_gamma | A WeekBasedMaterialDemand created by the customer and transmitted via Filetransfer Alpha and Theta | Create WeekBasedMaterialDemand for base journey, Provide WeekBasedMaterialDemand for base journey, Calculation for base journey, Consume IdBasedRequestForUpdate for base journey | +| MD_delta | A WeekBasedMaterialDemand created by the customer and transmitted via Filetransfer Beta | Create WeekBasedMaterialDemand for base journey, Provide WeekBasedMaterialDemand for base journey | +| CG_alpha | A WeekBasedCapacityGroup created by the supplier and transmitted via Filetransfer Gamma and Eta | Consume WeekBasedCapacityGroup for base journey, Provide IdBasedRequestForUpdate for base journey | +| CG_beta | A WeekBasedCapacityGroup created by the supplier and transmitted via Filetransfer Gamma | Consume WeekBasedCapacityGroup for base journey, Calculation for base journey | +| CG_gamma | A WeekBasedCapacityGroup created by the supplier and transmitted via Filetransfer Delta | Consume WeekBasedCapacityGroup for base journey | +| CG_delta | A WeekBasedCapacityGroup created by the supplier and transmitted via Filetransfer Delta | Consume WeekBasedCapacityGroup for base journey | +| RU_alpha | An IdBasedRequestForUpdate created by the customer and transmitted via Filetransfer Epsilon | Create IdBasedRequestForUpdate for base journey, Provide IdBasedRequestForUpdate for base journey | +| RU_beta | An IdBasedRequestForUpdate created by the supplier and transmitted via Filetransfer Zeta | Consume IdBasedRequestForUpdate for base journey | +| CT_alpha | An IdBasedComment created by the customer and transmitted via Filetransfer Iota | Create IdBasedComment for base journey, Provide IdBasedComment for base journey | +| CT_beta | An IdBasedComment created by the customer and transmitted via Filetransfer Iota | Create IdBasedComment for base journey, Provide IdBasedComment for base journey | +| CT_gamma | An IdBasedComment created by the supplier and transmitted via Filetransfer Kappa | Consume IdBasedComment for base journey | +| CT_delta | An IdBasedComment created by the supplier and transmitted via Filetransfer Kappa | Consume IdBasedComment for base journey | +| FT_alpha | A Filetransfer providing WeekBasedMaterialDemand for the supplier to consume | Provide WeekBasedMaterialDemand for base journey | +| FT_beta | A Filetransfer providing WeekBasedMaterialDemand for the supplier to consume | Provide WeekBasedMaterialDemand for base journey | +| FT_gamma | A Filetransfer providing WeekBasedCapacityGroup for the customer to consume | Consume WeekBasedCapacityGroup for base journey | +| FT_delta | A Filetransfer providing WeekBasedCapacityGroup for the customer to consume | Consume WeekBasedCapacityGroup for base journey | +| FT_epsilon | A Filetransfer providing IdBasedRequestForUpdate for the supplier to consume | Provide IdBasedRequestForUpdate for base journey | +| FT_eta | A Filetransfer providing WeekBasedCapacityGroup for the customer to consume | Provide IdBasedRequestForUpdate for base journey | +| FT_zeta | A Filetransfer providing IdBasedRequestForUpdate for the customer to consume | Consume IdBasedRequestForUpdate for base journey | +| FT_theta | A Filetransfer providing WeekBasedMaterialDemand for the supplier to consume | Consume IdBasedRequestForUpdate for base journey | +| FT_iota | A Filetransfer providing IdBasedComment for the supplier to consume | Provide IdBasedComment for base journey | +| FT_kappa | A Filetransfer providing IdBasedComment for the customer to consume | Consume IdBasedComment for base journey | +``` + +## Customer: Create WeekBasedMaterialDemand + +### Create valid WeekBasedMaterialDemand + +This test checks the implementation of the aspect model as well as some edge cases. + +```cucumber +Feature: Customer: Create WeekBasedMaterialDemand + +Scenario Outline: Try to generate valid WeekBasedMaterialDemand + Given the value for the property "unitOfMeasure" is with a default value of "unit:piece" + * the value for the property "changedAt" is with a default value of "{{TS_NOW}}" + * the value for the property "materialDemandIsInactive" is with a default value of "false" + * the value for the property "unitOfMeasureIsOmitted" is with a default value of "false" + * the value for the property "materialNumberCustomer" is with a default value of "MNR-7307-AU340474.002" + * the value for the property "materialNumberSupplier" is with a default value of "MNR-8101-ID146955.001" + * the value for the property "materialDescriptionCustomer" is with a default value of "Spark Plug" + * the value for the property "materialDemandId" is with a default value of "0157ba42-d2a8-4e28-8565-7b07830c1110" + * the value for the property "materialGlobalAssetId" is with a default value of "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df" + * the value for the property "supplier" is with a default value of "{{BPNL_SUP}}" + * the value for the property "customer" is with a default value of "{{BPNL_CUS}}" + * the value for the property "demandSeries" contains exactly one entity "DemandSeries" + * the value for the property "expectedSupplierLocation" is with a default value of "{{BPNS_SUP1}}" + * the value for the property "customerLocation" is with a default value of "{{BPNS_CUS1}}" + * the value for the property "demandCategoryCode" is with a default value of "0001" + * the value for the property "demands" contains exactly one entity "Demand" + * the value for the property "pointInTime" is with a default value of "2023-10-09" + * the value for the property "demand" is with a default value of "1000" + When the application tries to generate the WeekBasedMaterialDemand + Then it should generate the WeekBasedMaterialDemand + +Examples: +| v_unitOfMeasure | v_changedAt | v_materialDemandIsInactive | v_unitOfMeasureIsOmitted | v_materialNumberCustomer | v_materialNumberSupplier | v_materialDescriptionCustomer | v_materialDemandId | v_materialGlobalAssetId | v_supplier | v_customer | v_expectedSupplierLocation | v_customerLocation | v_demandCategoryCode | v_pointInTime | v_demand | +| {{OMITTED}} | | | true | | | | | | | | | | | | | +| | | | false | | | | | | | | | | | | | +| unit:gram | | | | | | | | | | | | | | | | +| unit:kilogram | | | | | | | | | | | | | | | | +| unit:tonneMetricTon | | | | | | | | | | | | | | | | +| unit:tonUsOrShortTonUkorus | | | | | | | | | | | | | | | | +| unit:ounceAvoirdupois | | | | | | | | | | | | | | | | +| unit:pound | | | | | | | | | | | | | | | | +| unit:centimetre | | | | | | | | | | | | | | | | +| unit:metre | | | | | | | | | | | | | | | | +| 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:millilitre | | | | | | | | | | | | | | | | +| unit:litre | | | | | | | | | | | | | | | | +| unit:hectolitre | | | | | | | | | | | | | | | | +| unit:piece | | | | | | | | | | | | | | | | +| unit:set | | | | | | | | | | | | | | | | +| unit:pair | | | | | | | | | | | | | | | | +| unit:page | | | | | | | | | | | | | | | | +| unit:kilowattHour | | | | | | | | | | | | | | | | +| unit:secondUnitOfTime | | | | | | | | | | | | | | | | +| unit:minuteUnitOfTime | | | | | | | | | | | | | | | | +| unit:hourUnitOfTime | | | | | | | | | | | | | | | | +| unit:cycle | | | | | | | | | | | | | | | | +| | 2000-01-01T14:23:00.66372+14:00 | | | | | | | | | | | | | | | +| | | true | | | | | | | | | | | | | | +| | | false | | | | | | | | | | | | | | +| | | | true | | | | | | | | | | | | | +| | | | false | | | | | | | | | | | | | +| | | | | Hello world | | | | | | | | | | | | +| | | | | Καλημέρα κόσμε | | | | | | | | | | | | +| | | | | コンニチハ | | | | | | | | | | | | +| | | | | @!"§$%&/()=?`;:_-.,'*+#~><²³][}{´ | | | | | | | | | | | | +| | | | | | Hello world | | | | | | | | | | | +| | | | | | Καλημέρα κόσμε | | | | | | | | | | | +| | | | | | コンニチハ | | | | | | | | | | | +| | | | | | @!"§$%&/()=?`;:_-.,'*+#~><²³][}{´ | | | | | | | | | | | +| | | | | | | A materia| description_that mig#t cont§in sp3cial ch@r@cters | | | | | | | | | | +| | | | | | | | 857e3c6f-f556-4ac4-a7cd-8f46ad03673f | | | | | | | | | +| | | | | | | | urn:uuid:857e3c6f-f556-4ac4-a7cd-8f46ad03673f | | | | | | | | | +| | | | | | | | | e2a72ce8-45b6-4d5a-8854-2d6e0299d337 | | | | | | | | +| | | | | | | | | urn:e2a72ce8-45b6-4d5a-8854-2d6e0299d337 | | | | | | | | +| | | | | | | | | | | | | | SR99 | | | +| | | | | | | | | | | | | | ED01 | | | +| | | | | | | | | | | | | | A1S1 | | | +| | | | | | | | | | | | | | OI01 | | | +| | | | | | | | | | | | | | OS01 | | | +| | | | | | | | | | | | | | PI01 | | | +| | | | | | | | | | | | | | PO01 | | | +| | | | | | | | | | | | | | 0001 | | | +| | | | | | | | | | | | | | | 2024-09-02 | | +| | | | | | | | | | | | | | | 1930-01-06 | | +| | | | | | | | | | | | | | | 2119-12-25 | | +| | | | | | | | | | | | | | | | 0 | +| | | | | | | | | | | | | | | | 10000 | +| unit:kilowattHour | | | | | | | | | | | | | | | 999999999999.999 | +| unit:tonneMetricTon | | | | | | | | | | | | | | | 4.4 | +``` + +### Create invalid WeekBasedMaterialDemand + +This test checks the implementation of the aspect model as well as some edge cases. + +```cucumber +Feature: Customer: Create WeekBasedMaterialDemand + +Scenario Outline: Try to generate invalid WeekBasedMaterialDemand + Given the value for the property "unitOfMeasure" is with a default value of "unit:piece" + * the value for the property "changedAt" is with a default value of "{{TS_NOW}}" + * the value for the property "materialDemandIsInactive" is with a default value of "false" + * the value for the property "unitOfMeasureIsOmitted" is with a default value of "false" + * the value for the property "materialNumberCustomer" is with a default value of "MNR-7307-AU340474.002" + * the value for the property "materialNumberSupplier" is with a default value of "MNR-8101-ID146955.001" + * the value for the property "materialDescriptionCustomer" is with a default value of "Spark Plug" + * the value for the property "materialDemandId" is with a default value of "0157ba42-d2a8-4e28-8565-7b07830c1110" + * the value for the property "materialGlobalAssetId" is with a default value of "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df" + * the value for the property "supplier" is with a default value of "{{BPNL_SUP}}" + * the value for the property "customer" is with a default value of "{{BPNL_CUS}}" + * the value for the property "demandSeries" contains exactly one entity "DemandSeries" + * the value for the property "expectedSupplierLocation" is with a default value of "{{BPNS_SUP1}}" + * the value for the property "customerLocation" is with a default value of "{{BPNS_CUS1}}" + * the value for the property "demandCategoryCode" is with a default value of "0001" + * the value for the property "demands" contains exactly one entity "Demand" + * the value for the property "pointInTime" is with a default value of "2023-10-09" + * the value for the property "demand" is with a default value of "1000" + When the application tries to generate the WeekBasedMaterialDemand + Then it should NOT generate the WeekBasedMaterialDemand and throw an instead + +Examples: +| v_unitOfMeasure | v_changedAt | v_materialDemandIsInactive | v_unitOfMeasureIsOmitted | v_materialNumberCustomer | v_materialNumberSupplier | v_materialDescriptionCustomer | v_materialDemandId | v_materialGlobalAssetId | v_supplier | v_customer | v_expectedSupplierLocation | v_customerLocation | v_demandCategoryCode | v_pointInTime | v_demand | error | +| unit:cake list | | | | | | | | | | | | | | | | AspectModel Conformity Error: unitOfMeasure | +| | 22.04.2021 | | | | | | | | | | | | | | | AspectModel Conformity Error: changedAt | +| | 2000-01-01T66:23:00.66372+14:00 | | | | | | | | | | | | | | | AspectModel Conformity Error: changedAt | +| | Wrong Format | | | | | | | | | | | | | | | AspectModel Conformity Error: changedAt | +| | | Maybe | | | | | | | | | | | | | | AspectModel Conformity Error: materialDemandIsInactive | +| | | | 2 | | | | | | | | | | | | | AspectModel Conformity Error: unitOfMeasureIsOmitted | +| | | | | | | | This is not an UUID | | | | | | | | | AspectModel Conformity Error: materialDemandId | +| | | | | | | | | 4888d48-6f1d-47f5-8ded-a4410d879df | | | | | | | | AspectModel Conformity Error: materialGlobalAssetId | +| | | | | | | | | | This is not BPNL | | | | | | | AspectModel Conformity Error: supplier | +| | | | | | | | | | | This is not BPNL | | | | | | AspectModel Conformity Error: customer | +| | | | | | | | | | | | This is not BPNS | | | | | AspectModel Conformity Error: expectedSupplierLocation | +| | | | | | | | | | | | | This is not BPNS | | | | AspectModel Conformity Error: customerLocation | +| | | | | | | | | | | | | | Default | | | AspectModel Conformity Error: demandCategoryCode | +| | | | | | | | | | | | | | OSO1 | | | AspectModel Conformity Error: demandCategoryCode | +| | | | | | | | | | | | | | 0S01 | | | AspectModel Conformity Error: demandCategoryCode | +| | | | | | | | | | | | | | | 22.04.2021 | | AspectModel Conformity Error: pointInTime | +| | | | | | | | | | | | | | | 2022-04-22 | | AspectModel Conformity Error: pointInTime | +| | | | | | | | | | | | | | | | 5,5 | AspectModel Conformity Error: demand | +| | | | | | | | | | | | | | | | 9999999999999999999999 | AspectModel Conformity Error: demand | +| | | | | | | | | | | | | | | | -1 | AspectModel Conformity Error: demand | + +``` + +### Create WeekBasedMaterialDemand for base journey + +The customer creates four WeekBasedMaterialDemand used by the base journey. + +```cucumber +Feature: Customer: Create WeekBasedMaterialDemand + +Scenario Outline: Try to generate WeekBasedMaterialDemand for base journey using different + + Given the value for the property "unitOfMeasure" is + * the value for the property "changedAt" is + * the value for the property "materialDemandIsInactive" is + * the value for the property "unitOfMeasureIsOmitted" is + * the value for the property "materialNumberCustomer" is + * the value for the property "materialNumberSupplier" is + * the value for the property "materialDescriptionCustomer" is + * the value for the property "materialDemandId" is + * the value for the property "materialGlobalAssetId" is + * the value for the property "supplier" is + * the value for the property "customer" is + * the value for the property "demandSeries" contains exactly one Entity "DemandSeries" + * the value for the property "expectedSupplierLocation" is + * the value for the property "customerLocation" is + * the value for the property "demandCategoryCode" is + * the value for the property "demands" contains exactly one Entity "Demand" + * the value for the property "pointInTime" is + * the value for the property "demand" is + When the application tries to generate the WeekBasedMaterialDemand + Then it should generate the WeekBasedMaterialDemand + +Examples: +| v_tests | v_unitOfMeasure | v_changedAt | v_materialDemandIsInactive | v_unitOfMeasureIsOmitted | v_materialNumberCustomer | v_materialNumberSupplier | v_materialDescriptionCustomer | v_materialDemandId | v_materialGlobalAssetId | v_supplier | v_customer | v_expectedSupplierLocation | v_customerLocation | v_demandCategoryCode | v_pointInTime | v_demand | +| MD_alpha | unit:pieces | {{TS_NOW}} | false | false | MNR-8540-CH063329.001 | {{OMITTED}} | {{DSC_MAT1}} | {{UUID_MD1}} | {{UUID_GA1}} | {{BPNL_SUP}} | {{BPNL_CUS}} | {{BPNS_SUP1}} | {{BPNS_CUS1}} | 0001 | 2026-01-05,2026-08-05,2026-01-12,2026-01-19,2026-01-26,2026-02-02,2026-02-09,2026-02-16,2026-02-23,2026-03-02,2026-03-09,2026-03-16,2026-03-23,2026-03-30,2026-04-06,2026-04-13,2026-04-20,2026-04-27,2026-05-04,2026-05-11 | 200,190,190,200,190,250,280,0,270,250,240,220,200,190,180,200,190,180,190,200 | +| MD_beta | unit:kilogram | {{TS_NOW}} | false | false | MNR-8549-CH706214.023 | {{OMITTED}} | {{DSC_MAT2}} | {{UUID_MD2}} | {{UUID_GA2}} | {{BPNL_SUP}} | {{BPNL_CUS}} | {{OMITTED}} | {{BPNS_CUS2}} | A1S1 | 2026-01-05,2026-08-05,2026-01-12,2026-01-19,2026-01-26,2026-02-02,2026-02-09,2026-02-16,2026-02-23,2026-03-02,2026-03-09,2026-03-16,2026-03-23,2026-03-30,2026-04-06,2026-04-13,2026-04-20,2026-04-27,2026-05-04,2026-05-11 | 100,100,100,100,100,100,100,100,100,100,100,200,100,200,200,100,100,200,100,200 | +| MD_gamma | unit:kilogram | {{TS_NOW}} | false | false | MNR-8549-CH706214.023 | {{OMITTED}} | {{DSC_MAT2}} | {{UUID_MD2}} | {{UUID_GA3}} | {{BPNL_SUP}} | {{BPNL_CUS}} | {{OMITTED}} | {{BPNS_CUS2}} | PI01 | 2026-01-05,2026-08-05,2026-01-12,2026-01-19,2026-01-26,2026-02-02,2026-02-09,2026-02-16,2026-02-23,2026-03-02,2026-03-09,2026-03-16,2026-03-23,2026-03-30,2026-04-06,2026-04-13,2026-04-20,2026-04-27,2026-05-04,2026-05-11 | 500,200,500,400,500,500,300,500,500,600,600,600,800,700,800,600,600,800,500,900 | +| MD_delta | unit:liters | {{TS_NOW}} | false | false | MNR-8538-CH809974.001 | {{OMITTED}} | {{DSC_MAT3}} | {{UUID_MD3}} | {{UUID_GA4}} | {{BPNL_SUP}} | {{BPNL_CUS}} | {{OMITTED}} | {{BPNS_CUS3}} | PO01 | 2026-01-05,2026-08-05,2026-01-12,2026-01-19,2026-01-26,2026-02-02,2026-02-09,2026-02-16,2026-02-23,2026-03-02,2026-03-09,2026-03-16,2026-03-23,2026-03-30,2026-04-06,2026-04-13,2026-04-20,2026-04-27,2026-05-04,2026-05-11 | 2540,4160,3660,3210,0,3570,490,3590,3400,3130,2920,3270,3210,0,3060,3030,2570,2740,0,1450 | +``` + +## Customer: Provide WeekBasedMaterialDemand + +### Provide valid WeekBasedMaterialDemand + +This test checks the basic implementation of the API. + +```cucumber +Feature: Customer: Provide WeekBasedMaterialDemand + +Scenario: Provide valid new WeekBasedMaterialDemand + Given the materialDemandId of the WeekBasedMaterialDemand is unknown to my supplier + When I try to provide my supplier with said WeekBasedMaterialDemand + Then I should get an http 201 status message + +Scenario: Provide valid existing WeekBasedMaterialDemand + Given the materialDemandId of the WeekBasedMaterialDemand is already known to my supplier + When I try to provide my supplier with said WeekBasedMaterialDemand + Then I should get an http 200 status message +``` + +### Provide invalid WeekBasedMaterialDemand + +This test checks the basic implementation of the API. + +```cucumber +Feature: Customer: Provide WeekBasedMaterialDemand + +Scenario: Provide invalid WeekBasedMaterialDemand + Given I accidentally created an invalid WeekBasedMaterialDemand + When I try to provide my supplier with said WeekBasedMaterialDemand + Then I should get an http 400 status message +``` + +### Provide WeekBasedMaterialDemand for base journey + +The customer sends the previously created WeekBasedMaterialDemands to the supplier as two separate data transfers. + +```cucumber +Feature: Customer: Provide WeekBasedMaterialDemand + +Scenario Outline: Provide WeekBasedMaterialDemand for base journey + Given I have successfully created demands alpha, beta, gamma and delta as described in Create WeekBasedMaterialDemand for base journey + When I try to provide my supplier with as + Then I should get from my supplier. + +Examples: +| testDemand | fileTransfer | http status code | +| MD_alpha,MD_beta,MD_gamma | FT_alpha | 200 OK | +| MD_delta | FT_beta | 200 OK | +``` + +## Customer: Consume WeekBasedCapacityGroup + +### Consume valid WeekBasedCapacityGroup + +This test checks the basic implementation of the API. + +```cucumber +Feature: Customer: Consume WeekBasedCapacityGroup + +Scenario: Consume valid unknown WeekBasedCapacityGroup + Given I receive a valid WeekBasedCapacityGroup from my supplier with a capacityGroupId that is unknown to me + When I try to consume said WeekBasedCapacityGroup + Then I should be able to consume it and send my supplier a http 201 status message + +Scenario: Consume valid known WeekBasedCapacityGroup + Given I receive a valid WeekBasedCapacityGroup from my supplier with a capacityGroupId that is already known to me + When I try to consume said WeekBasedCapacityGroup + Then I should be able to consume it and send my supplier a http 200 status message +``` + +### Consume invalid WeekBasedCapacityGroup + +This test checks the basic implementation of the API. + +```cucumber +Feature: Customer: Consume WeekBasedCapacityGroup + +Scenario: Consume invalid WeekBasedCapacityGroup + Given I receive an invalid WeekBasedCapacityGroup from my supplier + When I try to consume said WeekBasedCapacityGroup + Then I should not consume it and send my supplier a http 400 status message +``` + +### Consume WeekBasedCapacityGroup for base journey + +The customer receives the previously created WeekBasedCapacityGroups from the supplier as two separate data transfers. + +```cucumber +Feature: Customer: Consume WeekBasedCapacityGroup + +Scenario Outline: Consume WeekBasedCapacityGroup for base journey + Given I have successfully created demands alpha, beta, gamma and delta as described in Create WeekBasedMaterialDemand for base journey + When I try to consume provided by my supplier within + Then I should be able to consume the data and send to my supplier. + +Examples: +| testCapacityGroup | fileTransfer | http status code | +| CG_alpha,CG_beta | FT_gamma | 200 OK | +| CG_gamma,CG_delta | FT_delta | 200 OK | +``` + +## Customer: Visualize CapacityGroup together with MaterialDemand + +### Bottleneck calculation + +This test checks the basic implementation of the GUI. + +```cucumber +Feature: Customer: Visualize CapacityGroup together with MaterialDemand + +Scenario Outline: Bottleneck calculation + Given I have created a WeekBasedMaterialDemand + * I have consumed at least one WeekBasedCapacityGroup linked to the WeekBasedMaterialDemand + When I calculate and visualize the demand and capacity time series + Then it should show in for + +Examples: +| case | color | result | +| demand > actual capacity = maximum capacity | red | bottleneck | +| actual capacity < demand = maximum capacity | orange | bottleneck | +| actual capacity < demand < maximum capacity | orange | bottleneck | +| actual capacity < maximum capacity < demand | red | bottleneck | +``` + +### Surplus calculation + +This test checks the basic implementation of the GUI. + +```cucumber +Feature: Customer: Visualize CapacityGroup together with MaterialDemand + +Scenario Outline: Surplus calculation + Given I have created a WeekBasedMaterialDemand + * I have consumed at least one WeekBasedCapacityGroup linked to the WeekBasedMaterialDemand + When I calculate and visualize the demand and capacity time series + Then it should show in for + +Examples: +| case | color | result | +| demand < actual capacity = maximum capacity | green | surplus | +| demand < actual capacity < maximum capacity | green | surplus | +``` + +### Zero deviation calculation + +This test checks the basic implementation of the GUI. + +```cucumber +Feature: Customer: Visualize CapacityGroup together with MaterialDemand + +Scenario Outline: Zero deviation calculation + Given I have created a WeekBasedMaterialDemand + * I have consumed at least one WeekBasedCapacityGroup linked to the WeekBasedMaterialDemand + When I calculate and visualize the demand and capacity time series + Then it should show in for + +Examples: +| case | color | result | +| demand = actual capacity = maximum capacity | green | zero deviation | +| demand = actual capacity < maximum capacity | green | zero deviation | +``` + +### Calculation for base journey + +The customer compares the demand data, sent to the supplier, to the capacity data, received from the supplier. + +```cucumber +Feature: Customer: Visualize CapacityGroup together with MaterialDemand + +Scenario Outline: Calculation for base journey + Given I have successfully consumed + * I have successfully created + When I compare demand and capacity data for + Then I should get for in + +Examples: +| WeekBasedCapacityGroup | WeekBasedMaterialDemand | week | year | result | case | color | +| CG_beta | MD_beta, MD_gamma | 09 | 2026 | bottleneck | demand > actual capacity = maximum capacity | red | +| CG_beta | MD_beta, MD_gamma | 18 | 2026 | bottleneck | actual capacity < demand = maximum capacity | orange | +| CG_beta | MD_beta, MD_gamma | 12 | 2026 | bottleneck | actual capacity < demand < maximum capacity | orange | +| CG_beta | MD_beta, MD_gamma | 15 | 2026 | bottleneck | actual capacity < maximum capacity < demand | red | +| CG_beta | MD_beta, MD_gamma | 20 | 2026 | surplus | demand < actual capacity = maximum capacity | green | +| CG_beta | MD_beta, MD_gamma | 01 | 2026 | surplus | demand < actual capacity < maximum capacity | green | +| CG_beta | MD_beta, MD_gamma | 13 | 2026 | zero deviation | demand = actual capacity = maximum capacity | green | +| CG_beta | MD_beta, MD_gamma | 14 | 2026 | zero deviation | demand = actual capacity < maximum capacity | green | +``` + +## Customer: Create IdBasedRequestForUpdate + +### Create valid IdBasedRequestForUpdate + +This test checks the implementation of the aspect model as well as some edge cases. + +```cucumber +Feature: Customer: Create IdBasedRequestForUpdate + +Scenario Outline: Try to generate valid IdBasedRequestForUpdate + Given the value for the property "weekBasedMaterialDemand" is + * "weekBasedMaterialDemand" is a list with properties "changedAt" and "materialDemandId" + * the value for the property "weekBasedCapacityGroup" is + * "weekBasedCapacityGroup" is a list with properties "changedAt" and "materialDemandId" + When the application tries to generate the IdBasedRequestForUpdate + Then it should generate the IdBasedRequestForUpdate and represent the following + +Examples: +| v_weekBasedMaterialDemand | v_weekBasedCapacityGroup | case | +| {{OMITTED}} | {{OMITTED}} | Give me everything | +| [ {"materialDemandId" : "0157ba42-d2a8-4e28-8565-7b07830c3456","changedAt" : "2023-03-10T12:27:11.320Z"}] | [ {"capacityGroupId" : "0157ba42-d2a8-4e28-8565-7b07830c1110","changedAt" : "2023-03-10T12:27:11.320Z"} ] | Give me the specified aspect models, but only of they are newer than the specified timestamps | +| [ {"materialDemandId" : "0157ba42-d2a8-4e28-8565-7b07830c3456","changedAt" : "2023-03-10T12:27:11.320Z"}] | {{OMITTED}} | Give me the specified aspect models, but only of they are newer than the specified timestamps | +| {{OMITTED}} | [ {"capacityGroupId" : "0157ba42-d2a8-4e28-8565-7b07830c1110","changedAt" : "2023-03-10T12:27:11.320Z"} ] | Give me the specified aspect models, but only of they are newer than the specified timestamps | +| [ {"materialDemandId" : "0157ba42-d2a8-4e28-8565-7b07830c3456"}] | {{OMITTED}} | Give me the specified aspect models | +| {{OMITTED}} | [ {"capacityGroupId" : "0157ba42-d2a8-4e28-8565-7b07830c1110"} ] | Give me the specified aspect models | +| [ {"materialDemandId" : "e84f0078-cb3f-4917-8b56-8405c053d5ca"},{"materialDemandId" : "0157ba42-d2a8-4e28-8565-7b07830c3456"}] | {{OMITTED}} | Give me the specified aspect models | + +``` + +### Create invalid IdBasedRequestForUpdate + +This test checks the implementation of the aspect model as well as some edge cases. + +```cucumber +Feature: Customer: Create IdBasedRequestForUpdate + +Scenario Outline: Try to generate invalid IdBasedRequestForUpdate + Given the value for the property "weekBasedMaterialDemand" is + * "weekBasedMaterialDemand" is a list with properties "changedAt" and "materialDemandId" + * the value for the property "weekBasedCapacityGroup" is + * "weekBasedCapacityGroup" is a list with properties "changedAt" and "materialDemandId" + When the application tries to generate the IdBasedRequestForUpdate + Then it should NOT generate the IdBasedRequestForUpdate and throw an instead + +Examples: +| v_weekBasedMaterialDemand | v_weekBasedCapacityGroup | error | +| This should not compute | {{OMITTED}} | AspectModel Conformity Error: weekBasedMaterialDemand | +| {{OMITTED}} | This should not compute | AspectModel Conformity Error: weekBasedCapacityGroup | + +``` + +### Create IdBasedRequestForUpdate for base journey + +The customer creates an IdBasedRequestForUpdate used by the base journey which requests WeekBasedCapacityGroup Alpha, identified via {{UUID_CG1}}. + +```cucumber +Feature: Customer: Create IdBasedRequestForUpdate + +Scenario Outline: Try to generate IdBasedRequestForUpdate for base journey using different + Given the value for the property "weekBasedMaterialDemand" is + * "weekBasedMaterialDemand" is a list with properties "changedAt" and "materialDemandId" + * the value for the property "weekBasedCapacityGroup" is + * "weekBasedCapacityGroup" is a list with properties "changedAt" and "materialDemandId" + When the application tries to generate the IdBasedRequestForUpdate + Then it should generate the IdBasedRequestForUpdate + +Examples: +| v_tests | v_weekBasedMaterialDemand | v_weekBasedCapacityGroup | +| RU_alpha | {{OMITTED}} | [ {"capacityGroupId" : {{UUID_CG1}}}] | +``` + +## Customer: Provide IdBasedRequestForUpdate + +### Provide valid IdBasedRequestForUpdate + +This test checks the basic implementation of the API. + +```cucumber +Feature: Customer: Provide IdBasedRequestForUpdate + +Scenario: Provide valid IdBasedRequestForUpdate + Given I was able to create a valid IdBasedRequestForUpdate + When I try to provide my supplier with said IdBasedRequestForUpdate + Then I should get an http 200 status message +``` + +### Provide invalid IdBasedRequestForUpdate + +This test checks the basic implementation of the API. + +```cucumber +Feature: Customer: Provide IdBasedRequestForUpdate + +Scenario: Provide invalid IdBasedRequestForUpdate + Given I accidentally created an invalid IdBasedRequestForUpdate + When I try to provide my supplier with said IdBasedRequestForUpdate + Then I should get an http 400 status message +``` + +### Provide IdBasedRequestForUpdate for base journey + +The customer sends the previously created IdBasedRequestForUpdate to the supplier and expects one WeekBasedCapacityGroup in return. + +```cucumber +Feature: Customer: Provide IdBasedRequestForUpdate + +Scenario Outline: Provide IdBasedRequestForUpdate for base journey + Given I have previously consumed + When I provide my supplier with containing as payload + Then I should get a http 200 status message + * I should receive from my supplier, containing + +Examples: +| FileTransfer | IdBasedRequestForUpdate | reaction | reaction payload | +| FT_epsilon | RU_alpha | FT_eta | CG_alpha | +``` + +## Customer: Consume IdBasedRequestForUpdate + +### Consume valid IdBasedRequestForUpdate + +This test checks the basic implementation of the API. + +```cucumber +Feature: Customer: Consume IdBasedRequestForUpdate + +Scenario: Consume valid IdBasedRequestForUpdate + Given I receive a valid IdBasedRequestForUpdate from my supplier + When I try to consume said IdBasedRequestForUpdate + Then I should be able to consume it, send my supplier a http 200 status message and provide my supplier with the data requested, if applicable +``` + +### Consume invalid IdBasedRequestForUpdate + +This test checks the basic implementation of the API. + +```cucumber +Feature: Customer: Consume IdBasedRequestForUpdate + +Scenario: Consume invalid IdBasedRequestForUpdate + Given I receive an invalid IdBasedRequestForUpdate from my supplier + When I try to consume said IdBasedRequestForUpdate + Then I should not consume it and send my supplier a http 400 status message +``` + +### Consume IdBasedRequestForUpdate for base journey + +```cucumber +Feature: Customer: Consume IdBasedRequestForUpdate + +Scenario Outline: Consume IdBasedRequestForUpdate for base journey + Given I receive a containing as payload + When I try to consume + Then I should be able to consume it and send my supplier a http 200 status message + * I should react by sending with back to my supplier + +Examples: +| FileTransfer | IdBasedRequestForUpdate | reaction | reaction payload | +| FT_zeta | RU_beta | FT_theta | MD_gamma | +``` + +## Customer: Create IdBasedComment + +### Create valid IdBasedComment + +This test checks the implementation of the aspect model as well as some edge cases. + +```cucumber +Feature: Customer: Create IdBasedComment + +Scenario Outline: Try to generate valid IdBasedComment + Given the value for the property "CommentId" is with a default value of "a54348ce-7373-4cf0-8f00-8a73ea323dab" + * the value for the property "ObjectId" is with a default value of "b01fac51-6e7f-4754-a762-11814a1ff243" + * the value for the property "CommentType" is with a default value of "default" + * the value for the property "listOfReferenceDates" is with a default value of "2025-04-21" + * the value for the property "author" is with a default value of "max.mustermann@company.de" + * the value for the property "supplier" is with a default value of "{{BPNL_SUP}}" + * the value for the property "customer" is with a default value of "{{BPNL_CUS}}" + * the value for the property "CommentText" is with a default value of "This is a comment. Very nice! " + * the value for the property "requestDelete" is with a default value of "false" + * the value for the property "objectType" is with a default value of "urn:samm:io.catenax.week_based_capacity_group" + * the value for the property "postedAt" is with a default value of "2024-03-10T12:27:11.320Z" + * the value for the property "changedAt" is with a default value of "{{TS_NOW}}" + When the application tries to generate the IdBasedComment + Then it should generate the IdBasedComment + +Examples: +| v_CommentId | v_ObjectId | v_CommentType | v_listOfReferenceDates | v_author | v_supplier | v_customer | v_CommentText | v_requestDelete | v_objectType | v_postedAt | v_changedAt | +| 1236a465-93ab-45f7-ad17-67ad3107d6c8 | | | | | | | | | | | | +| urn:uuid:1236a465-93ab-45f7-ad17-67ad3107d6c8 | | | | | | | | | | | | +| | f38d7d7b-b8e7-452c-8ee2-08c8c56a4f80 | | | | | | | | | | | +| | urn:uuid:f38d7d7b-b8e7-452c-8ee2-08c8c56a4f80 | | | | | | | | | | | +| | | information | | | | | | | | | | +| | | warning | | | | | | | | | | +| | | default | | | | | | | | | | +| | | actionRequired | | | | | | | | | | +| | | | 2024-05-13 | | | | | | | | | +| | | | 2024-05-13,2024-05-20 | | | | | | | | | +| | | | | test@gmail.com | | | | | | | | +| | | | | {{BPNL_CUS}} | | | | | | | | +| | | | | | {{BPNL_SUP}} | | | | | | | +| | | | | | | {{BPNL_CUS}} | | | | | | +| | | | | | | | This can be up to 5000 characters long and contain special characters. | | | | | +| | | | | | | | !"§$%&/()=,.;:#'+*~<>[]{} | | | | | +| | | | | | | | | true | | | | +| | | | | | | | | false | | | | +| | | | | | | | | | urn:samm:io.catenax.week_based_material_demand | | | +| | | | | | | | | | urn:samm:io.catenax.week_based_capacity_group | | | +| | | | | | | | | | urn:samm:io.catenax.id_based_comment | | | +| | | | | | | | | | | 2024-03-11T11:27:11.320Z | | +| | | | | | | | | | | | 2024-03-11T11:27:11.320Z | +``` + +### Create invalid IdBasedComment + +This test checks the implementation of the aspect model as well as some edge cases. + +```cucumber +Feature: Customer: Create IdBasedComment + +Scenario Outline: Try to generate invalid IdBasedComment + Given the value for the property "CommentId" is with a default value of "a54348ce-7373-4cf0-8f00-8a73ea323dab" + * the value for the property "ObjectId" is with a default value of "b01fac51-6e7f-4754-a762-11814a1ff243" + * the value for the property "CommentType" is with a default value of "default" + * the value for the property "listOfReferenceDates" is with a default value of "2025-04-21" + * the value for the property "author" is with a default value of "max.mustermann@company.de" + * the value for the property "supplier" is with a default value of "{{BPNL_SUP}}" + * the value for the property "customer" is with a default value of "{{BPNL_CUS}}" + * the value for the property "CommentText" is with a default value of "This is a comment. Very nice! " + * the value for the property "requestDelete" is with a default value of "false" + * the value for the property "objectType" is with a default value of "urn:samm:io.catenax.week_based_capacity_group" + * the value for the property "postedAt" is with a default value of "2024-03-10T12:27:11.320Z" + * the value for the property "changedAt" is with a default value of "2024-03-10T12:27:11.320Z" + When the application tries to generate the IdBasedComment + Then it should NOT generate the IdBasedComment and throw an instead + +Examples: +| v_CommentId | v_ObjectId | v_CommentType | v_listOfReferenceDates | v_author | v_supplier | v_customer | v_CommentText | v_requestDelete | v_objectType | v_postedAt | v_changedAt | error | +| Not an UUID | | | | | | | | | | | | AspectModel Conformity Error: commentID | +| | Not an UUID | | | | | | | | | | | AspectModel Conformity Error: objectID | +| | | warnings | | | | | | | | | | AspectModel Conformity Error: commentType | +| | | comment | | | | | | | | | | AspectModel Conformity Error: commentType | +| | | Not a commentType | | | | | | | | | | AspectModel Conformity Error: commentType | +| | | | 2024-05-13;2024-05-20 | | | | | | | | | AspectModel Conformity Error: listOfReferenceDates | +| | | | List,Of,Strings | | | | | | | | | AspectModel Conformity Error: listOfReferenceDates | +| | | | | Not@a@valid.email.adress | | | | | | | | AspectModel Conformity Error: author | +| | | | | Not a BPNL | | | | | | | | AspectModel Conformity Error: author | +| | | | | | Not a BPNL | | | | | | | AspectModel Conformity Error: supplier | +| | | | | | | Not a BPNL | | | | | | AspectModel Conformity Error: customer | +| | | | | | | | {{String with more than 5000 characters}} | | | | | AspectModel Conformity Error: CommentText | +| | | | | | | | | maybe | | | | AspectModel Conformity Error: requestDelete | +| | | | | | | | | | urn:samm:io.catenax.id_based_request_for_update:3.0.0 | | | AspectModel Conformity Error: objectType | +| | | | | | | | | | urn:samm:io.catenax.id_based_comment | | | AspectModel Conformity Error: objectType | +| | | | | | | | | | Not an objectType | | | AspectModel Conformity Error: objectType | +| | | | | | | | | | | 2000-01-01T66:23:00.66372+14:00 | | AspectModel Conformity Error: postedAt | +| | | | | | | | | | | | 2000-01-0 | AspectModel Conformity Error: changedAt | +``` + +### Create IdBasedComment for base journey + +```cucumber +Feature: Customer: Create IdBasedComment for base journey + +Scenario Outline: Try to generate IdBasedComment for base journey for base journey using different + +Given the value for the property "CommentId" is +* the value for the property "ObjectId" is +* the value for the property "CommentType" is +* the value for the property "listOfReferenceDates" is +* the value for the property "author" is +* the value for the property "supplier" is +* the value for the property "customer" is +* the value for the property "CommentText" is +* the value for the property "requestDelete" is +* the value for the property "objectType" is +* the value for the property "postedAt" is +* the value for the property "changedAt" is + +When the application tries to generate the IdBasedComment + +Then it should generate the IdBasedComment + +Examples: +| v_tests | v_CommentId | v_ObjectId | v_CommentType | v_listOfReferenceDates | v_author | v_supplier | v_customer | v_CommentText | v_requestDelete | v_objectType | v_postedAt | v_changedAt | +| CT_alpha | {{UUID_COM1}} | {{UUID_MD1}} | information | {{OMITTED}} | max.mustermann@company.de | {{BPNL_SUP}} | {{BPNL_CUS}} | "Demand increase in all upcoming weeks expected." | {{OMITTED}} | urn:samm:io.catenax.week_based_material_demand | {{OMITTED}} | {{TS_NOW}} | +| CT_beta | {{UUID_COM3}} | {{UUID_MD1}} | action required | {{OMITTED}} | max.mustermann@company.de | {{BPNL_SUP}} | {{BPNL_CUS}} | "Demand Increase in CW45. Please confirm increase actual capacity." | {{OMITTED}} | urn:samm:io.catenax.week_based_material_demand | {{OMITTED}} | {{TS_NOW}} | +``` + +## Customer: Provide IdBasedComment + +### Provide valid IdBasedComment + +This test checks the basic implementation of the API. + +```cucumber +Feature: Customer: Provide IdBasedComment + +Scenario: Provide valid new IdBasedComment + Given the commentID of the IdBasedComment is unknown to my supplier + When I try to provide my supplier with said IdBasedComment + Then I should get an http 201 status message + +Scenario: Provide valid existing IdBasedComment + Given the commentID of the IdBasedComment is already known to my supplier + When I try to provide my supplier with said IdBasedComment + Then I should get an http 200 status message +``` + +### Provide invalid IdBasedComment + +This test checks the basic implementation of the API. + +```cucumber +Feature: Customer: Provide IdBasedComment + +Scenario: Provide invalid IdBasedComment + Given I accidentally created an invalid IdBasedComment + When I try to provide my supplier with said IdBasedComment + Then I should get an http 400 status message +``` + +### Provide IdBasedComment for base journey + +This test checks the basic implementation of the API. + +```cucumber +Feature: Customer: Provide IdBasedComment + +Scenario Outline: Provide IdBasedComment for base journey + Given I try to provide my supplier with an IdBasedComment + When I sent a containing as payload to my supplier + Then I should get an http 200 status message + +Examples: +| FileTransfer | IdBasedComment | +| FT_iota | CT_alpha, CT_beta | +``` + +## Customer: Consume IdBasedComment + +### Consume valid IdBasedComment + +This test checks the basic implementation of the API. + +```cucumber +Feature: Customer: Consume IdBasedComment + +Scenario: Consume valid unknown IdBasedComment + Given I receive a valid IdBasedComment from my supplier with a commentID that is unknown to me + When I try to consume said IdBasedComment + Then I should be able to consume it and send my supplier a http 201 status message + +Scenario: Consume valid known IdBasedComment + Given I receive a valid IdBasedComment from my supplier with a commentID that is already known to me + When I try to consume said IdBasedComment + Then I should be able to consume it and send my supplier a http 200 status message +``` + +### Consume invalid IdBasedComment + +This test checks the basic implementation of the API. + +```cucumber +Feature: Customer: Consume IdBasedComment + +Scenario: Consume invalid IdBasedComment + Given I receive an invalid IdBasedComment from my supplier + When I try to consume said IdBasedComment + Then I should not consume it and send my supplier a http 400 status message +``` + +### Consume IdBasedComment for base journey + +```cucumber +Feature: Customer: Consume IdBasedComment + +Scenario Outline: Consume IdBasedComment for base journey + Given I receive a containing as payload + When I try to consume + Then I should be able to consume it and send my supplier a http 200 status message + +Examples: +| FileTransfer | IdBasedComment | +| FT_kappa | CT_gamma, CT_delta | +``` + +## Customer: Visualize IdBasedComment together with CapacityGroup and MaterialDemand + +### Comment linked to WeekBasedCapacityGroup + +This test checks the basic implementation of the comment feature within the GUI + +```cucumber +Feature: Customer: Visualize IdBasedComment together with CapacityGroup and MaterialDemand + +Scenario: Comment linked to WeekBasedCapacityGroup + Given I have a comment that is linked to a WeekBasedCapacityGroup + When I try to view this comment in the graphical user interface + Then I should be able to view this comment in a list of all comments + * I should be able to view this comment by navigating to the WeekBasedCapacityGroup the comment is linking +``` + +### Comment linked to WeekBasedMaterialDemand + +This test checks the basic implementation of the comment feature within the GUI + +```cucumber +Feature: Customer: Visualize IdBasedComment together with CapacityGroup and MaterialDemand + +Scenario: Comment linked to WeekBasedMaterialDemand + Given I have a comment that is linked to a WeekBasedMaterialDemand + When I try to view this comment in the graphical user interface + Then I should be able to view this comment in a list of all comments + * I should be able to view this comment by navigating to the WeekBasedMaterialDemand the comment is linking + * I should be able to view this comment by navigating to the WeekBasedCapacityGroup, the WeekBasedMaterialDemand is linked to, the comment is linking + * the comments should be presented in a tree view +``` + +### Comment linked to IdBasedComment + +This test checks the basic implementation of the comment feature within the GUI + +```cucumber +Feature: Customer: Visualize IdBasedComment together with CapacityGroup and MaterialDemand + +Scenario: Comment linked ton IdBasedComment + Given I have a comment that is linked to an IdBasedComment + When I try to view this comment in the graphical user interface + Then I should be able to view this comment in a list of all comments + * I should be able to view this comment by navigating to the WeekBasedMaterialDemand the IdBasedComment is linking, the comment is linking + * I should be able to view this comment by navigating to the WeekBasedCapacityGroup, the WeekBasedMaterialDemand is linked to, the IdBasedComment is linking, the comment is linking +``` + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 CatX Service GmbH +- SPDX-FileCopyrightText: 2024 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/test-supplier.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/test-supplier.md new file mode 100644 index 00000000000..b4589204f03 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/development-view/test-supplier.md @@ -0,0 +1,1052 @@ +--- +id: test-supplier +title: Test - Supplier +description: 'Tests relevant for the business role supplier.' +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## Introduction + +This page lists tests that can be executed by the business role supplier. + +They are written in [Gherkin](https://cucumber.io/docs/gherkin/). + +For an overview of these tests you should visit [Testing a DCM application](./overview.md#testing-a-dcm-application) within the Development View of this KIT. + +## Supplier: Prepare yourself + +### Setup EDC + +This test ensures that the supplier sets up its EDC. + +```cucumber +Feature: Supplier: Prepare yourself + +Scenario: Setup EDC + Given I have joined the Catena-X dataspace and want to execute DCM tests + When I check whether I have setup my EDC or not + Then I should confirm that I have setup my EDC in the correct version successfully +``` + +### Register APIs as assets + +This test ensures that the supplier registers its API endpoints as data assets with its own EDC. + +```cucumber +Feature: Supplier: Prepare yourself + +Scenario Outline: Register APIs as assets + Given my EDC has been setup correctly + When I check the asset catalog of my own EDC + Then I should find an asset for the with the correct and + +Examples: +| API | Taxonomy | Version | +| WeekBasedMaterialDemand API | cx-taxo:DcmWeekBasedMaterialDemand | 2.0 | +| RequestForUpdate API | cx-taxo:DcmIdBasedRequestForUpdate | 2.0 | +| IdBasedComment API | cx-taxo:DcmIdBasedComment | 2.0 | +``` + +### Check wallet for certificates + +This test ensures that the supplier has the necessary credentials in its wallet. + +```cucumber +Feature: Supplier: Prepare yourself + +Scenario Outline: Check wallet for certificates + Given I have been successfully onboarded into the Catena-X dataspace + When I check my wallet + Then I should find a that corresponds to a + +Examples: +| credential | policy | +| BPN-restricted Data Usage | BPN-restricted Data Usage | +| Membership Credential | Membership Credential | +| DataExchangeGovernance:1.0 | DataExchangeGovernance:1.0 | +``` + +### Prepare variables for other tests + +This test ensures that the supplier is aware of the fact that some tests contain variables that need to be filled in with the correct values before executing the tests. + +```cucumber +Feature: Supplier: Prepare yourself + +Scenario Outline: Prepare + Given I want to execute a that uses a I need to have a assigned to that makes sense in the context of the and use the value of the variable instead of its name when testing. + When the test gets executed + Then it should work as intended + +Examples: +| test | variable | value | +| Supplier: Create WeekBasedCapacityGroup, Supplier: Create IdBasedComment | BPNL_SUP | {Use your own Business Partner Number Legal (BPNL) e.g. BPNL000000000JS9} | +| Supplier: Create WeekBasedCapacityGroup, Supplier: Create IdBasedComment | BPNL_CUS | {Business Partner Number Legal (BPNL) of the company that acts as the business role Supplier in the context of the test execution e.g. BPNL00000000052O } | +| Supplier: Create WeekBasedCapacityGroup | BPNS_CUS1 | {A Business Partner Number Site (BPNS) of the company that acts as the business role customer in the context of the test execution} | +| Supplier: Create WeekBasedCapacityGroup | BPNS_CUS2 | {A Business Partner Number Site (BPNS) of the company that acts as the business role customer in the context of the test execution} | +| Supplier: Create WeekBasedCapacityGroup | BPNS_CUS3 | {A Business Partner Number Site (BPNS) of the company that acts as the business role customer in the context of the test execution} | +| Supplier: Create WeekBasedCapacityGroup | BPNS_SUP1 | {Use one of your own Business Partner Number Site (BPNS)} | +| Supplier: Create WeekBasedCapacityGroup, Supplier: Create IdBasedComment | UUID_CG1 | {UUIDv4 that needs to be generated during the creation of the corresponding aspect model and uniquely identifies it e.g. 4914cc91-5725-4268-9cd8-b8f6d72c525e} | +| Supplier: Create WeekBasedCapacityGroup | UUID_CG2 | {UUIDv4 that needs to be generated during the creation of the corresponding aspect model and uniquely identifies it e.g. 4914cc91-5725-4268-9cd8-b8f6d72c525e} | +| Supplier: Create WeekBasedCapacityGroup | UUID_CG3 | {UUIDv4 that needs to be generated during the creation of the corresponding aspect model and uniquely identifies it e.g. 4914cc91-5725-4268-9cd8-b8f6d72c525e} | +| Supplier: Create WeekBasedCapacityGroup | UUID_CG4 | {UUIDv4 that needs to be generated during the creation of the corresponding aspect model and uniquely identifies it e.g. 4914cc91-5725-4268-9cd8-b8f6d72c525e} | +| Supplier: Create IdBasedRequestForUpdate | UUID_MD1 | {UUIDv4 of a WeekBasedCapacityGroup, which gets created through the customer} | +| Supplier: Create WeekBasedCapacityGroup | STR_LOCA | {Name of a capacity group, in the context of the base journey the name (not BPNS) of the customer sites that covered by the capacity group is used } | +| Supplier: Create WeekBasedCapacityGroup | STR_LOCB | {Name of a capacity group, in the context of the base journey the name (not BPNS) of the customer sites that covered by the capacity group is used } | +| Supplier: Create WeekBasedCapacityGroup | STR_LOCC | {Name of a capacity group, in the context of the base journey the name (not BPNS) of the customer sites that covered by the capacity group is used } | +| Supplier: Create WeekBasedCapacityGroup | STR_LOCD | {Name of a capacity group, in the context of the base journey the name (not BPNS) of the customer sites that covered by the capacity group is used } | +| Supplier: Create WeekBasedCapacityGroup, Supplier: Create IdBasedComment | TS_NOW | {Timestamp that represents the system time when the corresponding aspect model gets created e.g. 2023-11-05T08:15:30.123-05:00} | +| Supplier: Create WeekBasedCapacityGroup, Supplier: Create IdBasedRequestForUpdate, Supplier: Create IdBasedComment | OMITTED | {Special case where you do not include the property in the data at all. You do not even mention it.} | + +``` + +### Prepare for base journey + +This test ensures that the supplier is aware of the sequence of communication and naming conventions within the base journey. + +```cucumber +Feature: Supplier: Prepare yourself + + Scenario Outline: Prepare for base journey + Given I want to execute the base journey which uses in to fulfill a certain that I need to be aware of in order to execute my part of the base journey successfully + When the test gets executed + Then it should work as intended + +Examples: +| object | function | test | +| MD_alpha | A WeekBasedMaterialDemand created by the customer and transmitted via Filetransfer Alpha | Consume WeekBasedMaterialDemand for base journey | +| MD_beta | A WeekBasedMaterialDemand created by the customer and transmitted via Filetransfer Alpha | Consume WeekBasedMaterialDemand for base journey, Calculation for base journey | +| MD_gamma | A WeekBasedMaterialDemand created by the customer and transmitted via Filetransfer Alpha and Theta | Consume WeekBasedMaterialDemand for base journey, Calculation for base journey, Provide IdBasedRequestForUpdate for base journey | +| MD_delta | A WeekBasedMaterialDemand created by the customer and transmitted via Filetransfer Beta | Consume WeekBasedMaterialDemand for base journey | +| CG_alpha | A WeekBasedCapacityGroup created by the supplier and transmitted via Filetransfer Gamma and Eta | Create WeekBasedCapacityGroup for base journey, Provide WeekBasedCapacityGroup for base journey, Consume IdBasedRequestForUpdate for base journey | +| CG_beta | A WeekBasedCapacityGroup created by the supplier and transmitted via Filetransfer Gamma | Create WeekBasedCapacityGroup for base journey, Provide WeekBasedCapacityGroup for base journey, Calculation for base journey | +| CG_gamma | A WeekBasedCapacityGroup created by the supplier and transmitted via Filetransfer Delta | Create WeekBasedCapacityGroup for base journey, Provide WeekBasedCapacityGroup for base journey | +| CG_delta | A WeekBasedCapacityGroup created by the supplier and transmitted via Filetransfer Delta | Create WeekBasedCapacityGroup for base journey, Provide WeekBasedCapacityGroup for base journey | +| RU_alpha | An IdBasedRequestForUpdate created by the customer and transmitted via Filetransfer Epsilon | Consume IdBasedRequestForUpdate for base journey | +| RU_beta | An IdBasedRequestForUpdate created by the supplier and transmitted via Filetransfer Zeta | Create IdBasedRequestForUpdate for base journey, Provide IdBasedRequestForUpdate for base journey | +| CT_alpha | An IdBasedComment created by the customer and transmitted via Filetransfer Iota | Consume IdBasedComment for base journey | +| CT_beta | An IdBasedComment created by the customer and transmitted via Filetransfer Iota | Consume IdBasedComment for base journey | +| CT_gamma | An IdBasedComment created by the supplier and transmitted via Filetransfer Kappa | Create IdBasedComment for base journey, Provide IdBasedComment for base journey | +| CT_delta | An IdBasedComment created by the supplier and transmitted via Filetransfer Kappa | Create IdBasedComment for base journey, Provide IdBasedComment for base journey | +| FT_alpha | A Filetransfer providing WeekBasedMaterialDemand for the supplier to consume | Consume WeekBasedMaterialDemand for base journey | +| FT_beta | A Filetransfer providing WeekBasedMaterialDemand for the supplier to consume | Consume WeekBasedMaterialDemand for base journey | +| FT_gamma | A Filetransfer providing WeekBasedCapacityGroup for the customer to consume | Provide WeekBasedCapacityGroup for base journey | +| FT_delta | A Filetransfer providing WeekBasedCapacityGroup for the customer to consume | Provide WeekBasedCapacityGroup for base journey | +| FT_epsilon | A Filetransfer providing IdBasedRequestForUpdate for the supplier to consume | Consume IdBasedRequestForUpdate for base journey | +| FT_eta | A Filetransfer providing WeekBasedCapacityGroup for the customer to consume | Consume IdBasedRequestForUpdate for base journey | +| FT_zeta | A Filetransfer providing IdBasedRequestForUpdate for the customer to consume | Provide IdBasedRequestForUpdate for base journey | +| FT_theta | A Filetransfer providing WeekBasedMaterialDemand for the supplier to consume | Provide IdBasedRequestForUpdate for base journey | +| FT_iota | A Filetransfer providing IdBasedComment for the supplier to consume | Consume IdBasedComment for base journey | +| FT_kappa | A Filetransfer providing IdBasedComment for the customer to consume | Provide IdBasedComment for base journey | +``` + +## Supplier: Consume WeekBasedMaterialDemand + +### Consume valid WeekBasedMaterialDemand + +This test checks the basic implementation of the API. + +```cucumber +Feature: Customer: Consume WeekBasedMaterialDemand + +Scenario: Consume valid unknown WeekBasedMaterialDemand + Given I receive a valid WeekBasedMaterialDemand from my customer with a materialDemandId that is unknown to me + When I try to consume said WeekBasedMaterialDemand + Then I should be able to consume it and send my customer a http 201 status message + +Scenario: Consume valid known WeekBasedMaterialDemand + Given I receive a valid WeekBasedMaterialDemand from my customer with a materialDemandId that is already known to me + When I try to consume said WeekBasedMaterialDemand + Then I should be able to consume it and send my customer a http 200 status message +``` + +### Consume invalid WeekBasedMaterialDemand + +This test checks the basic implementation of the API. + +```cucumber +Feature: Customer: Consume WeekBasedMaterialDemand + +Scenario: Consume invalid WeekBasedMaterialDemand + Given I receive an invalid WeekBasedMaterialDemand from my customer + When I try to consume said WeekBasedMaterialDemand + Then I should not consume it and send my customer a http 400 status message +``` + +### Consume WeekBasedMaterialDemand for base journey + +The supplier receives the previously created WeekBasedMaterialDemands from the customer as two separate data transfers. + +```cucumber +Feature: Supplier: Consume WeekBasedMaterialDemand + +Scenario Outline: Consume WeekBasedMaterialDemand for base journey + Given this is my entry point into the base journey + When I try to consume provided by my customer within + Then I should be able to consume the data and send to my customer. + +Examples: +| testDemand | fileTransfer | http status code | +| MD_alpha,MD_beta,MD_gamma | FT_alpha | 200 OK | +| MD_delta | FT_beta | 200 OK | +``` + +## Supplier: Create WeekBasedCapacityGroup + +### Create valid WeekBasedCapacityGroup + +This test checks the implementation of the aspect model as well as some edge cases. + +```cucumber +Feature: Supplier: Create WeekBasedCapacityGroup + +Scenario Outline: Try to generate valid WeekBasedCapacityGroup + Given the value for the property "unitOfMeasure" is with a default value of "unit:piece" + * the value for the property "name" is with a default value of "All my beautiful spark plugs" + * the value for the property "demandVolatilityParameters" contains exactly one entity "DemandVolatilityParametersEntity" + * the value for the property "startReferenceDateTime" is with a default value of "2024-01-10T12:00:00.320Z" + * the value for the property "rollingHorizonAlertThresholds" contains exactly one entity "RollingHorizonAlertThresholdsEntity" + * the value for the property "measurementInterval" is with a default value of "4" + * the value for the property "sequenceNumber" is with a default value of "1" + * the value for the property "subhorizonLength" is with a default value of "4" + * the value for the property "absoluteNegativeDeviation" is with a default value of "100.0" + * the value for the property "relativePositiveDeviation" is with a default value of "0.2" + * the value for the property "absolutePositiveDeviation" is with a default value of "100.0" + * the value for the property "relativeNegativeDeviation" is with a default value of "0.3" + * the value for the property "changedAt" is with a default value of "{{TS_NOW}}" + * the value for the property "linkedDemandSeries" contains exactly one entity "LinkedDemandSeries" + * the value for the property "demandCategoryCode" is with a default value of "0001" + * the value for the property "loadFactor" is with a default value of "3.5" + * the value for the property "materialNumberSupplier" is with a default value of "MNR-8101-ID146955.001" + * the value for the property "materialNumberCustomer" is with a default value of "MNR-7307-AU340474.002" + * the value for the property "customerLocation" is with a default value of "{{BPNS_CUS1}}" + * the value for the property "supplierLocations" is with a default value of "{{BPNS_SUP1}}" + * the value for the property "capacities" contains exactly one entity "Capacity" + * the value for the property "actualCapacity" is with a default value of "1000" + * the value for the property "agreedCapacity" is with a default value of "1800" + * the value for the property "maximumCapacity" is with a default value of "2000" + * the value for the property "deltaProductionResult" is with a default value of "400" + * the value for the property "pointInTime" is with a default value of "2022-08-01" + * the value for the property "linkedCapacityGroups" is with a default value of "be4d8470-2de6-43d2-b5f8-2e5d3eebf3fd" + * the value for the property "capacityGroupId" is with a default value of "0157ba42-d2a8-4e28-8565-7b07830c1110" + * the value for the property "capacityGroupIsInactive" is with a default value of "true" + * the value for the property "unitOfMeasureIsOmitted" is with a default value of "false" + * the value for the property "supplier" is with a default value of "{{BPNL_SUP}}" + * the value for the property "customer" is with a default value of "{{BPNL_CUS}}" + When the application tries to generate the WeekBasedCapacityGroup + Then it should generate the WeekBasedCapacityGroup + +Examples: +| v_unitOfMeasure | v_name | v_startReferenceDateTime | v_measurementInterval | v_sequenceNumber | v_subhorizonLength | v_absoluteNegativeDeviation | v_relativePositiveDeviation | v_absolutePositiveDeviation | v_relativeNegativeDeviation | v_changedAt | v_demandCategoryCode | v_loadFactor | v_materialNumberSupplier | v_materialNumberCustomer | v_customerLocation | v_supplierLocations | v_actualCapacity | v_agreedCapacity | v_maximumCapacity | v_deltaProductionResult | v_pointInTime | v_linkedCapacityGroups | v_capacityGroupId | v_capacityGroupIsInactive | v_unitOfMeasureIsOmitted | v_supplier | v_customer | +| unit:gram | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| unit:kilogram | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| unit:tonneMetricTon | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| unit:tonUsOrShortTonUkorus | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| unit:ounceAvoirdupois | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| unit:pound | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| unit:centimetre | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| unit:metre | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| 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:millilitre | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| unit:litre | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| unit:hectolitre | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| unit:piece | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| unit:set | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| unit:pair | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| unit:page | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| unit:kilowattHour | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| unit:secondUnitOfTime | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| unit:minuteUnitOfTime | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| unit:hourUnitOfTime | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| unit:cycle | | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | @!"§$%&/()=?`;:_-.,'*+#~><²³][}{´ | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | コンニチハ | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | Καλημέρα κόσμε | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | Hello World | | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | 2000-01-01T14:23:00.66372+14:00 | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | 2000-01-01T14:23:00.66372 | | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | 1 | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | 999 | | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | 1 | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | 999 | | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | 1 | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | 999 | | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | 999999999999.999 | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | 4.4 | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | 0 | | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | 0 | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | 0.5 | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | 1 | | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | 999999999999.999 | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | 4.4 | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | 0 | | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | 0 | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | 0.5 | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | 1 | | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | 2000-01-01T14:23:00.66372+14:00 | | | | | | | | | | | | | | | | | | +| | | | | | | | | | | | SR99 | | | | | | | | | | | | | | | | | +| | | | | | | | | | | | ED01 | | | | | | | | | | | | | | | | | +| | | | | | | | | | | | A1S1 | | | | | | | | | | | | | | | | | +| | | | | | | | | | | | OI01 | | | | | | | | | | | | | | | | | +| | | | | | | | | | | | OS01 | | | | | | | | | | | | | | | | | +| | | | | | | | | | | | PI01 | | | | | | | | | | | | | | | | | +| | | | | | | | | | | | PO01 | | | | | | | | | | | | | | | | | +| | | | | | | | | | | | 0001 | | | | | | | | | | | | | | | | | +| | | | | | | | | | | | | 999999999999.999 | | | | | | | | | | | | | | | | +| | | | | | | | | | | | | 4.4 | | | | | | | | | | | | | | | | +| | | | | | | | | | | | | 0.5 | | | | | | | | | | | | | | | | +| | | | | | | | | | | | | | @!"§$%&/()=?`;:_-.,'*+#~><²³][}{´ | | | | | | | | | | | | | | | +| | | | | | | | | | | | | | コンニチハ | | | | | | | | | | | | | | | +| | | | | | | | | | | | | | Καλημέρα κόσμε | | | | | | | | | | | | | | | +| | | | | | | | | | | | | | Hello World | | | | | | | | | | | | | | | +| | | | | | | | | | | | | | | @!"§$%&/()=?`;:_-.,'*+#~><²³][}{´ | | | | | | | | | | | | | | +| | | | | | | | | | | | | | | コンニチハ | | | | | | | | | | | | | | +| | | | | | | | | | | | | | | Καλημέρα κόσμε | | | | | | | | | | | | | | +| | | | | | | | | | | | | | | Hello World | | | | | | | | | | | | | | +| | | | | | | | | | | | | | | | | | 0 | | | | | | | | | | | +| | | | | | | | | | | | | | | | | | 4.4 | | | | | | | | | | | +| | | | | | | | | | | | | | | | | | 10000 | | | | | | | | | | | +| | | | | | | | | | | | | | | | | | 999999999999.999 | | | | | | | | | | | +| | | | | | | | | | | | | | | | | | | 0 | | | | | | | | | | +| | | | | | | | | | | | | | | | | | | 4.4 | | | | | | | | | | +| | | | | | | | | | | | | | | | | | | 10000 | | | | | | | | | | +| | | | | | | | | | | | | | | | | | | 999999999999.999 | | | | | | | | | | +| | | | | | | | | | | | | | | | | | | | 0 | | | | | | | | | +| | | | | | | | | | | | | | | | | | | | 4.4 | | | | | | | | | +| | | | | | | | | | | | | | | | | | | | 10000 | | | | | | | | | +| | | | | | | | | | | | | | | | | | | | 999999999999.999 | | | | | | | | | +| | | | | | | | | | | | | | | | | | | | | 0 | | | | | | | | +| | | | | | | | | | | | | | | | | | | | | 4.4 | | | | | | | | +| | | | | | | | | | | | | | | | | | | | | 10000 | | | | | | | | +| | | | | | | | | | | | | | | | | | | | | 999999999999.999 | | | | | | | | +| | | | | | | | | | | | | | | | | | | | | | 2024-09-02 | | | | | | | +| | | | | | | | | | | | | | | | | | | | | | 1930-01-06 | | | | | | | +| | | | | | | | | | | | | | | | | | | | | | 2119-12-25 | | | | | | | +| | | | | | | | | | | | | | | | | | | | | | | | | true | | | | +| | | | | | | | | | | | | | | | | | | | | | | | | false | | | | +| {{OMITTED}} | | | | | | | | | | | | | | | | | | | | | | | | | true | | | +| | | | | | | | | | | | | | | | | | | | | | | | | | false | | | +``` + +### Create invalid WeekBasedCapacityGroup + +This test checks the implementation of the aspect model as well as some edge cases. + +```cucumber +Feature: Supplier: Create WeekBasedCapacityGroup + +Scenario Outline: Try to generate invalid WeekBasedCapacityGroup + Given the value for the property "unitOfMeasure" is with a default value of "unit:piece" + * the value for the property "name" is with a default value of "All my beautiful spark plugs" + * the value for the property "demandVolatilityParameters" contains exactly one entity "DemandVolatilityParametersEntity" + * the value for the property "startReferenceDateTime" is with a default value of "2024-01-10T12:00:00.320Z" + * the value for the property "rollingHorizonAlertThresholds" contains exactly one entity "RollingHorizonAlertThresholdsEntity" + * the value for the property "measurementInterval" is with a default value of "4" + * the value for the property "sequenceNumber" is with a default value of "1" + * the value for the property "subhorizonLength" is with a default value of "4" + * the value for the property "absoluteNegativeDeviation" is with a default value of "100.0" + * the value for the property "relativePositiveDeviation" is with a default value of "0.2" + * the value for the property "absolutePositiveDeviation" is with a default value of "100.0" + * the value for the property "relativeNegativeDeviation" is with a default value of "0.3" + * the value for the property "changedAt" is with a default value of "{{TS_NOW}}" + * the value for the property "linkedDemandSeries" contains exactly one entity "LinkedDemandSeries" + * the value for the property "demandCategoryCode" is with a default value of "0001" + * the value for the property "loadFactor" is with a default value of "3.5" + * the value for the property "materialNumberSupplier" is with a default value of "MNR-8101-ID146955.001" + * the value for the property "materialNumberCustomer" is with a default value of "MNR-7307-AU340474.002" + * the value for the property "customerLocation" is with a default value of "{{BPNS_CUS1}}" + * the value for the property "supplierLocations" is with a default value of "{{BPNS_SUP1}}" + * the value for the property "capacities" contains exactly one entity "Capacity" + * the value for the property "actualCapacity" is with a default value of "1000" + * the value for the property "agreedCapacity" is with a default value of "1800" + * the value for the property "maximumCapacity" is with a default value of "2000" + * the value for the property "deltaProductionResult" is with a default value of "400" + * the value for the property "pointInTime" is with a default value of "2022-08-01" + * the value for the property "linkedCapacityGroups" is with a default value of "be4d8470-2de6-43d2-b5f8-2e5d3eebf3fd" + * the value for the property "capacityGroupId" is with a default value of "0157ba42-d2a8-4e28-8565-7b07830c1110" + * the value for the property "capacityGroupIsInactive" is with a default value of "true" + * the value for the property "unitOfMeasureIsOmitted" is with a default value of "false" + * the value for the property "supplier" is with a default value of "{{BPNL_SUP}}" + * the value for the property "customer" is with a default value of "{{BPNL_CUS}}" + When the application tries to generate the WeekBasedCapacityGroup + Then it should NOT generate the WeekBasedCapacityGroup and throw an instead + +Examples: +| v_unitOfMeasure | v_name | v_startReferenceDateTime | v_measurementInterval | v_sequenceNumber | v_subhorizonLength | v_absoluteNegativeDeviation | v_relativePositiveDeviation | v_absolutePositiveDeviation | v_relativeNegativeDeviation | v_changedAt | v_demandCategoryCode | v_loadFactor | v_materialNumberSupplier | v_materialNumberCustomer | v_customerLocation | v_supplierLocations | v_actualCapacity | v_agreedCapacity | v_maximumCapacity | v_deltaProductionResult | v_pointInTime | v_linkedCapacityGroups | v_capacityGroupId | v_capacityGroupIsInactive | v_unitOfMeasureIsOmitted | v_supplier | v_customer | error | +| unit:decagram | | | | | | | | | | | | | | | | | | | | | | | | | | | | AspectModel Conformity Error: unitOfMeasure | +| | | 2023-02-29T12:00:00.320Z | | | | | | | | | | | | | | | | | | | | | | | | | | AspectModel Conformity Error: startReferenceDateTime | +| | | This is not a datetime | | | | | | | | | | | | | | | | | | | | | | | | | | AspectModel Conformity Error: startReferenceDateTime | +| | | | This is not an integer | | | | | | | | | | | | | | | | | | | | | | | | | AspectModel Conformity Error: measurementInterval | +| | | | 2.3 | 5.5 | | | | | | | | | | | | | | | | | | | | | | | | AspectModel Conformity Error: measurementInterval | +| | | | | This is not an integer | | | | | | | | | | | | | | | | | | | | | | | | AspectModel Conformity Error: sequenceNumber | +| | | | | | 4.6 | | | | | | | | | | | | | | | | | | | | | | | AspectModel Conformity Error: sequenceNumber | +| | | | | | This is not an integer | | | | | | | | | | | | | | | | | | | | | | | AspectModel Conformity Error: subhorizonLength | +| | | | | | | -100 | | | | | | | | | | | | | | | | | | | | | | AspectModel Conformity Error: subhorizonLength | +| | | | | | | This is not a decimal | | | | | | | | | | | | | | | | | | | | | | AspectModel Conformity Error: absoluteNegativeDeviation | +| | | | | | | | 2 | | | | | | | | | | | | | | | | | | | | | AspectModel Conformity Error: absoluteNegativeDeviation | +| | | | | | | | -0.1 | | | | | | | | | | | | | | | | | | | | | AspectModel Conformity Error: relativePositiveDeviation | +| | | | | | | | This is not a decimal | | | | | | | | | | | | | | | | | | | | | AspectModel Conformity Error: relativePositiveDeviation | +| | | | | | | | | -1.1 | | | | | | | | | | | | | | | | | | | | AspectModel Conformity Error: relativePositiveDeviation | +| | | | | | | | | This is not a decimal | | | | | | | | | | | | | | | | | | | | AspectModel Conformity Error: absolutePositiveDeviation | +| | | | | | | | | | -0.2 | | | | | | | | | | | | | | | | | | | AspectModel Conformity Error: absolutePositiveDeviation | +| | | | | | | | | | 2 | | | | | | | | | | | | | | | | | | | AspectModel Conformity Error: relativeNegativeDeviation | +| | | | | | | | | | This is not a decimal | | | | | | | | | | | | | | | | | | | AspectModel Conformity Error: relativeNegativeDeviation | +| | | | | | | | | | 200-01-0 | | | | | | | | | | | | | | | | | | | AspectModel Conformity Error: relativeNegativeDeviation | +| | | | | | | | | | | This is not a datetime | | | | | | | | | | | | | | | | | | AspectModel Conformity Error: changedAt | +| | | | | | | | | | | | 0O01 | | | | | | | | | | | | | | | | | AspectModel Conformity Error: demandCategoryCode | +| | | | | | | | | | | | 01OI | | | | | | | | | | | | | | | | | AspectModel Conformity Error: demandCategoryCode | +| | | | | | | | | | | | Default | | | | | | | | | | | | | | | | | AspectModel Conformity Error: demandCategoryCode | +| | | | | | | | | | | | | -1 | | | | | | | | | | | | | | | | AspectModel Conformity Error: loadFactor | +| | | | | | | | | | | | | 1,1 | | | | | | | | | | | | | | | | AspectModel Conformity Error: loadFactor | +| | | | | | | | | | | | | This is not a decimal | | | | | | | | | | | | | | | | AspectModel Conformity Error: loadFactor | +| | | | | | | | | | | | | | | | This is not a BPNS | | | | | | | | | | | | | AspectModel Conformity Error: customerLocation | +| | | | | | | | | | | | | | | | | This is not a BPNS | | | | | | | | | | | | AspectModel Conformity Error: supplierLocations | +| | | | | | | | | | | | | | | | | | 9999999999999999999999 | | | | | | | | | | | AspectModel Conformity Error: actualCapacity | +| | | | | | | | | | | | | | | | | | 5,5 | | | | | | | | | | | AspectModel Conformity Error: actualCapacity | +| | | | | | | | | | | | | | | | | | -1 | | | | | | | | | | | AspectModel Conformity Error: actualCapacity | +| | | | | | | | | | | | | | | | | | | 9999999999999999999999 | | | | | | | | | | AspectModel Conformity Error: agreedCapacity | +| | | | | | | | | | | | | | | | | | | 5,5 | | | | | | | | | | AspectModel Conformity Error: agreedCapacity | +| | | | | | | | | | | | | | | | | | | -1 | | | | | | | | | | AspectModel Conformity Error: agreedCapacity | +| | | | | | | | | | | | | | | | | | | | 9999999999999999999999 | | | | | | | | | AspectModel Conformity Error: maximumCapacity | +| | | | | | | | | | | | | | | | | | | | 5,5 | | | | | | | | | AspectModel Conformity Error: maximumCapacity | +| | | | | | | | | | | | | | | | | | | | -1 | | | | | | | | | AspectModel Conformity Error: maximumCapacity | +| | | | | | | | | | | | | | | | | | | | | This is not a decimal | | | | | | | | AspectModel Conformity Error: deltaProductionResult | +| | | | | | | | | | | | | | | | | | | | | | 2022-04-22 | | | | | | | AspectModel Conformity Error: pointInTime | +| | | | | | | | | | | | | | | | | | | | | | 22.04.2021 | | | | | | | AspectModel Conformity Error: pointInTime | +| | | | | | | | | | | | | | | | | | | | | | | d01bfdc9-b599-4d2a-8817-6174c3095381 | | | | | | AspectModel Conformity Error: linkedCapacityGroups | +| | | | | | | | | | | | | | | | | | | | | | | b90ae365-3866-9971-9004b1b1d003 | | | | | | AspectModel Conformity Error: linkedCapacityGroups | +| | | | | | | | | | | | | | | | | | | | | | | | b90ae365-3866-9971-9004b1b1d003 | | | | | AspectModel Conformity Error: capacityGroupId | +| | | | | | | | | | | | | | | | | | | | | | | | d01bfdc9-b599-4d2a-8817-6174c3095381 | | | | | AspectModel Conformity Error: capacityGroupId | +| | | | | | | | | | | | | | | | | | | | | | | | | maybe | | | | AspectModel Conformity Error: capacityGroupIsInactive | +| | | | | | | | | | | | | | | | | | | | | | | | | | maybe | | | AspectModel Conformity Error: unitOfMeasureIsOmitted | +| | | | | | | | | | | | | | | | | | | | | | | | | | | This is not a BPNL | | AspectModel Conformity Error: supplier | +| | | | | | | | | | | | | | | | | | | | | | | | | | | | This is not a BPNL | AspectModel Conformity Error: customer | +``` + +### Create WeekBasedCapacityGroup for base journey + +```cucumber +Feature: Customer: Create WeekBasedCapacityGroup + +Scenario Outline: Try to generate WeekBasedCapacityGroup for base journey using different + +Given the value for the property "unitOfMeasure" is +* the value for the property "changedAt" is +* the value for the property "capacityGroupIsInactive" is +* the value for the property "unitOfMeasureIsOmitted" is +* the value for the property "name" is +* the value for the property "capacityGroupId" is +* the value for the property "supplier" is +* the value for the property "customer" is +* the value for the property "LinkedDemandSeries" contains at least one Entity "DemandSeries" +* the value for the property "linkedCapacityGroups" is +* the value for the property "pointInTime" is +* the value for the property "actualCapacity" is +* the value for the property "maximumCapacity" is +* the value for the property "agreedCapacity" is +* the value for the property "deltaProductionResult" is + + +When the application tries to generate the WeekBasedCapacityGroup + +Then it should generate the WeekBasedCapacityGroup + +Examples: +| v_tests | v_unitOfMeasure | v_changedAt | v_capacityGroupIsInactive | v_unitOfMeasureIsOmitted | v_name | v_capacityGroupId | v_supplier | v_customer | v_materialNumberCustomer | v_customerLocation | v_demandCategory | v_linkedCapacityGroups | v_DemandVolatility | v_pointInTime | v_actualCapacity | v_maximumCapacity | v_agreedCapacity | v_deltaProductionResult | +| alpha | unit:pieces | {{TS_NOW}} | false | false | {{STR_LOCA}} | {{UUID_CG1}} | {{BPNL_SUP}} | {{BPNL_CUS}} | MNR-8540-CH063329.001 | {{BPNS_CUS1}} | 0001 | {{OMITTED}} | {{OMITTED}} | 2026-01-05,2026-08-05,2026-01-12,2026-01-19,2026-01-26,2026-02-02,2026-02-09,2026-02-16,2026-02-23,2026-03-02,2026-03-09,2026-03-16,2026-03-23,2026-03-30,2026-04-06,2026-04-13,2026-04-20,2026-04-27,2026-05-04,2026-05-11 | 220,209,209,220,209,245,250,0,240,250,245,242,220,209,198,220,109,198,209,220 | 250,250,250,250,250,250,250,0,250,250,250,250,250,250,250,250,250,250,250,250 | 300,300,300,300,300,300,300,300,300,300,300,300,300,300,300,300,300,300,300,300 | {{OMITTED}} | +| beta | unit:kilogram | {{TS_NOW}} | false | false | {{STR_LOCB}} | {{UUID_CG2}} | {{BPNL_SUP}} | {{BPNL_CUS}} | MNR-8549-CH706214.023, MNR-8549-CH706214.023 | {{BPNS_CUS2}}, {{BPNS_CUS2}} | A1S1,PI01 | {{OMITTED}} | {{OMITTED}} | 2026-01-05,2026-08-05,2026-01-12,2026-01-19,2026-01-26,2026-02-02,2026-02-09,2026-02-16,2026-02-23,2026-03-02,2026-03-09,2026-03-16,2026-03-23,2026-03-30,2026-04-06,2026-04-13,2026-04-20,2026-04-27,2026-05-04,2026-05-11 | 690,345,690,575,690,690,460,690,0,805,805,780,900,900,805,805,900,690,1150 | 900,900,900,900,900,900,900,900,0,900,900,900,900,910,950,900,900,1000,900,1150 | 800,800,800,800,800,800,800,800,800,800,800,800,800,800,800,800,800,800,800,800 | {{OMITTED}} | +| gamma | unit:liters | {{TS_NOW}} | false | false | {{STR_LOCC}} | {{UUID_CG3}} | {{BPNL_SUP}} | {{BPNL_CUS}} | MNR-8538-CH809974.001 | {{BPNS_CUS3}} | PO01 | {{OMITTED}} | {{OMITTED}} | 2026-01-05,2026-08-05,2026-01-12,2026-01-19,2026-01-26,2026-02-02,2026-02-09,2026-02-16,2026-02-23,2026-03-02,2026-03-09,2026-03-16,2026-03-23,2026-03-30,2026-04-06,2026-04-13,2026-04-20,2026-04-27,2026-05-04,2026-05-11 | 3790,3790,3890,3890,2020,2020,2310,2310,3690,0,3500,3500,1820,1820,3450,3450,3010,3010,550,550 | 3790,3790,3890,3890,3530,3530,3530,3910,3910,3910,3910,3910,3910,3910,3450,3450,3010,3010,2580,2580 | 4000,4000,4000,4000,4000,4000,4000,4000,4000,4000,4000,4000,4000,4000,4000,4000,4000,4000,4000,4000 | {{OMITTED}} | +| delta | unit:kilogram | {{TS_NOW}} | false | false | {{STR_LOCD}} | {{UUID_CG4}} | {{BPNL_SUP}} | {{BPNL_CUS}} | {{OMITTED}} | {{OMITTED}} | {{OMITTED}} | {{OMITTED}} | {{OMITTED}} | 2026-01-05,2026-08-05,2026-01-12,2026-01-19,2026-01-26,2026-02-02,2026-02-09,2026-02-16,2026-02-23,2026-03-02,2026-03-09,2026-03-16,2026-03-23,2026-03-30,2026-04-06,2026-04-13,2026-04-20,2026-04-27,2026-05-04,2026-05-11 | 690,345,690,575,690,690,460,690,0,805,805,780,900,900,805,805,900,690,1150 | 900,900,900,900,900,900,900,900,0,900,900,900,900,910,950,900,900,1000,900,1150 | 800,800,800,800,800,800,800,800,800,800,800,800,800,800,800,800,800,800,800,800 | {{OMITTED}} | +``` + +## Supplier: Provide WeekBasedCapacityGroup + +### Provide valid WeekBasedCapacityGroup + +This test checks the basic implementation of the API. + +```cucumber +Feature: Supplier: Provide WeekBasedCapacityGroup + +Scenario: Provide valid new WeekBasedCapacityGroup + Given the capacityGroupId of the WeekBasedCapacityGroup is unknown to my customer + When I try to provide my customer with said WeekBasedCapacityGroup + Then I should get an http 201 status message + +Scenario: Provide valid existing WeekBasedCapacityGroup + Given the capacityGroupId of the WeekBasedCapacityGroup is already known to my customer + When I try to provide my customer with said WeekBasedCapacityGroup + Then I should get an http 200 status message +``` + +### Provide invalid WeekBasedCapacityGroup + +This test checks the basic implementation of the API. + +```cucumber +Feature: Supplier: Provide WeekBasedCapacityGroup + +Scenario: Provide invalid WeekBasedCapacityGroup + Given I accidentally created an invalid WeekBasedCapacityGroup + When I try to provide my customer with said WeekBasedCapacityGroup + Then I should get an http 400 status message +``` + +### Provide WeekBasedCapacityGroup for base journey + +The supplier sends the previously created WeekBasedCapacityGroups to the customer as two separate data transfers. + +```cucumber +Feature: Supplier: Provide WeekBasedCapacityGroup + +Scenario Outline: Provide WeekBasedCapacityGroup for base journey + Given I have successfully created capacity groups alpha, beta, gamma and delta as described in Create WeekBasedCapacityGroup for base journey + When I try to provide my customer with as + Then I should get from my customer. + +Examples: +| testCapacityGroup | fileTransfer | http status code | +| CG_alpha, CG_beta | FT_gamma | 200 OK | +| CG_gamma, CG_delta | FT_delta | 200 OK | +``` + +## Supplier: Visualize CapacityGroup together with MaterialDemand + +### Bottleneck calculation + +This test checks the basic implementation of the GUI. + +```cucumber +Feature: Supplier: Visualize CapacityGroup together with MaterialDemand + +Scenario Outline: Bottleneck calculation + Given I have created a WeekBasedCapacityGroup + * I have consumed at least one WeekBasedMaterialDemand linked by the WeekBasedCapacityGroup + When I calculate and visualize the demand and capacity time series + Then it should show in for + +Examples: +| case | color | result | +| demand > actual capacity = maximum capacity | red | bottleneck | +| actual capacity < demand = maximum capacity | orange | bottleneck | +| actual capacity < demand < maximum capacity | orange | bottleneck | +| actual capacity < maximum capacity < demand | red | bottleneck | +``` + +### Surplus calculation + +This test checks the basic implementation of the GUI. + +```cucumber +Feature: Supplier: Visualize CapacityGroup together with MaterialDemand + +Scenario Outline: Bottleneck calculation + Given I have created a WeekBasedCapacityGroup + * I have consumed at least one WeekBasedMaterialDemand linked by the WeekBasedCapacityGroup + When I calculate and visualize the demand and capacity time series + Then it should show in for + +Examples: +| case | color | result | +| demand < actual capacity = maximum capacity | green | surplus | +| demand < actual capacity < maximum capacity | green | surplus | +``` + +### Zero deviation calculation + +This test checks the basic implementation of the GUI. + +```cucumber +Feature: Supplier: Visualize CapacityGroup together with MaterialDemand + +Scenario Outline: Bottleneck calculation + Given I have created a WeekBasedCapacityGroup + * I have consumed at least one WeekBasedMaterialDemand linked by the WeekBasedCapacityGroup + When I calculate and visualize the demand and capacity time series + Then it should show in for + +Examples: +| case | color | result | +| demand = actual capacity = maximum capacity | green | zero deviation | +| demand = actual capacity < maximum capacity | green | zero deviation | +``` + +### Calculation for base journey + +The supplier compares the demand data, received from the customer, to the capacity data, sent to the customer. + +```cucumber +Feature: Supplier: Visualize CapacityGroup together with MaterialDemand + +Scenario Outline: Calculation for base journey + Given I have successfully consumed + * I have successfully created + When I compare demand and capacity data for + Then I should get for in + +Examples: +| WeekBasedCapacityGroup | WeekBasedMaterialDemand | week | year | result | case | color | +| CG_beta | MD_beta, MD_gamma | 09 | 2026 | bottleneck | Demand > actual capacity = maximum capacity | red | +| CG_beta | MD_beta, MD_gamma | 18 | 2026 | bottleneck | Actual capacity < demand = maximum capacity | orange | +| CG_beta | MD_beta, MD_gamma | 12 | 2026 | bottleneck | Actual capacity < demand < maximum capacity | orange | +| CG_beta | MD_beta, MD_gamma | 15 | 2026 | bottleneck | Actual capacity < maximum capacity < demand | red | +| CG_beta | MD_beta, MD_gamma | 20 | 2026 | surplus | Demand < actual capacity = maximum capacity | green | +| CG_beta | MD_beta, MD_gamma | 01 | 2026 | surplus | Demand < actual capacity < maximum capacity | green | +| CG_beta | MD_beta, MD_gamma | 13 | 2026 | zero deviation | Demand = actual capacity = maximum capacity | green | +| CG_beta | MD_beta, MD_gamma | 14 | 2026 | zero deviation | Demand = actual capacity < maximum capacity | green | +``` + +## Supplier: Create IdBasedRequestForUpdate + +### Create valid IdBasedRequestForUpdate + +This test checks the implementation of the aspect model as well as some edge cases. + +```cucumber +Feature: Supplier: Create IdBasedRequestForUpdate + +Scenario Outline: Try to generate valid IdBasedRequestForUpdate + Given the value for the property "weekBasedMaterialDemand" is + * "weekBasedMaterialDemand" is a list with properties "changedAt" and "materialDemandId" + * the value for the property "weekBasedCapacityGroup" is + * "weekBasedCapacityGroup" is a list with properties "changedAt" and "materialDemandId" + When the application tries to generate the IdBasedRequestForUpdate + Then it should generate the IdBasedRequestForUpdate and represent the following + +Examples: +| v_weekBasedMaterialDemand | v_weekBasedCapacityGroup | case | +| {{OMITTED}} | {{OMITTED}} | Give me everything | +| [ {"materialDemandId" : "0157ba42-d2a8-4e28-8565-7b07830c3456","changedAt" : "2023-03-10T12:27:11.320Z"}] | [ {"capacityGroupId" : "0157ba42-d2a8-4e28-8565-7b07830c1110","changedAt" : "2023-03-10T12:27:11.320Z"} ] | Give me the specified aspect models, but only of they are newer than the specified timestamps | +| [ {"materialDemandId" : "0157ba42-d2a8-4e28-8565-7b07830c3456","changedAt" : "2023-03-10T12:27:11.320Z"}] | {{OMITTED}} | Give me the specified aspect models, but only of they are newer than the specified timestamps | +| {{OMITTED}} | [ {"capacityGroupId" : "0157ba42-d2a8-4e28-8565-7b07830c1110","changedAt" : "2023-03-10T12:27:11.320Z"} ] | Give me the specified aspect models, but only of they are newer than the specified timestamps | +| [ {"materialDemandId" : "0157ba42-d2a8-4e28-8565-7b07830c3456"}] | {{OMITTED}} | Give me the specified aspect models | +| {{OMITTED}} | [ {"capacityGroupId" : "0157ba42-d2a8-4e28-8565-7b07830c1110"} ] | Give me the specified aspect models | +| [ {"materialDemandId" : "e84f0078-cb3f-4917-8b56-8405c053d5ca"},{"materialDemandId" : "0157ba42-d2a8-4e28-8565-7b07830c3456"}] | {{OMITTED}} | Give me the specified aspect models | + +``` + +### Create invalid IdBasedRequestForUpdate + +This test checks the implementation of the aspect model as well as some edge cases. + +```cucumber +Feature: Supplier: Create IdBasedRequestForUpdate + +Scenario Outline: Try to generate invalid IdBasedRequestForUpdate + Given the value for the property "weekBasedMaterialDemand" is + * "weekBasedMaterialDemand" is a list with properties "changedAt" and "materialDemandId" + * the value for the property "weekBasedCapacityGroup" is + * "weekBasedCapacityGroup" is a list with properties "changedAt" and "materialDemandId" + When the application tries to generate the IdBasedRequestForUpdate + Then it should NOT generate the IdBasedRequestForUpdate and throw an instead + +Examples: +| v_weekBasedMaterialDemand | v_weekBasedCapacityGroup | error | +| This should not compute | {{OMITTED}} | AspectModel Conformity Error: weekBasedMaterialDemand | +| {{OMITTED}} | This should not compute | AspectModel Conformity Error: weekBasedCapacityGroup | + +``` + +### Create IdBasedRequestForUpdate for base journey + +The supplier creates an IdBasedRequestForUpdate used by the base journey which requests WeekBasedMaterialDemand Alpha, identified via {{UUID_MD1}}. + +```cucumber +Feature: Supplier: Create IdBasedRequestForUpdate + +Scenario Outline: Try to generate IdBasedRequestForUpdate for base journey using different + Given the value for the property "weekBasedMaterialDemand" is + * "weekBasedMaterialDemand" is a list with properties "changedAt" and "materialDemandId" + * the value for the property "weekBasedCapacityGroup" is + * "weekBasedCapacityGroup" is a list with properties "changedAt" and "materialDemandId" + When the application tries to generate the IdBasedRequestForUpdate + Then it should generate the IdBasedRequestForUpdate + +Examples: +| v_tests | v_weekBasedMaterialDemand | v_weekBasedCapacityGroup | +| RU_beta | [ {"capacityGroupId" : {{UUID_MD1}}}] | {{OMITTED}} | +``` + +## Supplier: Consume IdBasedRequestForUpdate + +### Consume valid IdBasedRequestForUpdate + +This test checks the basic implementation of the API. + +```cucumber +Feature: Supplier: Consume IdBasedRequestForUpdate + +Scenario: Consume valid IdBasedRequestForUpdate + Given I receive a valid IdBasedRequestForUpdate from my customer + When I try to consume said IdBasedRequestForUpdate + Then I should be able to consume it, send my customer a http 200 status message and provide my customer with the data requested, if applicable +``` + +### Consume invalid IdBasedRequestForUpdate + +This test checks the basic implementation of the API. + +```cucumber +Feature: Supplier: Consume IdBasedRequestForUpdate + +Scenario: Consume invalid IdBasedRequestForUpdate + Given I receive an invalid IdBasedRequestForUpdate from my customer + When I try to consume said IdBasedRequestForUpdate + Then I should not consume it and send my customer a http 400 status message +``` + +### Consume IdBasedRequestForUpdate for base journey + +The customer sends the previously created IdBasedRequestForUpdate to the supplier and expects one WeekBasedCapacityGroup in return. + +```cucumber +Feature: Supplier: Consume IdBasedRequestForUpdate + +Scenario Outline: Consume IdBasedRequestForUpdate for base journey + Given I receive a containing as payload + When I try to consume + Then I should be able to consume it and send my customer a http 200 status message + * I should react by sending with back to my customer + +Examples: +| FileTransfer | IdBasedRequestForUpdate | reaction | reaction payload | +| FT_epsilon | RU_alpha | FT_eta | CG_alpha | +``` + +## Supplier: Provide IdBasedRequestForUpdate + +### Provide valid IdBasedRequestForUpdate + +This test checks the basic implementation of the API. + +```cucumber +Feature: Supplier: Provide IdBasedRequestForUpdate + +Scenario: Provide valid IdBasedRequestForUpdate + Given I was able to create a valid IdBasedRequestForUpdate + When I try to provide my customer with said IdBasedRequestForUpdate + Then I should get an http 200 status message +``` + +### Provide invalid IdBasedRequestForUpdate + +This test checks the basic implementation of the API. + +```cucumber +Feature: Supplier: Provide invalid IdBasedRequestForUpdate + +Scenario: Provide invalid IdBasedRequestForUpdate + Given I accidentally created an invalid IdBasedRequestForUpdate + When I try to provide my customer with said IdBasedRequestForUpdate + Then I should get an http 400 status message +``` + +### Provide IdBasedRequestForUpdate for base journey + +```cucumber +Feature: Supplier: Provide IdBasedRequestForUpdate + +Scenario Outline: Provide IdBasedRequestForUpdate for base journey + Given I have previously consumed RU_epsilon + When I provide my customer with containing as payload + Then I should get a http 200 status message + * I should receive from my customer, containing + +Examples: +| FileTransfer | IdBasedRequestForUpdate | reaction | reaction payload | +| FT_zeta | RU_beta | FT_theta | MD_gamma | +``` + +## Supplier: Consume IdBasedComment + +### Consume valid IdBasedComment + +This test checks the basic implementation of the API. + +```cucumber +Feature: Supplier: Consume IdBasedComment + +Scenario: Consume valid unknown IdBasedComment + Given I receive a valid IdBasedComment from my customer with a commentID that is unknown to me + When I try to consume said IdBasedComment + Then I should be able to consume it and send my customer a http 201 status message + +Scenario: Consume valid known IdBasedComment + Given I receive a valid IdBasedComment from my customer with a commentID that is already known to me + When I try to consume said IdBasedComment + Then I should be able to consume it and send my customer a http 200 status message +``` + +### Consume invalid IdBasedComment + +This test checks the basic implementation of the API. + +```cucumber +Feature: Supplier: Consume IdBasedComment + +Scenario: Consume invalid IdBasedComment + Given I receive an invalid IdBasedComment from my customer + When I try to consume said IdBasedComment + Then I should not consume it and send my customer a http 400 status message +``` + +### Consume IdBasedComment for base journey + +```cucumber +Feature: Supplier: Consume IdBasedComment + +Scenario Outline: Consume IdBasedComment for base journey + Given I receive a containing as payload + When I try to consume + Then I should be able to consume it and send my customer a http 200 status message + +Examples: +| FileTransfer | IdBasedComment | +| FT_iota | CT_alpha, CT_beta | +``` + +## Supplier: Create IdBasedComment + +### Create valid IdBasedComment + +This test checks the implementation of the aspect model as well as some edge cases. + +```cucumber +Feature: Supplier: Create IdBasedComment + +Scenario Outline: Try to generate valid IdBasedComment + Given the value for the property "CommentId" is with a default value of "a54348ce-7373-4cf0-8f00-8a73ea323dab" + * the value for the property "ObjectId" is with a default value of "b01fac51-6e7f-4754-a762-11814a1ff243" + * the value for the property "CommentType" is with a default value of "default" + * the value for the property "listOfReferenceDates" is with a default value of "2025-04-21" + * the value for the property "author" is with a default value of "max.mustermann@company.de" + * the value for the property "supplier" is with a default value of "{{BPNL_SUP}}" + * the value for the property "customer" is with a default value of "{{BPNL_CUS}}" + * the value for the property "CommentText" is with a default value of "This is a comment. Very nice! " + * the value for the property "requestDelete" is with a default value of "false" + * the value for the property "objectType" is with a default value of "urn:samm:io.catenax.week_based_capacity_group" + * the value for the property "postedAt" is with a default value of "2024-03-10T12:27:11.320Z" + * the value for the property "changedAt" is with a default value of "2024-03-10T12:27:11.320Z" + When the application tries to generate the IdBasedComment + Then it should generate the IdBasedComment + +Examples: +| v_CommentId | v_ObjectId | v_CommentType | v_listOfReferenceDates | v_author | v_supplier | v_customer | v_CommentText | v_requestDelete | v_objectType | v_postedAt | v_changedAt | +| 1236a465-93ab-45f7-ad17-67ad3107d6c8 | | | | | | | | | | | | +| urn:uuid:1236a465-93ab-45f7-ad17-67ad3107d6c8 | | | | | | | | | | | | +| | f38d7d7b-b8e7-452c-8ee2-08c8c56a4f80 | | | | | | | | | | | +| | urn:uuid:f38d7d7b-b8e7-452c-8ee2-08c8c56a4f80 | | | | | | | | | | | +| | | information | | | | | | | | | | +| | | warning | | | | | | | | | | +| | | default | | | | | | | | | | +| | | actionRequired | | | | | | | | | | +| | | | 2024-05-13 | | | | | | | | | +| | | | 2024-05-13,2024-05-20 | | | | | | | | | +| | | | | test@gmail.com | | | | | | | | +| | | | | {{BPNL_CUS}} | | | | | | | | +| | | | | | {{BPNL_SUP}} | | | | | | | +| | | | | | | {{BPNL_CUS}} | | | | | | +| | | | | | | | This can be up to 5000 characters long and contain special characters. | | | | | +| | | | | | | | !"§$%&/()=,.;:#'+*~<>[]{} | | | | | +| | | | | | | | | true | | | | +| | | | | | | | | false | | | | +| | | | | | | | | | urn:samm:io.catenax.week_based_material_demand | | | +| | | | | | | | | | urn:samm:io.catenax.week_based_capacity_group | | | +| | | | | | | | | | urn:samm:io.catenax.id_based_comment | | | +| | | | | | | | | | | 2024-03-11T11:27:11.320Z | | +| | | | | | | | | | | | 2024-03-11T11:27:11.320Z | +``` + +### Create invalid IdBasedComment + +This test checks the implementation of the aspect model as well as some edge cases. + +```cucumber +Feature: Supplier: Create IdBasedComment + +Scenario Outline: Try to generate invalid IdBasedComment + Given the value for the property "CommentId" is with a default value of "a54348ce-7373-4cf0-8f00-8a73ea323dab" + * the value for the property "ObjectId" is with a default value of "b01fac51-6e7f-4754-a762-11814a1ff243" + * the value for the property "CommentType" is with a default value of "default" + * the value for the property "listOfReferenceDates" is with a default value of "2025-04-21" + * the value for the property "author" is with a default value of "max.mustermann@company.de" + * the value for the property "supplier" is with a default value of "{{BPNL_SUP}}" + * the value for the property "customer" is with a default value of "{{BPNL_CUS}}" + * the value for the property "CommentText" is with a default value of "This is a comment. Very nice! " + * the value for the property "requestDelete" is with a default value of "false" + * the value for the property "objectType" is with a default value of "urn:samm:io.catenax.week_based_capacity_group" + * the value for the property "postedAt" is with a default value of "2024-03-10T12:27:11.320Z" + * the value for the property "changedAt" is with a default value of "2024-03-10T12:27:11.320Z" + When the application tries to generate the IdBasedComment + Then it should NOT generate the IdBasedComment and throw an instead + +Examples: +| v_CommentId | v_ObjectId | v_CommentType | v_listOfReferenceDates | v_author | v_supplier | v_customer | v_CommentText | v_requestDelete | v_objectType | v_postedAt | v_changedAt | error | +| Not an UUID | | | | | | | | | | | | AspectModel Conformity Error: commentID | +| | Not an UUID | | | | | | | | | | | AspectModel Conformity Error: objectID | +| | | warnings | | | | | | | | | | AspectModel Conformity Error: commentType | +| | | comment | | | | | | | | | | AspectModel Conformity Error: commentType | +| | | Not a commentType | | | | | | | | | | AspectModel Conformity Error: commentType | +| | | | 2024-05-13;2024-05-20 | | | | | | | | | AspectModel Conformity Error: listOfReferenceDates | +| | | | List,Of,Strings | | | | | | | | | AspectModel Conformity Error: listOfReferenceDates | +| | | | | Not@a@valid.email.adress | | | | | | | | AspectModel Conformity Error: author | +| | | | | Not a BPNL | | | | | | | | AspectModel Conformity Error: author | +| | | | | | Not a BPNL | | | | | | | AspectModel Conformity Error: supplier | +| | | | | | | Not a BPNL | | | | | | AspectModel Conformity Error: customer | +| | | | | | | | {{String with more than 5000 characters}} | | | | | AspectModel Conformity Error: CommentText | +| | | | | | | | | maybe | | | | AspectModel Conformity Error: requestDelete | +| | | | | | | | | | urn:samm:io.catenax.id_based_request_for_update:3.0.0 | | | AspectModel Conformity Error: objectType | +| | | | | | | | | | urn:samm:io.catenax.id_based_comment | | | AspectModel Conformity Error: objectType | +| | | | | | | | | | Not an objectType | | | AspectModel Conformity Error: objectType | +| | | | | | | | | | | 2000-01-01T66:23:00.66372+14:00 | | AspectModel Conformity Error: postedAt | +| | | | | | | | | | | | 2000-01-0 | AspectModel Conformity Error: changedAt | +``` + +### Create IdBasedComment for base journey + +```cucumber +Feature: Customer: Create IdBasedComment + +Scenario Outline: Try to generate IdBasedComment for base journey using different + + Given the value for the property "CommentId" is + * the value for the property "ObjectId" is + * the value for the property "CommentType" is + * the value for the property "listOfReferenceDates" is + * the value for the property "author" is + * the value for the property "supplier" is + * the value for the property "customer" is + * the value for the property "CommentText" is + * the value for the property "requestDelete" is + * the value for the property "objectType" is + * the value for the property "postedAt" is + * the value for the property "changedAt" is + When the application tries to generate the IdBasedComment + Then it should generate the IdBasedComment + +Examples: +| v_tests | v_CommentId | v_ObjectId | v_CommentType | v_listOfReferenceDates | v_author | v_supplier | v_customer | v_CommentText | v_requestDelete | v_objectType | v_postedAt | v_changedAt | +| CT_gamma | {{UUID_COM2}} | {{UUID_CG1}} | warning | {{OMITTED}} | max.mustermann@company.de | {{BPNL_SUP}} | {{BPNL_CUS}} | "Capacity set to 0 because machine is destroyed." | false | urn:samm:io.catenax.week_based_capacity_group | {{TS_NOW}} | {{TS_NOW}} | +| CT_delta | {{UUID_COM4}} | {{UUID_CG1}} | default | {{OMITTED}} | max.mustermann@company.de | {{BPNL_SUP}} | {{BPNL_CUS}} | "Capacity set to 0 in CW45 due to machine maintenance. Please set demand in CW 45 to 0." | false | urn:samm:io.catenax.week_based_capacity_group | {{TS_NOW}} | {{TS_NOW}} | +``` + +## Supplier: Provide IdBasedComment + +### Provide valid IdBasedComment + +This test checks the basic implementation of the API. + +```cucumber +Feature: Supplier: Provide IdBasedComment + +Scenario: Provide valid new IdBasedComment + Given the commentID of the IdBasedComment is unknown to my supplier + When I try to provide my customer with said IdBasedComment + Then I should get an http 201 status message + +Scenario: Provide valid existing IdBasedComment + Given the commentID of the IdBasedComment is already known to my supplier + When I try to provide my customer with said IdBasedComment + Then I should get an http 200 status message +``` + +### Provide invalid IdBasedComment + +This test checks the basic implementation of the API. + +```cucumber +Feature: Supplier: Provide IdBasedComment + +Scenario: Provide invalid IdBasedComment + Given I accidentally created an invalid IdBasedComment + When I try to provide my customer with said IdBasedComment + Then I should get an http 400 status message +``` + +### Provide IdBasedComment for base journey + +This test checks the basic implementation of the API. + +```cucumber +Feature: Supplier: Provide IdBasedComment + +Scenario Outline: Provide IdBasedComment for base journey + Given I try to provide my customer with an IdBasedComment + When I sent a containing as payload to my customer + Then I should get an http 200 status message + +Examples: +| FileTransfer | IdBasedComment | +| FT_kappa | CT_gamma, CT_delta | +``` + +## Supplier: Visualize IdBasedComment together with CapacityGroup and MaterialDemand + +### Comment linked to WeekBasedCapacityGroup + +This test checks the basic implementation of the comment feature within the GUI. + +```cucumber +Feature: Supplier: Visualize IdBasedComment together with CapacityGroup and MaterialDemand + +Scenario: Comment linked to WeekBasedCapacityGroup + Given I have a comment that is linked to a WeekBasedCapacityGroup + When I try to view this comment in the graphical user interface + Then I should be able to view this comment in a list of all comments + * I should be able to view this comment by navigating to the WeekBasedCapacityGroup the comment is linking +``` + +### Comment linked to WeekBasedMaterialDemand + +This test checks the basic implementation of the comment feature within the GUI. + +```cucumber +Feature: Supplier: Visualize IdBasedComment together with CapacityGroup and MaterialDemand + +Scenario: Comment linked to WeekBasedMaterialDemand + Given I have a comment that is linked to a WeekBasedMaterialDemand + When I try to view this comment in the graphical user interface + Then I should be able to view this comment in a list of all comments + * I should be able to view this comment by navigating to the WeekBasedMaterialDemand the comment is linking + * I should be able to view this comment by navigating to the WeekBasedCapacityGroup, the WeekBasedMaterialDemand is linked to, the comment is linking + * the comments should be presented in a tree view +``` + +### Comment linked to IdBasedComment + +This test checks the basic implementation of the comment feature within the GUI. + +```cucumber +Feature: Supplier: Visualize IdBasedComment together with CapacityGroup and MaterialDemand + +Scenario: Comment linked to IdBasedComment + Given I have a comment that is linked to an IdBasedComment + When I try to view this comment in the graphical user interface + Then I should be able to view this comment in a list of all comments + * I should be able to view this comment by navigating to the WeekBasedMaterialDemand the IdBasedComment is linking, the comment is linking + * I should be able to view this comment by navigating to the WeekBasedCapacityGroup, the WeekBasedMaterialDemand is linked to, the IdBasedComment is linking, the comment is linking +``` + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 CatX Service GmbH +- SPDX-FileCopyrightText: 2024 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/operation-view.md b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/operation-view.md new file mode 100644 index 00000000000..bab276e810a --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Demand and Capacity Management Kit/operation-view.md @@ -0,0 +1,39 @@ +--- +id: operation-view +title: Operation View +description: Your first steps +--- + +![DCM kit banner](/img/kit-icons/dcm-kit-icon.svg) + +## DCM FOSS Application + +A free and open source software (FOSS) implementing the Catena-X standard CX-0128 is under development. Feel free to contribute to this community effort and visit the corresponding [GitHub repository](https://github.com/eclipse-tractusx/demand-capacity-mgmt) and [GitHub project](https://github.com/orgs/eclipse-tractusx/projects/66). + +### Prerequisites + +Further information can be found in the [GitHub repository](https://github.com/eclipse-tractusx/demand-capacity-mgmt) + +### Authorization information + +Further information can be found in the [GitHub repository](https://github.com/eclipse-tractusx/demand-capacity-mgmt) + +### Deployment + +Further information can be found in the [GitHub repository](https://github.com/eclipse-tractusx/demand-capacity-mgmt) + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023 BASF SE +- SPDX-FileCopyrightText: 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V (Fraunhofer) +- SPDX-FileCopyrightText: 2023 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2023 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2023 SAP SE +- SPDX-FileCopyrightText: 2023 SupplyOn AG +- SPDX-FileCopyrightText: 2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/_category_.json b/docs-kits_versioned_docs/version-24.12/kits/Digital Twin Kit/Software Development View/_category_.json similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/_category_.json rename to docs-kits_versioned_docs/version-24.12/kits/Digital Twin Kit/Software Development View/_category_.json diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/page_interaction-patterns.md b/docs-kits_versioned_docs/version-24.12/kits/Digital Twin Kit/Software Development View/page_interaction-patterns.md similarity index 97% rename from docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/page_interaction-patterns.md rename to docs-kits_versioned_docs/version-24.12/kits/Digital Twin Kit/Software Development View/page_interaction-patterns.md index aa5ca2bdeb3..eb82d70e03c 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/page_interaction-patterns.md +++ b/docs-kits_versioned_docs/version-24.12/kits/Digital Twin Kit/Software Development View/page_interaction-patterns.md @@ -84,6 +84,7 @@ sequenceDiagram participant Con as Data Consumer participant CEDC as Consumer EDC
          Control Plane participant PEDC as Provider EDC
          Control Plane + participant PEDCDP as Provider EDC
          Data Plane participant DTR as Digital Twin Registry participant SM as Submodel Server participant EDCD as EDC Discovery @@ -109,8 +110,10 @@ autonumber CEDC-->>Con: Dataset for submodel(-bundle) Con->>PEDC: negotiate for Dataset and retrieve token PEDC-->>Con: access token - Con->>SM: GET {{submodel-descriptor/href}}/$value - SM-->>Con: data + Con->>PEDCDP: GET {{submodel-descriptor/href}}/$value + PEDCDP-->>SM: consume + SM-->>PEDCDP: return + PEDCDP-->>Con: data ``` If the `data` is a Bill of @@ -282,5 +285,5 @@ The same holds true for use-case-defined APIs that trigger automatic updates/cre This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - SPDX-License-Identifier: CC-BY-4.0 -- SPDX-FileCopyrightText: 2023 Contributors of the Eclipse Foundation -- Source URL: [https://github.com/eclipse-tractusx/tractusx-edc](https://github.com/eclipse-tractusx/tractusx-edc) +- SPDX-FileCopyrightText: 2023, 2024 Contributors of the Eclipse Foundation +- Source URL: [https://github.com/eclipse-tractusx/eclipse-tractusx.github.io](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io) diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/page_software-development-view.md b/docs-kits_versioned_docs/version-24.12/kits/Digital Twin Kit/Software Development View/page_software-development-view.md similarity index 95% rename from docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/page_software-development-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Digital Twin Kit/Software Development View/page_software-development-view.md index 5c9ccc5594b..e78f00bbb58 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/Software Development View/page_software-development-view.md +++ b/docs-kits_versioned_docs/version-24.12/kits/Digital Twin Kit/Software Development View/page_software-development-view.md @@ -23,15 +23,15 @@ the [Operation View](../page_software-operation-view.md). ## API Specifications -All openAPI-specifications for the Digital Twin Kit services are rendered in the -section [of these docs](API%20AAS%20Discovery/dotaas-part-2-http-rest-discovery-service-specification.info.mdx) +All openAPI-specifications for the Digital Twin Kit services are stored in the [openApi section](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/openApi/dt) of this repo. +Please note that these are non-normative replicas from the original standards and their normative references. ### Asset Administration Shell The Asset Administration Shell (AAS) is a specification that is released by the [Industrial Digital Twin Association (IDTA)](https://industrialdigitaltwin.org/) -with a perspective to be adopted by the [International Electrotechnical Commission (IEC)](https://www.iec.ch/homepage) as -IEC 63278. +and already partly adopted by the [International Electrotechnical Commission (IEC)](https://www.iec.ch/homepage) as +[IEC 63278](https://webstore.iec.ch/en/publication/65628). Its mission is defining how “information about assets […] can be exchanged in a meaningful way between partners in a value creation network” ([IDTA 01001-3-0](https://industrialdigitaltwin.org/wp-content/uploads/2023/04/IDTA-01001-3-0_SpecificationAssetAdministrationShell_Part1_Metamodel.pdf) @@ -69,7 +69,7 @@ security setup etc.). As the information contained in the DTR may be sensitive a every data provider must offer his own DTR as an EDC Data Asset. While it is only mandatory to implement the GET endpoints as specified in -the [Development View](API%20AAS%20Registry/dotaas-part-2-http-rest-registry-service-specification.info.mdx), +the [Standard CX-0002](https://catenax-ev.github.io/docs/next/standards/CX-0002-DigitalTwinsInCatenaX), data providers may find it useful to implement other requests for registration on top. Either way, they are free to populate their DTR in any way they desire. @@ -162,9 +162,8 @@ A full example on the default case is shown in the next section. #### Registering a new Twin Registration of a new twin is (at least in Catena-X) equivalent to the creation of a new twin. Thus, a Data Provider -should always ensure that there is no AAS-descriptor created for the respective assetIds yet. If there already is one, -the submodel-descriptor should -be [added to the existing shell-descriptor](#registering-a-new-submodel-at-an-existing-twin). +should always ensure that an AAS-descriptor for the respective assetIds does not exist yet. If one exists, the +submodel-descriptor should be [added to the existing shell-descriptor](#registering-a-new-submodel-at-an-existing-twin). `POST /shell-descriptors` @@ -480,14 +479,14 @@ differences are the changed typization. `proxyPath` parameter should be set `"tr ### Usage Policies For Digital Twin Registries, Data Providers are encouraged to only extend Data Offers that make no explicit checks to -use-case frameworks (formerly known as `FrameworkAgreements`. The DTR is an Enablement Service that should only be +use-case frameworks (formerly known as `FrameworkAgreement`s). The DTR is an Enablement Service that should only be visible once to every Data Consumer in the DSP-Catalog because it is a meta-data broker for data from multiple use-cases. Registering it with a Constraint that's specific to a particular use-case would restrict it only to a small subset of the dataspace. Of course, the DTR could be registered once per use-case but that's not recommended as it bloats the catalog and requires a lot of consumer-side processing. That's why Offers for a DTR should always be extended to the dataspace using the at least two Constraints: -1. Check for an active `Membership` credential. This is agnostic to use-cases but still ensures that a Consumer's VP +1. Check for an active `DataExchangeGovernanceCredential` credential. This is agnostic to use-cases but still ensures that a Consumer's VP is valid and issued by a common trust-anchor. 2. using the DTR as a roadsign in the discovery process is legitimate but requires a set of predefined behavior which is why there's a `purpose` for the DTR. @@ -497,10 +496,7 @@ Here's an example ````json { "@context": [ - "https://www.w3.org/ns/odrl.jsonld", - { - "cx-policy": "https://w3id.org/catenax/policy/" - } + "https://www.w3.org/ns/odrl.jsonld" ], "@type": "Policy", "permission": [ @@ -509,12 +505,12 @@ Here's an example "constraint": { "and": [ { - "leftOperand": "cx-policy:Membership", + "leftOperand": "https://w3id.org/catenax/policy/Framework", "operator": "eq", - "rightOperand": "active" + "rightOperand": "DataExchangeGovernance:1.0" }, { - "leftOperand": "cx-policy:UsagePurpose", + "leftOperand": "https://w3id.org/catenax/policy/UsagePurpose", "operator": "eq", "rightOperand": "cx.core.digitalTwinRegistry:1" } @@ -618,5 +614,5 @@ the assets but also for the AAS - this is hard to realize in a pure stateless im This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - SPDX-License-Identifier: CC-BY-4.0 -- SPDX-FileCopyrightText: 2023 Contributors of the Eclipse Foundation -- Source URL: [https://github.com/eclipse-tractusx/tractusx-edc](https://github.com/eclipse-tractusx/tractusx-edc) +- SPDX-FileCopyrightText: 2023, 2024 Contributors of the Eclipse Foundation +- Source URL: [https://github.com/eclipse-tractusx/eclipse-tractusx.github.io](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io) diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/assets/img/DTKIT_high_level_arch.svg b/docs-kits_versioned_docs/version-24.12/kits/Digital Twin Kit/assets/img/DTKIT_high_level_arch.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/assets/img/DTKIT_high_level_arch.svg rename to docs-kits_versioned_docs/version-24.12/kits/Digital Twin Kit/assets/img/DTKIT_high_level_arch.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/assets/img/DTKIT_pictogram_blue.png b/docs-kits_versioned_docs/version-24.12/kits/Digital Twin Kit/assets/img/DTKIT_pictogram_blue.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/assets/img/DTKIT_pictogram_blue.png rename to docs-kits_versioned_docs/version-24.12/kits/Digital Twin Kit/assets/img/DTKIT_pictogram_blue.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-24.12/kits/Digital Twin Kit/page_adoption-view.md similarity index 79% rename from docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/page_adoption-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Digital Twin Kit/page_adoption-view.md index 09625cbcc46..df827322a74 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/page_adoption-view.md +++ b/docs-kits_versioned_docs/version-24.12/kits/Digital Twin Kit/page_adoption-view.md @@ -63,7 +63,7 @@ This Kit's aim is not to solve a dedicated business problem. It is an infrastruc data sharing and integration. It does however deliver a broad set of capabilities that the use cases can leverage, namely: - Well-defined API structures extensible by domain models. Each use case will want to share different data but make it -available in a shared manner. (see [Submodel API](./Software%20Development%20View/API%20Submodel)) +available in a shared manner. (see [Submodel API](https://eclipse-tractusx.github.io/api-hub/)) - A distributed infrastructure of central and decentral components integrating on the one hand with backend-systems in existing enterprise IT and on other hand with the Dataspace. @@ -83,22 +83,21 @@ For more information how specifically the Asset Administration Shell is used, co ### CX-Standards -Links open PDFs. +Links open html. -- [CX - 0001 EDC Discovery API](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_September23/CX-0001-EDCDiscoveryAPI_v1.0.2.pdf) *(version 1.0.2)* -- [CX - 0002 Digital Twins in Catena-X](https://catena-x.net/de/standard-library)*(version 2.2.0, public release pending)* -- [CX - 0003 Semantic Aspect Meta-Model](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_Maerz_2024/CX-0003-SAMMSemanticAspectMetaModel-v1.1.0.pdf)*(version 1.1.0)* -- [CX - 0053 BPN Discovery Service](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_Januar_2024/CX-0053-BPNDiscoveryServiceAPIs-v1.0.1.pdf) *(version 1.0.1)* +- [CX - 0001 EDC Discovery API](https://catenax-ev.github.io/docs/next/standards/CX-0001-EDCDiscoveryAPI) *(version 1.0.2)* +- [CX - 0002 Digital Twins in Catena-X](https://catenax-ev.github.io/docs/next/standards/CX-0002-DigitalTwinsInCatenaX)*(version 2.2.0)* +- [CX - 0003 Semantic Aspect Meta-Model](https://catenax-ev.github.io/docs/next/standards/CX-0003-SAMMSemanticAspectMetaModel)*(version 1.1.0)* +- [CX - 0053 BPN Discovery Service](https://catenax-ev.github.io/docs/next/standards/CX-0053-BPNDiscoveryServiceAPIs) *(version 1.1.0)* ### Terminology -CX-0002 includes a figure on how the terms (also used in this Kit) interrelate. Check it out on page 5 of the [published -standard](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_Januar_2024/CX-0002-DigitalTwinsInCatenaX-v2.1.0.pdf). +CX-0002 includes a figure on how the terms (also used in this Kit) interrelate. Check it out [here](https://catenax-ev.github.io/docs/next/standards/CX-0002-DigitalTwinsInCatenaX#123-asset-administration-shell) ## Notice This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - SPDX-License-Identifier: CC-BY-4.0 -- SPDX-FileCopyrightText: 2023 Contributors of the Eclipse Foundation -- Source URL: [https://github.com/eclipse-tractusx/tractusx-edc](https://github.com/eclipse-tractusx/tractusx-edc) +- SPDX-FileCopyrightText: 2023, 2024 Contributors of the Eclipse Foundation +- Source URL: [https://github.com/eclipse-tractusx/eclipse-tractusx.github.io](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io) diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/page_changelog.md b/docs-kits_versioned_docs/version-24.12/kits/Digital Twin Kit/page_changelog.md similarity index 84% rename from docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/page_changelog.md rename to docs-kits_versioned_docs/version-24.12/kits/Digital Twin Kit/page_changelog.md index 4b8173cd2db..0622869f3c3 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/page_changelog.md +++ b/docs-kits_versioned_docs/version-24.12/kits/Digital Twin Kit/page_changelog.md @@ -11,7 +11,17 @@ sidebar_position: 1 All notable changes to this Kit will be documented in this file. -## [2.0.0] - unreleased +## [2.0.1] - 2024-08-01 + +### Changed + +- updated links and bugfixes + +### Removed + +- rendered openApi Docs + +## [2.0.0] - 2024-05-02 ### Added @@ -92,5 +102,5 @@ All notable changes to this Kit will be documented in this file. This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - SPDX-License-Identifier: CC-BY-4.0 -- SPDX-FileCopyrightText: 2023 Contributors of the Eclipse Foundation -- Source URL: [https://github.com/eclipse-tractusx/tractusx-edc](https://github.com/eclipse-tractusx/tractusx-edc) +- SPDX-FileCopyrightText: 2023, 2024 Contributors of the Eclipse Foundation +- Source URL: [https://github.com/eclipse-tractusx/eclipse-tractusx.github.io](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io) diff --git a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/page_software-operation-view.md b/docs-kits_versioned_docs/version-24.12/kits/Digital Twin Kit/page_software-operation-view.md similarity index 72% rename from docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/page_software-operation-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Digital Twin Kit/page_software-operation-view.md index a71524d1466..354ef61063d 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Digital Twin Kit/page_software-operation-view.md +++ b/docs-kits_versioned_docs/version-24.12/kits/Digital Twin Kit/page_software-operation-view.md @@ -23,13 +23,13 @@ CX-0002. ## Deployment -| Service Name | Description | Reference Implementation | [Standardized in](https://catena-x.net/de/standard-library) | -|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------| -| Discovery Finder | A microservice resolving a type of specific asset identifiers, e.g. `manufacturerPartId` or `intrinsicId` against a set of BPN-, and EDC-Discovery Servers hosted at Catena-X operating companies. These identifiers are often shared across use-cases (see [Industry Core](../Industry%20Core%20Kit/Software%20Development%20View)) but are not specified by the DT Kit and standards. | [Tractus-X Discovery Finder](https://github.com/eclipse-tractusx/sldt-discovery-finder) | CX - 0053 | -| BPN Discovery | A microservice resolving a particular specific asset identifier (consisting of its type - defined above - and the value for a particular asset) against the registered [Business Partner Number](../Business%20Partner%20Kit/page_adoption-view.md#business-value) of its owner. This is useful in discovery when the location of data on a particular asset is unknown. | [Tractus-X BPN Discovery](https://github.com/eclipse-tractusx/sldt-bpn-discovery) | CX - 0053 | -| EDC Discovery | A microservice that resolves a BPN against a list of EDC endpoints. It is populated during onboarding and is the last step of the discovery sequence preceeding the DSP-interaction starting with the catalog-request. | [Tractus-X Portal including EDC Discovery API](https://github.com/eclipse-tractusx/portal-backend) | CX - 0001 | -| Digital Twin Registry | A registry for digital twins. Here, a provider publicises digital representations (digital twins) of the assets the participant has data on. This data is encapsulated in submodels accessible via instructions that a consumer will find in the Digital Twin Registry (DTR). The DTR adheres to the [AssetAdministrationShellRegistryServiceSpecification](https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShellRegistryServiceSpecification/V3.0_SSP-002#/) and the [DiscoveryServiceSpecification](https://app.swaggerhub.com/apis/Plattform_i40/DiscoveryServiceSpecification/V3.0.1_SSP-001) and thus contains only meta-data. | [Tractus-X Digital Twin Registry](https://github.com/eclipse-tractusx/sldt-digital-twin-registry) | CX - 0002 | -| Submodel Server | The data source adhering to a subset of the Submodel API as defined in AAS Part-2 3.0. It delivers the actual data that the consumer is looking for via a structured endpoint defined by the [SubmodelServiceSpecification](https://app.swaggerhub.com/apis/Plattform_i40/SubmodelServiceSpecification/V3.0_SSP-003) and according to the structured data formats defined in the [Semantic Models Repository](https://github.com/eclipse-tractusx/sldt-semantic-models). | [FA³ST-Framework](https://github.com/FraunhoferIOSB/FAAAST-Service),
          [Eclipse Basyx](https://github.com/eclipse-basyx/basyx-java-sdk),
          [AASX Server](https://github.com/admin-shell-io/aasx-server) | CX - 0002 | +| Service Name | Description | Reference Implementation | [Standardized in](https://catena-x.net/de/standard-library) | +|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------| +| Discovery Finder | A microservice resolving a type of specific asset identifiers, e.g. `manufacturerPartId` or `intrinsicId` against a set of BPN-, and EDC-Discovery Servers hosted at Catena-X operating companies. These identifiers are often shared across use-cases (see [Industry Core](../Industry%20Core%20Kit/Software%20Development%20View)) but are not specified by the DT Kit and standards. | [Tractus-X Discovery Finder](https://github.com/eclipse-tractusx/sldt-discovery-finder) | CX - 0053 | +| BPN Discovery | A microservice resolving a particular specific asset identifier (consisting of its type - defined above - and the value for a particular asset) against the registered [Business Partner Number](../Business%20Partner%20Kit/page_adoption-view.md#business-value) of its owner. This is useful in discovery when the location of data on a particular asset is unknown. | [Tractus-X BPN Discovery](https://github.com/eclipse-tractusx/sldt-bpn-discovery) | CX - 0053 | +| EDC Discovery | A microservice that resolves a BPN against a list of EDC endpoints. It is populated during onboarding and is the last step of the discovery sequence preceeding the DSP-interaction starting with the catalog-request. | [Tractus-X Portal including EDC Discovery API](https://github.com/eclipse-tractusx/portal-backend) | CX - 0001 | +| Digital Twin Registry | A registry for digital twins. Here, a provider publicises digital representations (digital twins) of the assets the participant has data on. This data is encapsulated in submodels accessible via instructions that a consumer will find in the Digital Twin Registry (DTR). The DTR adheres to the [AssetAdministrationShellRegistryServiceSpecification](https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShellRegistryServiceSpecification/V3.0_SSP-002#/) and the [DiscoveryServiceSpecification](https://app.swaggerhub.com/apis/Plattform_i40/DiscoveryServiceSpecification/V3.0.1_SSP-001) and thus contains only meta-data. | [Tractus-X Digital Twin Registry](https://github.com/eclipse-tractusx/sldt-digital-twin-registry) | CX - 0002 | +| Submodel Server | The data source adhering to a subset of the Submodel API as defined in AAS Part-2 3.0. It delivers the actual data that the consumer is looking for via a structured endpoint defined by the [SubmodelServiceSpecification](https://app.swaggerhub.com/apis/Plattform_i40/SubmodelServiceSpecification/V3.0_SSP-003) and according to the structured data formats defined in the [Semantic Models Repository](https://github.com/eclipse-tractusx/sldt-semantic-models). | There are no official reference implementations for the Submodel-API. Implementations of the API exist in frameworks such as [FA³ST-Framework](https://github.com/FraunhoferIOSB/FAAAST-Service), [Eclipse Basyx](https://github.com/eclipse-basyx/basyx-java-sdk), [AASX Server](https://github.com/admin-shell-io/aasx-server). These implementations are not certified according to the standard nor involved in systematic end-to-end testing. | CX - 0002 | ![High Level Architecture of an App leveraging the Digital Twin Kit](assets/img/DTKIT_high_level_arch.svg) @@ -48,5 +48,6 @@ implementations. This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - SPDX-License-Identifier: CC-BY-4.0 -- SPDX-FileCopyrightText: 2023 Contributors of the Eclipse Foundation -- Source URL: [https://github.com/eclipse-tractusx/tractusx-edc](https://github.com/eclipse-tractusx/tractusx-edc) +- SPDX-FileCopyrightText: 2023, 2024 Contributors of the Eclipse Foundation +- Source + URL: [https://github.com/eclipse-tractusx/eclipse-tractusx.github.io](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io) diff --git a/docs-kits_versioned_docs/version-24.05/kits/ESS-Kit/assets/CatenaX_ESS_KitBlockDiagram.png b/docs-kits_versioned_docs/version-24.12/kits/ESS-Kit/assets/CatenaX_ESS_KitBlockDiagram.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/ESS-Kit/assets/CatenaX_ESS_KitBlockDiagram.png rename to docs-kits_versioned_docs/version-24.12/kits/ESS-Kit/assets/CatenaX_ESS_KitBlockDiagram.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/ESS-Kit/assets/CatenaX_ESS_KitBusinessArchitecture.png b/docs-kits_versioned_docs/version-24.12/kits/ESS-Kit/assets/CatenaX_ESS_KitBusinessArchitecture.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/ESS-Kit/assets/CatenaX_ESS_KitBusinessArchitecture.png rename to docs-kits_versioned_docs/version-24.12/kits/ESS-Kit/assets/CatenaX_ESS_KitBusinessArchitecture.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/ESS-Kit/assets/CatenaX_ESS_KitCustomerJourney.svg b/docs-kits_versioned_docs/version-24.12/kits/ESS-Kit/assets/CatenaX_ESS_KitCustomerJourney.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/ESS-Kit/assets/CatenaX_ESS_KitCustomerJourney.svg rename to docs-kits_versioned_docs/version-24.12/kits/ESS-Kit/assets/CatenaX_ESS_KitCustomerJourney.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/ESS-Kit/assets/CatenaX_ESS_KitSequenceView.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/ESS-Kit/assets/CatenaX_ESS_KitSequenceView.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/ESS-Kit/assets/CatenaX_ESS_KitSequenceView.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/ESS-Kit/assets/CatenaX_ESS_KitSequenceView.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/ESS-Kit/assets/CatenaX_ESS_KitSequenceView.svg b/docs-kits_versioned_docs/version-24.12/kits/ESS-Kit/assets/CatenaX_ESS_KitSequenceView.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/ESS-Kit/assets/CatenaX_ESS_KitSequenceView.svg rename to docs-kits_versioned_docs/version-24.12/kits/ESS-Kit/assets/CatenaX_ESS_KitSequenceView.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/ESS-Kit/changelog.md b/docs-kits_versioned_docs/version-24.12/kits/ESS-Kit/changelog.md similarity index 69% rename from docs-kits_versioned_docs/version-24.05/kits/ESS-Kit/changelog.md rename to docs-kits_versioned_docs/version-24.12/kits/ESS-Kit/changelog.md index a6dac67e7f2..4ebed9b2cb2 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/ESS-Kit/changelog.md +++ b/docs-kits_versioned_docs/version-24.12/kits/ESS-Kit/changelog.md @@ -6,18 +6,29 @@ sidebar_position: 1 ![ESS Kit Icon](@site/static/img/kit-icons/ess-kit-icon.svg) -## [0.2.0] - 2024-05-24 +## [0.3.0] - 2024-07-11 ### Added -- information about Code of Conduct in Adoption View -- added link to BPNL-Kit and to Industry Core Kit +- add reference to Code of Conduct that will be published on Web page +- add description of Occasion-related tracking in broken supply chains + +### Changed + +- changed link to video about ESS customer journey + +### Removed + +## [0.2.0] - 2024-05-23 + +### Added + +chapters for Code of Conduct in Adoption View ### Changed - replace picture CatenaX_ESS_KitCustomerJourney -- corrected typos e.g. youtube, respectively -- adjusted all links to images of ESS-Kit moved to folder assets within ESS-Kit +- moved pictures from folder static to folder asset within ESS-Kit ### Removed diff --git a/docs-kits_versioned_docs/version-24.05/kits/ESS-Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-24.12/kits/ESS-Kit/page_adoption-view.md similarity index 93% rename from docs-kits_versioned_docs/version-24.05/kits/ESS-Kit/page_adoption-view.md rename to docs-kits_versioned_docs/version-24.12/kits/ESS-Kit/page_adoption-view.md index 123e1386a74..a9cad7bb36f 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/ESS-Kit/page_adoption-view.md +++ b/docs-kits_versioned_docs/version-24.12/kits/ESS-Kit/page_adoption-view.md @@ -88,7 +88,14 @@ The trace of an incident follows previously mentioned principles along any oblig ![ESS_KitCustomerJourney](assets/CatenaX_ESS_KitCustomerJourney.svg) -**Note:** There will be an explanatory youtube video, which will be available after IP clearance. [ESS video]() +**Note:** There is an explanatory video published on youtube. [ESS video]() + +### Customer Journey: Occasion-related tracking in broken supply chains + +If no Catena-X member can be identified within the Catena-X network, other external sources could be used to identify the missing suppliers and fill the gaps that are relevant for this ESS incident. + +For each supplier that could be found, the Clearing Agency would need to check against the Catena-X network if a BPN is available or not. The identified supplier (there could be more than one), who is a member of the Catena-X network, will be assigned as the ESS incident moderator for this ESS incident. The incident moderator can be addressed via the EDC endpoint of the Business Partner and is most likely the incident manager of this Business Partner. +Now, the tracing of an ESS incident can continue as described above. The ESS incident moderator shall trace the supply chain both upstream (towards his suppliers) and downstream (towards his customers). For Business Partners, that are members of the supply chain, the Catena-X network and its services can be utilized, for Business Partners, that are not in the Catena-X network other means of communication must be used. ### ESS Incidents personas @@ -177,7 +184,7 @@ The data model follows the Catena-X Standard [CX-0144]( diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/Success Stories/BatteryPass_Viewer_App.mdx b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/Success Stories/BatteryPass_Viewer_App.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/Success Stories/BatteryPass_Viewer_App.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/Success Stories/BatteryPass_Viewer_App.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/changelog.md b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/changelog.md similarity index 84% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/changelog.md rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/changelog.md index de700541e82..0dc1985fc65 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/changelog.md +++ b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/changelog.md @@ -2,6 +2,21 @@ title: Changelog --- +## [1.5.0] - 2024-07-25 + +### 24.08 Added + +- Added Digital Product Pass Verification Section in adoption view +- Added Digital Product Pass Tutorial Section adoption view & software view +- Added Digital Product Passport as Enabler for Circular Economy Whitepaper reference + +### 24.08 Updated + +- Updated DPP model to version v5.0.0 +- Updated BatteryPass to v6.0.0 +- Updated TransmissionPass to v3.0.0 +- Updated DPP Verification add-on in the software development view. + ## [1.4.0] - 2024-05-15 ### 24.05 Added diff --git a/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/page-adoption-view.md b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/page-adoption-view.md new file mode 100644 index 00000000000..eb9a25d51dd --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/page-adoption-view.md @@ -0,0 +1,1809 @@ +--- +title: Adoption View +--- + +![EcoPass KIT Pictotogram](/img/kit-icons/ecopass-kit-icon.svg) + +## Introduction + +The EcoPass KIT will be the key enabler for various stakeholders to use digital product passports, which represent a digital collection of specific information about a physical product in a standardized exchange format. This data is governed by agreed-upon ownership and access rights, which are conveyed through the Eclipse Data Space Connector (EDC). The primary purpose of the product passport is to enable the electronic registration, processing and sharing of product-related details among various entities in the supply chain, including several businesses and authorities. The demand for interoperable product passports exists worldwide, driven by the need to establish sustainable and transparent supply chains across different types of products, for which the adoption of standards will become crucial. +In this context, Catena-X offers a decentralized ecosystem supported by standards and principles like data sovereignty, which can effectively implement such a product passport system. The objective of the EcoPass KIT is therefore to: + +- Provide a comprehensive overview of the business context and benefits of product passports. +- Offer guidelines for industry stakeholders. +- Provide a detailed description and offer tools to implement product passports. + +## Vision & Mission + +### Vision: Empowering Sustainability – One Product at a Time + +The EcoPass KIT envisions a future where sustainability is at the core of every product's lifecycle, from design and manufacturing to usage and end-of-life. By fostering transparency, traceability and informed decision-making, we aim to inspire solution and service providers to create innovative, eco-friendly products that reduce environmental impact and drive the global economy towards a circular model. + +### Mission: Unleashing Circularity Potential + +The EcoPass KIT enables the scalable usage of digital product passports in order to address the pressing issue of inefficient resource usage and lack of product transparency. With growing concerns over environmental impact, limited resources and waste generation, there is an urgent need for a comprehensive solution to drive sustainable practices across the value chain. The KIT offers unified data models, a reference application for passport utilization as well as the required API. Low entry barriers will allow you to adapt digital product passports rapidly and pay your contribution to a fully circular value chain without the necessity of vast expertise or resources. Designed for multiple products, the KIT offers scalability, high-quality product information and a set of tools for regulatory compliance. Our mission is to unlock the circular potential of every component and material, fostering a culture of sustainability, innovation, and shared responsibility among all stakeholders. + +All described specifications in the KIT are based on [Catena-X standards](https://catena-x.net/de/standard-library) such as the Asset Administration Shell, SSI and decentral Digital Twin Registry. They refer to other Catena-X KITs like the [Connector KIT](https://eclipse-tractusx.github.io/docs-kits/kits/tractusx-edc/docs/kit/adoption-view/Adoption%20View) (EDC), [Data Chain KIT](https://eclipse-tractusx.github.io/docs-kits/category/data-chain-kit/) (Item Relationship Service = IRS) and [Business Partner KIT](https://eclipse-tractusx.github.io/docs-kits/category/business-partner-kit/) to ensure interoperability and data sovereignty according to IDSA and Gaia-X principles. + +## Business Value + +Following this mission, the EcoPass KIT serves as an instrumental tool promoting sustainable and circular value chains. The improved transparency, traceability and accountability offered with digital product passports will facilitate informed decision-making for various stakeholders. This will bring ethical sourcing, efficient use of resources and reduction of environmental impacts to a new level. By making use of the Catena-X standards defined within the EcoPass KIT, product passports will ensure interoperability for stakeholders and systems to communicate seamlessly. This standardized language is crucial to improve efficiency, lower operational costs and create faster data processing. It ensures a consistent approach to data collection, storage and visualization to enhance the accuracy, reliability and comparability of information. +The following section will highlight the five major advantages of the Catena-X EcoPass KIT, which are also displayed below. + +![AdoptionView Business Value](./resources/adoption-view/adoption-view-BusinessValue.svg) + +**Seamless Integration and Collaboration**: By leveraging the EcoPass KIT, service providers can easily integrate with the Catena-X marketplace, promoting efficient collaboration and exchange of information with other businesses in the network. The unified data model and API specification simplifies the process, reducing the time and resources needed for integration and fostering interoperability between various players. + +**Enhanced Consumer Trust and Brand Loyalty**: Utilizing the KIT to develop solutions for the Catena-X marketplace allows service providers to showcase their commitment to transparency and sustainability. This fosters consumer trust and brand loyalty, as increasingly conscious customers prefer products and services that align with their values and make a positive impact on the environment. + +**Data-Driven Decision Making**: The EcoPass KIT enables service providers to harness the power of high-quality data sets from various sources in the Catena-X network. This wealth of information supports data-driven decision-making, helping businesses optimize their processes, reduce waste and identify opportunities for growth and innovation. Leveraging the dynamic data attributes within a passport, the product's evolving condition can be reflected, which offers a highly valuable increase of knowledge about the product’s behavior, quality and performance. + +**Regulatory Compliance and Risk Mitigation**: By offering solutions based on the KIT, service providers can help businesses comply with evolving regulations and industry standards. The increased transparency and traceability provided by digital product passports facilitate compliance management, offer the creation of certificates, and reduce the risks associated with non-compliance, such as penalties and reputational damage. + +**Competitive Advantage through Innovation**: The KIT's foundation for value-added services and innovative solutions provides service providers with a unique competitive edge in the Catena-X marketplace. By developing and offering cutting-edge products and services that cater to the growing demand for sustainable and transparent solutions, service providers can differentiate themselves in a crowded market and seize new business opportunities. + +## Use Case Explanation + +### Today's Challenges + +Today's globalized supply chains often struggle with transparency, data fragmentation and inefficiencies through the lack of digitally available product information. Traceability becomes difficult, hindering the ability to track products' origins and ensure accountability. Risk management and compliance efforts are compromised, impacting product quality and sustainability. Customer expectations for transparency and sustainability information remain unmet, potentially leading to dissatisfaction and loss of market share. Moreover, supply chains lack the resilience and responsiveness needed to adapt to disruptions effectively. +Embracing a digital product passport can address these challenges, enabling transparent, efficient and sustainable supply chains. Implementing the EcoPass KIT can enable companies to address these challenges by creating a comprehensive, accurate and up-to-date record of their products' lifecycles. This information can be used to improve resource efficiency, optimize recycling processes and reduce waste, ultimately driving the adoption of circular economy principles. + +### How can the EcoPass KIT help to address regulatory challenges? + +- Manufacturers are required to disclose information regarding the environmental impact of their products under the European Union's (EU) Ecodesign Directive. The EcoPass KIT can assist producers in adhering to this rule by offering a digital record of the environmental impact of their products. +- Companies are required to provide information regarding their efforts to address forced labor and human trafficking in their supply chains under the California Transparency in Supply Chains Act (CTSCA). The EcoPass KIT's digital record of a company's supply chain operations can assist businesses to comply with this law. +- Certain manufacturers of products are required to take back and recycle their products at the end of their functional lifespans under the German Waste Management Act (Kreislaufwirtschaftsgesetz). The EcoPass KIT, which offers a digital record of the goods that have been returned and recycled, can assist producers in adhering to this obligation. + +### Ecopass KIT benefits for value chain partners and solution providers + +Stakeholders along the value chain, as well as solution providers can reap the benefits of utilizing KITs in their organization. The Figure below shows an overview of these benefits, further explanation can be found below the illustration. + +![ValueChain Benefits](./resources/adoption-view/adoption-view-ValueChainBenefits.svg) + +**Value Chain Partners** can benefit from the EcoPass KIT especially by bringing the product transparency to a next level which will allow for several areas to increase the company’s value. Multiple risks (e.g. regulatory compliance) can be mitigated, cost and process efficiency may be improved, the strategic knowledge about products increases and the possibility for new business is being established. + +1. **Regulatory Compliance**: Improve compliance with regulations and industry standards by utilizing a digital product passport to demonstrate responsible sourcing, production and waste management practices. +2. **Enhanced Transparency**: Visibility of the product's condition, origins and components will lead to better decision-making and higher resource efficiency. +3. **Efficient Data Management**: Adopting a digital product passport will reduce administrative burdens and facilitate seamless data exchange between stakeholders. +4. **Increased Accountability**: A clear chain of custody for products fosters accountability among value chain participants for product quality, safety and sustainability. +5. **Risk Mitigation**: Comprehensive product data helps value chain participants to proactively identify and mitigate risks, ensuring higher product quality and safety standards. +6. **Strengthened Customer Trust**: Offering transparency of business practices and sustainability efforts builds trust with customers and enhances brand loyalty. +7. **Supply Chain Optimization**: Data-driven insights enable the optimization of supply chain processes to support the integration of sustainable approaches. +8. **Foster Collaborations**: Connecting and sharing information across the value chain facilitates collaboration with other stakeholders to promote joint efforts towards sustainability challenges. + +**Solution Providers** will gain a head start in delivering comprehensive and efficient digital product passport solutions. The pre-built features accelerate time-to-market, reduce costs and ensure a reliable, scalable and compliant system. In addition, solution providers can leverage a KIT as the basis to build their own customized solutions and to offer their customers innovative and value-driven digital product passport services in an efficient and simplified way. + +1. **New Market & Customer Base**: The possibility of developing innovative solutions and providing them through the Catena-X marketplace fosters new market opportunities and scalability of the customer base. +2. **Accelerated Time-to-Market**: The KIT provides the thematical and technical basis to build solutions, significantly reducing the time and resources required to develop digital product passport solutions. +3. **Flexibility and Customization**: While the KIT offers a solid foundation, it is designed to allow solution providers for customizing and tailoring the platform to meet specific needs and preferences of the target market and value chain participants. +4. **Risk Mitigation**: The predefined KIT tools support solution providers in reducing the risk of development errors and vulnerabilities. +5. **Cost Efficiency**: The KIT's standardized data model and open interface simplify the process of connecting to the Catena-X network, reducing the investment needs for integration. +6. **Competitive Advantage**: Adopting the KIT quickly positions solution providers in the market faster with cutting-edge services gaining a competitive advantage. +7. **Alignment with Industry Standards**: The KITs adhere to industry standards, making it easier for solution providers to align with existing supply chain ecosystems and collaborate with other stakeholders. +8. **Data Utilization**: The wealth of data available in the Catena-X network is leveraged to drive innovation and develop data-driven solutions tailored to the unique needs of various industries. + +#### Battery Pass: A real-world example + +In the automotive industry, a Battery Passport or Digital Product Passport for batteries plays a crucial role in ensuring transparency, traceability, and sustainability in the battery supply chain. Here's a real-world example of how a digital product passport might be set up for a battery used in electric vehicles (EVs), including its benefits, illustrated below: + +![BP realWorldExample](./resources/adoption-view/adoption-view-BatteryPass_a_example.svg) + +1. **Battery Manufacturing**: During the production stage, the battery manufacturer collects and records relevant data, such as the battery's unique identifier, type and model, manufacturing date and location, energy capacity and raw materials composition, including the content of critical elements like lithium, cobalt and nickel. +2. **Supply Chain Transparency**: Information about the battery's sourcing, manufacturing and distribution processes is documented, ensuring compliance with environmental and social standards. This includes data on the origin of raw materials, labor practices and the environmental footprint of each stage of the supply chain. +3. **Vehicle Integration**: When the battery is integrated into an electric vehicle, the Battery Pass is linked to the car's unique identification number (VIN), allowing seamless tracking and communication between the battery, the vehicle and relevant stakeholders. +4. **In-Use Performance Tracking**: As the vehicle is used, the Battery Pass continuously collects data on the battery's performance, such as its state of charge, charging cycles and degradation over time. This information is essential for the vehicle owner, car manufacturer and service providers to monitor the battery's health and optimize its lifespan. +5. **End-of-Life Management**: When the battery reaches the end of its useful life, the Battery Passport provides detailed instructions for proper disposal and recycling, ensuring compliance with regulations and facilitating the recovery of valuable materials. The data stored in the Battery Passport helps recycling facilities to efficiently process the battery, reducing waste and promoting a circular economy. + +Throughout this process, the Battery Passport serves as a single, secure, and easily accessible source of information for various stakeholders, such as vehicle manufacturers, suppliers, service providers, regulators and vehicle owners. By implementing a digital product passport like the Battery Pass in the automotive industry, companies can promote transparency, traceability, and sustainability, ultimately contributing to a more eco-friendly and circular economy. +For more information please read the [Battery Pass Viewer App Success Story](./Success%20Stories/BatteryPass_Viewer_App.mdx)! + +### How the KIT can help + +The EcoPass KIT addresses the real-world problem of battery traceability and sustainability in the automotive industry by providing a standardized, easy-to-implement solution for creating and managing digital product passports. Here's how the EcoPass KIT can help and scale in this context: + +1. **Standardization and Interoperability**: The EcoPass KIT offers a unified data model and is planning an API specification, allowing for seamless integration across different stakeholders, including manufacturers, suppliers, service providers and regulatory bodies. This standardization promotes interoperability and streamlines communication throughout the battery lifecycle. +2. **Simplified Adoption**: By providing a comprehensive and easy-to-use KIT, EcoPass can lower the barrier to entry for businesses of all sizes, enabling them to implement digital product passports without extensive technical expertise or resources. This can encourage widespread adoption of the solution, resulting in a larger-scale positive impact on sustainability and traceability. +3. **Scalable Solution**: The EcoPass KIT is designed to accommodate various product types, sizes and applications, ensuring its relevance and adaptability to the evolving automotive industry. This scalability allows the KIT to be utilized for a wide range of battery technologies, facilitating its adoption across diverse sectors. +4. **Enhanced Data Quality and Analysis**: The EcoPass KIT enables the collection and management of high-quality data throughout the product lifecycle. This wealth of information can be used by stakeholders to make data-driven decisions, optimize processes and identify opportunities for innovation and improvement in battery design, manufacturing and recycling. +5. **Facilitated Regulatory Compliance**: With the EcoPass KIT in place, businesses can more easily comply with the evolving regulations and industry standards related to battery traceability and sustainability. The digital product passport provides a comprehensive record of the battery's lifecycle, supporting compliance management and reducing the risk of penalties and reputational damage. + +By providing a standardized, scalable and easy-to-adopt solution, the EcoPass KIT will play a significant role in addressing the challenges of product traceability and sustainability in the automotive industry, promoting a more transparent, environmentally friendly and circular economy. + +## Semantic Models + +Depending on the use case and related KIT, Catena-X provides different semantic models that help to structure and make use of data via semantic information. These models help to provide a basic meaning to the data and their relationship, thereby enabling interoperability between data sets. Catena-X data models rely on principles as understandability, standardization, accuracy, differentiation, auditability, comprehensiveness, and provision of insights to drive improvement actions. The KIT entails the main data models of a Digital Product Passport and Battery Passport, whereat both are justified with an underlying regulation. + +Other specific product passports which are further described in the EcoPass KIT are the [battery](#battery-passport), [transmission](#transmission-passport) and [electric drive](#electric-drive-passport). All of them depend on the generic Digital Product Passport data model. Further data models will follow. + +The goal of these passports is to create unified data models that can be used and adapted across the automotive industry. These data models are modelled according to the [CX-0003](https://catenax-ev.github.io/docs/next/standards/CX-0003-SAMMSemanticAspectMetaModel) SAMM Standard in Version 1.1.0. For detailed information please follow the embedded links to the Catena-X Standard library. + +### Digital Product Passport + +#### Digital Product Passport Introduction + +Digital Product Passports address three needs by the industry: First, they gather all relevant information about a product in a single, digital tool. Second, digital product passports answer increasing regulatory requirements and demand for sustainability information along the value chain of a product. And third, Digital product passports are crucial enablers for circular economies due to their ability to provide comprehensive and transparent information about the lifecycle of automotive products. They play a critical role by fostering transparency, enhancing recycling and reuse, improving maintenance and repairs, and facilitating regulatory compliance. +In the following whitepaper, the role of digital product passports is discussed in relation to the current situation in the automotive industry. + +[Link to the Whitepaper "Digital Product Passports as enablers for Circular Economy".](https://catena-x.net/fileadmin/user_upload/Publikationen_und_WhitePaper_des_Vereins/2407_DPP_Circular_Economy_WP_v1.pdf) + +The collected data is defined via standards specified by the Catena-X network and obtained from the industry. The content of the Product Passport is product-related information that is useful and necessary for the consumer, and other actors who will deal with the product till end of its life, and is limited to the required minimum of the necessary information. +The data model in version `v.5.0.0` corresponds to the Digital Product Passport information required by the proposed Ecodesign Regulation ([ESPR-2022](<(https://commission.europa.eu/energy-climate-change-environment/standards-tools-and-labels/products-labelling-rules-and-requirements/sustainable-products/ecodesign-sustainable-products_en)>)) from March 30th, 2022. In the future, delegated acts for specific product groups would require a product passport to be available for each product. The data model will be updated, as newer versions of the regulation will be published. The latest to the model corresponding version of the document was the [provisional agreement](https://eur-lex.europa.eu/legal-content/EN/TXT/PDF/?uri=CONSIL:ST_5147_2024_INIT) between the EU Council and the Parliament from January 9th, 2024. The text is informal, but the content of the final regulation was agreed between these two institutions. + +It is important to note that the data model contains information/data fields, which are mandatory for the fulfilment of the regulation ([ESPR-2022](<(https://commission.europa.eu/energy-climate-change-environment/standards-tools-and-labels/products-labelling-rules-and-requirements/sustainable-products/ecodesign-sustainable-products_en)>)). It is also worth mentioning that sharing information within the network is based on decentralized technologies and is always based on the individual decision of each provider. + +The Digital Product Passport is the core model and can be used as the root class for other, specific, product models. The latest model `v.5.0.0` consists out of the following information: + +- Passport metadata +- Product identification +- Product operation +- Product handling +- Product characteristic +- Sustainability information +- Materials information +- Commercial information +- Sources (documents) +- Additional data + +References to shared aspects are the following: + +- urn:samm:io.catenax.batch:3.0.0 +- urn:samm:io.catenax.shared.part_classification:1.0.0 +- urn:samm:io.catenax.part_type_information:1.0.0 +- urn:samm:io.catenax.shared.business_partner_number:2.0.0 +- urn:samm:io.catenax.serial_part:3.0.0 +- urn:samm:io.catenax.shared.quantity:2.0.0 +- urn:samm:io.catenax.shared.uuid:2.0.0 +- and indirect references from the above mentioned aspects + +In addition, the Digital Product Passport data model offers the following advantages: + +- **Self-describing**: Which means it has all the details necessary to comprehend what it includes. Different systems can easily interpret the Passport as a result. +- **Extendable**: New information can be added without much difficulty. As a result, the Passport will be able to adapt to the changing requirements. +- **Common semantics**: The model of a generic passport is established in Catena-X which other passes can build upon. + +#### Link to current Digital Product Passport model + +The semantic models are located [here](https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.generic.digital_product_passport). For each version there is a separated directory containing the ttl-file and generated samples. + +#### Example Digital Product Passport Payload + +
          + Payload + +```json +{ + "metadata" : { + "backupReference" : "https://dummy.link", + "registrationIdentifier" : "https://dummy.link/ID8283746239078", + "economicOperatorId" : "BPNL0123456789ZZ", + "lastModification" : "2000-01-01", + "predecessor" : "urn:uuid:00000000-0000-0000-0000-000000000000", + "issueDate" : "2000-01-01", + "version" : "1.0.0", + "passportIdentifier" : "urn:uuid:550e8400-e29b-41d4-a716-446655440000", + "status" : "draft", + "expirationDate" : "2030-01-01" + }, + "characteristics" : { + "generalPerformanceClass" : "A", + "physicalState" : "solid", + "physicalDimension" : { + "volume" : { + "value" : 20.0, + "unit" : "unit:cubicMetre" + }, + "grossWeight" : { + "value" : 20.0, + "unit" : "unit:gram" + }, + "diameter" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "grossVolume" : { + "value" : 20.0, + "unit" : "unit:cubicMetre" + }, + "width" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "length" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "weight" : { + "value" : 20.0, + "unit" : "unit:gram" + }, + "height" : { + "value" : 20.0, + "unit" : "unit:millimetre" + } + }, + "lifespan" : [ { + "value" : 36, + "unit" : "unit:day", + "key" : "guaranteed lifetime" + } ] + }, + "commercial" : { + "placedOnMarket" : "2000-01-01", + "purpose" : [ "automotive" ] + }, + "identification" : { + "batch" : [ { + "value" : "BID12345678", + "key" : "batchId" + } ], + "codes" : [ { + "value" : "8703 24 10 00", + "key" : "TARIC" + } ], + "type" : { + "manufacturerPartId" : "123-0.740-3434-A", + "nameAtManufacturer" : "Mirror left" + }, + "classification" : [ { + "classificationStandard" : "GIN 20510-21513", + "classificationID" : "1004712", + "classificationDescription" : "Generic standard for classification of parts in the automotive industry." + } ], + "serial" : [ { + "value" : "SN12345678", + "key" : "partInstanceId" + } ], + "dataCarrier" : { + "carrierType" : "QR", + "carrierLayout" : "upper-left side" + } + }, + "sources" : [ { + "header" : "Example Document XYZ", + "category" : "Product Specifications", + "type" : "URL", + "content" : "https://dummy.link" + } ], + "materials" : { + "substancesOfConcern" : { + "applicable" : true, + "content" : [ { + "unit" : "unit:partPerMillion", + "hazardClassification" : { + "category" : "category 1A", + "statement" : "Causes severe skin burns and eye damage.", + "class" : "Skin corrosion" + }, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "concentrationRange" : [ { + "max" : 2.6, + "min" : 2.1 + } ], + "location" : "Housing", + "concentration" : 5.3, + "exemption" : "shall not apply to product x containing not more than 1,5 ml of liquid", + "id" : [ { + "type" : "CAS", + "name" : "phenolphthalein", + "id" : "201-004-7" + } ] + } ] + }, + "materialComposition" : { + "applicable" : true, + "content" : [ { + "unit" : "unit:partPerMillion", + "recycled" : 12.5, + "critical" : true, + "renewable" : 23.5, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "concentration" : 5.3, + "id" : [ { + "type" : "CAS", + "name" : "phenolphthalein", + "id" : "201-004-7" + } ] + } ] + } + }, + "handling" : { + "applicable" : true, + "content" : { + "producer" : [ { + "id" : "BPNL0123456789ZZ" + } ], + "sparePart" : [ { + "manufacturerPartId" : "123-0.740-3434-A", + "nameAtManufacturer" : "Mirror left" + } ] + } + }, + "additionalData" : [ { + "description" : "Description of an attribute", + "label" : "Maximum permitted battery power", + "type" : { + "typeUnit" : "unit:volume", + "dataType" : "array" + }, + "data" : "23", + "children" : [ { + "description" : "Description of an attribute", + "label" : "Maximum permitted battery power", + "type" : { + "typeUnit" : "unit:volume", + "dataType" : "array" + }, + "data" : "23" + } ] + } ], + "operation" : { + "import" : { + "applicable" : true, + "content" : { + "eori" : "GB123456789000", + "id" : "BPNL0123456789ZZ" + } + }, + "other" : { + "id" : "BPNL0123456789XX", + "role" : "distributor" + }, + "manufacturer" : { + "facility" : [ { + "facility" : "BPNA1234567890AA" + } ], + "manufacturingDate" : "2000-01-31", + "manufacturer" : "BPNLbi7tAJ8UiMsF" + } + }, + "sustainability" : { + "reparabilityScore" : "B", + "productFootprint" : { + "material" : [ { + "lifecycle" : "main product production", + "rulebook" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "unit" : "kg CO2 / kWh", + "performanceClass" : "A", + "manufacturingPlant" : [ { + "facility" : "BPNA1234567890AA" + } ], + "type" : "Climate Change Total", + "value" : 12.678, + "declaration" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ], + "carbon" : [ { + "lifecycle" : "main product production", + "rulebook" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "unit" : "kg CO2 / kWh", + "performanceClass" : "A", + "manufacturingPlant" : [ { + "facility" : "BPNA1234567890AA" + } ], + "type" : "Climate Change Total", + "value" : 12.678, + "declaration" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ], + "environmental" : [ { + "lifecycle" : "main product production", + "rulebook" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "unit" : "kg CO2 / kWh", + "performanceClass" : "A", + "manufacturingPlant" : [ { + "facility" : "BPNA1234567890AA" + } ], + "type" : "Climate Change Total", + "value" : 12.678, + "declaration" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ] + }, + "status" : "original", + "durabilityScore" : "A" + } +} +``` + +
          + +### Battery Passport + +#### Battery Passport Introduction + +The Catena-X standards, which are crucial to create a more sustainable battery business, serve as the foundation for the data model behind the Battery Passport. The Battery Passport assists in enhancing the traceability and sustainability of batteries by offering a thorough record of a battery's life cycle. This will mitigate the battery industry's environmental effect and make it easier to recycle batteries. + +Due to requirements of the regulation [(EU) 2023/1542](https://eur-lex.europa.eu/legal-content/EN/TXT/PDF/?uri=CELEX:32023R1542) for batteries and waste batteries, a data model for Battery Passport was created, which increases the efficiency of circular economy ecosystems of all partners in the value network. The battery passport is a tool for the exchange of information and enables tracking and tracing of batteries usage information. +The Battery Passport is a standardized data model that will enable stakeholders to access the relevant data. The version of the Battery Passport Data Model `v.6.0.0` consists out of the following information: + +- Passport metadata +- Product identification +- Product operation +- Product handling +- Product characteristic +- Sustainability information +- Materials information +- Commercial information +- Sources (documents) +- Conformity information +- Safety information +- Performance information + +References to shared aspects are the following: + +- urn:samm:io.catenax.generic.digital_product_passport:5.0.0 +- and indirect references from the above mentioned aspect + +It is important to note that the data model contains information/data fields, which are mandatory for the fulfilment of the regulation ([(EU) 2023/1542](https://eur-lex.europa.eu/legal-content/EN/TXT/PDF/?uri=CELEX:32023R1542)). It is also worth mentioning that sharing information within the network is based on decentralized technologies and is always based on the individual decision of each provider. + +#### Link to current Battery Pass model + +The semantic models are located [here](https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.battery.battery_pass). For each version there is a separated directory containing the ttl-file and a generated samples. + +#### Example Battery Passport Payload + +
          + Payload + +```json +{ + "characteristics" : { + "physicalDimension" : { + "length" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "width" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "weight" : { + "value" : 20.0, + "unit" : "unit:gram" + }, + "height" : { + "value" : 20.0, + "unit" : "unit:millimetre" + } + }, + "warranty" : { + "lifeValue" : 36, + "lifeUnit" : "unit:day" + } + }, + "metadata" : { + "backupReference" : "https://dummy.link", + "registrationIdentifier" : "https://dummy.link/ID8283746239078", + "economicOperatorId" : "BPNL0123456789ZZ", + "lastModification" : "2000-01-01", + "predecessor" : "urn:uuid:00000000-0000-0000-0000-000000000000", + "issueDate" : "2000-01-01", + "version" : "1.0.0", + "passportIdentifier" : "urn:uuid:550e8400-e29b-41d4-a716-446655440000", + "status" : "draft", + "expirationDate" : "2030-01-01" + }, + "commercial" : { + "placedOnMarket" : "2000-01-01", + "purpose" : [ "automotive" ] + }, + "identification" : { + "chemistry" : "Nickel Cobalt Manganese (NCM)", + "idDmc" : "34567890", + "identification" : { + "batch" : [ { + "value" : "BID12345678", + "key" : "batchId" + } ], + "codes" : [ { + "value" : "8703 24 10 00", + "key" : "TARIC" + } ], + "type" : { + "manufacturerPartId" : "123-0.740-3434-A", + "nameAtManufacturer" : "Mirror left" + }, + "classification" : [ { + "classificationStandard" : "GIN 20510-21513", + "classificationID" : "1004712", + "classificationDescription" : "Generic standard for classification of parts in the automotive industry." + } ], + "serial" : [ { + "value" : "SN12345678", + "key" : "partInstanceId" + } ], + "dataCarrier" : { + "carrierType" : "QR", + "carrierLayout" : "upper-left side" + } + }, + "category" : "SLI" + }, + "performance" : { + "rated" : { + "roundTripEfficiency" : { + "depthOfDischarge" : 90.5, + "temperature" : 20.0, + "50PercentLife" : 89.0, + "initial" : 96.0 + }, + "selfDischargingRate" : 0.25, + "performanceDocument" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "testReport" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "temperature" : { + "lower" : -18.0, + "upper" : 60.0 + }, + "lifetime" : { + "report" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "cycleLifeTesting" : { + "temperature" : 20.0, + "depthOfDischarge" : 90.5, + "appliedDischargeRate" : 4.0, + "cycles" : 1500, + "appliedChargeRate" : 3.0 + }, + "expectedYears" : 8 + }, + "power" : { + "at20SoC" : 35000.0, + "temperature" : 20.0, + "value" : 40000.0, + "at80SoC" : 39000.0 + }, + "resistance" : { + "temperature" : 20.0, + "cell" : 0.025, + "pack" : 0.55, + "module" : 0.2 + }, + "voltage" : { + "temperature" : 20.0, + "min" : 2.5, + "nominal" : 3.7, + "max" : 4.2 + }, + "energy" : { + "temperature" : 20.0, + "value" : 0.5 + }, + "capacity" : { + "temperature" : 20.0, + "value" : 4.0, + "thresholdExhaustion" : 80.0 + } + }, + "dynamic" : { + "selfDischargingRate" : 0.25, + "roundTripEfficiency" : { + "remaining" : { + "value" : 50.0, + "time" : "2023-12-07T10:39:13.576+01:00" + }, + "fade" : { + "value" : 50.0, + "time" : "2023-12-07T10:39:13.576+01:00" + } + }, + "operatingEnvironment" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "stateOfCharge" : { + "value" : 50.0, + "time" : "2023-12-07T10:39:13.576+01:00" + }, + "performanceDocument" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "fullCycles" : { + "value" : 1500, + "time" : "2023-12-07T10:39:13.576+01:00" + }, + "power" : { + "remaining" : { + "value" : 40000.0, + "time" : "2023-12-07T10:39:13.576+01:00" + }, + "fade" : { + "value" : 50.0, + "time" : "2023-12-07T10:39:13.576+01:00" + } + }, + "negativeEvents" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "resistance" : { + "increase" : { + "cell" : { + "value" : 50.0, + "time" : "2023-12-07T10:39:13.576+01:00" + }, + "pack" : { + "value" : 50.0, + "time" : "2023-12-07T10:39:13.576+01:00" + }, + "module" : { + "value" : 50.0, + "time" : "2023-12-07T10:39:13.576+01:00" + } + }, + "remaining" : { + "cell" : { + "value" : 0.3, + "time" : "2023-12-07T10:39:13.576+01:00" + }, + "pack" : { + "value" : 0.3, + "time" : "2023-12-07T10:39:13.576+01:00" + }, + "module" : { + "value" : 0.3, + "time" : "2023-12-07T10:39:13.576+01:00" + } + } + }, + "capacity" : { + "fade" : { + "value" : 50.0, + "time" : "2023-12-07T10:39:13.576+01:00" + }, + "throughput" : { + "value" : 4.0, + "time" : "2023-12-07T10:39:13.576+01:00" + }, + "capacity" : { + "value" : 4.0, + "time" : "2023-12-07T10:39:13.576+01:00" + } + }, + "energy" : { + "remaining" : { + "value" : 0.5, + "time" : "2023-12-07T10:39:13.576+01:00" + }, + "soce" : { + "value" : 50.0, + "time" : "2023-12-07T10:39:13.576+01:00" + }, + "throughput" : { + "value" : 0.5, + "time" : "2023-12-07T10:39:13.576+01:00" + } + } + } + }, + "sources" : [ { + "header" : "Example Document XYZ", + "category" : "Product Specifications", + "type" : "URL", + "content" : "https://dummy.link" + } ], + "materials" : { + "hazardous" : { + "cadmium" : { + "concentration" : 5.3, + "location" : "Housing", + "critical" : true, + "impactOfSubstances" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "materialUnit" : "unit:partPerMillion", + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + }, + "other" : [ { + "critical" : true, + "impactOfSubstances" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "concentration" : 5.3, + "materialIdentification" : [ { + "type" : "CAS", + "name" : "phenolphthalein", + "id" : "201-004-7" + } ], + "location" : "Housing", + "materialUnit" : "unit:partPerMillion" + } ], + "mercury" : { + "concentration" : 5.3, + "location" : "Housing", + "critical" : true, + "impactOfSubstances" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "materialUnit" : "unit:partPerMillion", + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + }, + "lead" : { + "recycled" : 12.5, + "critical" : true, + "impactOfSubstances" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "location" : "Housing", + "concentration" : 5.3, + "materialUnit" : "unit:partPerMillion" + } + }, + "active" : { + "nickel" : { + "location" : "Housing", + "recycled" : 12.5, + "critical" : true, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + }, + "lithium" : { + "location" : "Housing", + "recycled" : 12.5, + "critical" : true, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + }, + "cobalt" : { + "location" : "Housing", + "recycled" : 12.5, + "critical" : true, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + }, + "other" : [ { + "location" : "Housing", + "materialIdentification" : [ { + "type" : "CAS", + "name" : "phenolphthalein", + "id" : "201-004-7" + } ], + "recycled" : 12.5, + "critical" : true, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ], + "lead" : { + "recycled" : 12.5, + "critical" : true, + "impactOfSubstances" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "location" : "Housing", + "concentration" : 5.3, + "materialUnit" : "unit:partPerMillion" + } + }, + "composition" : [ { + "unit" : "unit:partPerMillion", + "recycled" : 12.5, + "critical" : true, + "renewable" : 23.5, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "concentration" : 5.3, + "location" : "Housing", + "id" : [ { + "type" : "CAS", + "name" : "phenolphthalein", + "id" : "201-004-7" + } ] + } ] + }, + "safety" : { + "usableExtinguishAgent" : [ { + "fireClass" : "A, B", + "document" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "media" : "Dry Powder" + } ], + "safeDischarging" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "meaningOfLabels" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "dismantling" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "removalFromAppliance" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "safetyMeasures" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + }, + "handling" : { + "applicable" : true, + "content" : { + "producer" : [ { + "id" : "BPNL0123456789ZZ" + } ], + "sparePart" : [ { + "manufacturerPartId" : "123-0.740-3434-A", + "nameAtManufacturer" : "Mirror left" + } ] + } + }, + "conformity" : { + "declarationOfConformityId" : "0978234-34567890-01", + "thirdPartyAssurance" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "resultOfTestReport" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "declarationOfConformity" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "dueDiligencePolicy" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + }, + "operation" : { + "intoServiceDate" : "7345-31-31", + "manufacturer" : { + "facility" : [ { + "facility" : "BPNA1234567890AA" + } ], + "manufacturingDate" : "2000-01-31", + "manufacturer" : "BPNL6XI3KZ55MzYB" + } + }, + "sustainability" : { + "documents" : { + "separateCollection" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "sustainabilityReport" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "euTaxonomyDisclosureStatement" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "wastePrevention" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + }, + "carbonFootprint" : [ { + "lifecycle" : "main product production", + "rulebook" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "unit" : "kg CO2 / kWh", + "performanceClass" : "A", + "manufacturingPlant" : [ { + "facility" : "BPNA1234567890AA" + } ], + "type" : "Climate Change Total", + "value" : 12.678, + "declaration" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ], + "status" : "original" + } +} +``` + +
          + +### Transmission Passport + +#### Transmission Passport Introduction + +In July 2023, the European Commission presented a proposal for a regulation addressing the whole life cycle of vehicles, from design to end-of-life, aimed at improving design and end-of-life management of vehicles for a more resource-efficient automotive sector. It would set circularity requirements on vehicle design and production concerning reusability, recyclability, recoverability and the use of recycled content. It would also lay down requirements on information and labelling of parts, components and materials in vehicles. + +As preparation for the implementation of the proposed regulation and its requirements, manufacturers and OEMs within the Catena-X network decided on developing data models for the most commonly used products. + +The Transmission Passport `v.3.0.0` corresponds to the [digital product passport](#digital-product-passport) information required by the proposed Ecodesign Regulation and describes the data that is collected and available during the lifespan of a transmission. The consumers can see at a glance the relevant data about the transmission which is installed in the specified vehicle. By incorporating circularity parameters, the Transmission Passport aims to enhance transparency and promote a circular economy within the European Union. Detailed descriptions can be found in the Ecodesign for Sustainable Products Regulation Proposal (ESPR). +The Transmission Passport model `v.3.0.0` includes the following product specific information: + +- Type of drive +- Transmission performance information +- Torque converter information +- Speed resistance information +- Standard gear ratio information +- Transmission spreading information +- Transmission oil information +- Electric machine information +- Electric performance information + +Product unspecific information incudes following information: + +- Passport metadata +- Product identification +- Product operation +- Product handling +- Product characteristic +- Sustainability information +- Materials information +- Commercial information +- Sources (documents) + +References to shared aspects are the following: + +- urn:samm:io.catenax.generic.digital_product_passport:5.0.0 +- and indirect references from the above mentioned aspect + +It is important to note that the data model contains information/data fields, which are mandatory for the fulfilment of the regulation ([ESPR-2022](<(https://commission.europa.eu/energy-climate-change-environment/standards-tools-and-labels/products-labelling-rules-and-requirements/sustainable-products/ecodesign-sustainable-products_en)>)). It is also worth mentioning that sharing information within the network is based on decentralized technologies and is always based on the individual decision of each provider. + +#### Link to current Transmission Passport model + +The semantic models are located [here](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.transmission.transmission_pass). For each version there is a separated directory containing the ttl-file and a generated samples. + +#### Example Transmission Passport Payload + +
          + Payload + +```json +{ + "specific" : { + "serviceHistory" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "oil" : { + "oilType" : [ "Transmission Oil XY" ], + "oilCapacity" : 8.9 + }, + "torqueConverter" : [ "NW 200 TTD" ], + "driveType" : [ "full hybrid" ], + "spreading" : 6.79, + "torque" : 500, + "power" : 300, + "standardGearRatio" : [ { + "gearRatio" : 4.1567, + "gear" : "1" + } ], + "speedResistance" : [ { + "ratedSpeed" : 7800, + "gear" : "1" + } ], + "electricalPerformance" : { + "applicable" : true, + "electricalMachine" : { + "torque" : { + "max" : 180, + "maximumAvailability" : 10, + "continuous" : 178 + }, + "power" : { + "max" : 22, + "continuous" : 16, + "maximumAvailability" : 10 + }, + "speed" : 16700, + "voltage" : 52 + } + } + }, + "generic" : { + "characteristics" : { + "physicalDimension" : { + "volume" : { + "value" : 20.0, + "unit" : "unit:cubicMetre" + }, + "grossWeight" : { + "value" : 20.0, + "unit" : "unit:gram" + }, + "diameter" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "grossVolume" : { + "value" : 20.0, + "unit" : "unit:cubicMetre" + }, + "width" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "length" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "weight" : { + "value" : 20.0, + "unit" : "unit:gram" + }, + "height" : { + "value" : 20.0, + "unit" : "unit:millimetre" + } + }, + "warranty" : 60, + "lifeTime" : 500000 + }, + "metadata" : { + "backupReference" : "https://dummy.link", + "registrationIdentifier" : "https://dummy.link/ID8283746239078", + "economicOperatorId" : "BPNL0123456789ZZ", + "lastModification" : "2000-01-01", + "predecessor" : "urn:uuid:00000000-0000-0000-0000-000000000000", + "issueDate" : "2000-01-01", + "version" : "1.0.0", + "passportIdentifier" : "urn:uuid:550e8400-e29b-41d4-a716-446655440000", + "status" : "draft", + "expirationDate" : "2030-01-01" + }, + "commercial" : { + "placedOnMarket" : "2000-01-01", + "purpose" : [ "automotive" ] + }, + "identification" : { + "batch" : [ { + "value" : "BID12345678", + "key" : "batchId" + } ], + "codes" : [ { + "value" : "8703 24 10 00", + "key" : "TARIC" + } ], + "type" : { + "manufacturerPartId" : "123-0.740-3434-A", + "nameAtManufacturer" : "Mirror left" + }, + "classification" : [ { + "classificationStandard" : "GIN 20510-21513", + "classificationID" : "1004712", + "classificationDescription" : "Generic standard for classification of parts in the automotive industry." + } ], + "serial" : [ { + "value" : "SN12345678", + "key" : "partInstanceId" + } ], + "dataCarrier" : { + "carrierType" : "QR", + "carrierLayout" : "upper-left side" + } + }, + "sources" : [ { + "header" : "Example Document XYZ", + "category" : "Product Specifications", + "type" : "URL", + "content" : "https://dummy.link" + } ], + "materials" : { + "substancesOfConcern" : { + "applicable" : true, + "content" : [ { + "unit" : "unit:partPerMillion", + "hazardClassification" : { + "category" : "category 1A", + "statement" : "Causes severe skin burns and eye damage.", + "class" : "Skin corrosion" + }, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "concentrationRange" : [ { + "max" : 2.6, + "min" : 2.1 + } ], + "location" : "Housing", + "concentration" : 5.3, + "exemption" : "shall not apply to product x containing not more than 1,5 ml of liquid", + "id" : [ { + "type" : "CAS", + "name" : "phenolphthalein", + "id" : "201-004-7" + } ] + } ] + }, + "materialComposition" : { + "applicable" : true, + "content" : [ { + "unit" : "unit:partPerMillion", + "recycled" : 12.5, + "critical" : true, + "renewable" : 23.5, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "concentration" : 5.3, + "id" : [ { + "type" : "CAS", + "name" : "phenolphthalein", + "id" : "201-004-7" + } ] + } ] + } + }, + "handling" : { + "applicable" : true, + "content" : { + "producer" : [ { + "id" : "BPNL0123456789ZZ" + } ], + "sparePart" : [ { + "manufacturerPartId" : "123-0.740-3434-A", + "nameAtManufacturer" : "Mirror left" + } ] + } + }, + "operation" : { + "import" : { + "applicable" : true, + "content" : { + "eori" : "GB123456789000", + "id" : "BPNL0123456789ZZ" + } + }, + "other" : { + "id" : "BPNL0123456789XX", + "role" : "distributor" + }, + "manufacturer" : { + "facility" : [ { + "facility" : "BPNA1234567890AA" + } ], + "manufacturingDate" : "2000-01-31", + "manufacturer" : "BPNLvO2y5Eu4L2hi" + } + }, + "sustainability" : { + "reparabilityScore" : "B", + "productFootprint" : { + "material" : [ { + "lifecycle" : "main product production", + "rulebook" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "unit" : "kg CO2 / kWh", + "performanceClass" : "A", + "manufacturingPlant" : [ { + "facility" : "BPNA1234567890AA" + } ], + "type" : "Climate Change Total", + "value" : 12.678, + "declaration" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ], + "carbon" : [ { + "lifecycle" : "main product production", + "rulebook" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "unit" : "kg CO2 / kWh", + "performanceClass" : "A", + "manufacturingPlant" : [ { + "facility" : "BPNA1234567890AA" + } ], + "type" : "Climate Change Total", + "value" : 12.678, + "declaration" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ], + "environmental" : [ { + "lifecycle" : "main product production", + "rulebook" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "unit" : "kg CO2 / kWh", + "performanceClass" : "A", + "manufacturingPlant" : [ { + "facility" : "BPNA1234567890AA" + } ], + "type" : "Climate Change Total", + "value" : 12.678, + "declaration" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ] + }, + "status" : "original", + "durabilityScore" : "A" + } + } +} +``` + +
          + +### Electric Drive Passport + +#### Electric Drive Introduction + +In July 2023, the European Commission presented a proposal for a regulation addressing the whole life cycle of vehicles, from design to end-of-life, aimed at improving design and end-of-life management of vehicles for a more resource-efficient automotive sector. As preparation for the implementation of the proposed regulation and its requirements, manufacturers and OEMs within the Catena-X network decided on developing data models for the most commonly used products. As well as the transmission, the electric drive is one of such a component. + +The data model corresponds to the [digital product passport](#digital-product-passport) information required by the proposed Ecodesign Regulation and describes the data that is collected and available during the lifespan of a electric drive. The consumers can see at a glance the relevant data about the electric drive which is installed in the specified vehicle. The Electric Drive Passport model `v.2.0.0` includes the following product specific information: + +- General information +- System and performance data +- Inverter information +- E-Machine information +- Transmission information +- Cooling and lubricants information +- Specific documents + +Product unspecific information incudes following information: + +- Passport metadata +- Product identification +- Product operation +- Product handling +- Product characteristic +- Sustainability information +- Materials information +- Commercial information +- Sources (documents) + +References to shared aspects are the following: + +- urn:samm:io.catenax.generic.digital_product_passport:5.0.0 +- urn:samm:io.catenax.transmission.transmission_pass:3.0.0 +- urn:samm:io.catenax.shared.quantity:2.0.0 +- and indirect references from the above mentioned aspects + +It is important to note that the data model contains information/data fields, which are mandatory for the fulfilment of the regulation ([ESPR-2022](<(https://commission.europa.eu/energy-climate-change-environment/standards-tools-and-labels/products-labelling-rules-and-requirements/sustainable-products/ecodesign-sustainable-products_en)>)). It is also worth mentioning that sharing information within the network is based on decentralized technologies and is always based on the individual decision of each provider. + +#### Link to current Electric Drive model + +The semantic models are located [here](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.electric_drive.electric_drive_passport). For each version there is a separated directory containing the ttl-file and a generated samples. + +#### Example Electric Drive Payload + +
          + Payload + +```json +{ + "specific" : { + "eMachine" : { + "ratedSpeed" : 8000.0, + "weight" : { + "value" : 20.0, + "unit" : "unit:gram" + }, + "permanentMagnetType" : "Ceramic", + "statorDiameter" : 450.0, + "id" : "1785030A72B5752", + "technology" : "ESM" + }, + "transmission" : { + "transmissionId" : "384502A54FC9", + "gearboxStructure" : "Planetary", + "oil" : { + "oilType" : [ "Transmission Oil XY" ], + "oilCapacity" : 8.9 + } + }, + "inverter" : { + "maximumPhaseCurrent" : 700.0, + "inverterCurrent" : 500.0, + "softwareVersion" : "2.525.b" + }, + "generalInformation" : { + "compatibleVehicleTypes" : [ "battery-electric vehicle" ], + "service" : { + "history" : [ "2020-02-15" ], + "lastServiceDate" : "2022-03-03" + } + }, + "systemAndPerformance" : { + "torque" : { + "maximum" : { + "value" : 300.0, + "maximumAvailability" : 10 + }, + "maxAxle" : { + "value" : 300.0, + "maximumAvailability" : 10 + }, + "continuous" : 178 + }, + "gearRatio" : 4.1567, + "power" : { + "maximum" : { + "value" : 200.0, + "ECER85" : 195.0, + "maximumAvailability" : 10 + }, + "continuousRegenerated" : 5.0, + "maxRegenerated" : { + "maxValue" : 200.0, + "maximumAvailability" : 10 + }, + "continuous" : 16 + }, + "voltage" : 400.0 + }, + "electricDriveDocuments" : { + "requiredToolsForDismantling" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "technicalDismantlingInstructions" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + }, + "coolingAndLubricants" : { + "maximumOilPressure" : 4.82633, + "oilCapacityEdrive" : 50.0, + "maximumOilTemperature" : 80.5, + "coolingTopology" : "air-cooled", + "oilTypeEdrive" : "5W-30", + "oilModule" : true, + "minimumOilPressure" : 2.068427 + } + }, + "generic" : { + "metadata" : { + "backupReference" : "https://dummy.link", + "registrationIdentifier" : "https://dummy.link/ID8283746239078", + "economicOperatorId" : "BPNL0123456789ZZ", + "lastModification" : "2000-01-01", + "predecessor" : "urn:uuid:00000000-0000-0000-0000-000000000000", + "issueDate" : "2000-01-01", + "version" : "1.0.0", + "passportIdentifier" : "urn:uuid:550e8400-e29b-41d4-a716-446655440000", + "status" : "draft", + "expirationDate" : "2030-01-01" + }, + "characteristics" : { + "generalPerformanceClass" : "A", + "physicalState" : "solid", + "physicalDimension" : { + "volume" : { + "value" : 20.0, + "unit" : "unit:cubicMetre" + }, + "grossWeight" : { + "value" : 20.0, + "unit" : "unit:gram" + }, + "diameter" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "grossVolume" : { + "value" : 20.0, + "unit" : "unit:cubicMetre" + }, + "width" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "length" : { + "value" : 20.0, + "unit" : "unit:millimetre" + }, + "weight" : { + "value" : 20.0, + "unit" : "unit:gram" + }, + "height" : { + "value" : 20.0, + "unit" : "unit:millimetre" + } + }, + "lifespan" : [ { + "value" : 36, + "unit" : "unit:day", + "key" : "guaranteed lifetime" + } ] + }, + "commercial" : { + "placedOnMarket" : "2000-01-01", + "purpose" : [ "automotive" ] + }, + "identification" : { + "batch" : [ { + "value" : "BID12345678", + "key" : "batchId" + } ], + "codes" : [ { + "value" : "8703 24 10 00", + "key" : "TARIC" + } ], + "type" : { + "manufacturerPartId" : "123-0.740-3434-A", + "nameAtManufacturer" : "Mirror left" + }, + "classification" : [ { + "classificationStandard" : "GIN 20510-21513", + "classificationID" : "1004712", + "classificationDescription" : "Generic standard for classification of parts in the automotive industry." + } ], + "serial" : [ { + "value" : "SN12345678", + "key" : "partInstanceId" + } ], + "dataCarrier" : { + "carrierType" : "QR", + "carrierLayout" : "upper-left side" + } + }, + "sources" : [ { + "header" : "Example Document XYZ", + "category" : "Product Specifications", + "type" : "URL", + "content" : "https://dummy.link" + } ], + "materials" : { + "substancesOfConcern" : { + "applicable" : true, + "content" : [ { + "unit" : "unit:partPerMillion", + "hazardClassification" : { + "category" : "category 1A", + "statement" : "Causes severe skin burns and eye damage.", + "class" : "Skin corrosion" + }, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "concentrationRange" : [ { + "max" : 2.6, + "min" : 2.1 + } ], + "location" : "Housing", + "concentration" : 5.3, + "exemption" : "shall not apply to product x containing not more than 1,5 ml of liquid", + "id" : [ { + "type" : "CAS", + "name" : "phenolphthalein", + "id" : "201-004-7" + } ] + } ] + }, + "materialComposition" : { + "applicable" : true, + "content" : [ { + "unit" : "unit:partPerMillion", + "recycled" : 12.5, + "critical" : true, + "renewable" : 23.5, + "documentation" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "concentration" : 5.3, + "id" : [ { + "type" : "CAS", + "name" : "phenolphthalein", + "id" : "201-004-7" + } ] + } ] + } + }, + "handling" : { + "applicable" : true, + "content" : { + "producer" : [ { + "id" : "BPNL0123456789ZZ" + } ], + "sparePart" : [ { + "manufacturerPartId" : "123-0.740-3434-A", + "nameAtManufacturer" : "Mirror left" + } ] + } + }, + "operation" : { + "import" : { + "applicable" : true, + "content" : { + "eori" : "GB123456789000", + "id" : "BPNL0123456789ZZ" + } + }, + "other" : { + "id" : "BPNL0123456789XX", + "role" : "distributor" + }, + "manufacturer" : { + "facility" : [ { + "facility" : "BPNA1234567890AA" + } ], + "manufacturingDate" : "2000-01-31", + "manufacturer" : "BPNLBfN4ucXtBZdg" + } + }, + "sustainability" : { + "reparabilityScore" : "B", + "productFootprint" : { + "material" : [ { + "lifecycle" : "main product production", + "rulebook" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "unit" : "kg CO2 / kWh", + "performanceClass" : "A", + "manufacturingPlant" : [ { + "facility" : "BPNA1234567890AA" + } ], + "type" : "Climate Change Total", + "value" : 12.678, + "declaration" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ], + "carbon" : [ { + "lifecycle" : "main product production", + "rulebook" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "unit" : "kg CO2 / kWh", + "performanceClass" : "A", + "manufacturingPlant" : [ { + "facility" : "BPNA1234567890AA" + } ], + "type" : "Climate Change Total", + "value" : 12.678, + "declaration" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ], + "environmental" : [ { + "lifecycle" : "main product production", + "rulebook" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ], + "unit" : "kg CO2 / kWh", + "performanceClass" : "A", + "manufacturingPlant" : [ { + "facility" : "BPNA1234567890AA" + } ], + "type" : "Climate Change Total", + "value" : 12.678, + "declaration" : [ { + "contentType" : "URL", + "header" : "Example Document XYZ", + "content" : "https://dummy.link" + } ] + } ] + }, + "status" : "original", + "durabilityScore" : "A" + } + } +} +``` + +
          + +## Creation of new passports + +The process for the creation can be structured like following: + +- Preparation phase +- Research phase +- Documentation phase +- Approval phase I. +- Data modelling phase +- Approval phase II. +- Release phase +- Communication & Standardization + +In case of a new proposal, the checking of the already existing passports or aspect models is necessary. If none of the already existing passports or aspect models comply with the proposed requirements a new passport must be requested. + +In case of request from one of the involved companies, the checking of the already existing passports or aspect models is necessary. If none of the already existing aspect models fulfil the request a new aspect model must be requested. + +Development teams should be formed and designated. The team members must be from at least two different companies, that has involvement in the production of the product which the aspect model was requested for. From each of the involved companies subject matter experts should get involved. Involvement of a legal expert is necessary. The lifecycle of the product and the related scenarios should be discovered and documented. Scenarios should be assigned to the responsible parties. All responsible parties should validate their data availability. + +Collection of possible data attributes must be documented in a shared file. The possible data attributes should be aligned with the already existing, related aspect models to avoid duplications. After the list of the possible attributes are agreed on by the responsible parties, for testing and validation purposes other companies should be involved. + +In case of a new or changed aspect model, the changes need to be submitted and requested from the association. The approval is dependent on many different factors. + +Linking with other already existing data models, if reasonable, is mandatory. The data model must be created with the catena-x conform modelling language. + +To get the approval, specific requirements have to be fulfilled. Several iterations between modelling adjustments and reviews can be made. + +Note: Data model creation and standardization will be supported in the association + +![Image: Passport Creation](./resources/adoption-view/passport_model_creation.svg) + +## Business Architecture + +The Business Architecture illustrates the interaction between the EcoPass KIT and other KITs, components, data models, and artifacts used for identity and access management, illustrated by the Figure below. + +![Image: Business Architecture](./resources/adoption-view/adoption-view-EcoPassKITBusinessArch.svg) + +The core of the network is to provide interoperability between different applications. For this reason, a common semantic is indispensable. In the Catena-X ecosystem, it has been agreed to use the description language SAMM to describe data models. +To additionally provide a standardized interface, the open standard of the International Digital Twin Association (IDTA) is used, abbreviated as IDTA. This [standard](https://industrialdigitaltwin.org/wp-content/uploads/2023/04/IDTA-01002-3-0_SpecificationAssetAdministrationShell_Part2_API.pdf) corresponds to the Asset Administration Shell (AAS 3.0). +It is used to discover digital twins and exchange actual usage data. The registration and search of digital twins is done by using the [Digital Twin KIT](https://eclipse-tractusx.github.io/docs-kits/kits/Digital%20Twin%20Kit/Adoption%20View%20Digital%20Twin%20Kit) which reference implementation is the [Digital Twin Registry](https://github.com/eclipse-tractusx/sldt-digital-twin-registry/tree/main) in Tractus-X. +To control access to both usage and meta data, the EcoPass KIT relies on the [Connector KIT](https://eclipse-tractusx.github.io/docs-kits/kits/tractusx-edc/docs/kit/adoption-view/Adoption%20View/). Interactions between two parties occur exclusively peer-to-peer via the standardized interfaces of the Connector KIT, based on the International Data Space Protocol. +Data sovereignty is enabled by so-called verifiable credentials. These rely on the technology of Self-Sovereign Identity (SSI) and are enabled through the Connector KIT. In short, consumers must present their signed credentials, defined by a data provider, before a data contract (and thus a data exchange) can take place. It should be mentioned that this concept is still in the prototype phase as of Release 3.2 and will be expanded in future releases. + +## Digital Product Pass Verification + +The Digital Product Pass Reference Implementation has a concept and implementation for the Certification and Verification of Data Aspects in Catena-X. This concept may help adopters from the EcoPass KIT, containing guidelines on how to verify data integrity, after it has been retrieved from the EDC. + +This Catena-X Data Certification/Verification Framework aims to create a second layer of trust over the EDC data exchanges between consumers and data providers. It enables auditors to verify specific attributes or complete aspect models for data providers and allowing consumers to retrieve and verify the "validity" of the verification done. Using a simple wallet, a Data Provider is able to certify its attributes or the complete semantic models from Catena-X and include it in a Verifiable Credential, which can then be verified on the Data Consumer side. + +The concept is the First Aspect Model Verification/Certification Concept in Catena-X. It aims to provide a "lighthouse" for any other aspect model verification/certification that MUST be done in Catena-X using SAMM Aspect Models. +It provides a generic concept for Attribute Verification/Certification by external/internal auditors, and also provides a Self-Testification option for Data Providers to certify their data while still maintaining data sovereighty at all costs. By using the EDC connector for the data exchanges the concept uses the current Catena-X Architecture: + +- [eclipse-tractusx/digital-product-pass/dpp-verification](https://github.com/eclipse-tractusx/digital-product-pass/tree/main/dpp-verification) + +Furthermore, it gives guidance and ready to use components for verifying the data received from their Data Providers. The Digital Product Pass Add-on offers the consumers components like the simple-wallet, an MVP decentral wallet able to issue and verify aspect model Verifiable Credential Documents. It also provides a proof of concept (PoC) in the dpp-backend and dpp-frontend components for complete data payloads to be verified. + +## Tutorials + +The Digital Product Pass Reference Implementation: [eclipse-tractusx/digital-product-pass](https://github.com/eclipse-tractusx/digital-product-pass) offers a tutorial for understanding the E2E journey of the EcoPass KIT. This tutorial was presented at the Second Tractus-X Community Days at the Digital Product Pass Introduction Workstream, it contains valuable and technical explanations on how to configure the Digital Twins and the Passport Aspects at the submodel server, easing the learning process of the adopters: + +- [eclipse-tractusx/digital-product-pass/dpp-tutorial](https://github.com/eclipse-tractusx/digital-product-pass/tree/main/dpp-tutorial) + +For more information about the Reference Implementation and how the KIT can be adoped consult the [Software Development View](./page-software-development-view.md). + +## NOTICE + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023, 2024 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023, 2024 Robert Bosch GmbH +- SPDX-FileCopyrightText: 2023, 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023, 2024 T-Systems International GmbH +- SPDX-FileCopyrightText: 2023, 2024 SAP SE +- SPDX-FileCopyrightText: 2023, 2024 CGI Deutschland B.V. & Co. KG +- SPDX-FileCopyrightText: 2023, 2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V. für ihre Institute IPK und IPK +- SPDX-FileCopyrightText: 2023, 2024 BASF SE +- SPDX-FileCopyrightText: 2023, 2024 Henkel AG & Co. KGaA +- SPDX-FileCopyrightText: 2023, 2024 Contributors to the Eclipse Foundation +- SPDX-FileCopyrightText: 2024 Volkswagen AG +- Source URL: diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/page-software-development-view.md b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/page-software-development-view.md similarity index 98% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/page-software-development-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/page-software-development-view.md index 3c71256ea64..7f5c81a55be 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/page-software-development-view.md +++ b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/page-software-development-view.md @@ -316,14 +316,19 @@ The Digital Product Passport Verification add-on is basically a concept for Cert The focus is on proving a process, artifacts and technologies, based on the existing SSI concept, aiming to enable Certification/Verification processes in Catena-X using wallets. -The documentation from the Digital Product Pass Verification Add-on is available [here](https://github.com/eclipse-tractusx/digital-product-pass/tree/main/dpp-verification) and is planned to be released as an official Catena-X whitepaper in R24.08. +The documentation from the Digital Product Pass Verification Add-on is available [here](https://github.com/eclipse-tractusx/digital-product-pass/tree/main/dpp-verification). The concept enables the verification of the Data in the Reference Implementation using a [simple wallet](https://github.com/eclipse-tractusx/digital-product-pass/tree/main/dpp-verification/simple-wallet), a functional wallet that can: -> [!TIP] -> The implementation is **NOT YET AVAILABLE**, it is planned for R24.08 and it is a **PoC** for data certification and verification for any other aspect model in Catena-X. Keep an eye on the [`Digital Product Pass Repository`](https://github.com/eclipse-tractusx/digital-product-pass/tree/main/dpp-verification) for further updates. +- Sign verifiable credentials with JsonWebSignature2020 proofs +- Verify verifiable credentials with JsonWebSignature2020 proofs +- Manage private and public keys, providing via DID Documents public keys in JsonWebKey2020 format + +Additionally the simple wallet contains a extension for creating JSON-LD @contexts using Catena-X SAMM Models Schemas. This allows the verifiable credentials with the semantic models to be valid JSON-LDs documents and enables the context of the existing and future modeled documents. + +![Verification Addon Screenshot](./resources/development-view/verificationAddon.png) ### Business Partner Data Management Add-on -When passports are retrieved from the data providers not all the company data is available to be visualized and shown. In order to eliminate the need to maintain models which contain references to companies in Catena-X the new models contain the `BPNS` and `BPNL` from the companies. Which can be translated into Address and Company information using the [https://github.com/eclipse-tractusx/bpdm](https://github.com/eclipse-tractusx/bpdm) reference implementation. This add-on will be implemented in R24.08. +When passports are retrieved from the data providers not all the company data is available to be visualized and shown. In order to eliminate the need to maintain models which contain references to companies in Catena-X the new models contain the `BPNS` and `BPNL` from the companies. Which can be translated into Address and Company information using the [https://github.com/eclipse-tractusx/bpdm](https://github.com/eclipse-tractusx/bpdm) reference implementation. > [!IMPORTANT] > diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/page-software-operation-view.md b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/page-software-operation-view.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/page-software-operation-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/page-software-operation-view.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BatteryPass_a_example.svg b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BatteryPass_a_example.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BatteryPass_a_example.svg rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BatteryPass_a_example.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BatteryPass_a_example.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BatteryPass_a_example.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BatteryPass_a_example.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BatteryPass_a_example.svg.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BusinessValue.svg b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BusinessValue.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BusinessValue.svg rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BusinessValue.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BusinessValue.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BusinessValue.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BusinessValue.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-BusinessValue.svg.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-EcoPassKITBusinessArch.svg b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-EcoPassKITBusinessArch.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-EcoPassKITBusinessArch.svg rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-EcoPassKITBusinessArch.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-EcoPassKITBusinessArch.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-EcoPassKITBusinessArch.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-EcoPassKITBusinessArch.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-EcoPassKITBusinessArch.svg.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-ValueChainBenefits.svg b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-ValueChainBenefits.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-ValueChainBenefits.svg rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-ValueChainBenefits.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-ValueChainBenefits.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-ValueChainBenefits.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-ValueChainBenefits.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/adoption-view/adoption-view-ValueChainBenefits.svg.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/adoption-view/passport_model_creation.svg b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/adoption-view/passport_model_creation.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/adoption-view/passport_model_creation.svg rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/adoption-view/passport_model_creation.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/adoption-view/passport_model_creation.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/adoption-view/passport_model_creation.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/adoption-view/passport_model_creation.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/adoption-view/passport_model_creation.svg.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/dataRetrievalFlow.svg b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/dataRetrievalFlow.svg similarity index 50% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/dataRetrievalFlow.svg rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/dataRetrievalFlow.svg index 4f96d4be3ff..45fd4a763aa 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/dataRetrievalFlow.svg +++ b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/dataRetrievalFlow.svg @@ -1,4 +1,4 @@ -
          EcoPass KIT Data Retrieval Flow
          1º
          2º
          3º
          4º
          1
          2
          3
          4
          5
          6
          7
          8
          9
          10
          Discovery Service
          BPN Discovery
          EDC Discovery
          Digital Twin Registries Assets Search
          Negotiate Contracts for
          Digital Twin Registries
          Search Digital Twin in
          Digital Twin Registries
          Request Asset
          Contracts in the Catalog
          of the EDC Provider
          Negotiate Contract
          Request Transfer for the Data
          Retrieve Data from the EDC Provider Data Plane Proxy
          DATA
          Digital Twin Registry
          Search Phase
          Digital Twin
          Search Phase
          Data Negotiation
          and Transfer Phase
          Discovery
          Phase
          ID
          CX:<manufacturerPartId>:<partInstanceId>
           \ No newline at end of file +
          EcoPass KIT Data Retrieval Flow
          1º
          2º
          3º
          4º
          1
          2
          3
          4
          5
          6
          7
          8
          9
          10
          Discovery Service
          BPN Discovery
          EDC Discovery
          Digital Twin Registries Assets Search
          Negotiate Contracts for
          Digital Twin Registries
          Search Digital Twin in
          Digital Twin Registries
          Request Asset
          Contracts in the Catalog
          of the EDC Provider
          Negotiate Contract
          Request Transfer for the Data
          Retrieve Data from the EDC Provider Data Plane Proxy
          DATA
          Digital Twin Registry
          Search Phase
          Digital Twin
          Search Phase
          Data Negotiation
          and Transfer Phase
          Discovery
          Phase
          ID
          CX:<manufacturerPartId>:<partInstanceId>
           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/dataRetrievalFlow.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/dataRetrievalFlow.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/dataRetrievalFlow.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/dataRetrievalFlow.svg.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/developmentview-sequence-diagramm.svg b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/developmentview-sequence-diagramm.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/developmentview-sequence-diagramm.svg rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/developmentview-sequence-diagramm.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/developmentview-sequence-diagramm.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/developmentview-sequence-diagramm.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/developmentview-sequence-diagramm.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/developmentview-sequence-diagramm.svg.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/ecoPassContext.svg b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/ecoPassContext.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/ecoPassContext.svg rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/ecoPassContext.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/ecoPassContext.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/ecoPassContext.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/ecoPassContext.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/ecoPassContext.svg.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/ecoPassNegotiationAndTransferSequence.svg b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/ecoPassNegotiationAndTransferSequence.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/ecoPassNegotiationAndTransferSequence.svg rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/ecoPassNegotiationAndTransferSequence.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/ecoPassNegotiationAndTransferSequence.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/ecoPassNegotiationAndTransferSequence.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/ecoPassNegotiationAndTransferSequence.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/ecoPassNegotiationAndTransferSequence.svg.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/ecoPassSearchSequence.svg b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/ecoPassSearchSequence.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/ecoPassSearchSequence.svg rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/ecoPassSearchSequence.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/ecoPassSearchSequence.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/ecoPassSearchSequence.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/development-view/ecoPassSearchSequence.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/ecoPassSearchSequence.svg.license diff --git a/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/verificationAddon.png b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/verificationAddon.png new file mode 100644 index 00000000000..bf34184ce63 Binary files /dev/null and b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/verificationAddon.png differ diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/img/EcoPassKIT_pictogram.png.license b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/verificationAddon.png.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/img/EcoPassKIT_pictogram.png.license rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/development-view/verificationAddon.png.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/img/EcoPassKIT_pictogram.png b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/img/EcoPassKIT_pictogram.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/img/EcoPassKIT_pictogram.png rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/img/EcoPassKIT_pictogram.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/success-stories/BatteryLogo.png.license b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/img/EcoPassKIT_pictogram.png.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/success-stories/BatteryLogo.png.license rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/img/EcoPassKIT_pictogram.png.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/styles.module.css b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/styles.module.css similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/styles.module.css rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/styles.module.css diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/success-stories/BatteryLogo.png b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/success-stories/BatteryLogo.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/success-stories/BatteryLogo.png rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/success-stories/BatteryLogo.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/success-stories/BatteryPass_Viewer_App1.png.license b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/success-stories/BatteryLogo.png.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/success-stories/BatteryPass_Viewer_App1.png.license rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/success-stories/BatteryLogo.png.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/success-stories/BatteryPass_Viewer_App1.png b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/success-stories/BatteryPass_Viewer_App1.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/success-stories/BatteryPass_Viewer_App1.png rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/success-stories/BatteryPass_Viewer_App1.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/success-stories/BatteryPass_Viewer_App2.png.license b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/success-stories/BatteryPass_Viewer_App1.png.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/success-stories/BatteryPass_Viewer_App2.png.license rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/success-stories/BatteryPass_Viewer_App1.png.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/success-stories/BatteryPass_Viewer_App2.png b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/success-stories/BatteryPass_Viewer_App2.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/success-stories/BatteryPass_Viewer_App2.png rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/success-stories/BatteryPass_Viewer_App2.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/success-stories/DigitalProductPass_DEMO_View1_Module.png.license b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/success-stories/BatteryPass_Viewer_App2.png.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/success-stories/DigitalProductPass_DEMO_View1_Module.png.license rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/success-stories/BatteryPass_Viewer_App2.png.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/success-stories/DigitalProductPass_DEMO_View1_Module.png b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/success-stories/DigitalProductPass_DEMO_View1_Module.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/success-stories/DigitalProductPass_DEMO_View1_Module.png rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/success-stories/DigitalProductPass_DEMO_View1_Module.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/success-stories/DigitalProductPass_DEMO_View2_Components_Module.png.license b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/success-stories/DigitalProductPass_DEMO_View1_Module.png.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/success-stories/DigitalProductPass_DEMO_View2_Components_Module.png.license rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/success-stories/DigitalProductPass_DEMO_View1_Module.png.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/success-stories/DigitalProductPass_DEMO_View2_Components_Module.png b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/success-stories/DigitalProductPass_DEMO_View2_Components_Module.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Eco_Pass_KIT/resources/success-stories/DigitalProductPass_DEMO_View2_Components_Module.png rename to docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/success-stories/DigitalProductPass_DEMO_View2_Components_Module.png diff --git a/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/success-stories/DigitalProductPass_DEMO_View2_Components_Module.png.license b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/success-stories/DigitalProductPass_DEMO_View2_Components_Module.png.license new file mode 100644 index 00000000000..b4e2c813d8f --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Eco_Pass_KIT/resources/success-stories/DigitalProductPass_DEMO_View2_Components_Module.png.license @@ -0,0 +1,16 @@ +## NOTICE + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023, 2024 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023, 2024 Robert Bosch GmbH +- SPDX-FileCopyrightText: 2023, 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023, 2024 T-Systems International GmbH +- SPDX-FileCopyrightText: 2023, 2024 SAP SE +- SPDX-FileCopyrightText: 2023, 2024 CGI Deutschland B.V. & Co. KG +- SPDX-FileCopyrightText: 2023, 2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V. für ihre Institute IPK und IPK +- SPDX-FileCopyrightText: 2023, 2024 BASF SE +- SPDX-FileCopyrightText: 2023, 2024 Henkel AG & Co. KGaA +- SPDX-FileCopyrightText: 2023, 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/digital-product-pass \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/Software Development View/_category_.json b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/Software Development View/_category_.json similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/Software Development View/_category_.json rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/Software Development View/_category_.json diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/Software Development View/page_aspect-models.mdx b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/Software Development View/page_aspect-models.mdx similarity index 97% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/Software Development View/page_aspect-models.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/Software Development View/page_aspect-models.mdx index cde92f264a8..bd3f69a4f73 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/Software Development View/page_aspect-models.mdx +++ b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/Software Development View/page_aspect-models.mdx @@ -26,7 +26,7 @@ This work is licensed under the CC-BY-4.0 (https://creativecommons.org/licenses/ import Notice from '../part_notice.mdx' import AspectModelOverview from './part_aspect-model-overview.mdx' -![Industry Core kit banner](@site/static/img/kit-icons/industry-core-kit-icon.svg) +![Industry Core kit banner](@site/static/img/kits/industry-core/industry-core-kit-logo.drawio.svg) Aspect models are mostly easy to create by transforming a company's internal data into the target aspect model. Transformations are mostly straightforward in these cases. If necessary, special steps in creating aspect models are mentioned in the corresponding sections. @@ -179,10 +179,6 @@ Aspect model in GitHub: "key": "manufacturerId", "value": "BPNL7588787849VQ" }, - { - "key": "manufacturerPartId", - "value": "95657362-83" - }, { "key": "partInstanceId", "value": "OEM-A-F8LM95T92WJ9KNDD3HA5P" @@ -231,10 +227,6 @@ Aspect model in GitHub: "key": "manufacturerId", "value": "BPNL7588787849VQ" }, - { - "key": "manufacturerPartId", - "value": "95657362-83" - }, { "key": "partInstanceId", "value": "NO-574868639429552535768526" @@ -293,13 +285,13 @@ Aspect model in GitHub: "key": "batchId" }, { - "value": "123-0.740-3434-A", - "key": "manufacturerPartId" + "value": "BPNL7588787849VQ", + "key": "manufacturerId" }, ], "manufacturingInformation": { "date": "2022-02-04T14:48:54", - "country": "HUR", + "country": "DEU", "sites": [ { "catenaXsiteId": "BPNS1234567890ZZ", @@ -355,14 +347,6 @@ Aspect model in GitHub: "key": "parentOrderNumber", "value": "OEM-A-F8LM95T92WJ9KNDD3HA5P" }, - { - "key": "manufacturerPartId", - "value": "84816168424" - }, - { - "key": "nameAtManufacturer", - "value": "Black Leather Front Row Seat for Vehicle Model B" - }, { "key": "jisCallDate", "value": "2022-01-24T09:13:34" diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/Software Development View/page_digital-twins.mdx b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/Software Development View/page_digital-twins.mdx similarity index 92% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/Software Development View/page_digital-twins.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/Software Development View/page_digital-twins.mdx index 19ac18b2ba0..6541ee9e958 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/Software Development View/page_digital-twins.mdx +++ b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/Software Development View/page_digital-twins.mdx @@ -26,7 +26,7 @@ This work is licensed under the CC-BY-4.0 (https://creativecommons.org/licenses/ import Notice from '../part_notice.mdx' import UniqueIDPush from './part_uniqueidpush.mdx' -![Industry Core kit banner](@site/static/img/kit-icons/industry-core-kit-icon.svg) +![Industry Core kit banner](@site/static/img/kits/industry-core/industry-core-kit-logo.drawio.svg) Industry Core uses digital twins to make a company's data available to other Catena-X partners. Basics about digital twins with which you should be familiar to understand this section are described in the [Digital Twin KIT](../../../../../docs-kits/category/digital-twin-kit). @@ -38,6 +38,14 @@ In Industry Core, different types of parts, e. g. serialized parts, batches, JIS To enforce a strict need-to-know principle (and to prevent data from being exposed to non-authorized partners in the Catena-X network), the visibility of digital twins and the content of the attribute `specificAssetIds` of digital twins must be restricted to authorized partners only. The actual implemenetation depends on the DTR product used by the Catena-X partner. More details can be found in the [Digital Twin KIT](../../../../../docs-kits/category/digital-twin-kit). +#### Handling of Digital Twins at Contract Manufacturing + +Contract manufacturing refers to the practice of outsourcing the production of vehicles or components to external manufacturers through formal agreements. This is a common business model and process in the automotive industry and therefore needs to be considered within Catena-X. + +- The creation of a DT has to be agreed first between the contracting authority and the contracting manufacturer. Regardless of who of the two parties creates the digital twin, it must always be created in the contracting authority's DTR. This in turn means that the contracting authority is always the owner of the digital twin of a part that is manufactured by a contract manufacturer. +- The contract manufacturer does not necessarily need to be a member of Catena-X, as it is often intended to remain confidential if a part is produced by a contract manufacturer. The contracting authority bears responsibility for the externally manufactured parts towards their customers, and therefore all communication, such as Quality Notifications, takes place via the contracting authority. +- If the contract manufacturer is not part of Catena-X, the required data are provided by the contractor outside of Catena-X, and the contracting authority creates the digital twin and performs the Look-up of the child parts to ensure traceability. + #### Unique ID for Parts In the Industry Core, a Unique ID uniquely identifies a particular real-world asset. Currently, these are: serialized parts (including vehicles), batches, JIS parts (Just-in-Sequence) and also catalog parts. @@ -201,7 +209,7 @@ Here's an example how such a submodel descriptor could look like: "keys": [ { "type": "GlobalReference", - "value": "urn:samm:io.catenax.serial_part:1.0.1#SerialPart" + "value": "urn:samm:io.catenax.serial_part:3.0.0#SerialPart" } ] }, @@ -245,7 +253,7 @@ Here's an example how such a submodel descriptor could look like: "keys": [ { "type": "GlobalReference", - "value": "urn:samm:io.catenax.serial_part:1.0.1#SerialPart" + "value": "urn:samm:io.catenax.serial_part:3.0.0#SerialPart" } ] }, @@ -345,6 +353,14 @@ Currently, even if more than one digital twin is returned in a lookup, these dig The next section describes to modify the lookup to additionally restrict the results to digital twins with a specific submodel type based on it's semanticId. +#### Implicit Connection Between a Part Type Twin and the Corresponding Part Instance Twins + +To find the corresponding part instance twins to a given part type twin, it is possible to use the lookup functionality. Searching for the specific asset IDs `manufacturerId` and `manufacturerPartId` and `digitalTwinType = "PartInstance"` of the given part type twin will find all corresponding part instance twins. + +To find the corresponding part type twin to a given part instance twin, it is possible to search for the specific asset IDs `manufacturerId`, `manufacturerPartId` and `digitalTwinType = "PartType"` of the given part instance twin. + +To find the corresponding part instance twins to a given part instance twin, it is possible to search for the specific asset IDs `manufacturerId`, `manufacturerPartId` and `digitalTwinType = "PartInstance"` of the given part instance twin. + ### Unique ID Push Once the digital twin was created, optionally a Unique ID Push notification can be send by the manufacturer of the part to the customer of the serialized part of batch to inform the customer that information about a serialized part or batch is available as a digital twin. This is an optional process and both, the manufacturer of a part as well as the customer of the part must support Unique ID Push notifications. diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/Software Development View/page_policies.mdx b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/Software Development View/page_policies.mdx similarity index 97% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/Software Development View/page_policies.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/Software Development View/page_policies.mdx index 5daa686e299..c3423549e1d 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/Software Development View/page_policies.mdx +++ b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/Software Development View/page_policies.mdx @@ -25,7 +25,7 @@ This work is licensed under the CC-BY-4.0 (https://creativecommons.org/licenses/ import Notice from '../part_notice.mdx' -![Industry Core kit banner](@site/static/img/kit-icons/industry-core-kit-icon.svg) +![Industry Core kit banner](@site/static/img/kits/industry-core/industry-core-kit-logo.drawio.svg) The Policies are used to increase data sovereignty by limiting the access and usage of data. In the following, access and usage policies with their usage in the EDC are described. An explanation of Policy-handling mechanics in the EDC diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/Software Development View/part_aspect-model-overview.mdx b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/Software Development View/part_aspect-model-overview.mdx similarity index 52% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/Software Development View/part_aspect-model-overview.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/Software Development View/part_aspect-model-overview.mdx index 533d638bc41..bc60a352e98 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/Software Development View/part_aspect-model-overview.mdx +++ b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/Software Development View/part_aspect-model-overview.mdx @@ -20,16 +20,15 @@ This work is licensed under the CC-BY-4.0 (https://creativecommons.org/licenses/ - Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Industry%20Core%20Kit (latest version) --> -In the following section, all aspect models that are part of Industry Core are documented. +The following section shows an overview of all aspect models that are currently attached to part type or part instance twins by Catena-X use cases. -| Digital Twin Type | Aspect Model | Mandatory Version | Optional Versions | KIT | -| :-- | :-- | :-- | :-- | :-- | -| PartType | PartTypeInformation | 1.0.0 | | Industry Core | -| | SingleLevelBomAsPlanned | 3.0.0 | | Industry Core | -| | SingleLevelUsageAsPlanned | 2.0.0 | | Industry Core | -| PartInstance | SerialPart | 3.0.0 | | Industry Core | -| | Batch | 3.0.0 | | Industry Core | -| | JustInSequencePart | 3.0.0 | | Industry Core | -| | SingleLevelBomAsBuilt | 3.0.0 | | Industry Core | -| | SingleLevelUsageAsBuilt | 3.0.0 | | Industry Core | -| | TractionBatteryCode | 1.0.0 | | Traceability | +| Digital Twin Type | Aspect Model | Mandatory Version | Optional Versions | KIT | Standard | +| :-- | :-- | :-- | :-- | :-- | :-- | +| PartType | PartTypeInformation | 1.0.0 | | Industry Core | CX-0126 Industry Core: Part Type v2.0.0 | +| | SingleLevelBomAsPlanned | 3.0.0 | | Industry Core | CX-0126 Industry Core: Part Type v2.0.0 | +| | SingleLevelUsageAsPlanned | 2.0.0 | | Industry Core | CX-0126 Industry Core: Part Type v2.0.0 | +| PartInstance | SerialPart | 3.0.0 | | Industry Core | CX-0127 Industry Core: Part Instance v2.0.0 | +| | Batch | 3.0.0 | | Industry Core | CX-0127 Industry Core: Part Instance v2.0.0 | +| | JustInSequencePart | 3.0.0 | | Industry Core | CX-0127 Industry Core: Part Instance v2.0.0 | +| | SingleLevelBomAsBuilt | 3.0.0 | | Industry Core | CX-0127 Industry Core: Part Instance v2.0.0 | +| | SingleLevelUsageAsBuilt | 3.0.0 | | Industry Core | CX-0127 Industry Core: Part Instance v2.0.0 | diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/Software Development View/part_uniqueidpush.mdx b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/Software Development View/part_uniqueidpush.mdx similarity index 97% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/Software Development View/part_uniqueidpush.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/Software Development View/part_uniqueidpush.mdx index 869ddabb151..7d47c52f465 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/Software Development View/part_uniqueidpush.mdx +++ b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/Software Development View/part_uniqueidpush.mdx @@ -28,7 +28,9 @@ The solution is based on notification assets in the EDC (which is the same appro > :raised_hand: It is important to understand that the receiver creates EDC asset and policies, and thus, the sender of the Unique ID push notification must check during the EDC negotiation process if the conditions the receiver offers are acceptable for the sender. -Currently there are two types of Unique ID Push Notifications available: "Connect to Parent" and "Connect to Child". +Currently there are two types of Unique ID Push Notifications available: "Connect to Parent" and "Connect to Child": + +![Unique ID Push Notifications](../assets/unique_id_push_notifications.svg) ##### Connect to Parent @@ -123,7 +125,7 @@ Upon receipt of the message, the supplier needs to update the corresponding sing #### Schema of Unique ID Push Notifications -The Unique ID Push notifications have a standardized format. Schemas of these notifications are described in detail in the Unique ID Push Open API specification. The standardized version of this API is [2.0.0](../../../../openApi/industrycore/unique-id-push.yaml). Version [2.1.0](../../../../openApi/industrycore/unique-id-push_2-1-0.yaml) is not (yet) standardized, but backwards compatible, and extends v2.0.0 with the Connect-to-Child feature. +The Unique ID Push notifications have a standardized format. Schemas of these notifications are described in detail in the Unique ID Push Open API specification. The standardized version of this API is [2.0.0](../openapi/unique-id-push.yaml). Version [2.1.0](../openapi/unique-id-push_2-1-0.yaml) is not (yet) standardized, but backwards compatible, and extends v2.0.0 with the Connect-to-Child feature. ##### Connect to Parent diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/datachain_oneup_onedown.png b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/datachain_oneup_onedown.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/datachain_oneup_onedown.png rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/datachain_oneup_onedown.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/architecture_level_1.png.license b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/datachain_oneup_onedown.png.license similarity index 98% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/architecture_level_1.png.license rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/datachain_oneup_onedown.png.license index 725b4f88d99..7208212b02c 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/architecture_level_1.png.license +++ b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/datachain_oneup_onedown.png.license @@ -12,4 +12,4 @@ This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses - SPDX-FileCopyrightText: 2023 T-Systems International GmbH - SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG - SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation -- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Traceability%20Kit (latest version) \ No newline at end of file +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Traceability%20Kit (latest version) diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/ic-arch-view-blocks.svg b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/ic-arch-view-blocks.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/ic-arch-view-blocks.svg rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/ic-arch-view-blocks.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/ic-arch-view-blocks.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/ic-arch-view-blocks.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/ic-arch-view-blocks.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/ic-arch-view-blocks.svg.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/ic-arch-view-stds.svg b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/ic-arch-view-stds.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/ic-arch-view-stds.svg rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/ic-arch-view-stds.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/ic-arch-view-stds.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/ic-arch-view-stds.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/ic-arch-view-stds.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/ic-arch-view-stds.svg.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/ic-components.png b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/ic-components.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/ic-components.png rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/ic-components.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/ic-components.png.license b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/ic-components.png.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/ic-components.png.license rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/ic-components.png.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/ic-customer-journey.png.license b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/ic-customer-journey.png.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/ic-customer-journey.png.license rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/ic-customer-journey.png.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/ic-type_levels.png b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/ic-type_levels.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/ic-type_levels.png rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/ic-type_levels.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/ic-type_levels.png.license b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/ic-type_levels.png.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/ic-type_levels.png.license rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/ic-type_levels.png.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/ic_customer-journey.png b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/ic_customer-journey.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/ic_customer-journey.png rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/ic_customer-journey.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/ic_sources.pptx b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/ic_sources.pptx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/ic_sources.pptx rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/ic_sources.pptx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/ic_sources.pptx.license b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/ic_sources.pptx.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/ic_sources.pptx.license rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/ic_sources.pptx.license diff --git a/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/unique_id_push_notifications.svg b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/unique_id_push_notifications.svg new file mode 100644 index 00000000000..42fa2c32c9f --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/unique_id_push_notifications.svg @@ -0,0 +1,4 @@ + + + +

          Customer

          Supplier
          gearbox
          DT

          Customer

          Supplier
          Connect-to-Parent
          (Bottom-Up)
          New DT has been created for a part and is available. The customer can update the SingleLevelBom data model.
          The part was assembled in, so the SingleLevelUsage data model can be updated at the supplier.
          Connect-to-Child
          (Top-Down)
          Part and corresponding digital twin was created.
          POST: .../uniqueidpush/connect-to-parent
          POST: .../uniqueidpush/connect-to-child
          gear
          DT
          The next step would be to install a part and then send a new Unique-ID push notification to the original supplier (connect-to-child)
          gearbox
          DT
          DT
          DT
          Exist a DT for the parts that will be assembled in?
          Product was created containing the parts assembled in.
          DT
          DT
          Has the part already been assembled in?
          gear
          gearbox
          gear
          DT
          gear
           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/unique_id_push_notifications.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/unique_id_push_notifications.svg.license new file mode 100644 index 00000000000..60aad7a3096 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/unique_id_push_notifications.svg.license @@ -0,0 +1,15 @@ +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 BASF SE +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST & Fraunhofer IML) +- SPDX-FileCopyrightText: 2024 German Edge Cloud GmbH & Co. KG +- SPDX-FileCopyrightText: 2024 Mercedes Benz AG +- SPDX-FileCopyrightText: 2024 Robert Bosch Manufacturing Solutions GmbH +- SPDX-FileCopyrightText: 2024 SAP SE +- SPDX-FileCopyrightText: 2024 Siemens AG +- SPDX-FileCopyrightText: 2024 T-Systems International GmbH +- SPDX-FileCopyrightText: 2024 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Industry%20Core%20Kit (latest version) diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/unique_id_push_process.png b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/unique_id_push_process.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/unique_id_push_process.png rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/unique_id_push_process.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/unique_id_push_process.png.license b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/unique_id_push_process.png.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/assets/unique_id_push_process.png.license rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/assets/unique_id_push_process.png.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/openapi/unique-id-push.yaml b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/openapi/unique-id-push.yaml similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/openapi/unique-id-push.yaml rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/openapi/unique-id-push.yaml diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/openapi/unique-id-push_2-1-0.yaml b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/openapi/unique-id-push_2-1-0.yaml similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/openapi/unique-id-push_2-1-0.yaml rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/openapi/unique-id-push_2-1-0.yaml diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/page_architecture-view.mdx b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/page_architecture-view.mdx similarity index 99% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/page_architecture-view.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/page_architecture-view.mdx index 6d61883ec47..54fd19b6f61 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/page_architecture-view.mdx +++ b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/page_architecture-view.mdx @@ -26,7 +26,7 @@ This work is licensed under the CC-BY-4.0 (https://creativecommons.org/licenses/ import Notice from './part_notice.mdx' import FutureConcepts from './part_future-concepts.mdx' -![Industry Core kit banner](@site/static/img/kit-icons/industry-core-kit-icon.svg) +![Industry Core kit banner](@site/static/img/kits/industry-core/industry-core-kit-logo.drawio.svg) The following page offers an architecture perspective including the main building blocks and information regarding communication between different components, shown as sequence diagrams in a runtime view. In general, data access must diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/page_business_view.mdx b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/page_business_view.mdx similarity index 99% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/page_business_view.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/page_business_view.mdx index 0700f650b3b..7899b0963fa 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/page_business_view.mdx +++ b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/page_business_view.mdx @@ -26,7 +26,7 @@ This work is licensed under the CC-BY-4.0 (https://creativecommons.org/licenses/ import Notice from './part_notice.mdx' import BillOfMaterials from './part_bill-of-materials.mdx' -![Industry Core kit banner](@site/static/img/kit-icons/industry-core-kit-icon.svg) +![Industry Core kit banner](@site/static/img/kits/industry-core/industry-core-kit-logo.drawio.svg) The following page offers a high level business view on the Industry Core KIT with its vision, mission, benefits, business value, customer journey and examples in form of videos. diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/page_changelog.mdx b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/page_changelog.mdx similarity index 75% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/page_changelog.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/page_changelog.mdx index e030bcf28be..48fb3ab0cbc 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/page_changelog.mdx +++ b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/page_changelog.mdx @@ -25,10 +25,51 @@ This work is licensed under the CC-BY-4.0 (https://creativecommons.org/licenses/ import Notice from './part_notice.mdx' -![Industry Core kit banner](@site/static/img/kit-icons/industry-core-kit-icon.svg) +![Industry Core kit banner](@site/static/img/kits/industry-core/industry-core-kit-logo.drawio.svg) All notable changes to this Kit will be documented in this file. +## [1.3.0] - 2024-12-01 + +Compatible for **release 24.08**. + +### Removed +- **Development View:** + - **Aspect Models:** + - Removed the listed Traceability aspect models in the overview (were moved to the Traceability KIT) + +## [1.2.0] - 2024-10-22 + +Compatible for **release 24.08**. + +### Added + +- **Development View:** + - **Digital Twins | Unique ID Push:** + - Added a new illustration to describe the unique id push notifications in a visual way + +## [1.1.1] - 2024-10-23 + +Compatible for **release 24.08**. + +### Removed + +- **Development View:** + - **Aspect Models:** + - Removed the *manufacturerPartId* in the key-value list of the localIdentifiers for the SerialPart, Batch and JustInsequencePart JSON-Example + - Replaced the faulty (production) country abbreviation in the JSON-Example of the Batch aspect model from *HUR* to *DEU* + +## [1.1.0] - 2024-07-11 + +Compatible for **release 24.08**. + +### Added + +- **Development View:** + - **Digital Twins:** + - Added a new guideline on how to handle Digital Twins at contract manufacturing + - Added a new guideline on how to create an implicit connection between a Part Type twin and the corresponding Part Instance twins + ## [1.0.0] - 2024-05-06 Compatible for **release 24.05**. diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/page_software-operation-view.mdx b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/page_software-operation-view.mdx similarity index 95% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/page_software-operation-view.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/page_software-operation-view.mdx index 19d43b544f2..96c8dc338f6 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/page_software-operation-view.mdx +++ b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/page_software-operation-view.mdx @@ -25,7 +25,7 @@ This work is licensed under the CC-BY-4.0 (https://creativecommons.org/licenses/ import Notice from './part_notice.mdx' -![Industry Core kit banner](@site/static/img/kit-icons/industry-core-kit-icon.svg) +![Industry Core kit banner](@site/static/img/kits/industry-core/industry-core-kit-logo.drawio.svg) The following page offers information on how to operate and deploy the Industry Core. diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/part_bill-of-materials.mdx b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/part_bill-of-materials.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/part_bill-of-materials.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/part_bill-of-materials.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/part_future-concepts.mdx b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/part_future-concepts.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/part_future-concepts.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/part_future-concepts.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/part_notice.mdx b/docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/part_notice.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Industry Core Kit/part_notice.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Industry Core Kit/part_notice.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/Manufacturing Capability/get-manufacturing-capability.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/Manufacturing Capability/get-manufacturing-capability.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/Manufacturing Capability/get-manufacturing-capability.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/Manufacturing Capability/get-manufacturing-capability.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/Manufacturing Capability/manufacturing-capability-aspect-model.info.mdx b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/Manufacturing Capability/manufacturing-capability-aspect-model.info.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/Manufacturing Capability/manufacturing-capability-aspect-model.info.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/Manufacturing Capability/manufacturing-capability-aspect-model.info.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/Manufacturing Capability/page_software-development-view.md b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/Manufacturing Capability/page_software-development-view.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/Manufacturing Capability/page_software-development-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/Manufacturing Capability/page_software-development-view.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/Manufacturing Capability/post-manufacturing-capability.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/Manufacturing Capability/post-manufacturing-capability.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/Manufacturing Capability/post-manufacturing-capability.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/Manufacturing Capability/post-manufacturing-capability.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/Manufacturing Capability/res/RefArcMC.JPG b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/Manufacturing Capability/res/RefArcMC.JPG similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/Manufacturing Capability/res/RefArcMC.JPG rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/Manufacturing Capability/res/RefArcMC.JPG diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/Manufacturing Capability/sidebar.js b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/Manufacturing Capability/sidebar.js similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/Manufacturing Capability/sidebar.js rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/Manufacturing Capability/sidebar.js diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/Request for Quotation/page_software-development-view.md b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/Request for Quotation/page_software-development-view.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/Request for Quotation/page_software-development-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/Request for Quotation/page_software-development-view.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/Request for Quotation/post-request-for-quotation.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/Request for Quotation/post-request-for-quotation.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/Request for Quotation/post-request-for-quotation.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/Request for Quotation/post-request-for-quotation.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/Request for Quotation/request-for-quotation.info.mdx b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/Request for Quotation/request-for-quotation.info.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/Request for Quotation/request-for-quotation.info.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/Request for Quotation/request-for-quotation.info.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/Request for Quotation/resources/RefArcRfQ.JPG b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/Request for Quotation/resources/RefArcRfQ.JPG similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/Request for Quotation/resources/RefArcRfQ.JPG rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/Request for Quotation/resources/RefArcRfQ.JPG diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/Request for Quotation/sidebar.js b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/Request for Quotation/sidebar.js similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/Request for Quotation/sidebar.js rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/Request for Quotation/sidebar.js diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/page_software-development-view.md b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/page_software-development-view.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/page_software-development-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/page_software-development-view.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/page_software_architecture.md b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/page_software_architecture.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/page_software_architecture.md rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/page_software_architecture.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/1st level whitebox marketplace use case.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/1st level whitebox marketplace use case.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/1st level whitebox marketplace use case.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/1st level whitebox marketplace use case.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/Deployment View.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/Deployment View.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/Deployment View.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/Deployment View.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/Manufacturing_Capability_Model.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/Manufacturing_Capability_Model.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/Manufacturing_Capability_Model.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/Manufacturing_Capability_Model.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/MarketplaceUseCases.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/MarketplaceUseCases.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/MarketplaceUseCases.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/MarketplaceUseCases.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/RFQ.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/RFQ.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/RFQ.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/RFQ.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/Reference Architecture - Functional Layer.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/Reference Architecture - Functional Layer.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/Reference Architecture - Functional Layer.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/Reference Architecture - Functional Layer.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/Swim Lane Diagrams Federated Marketplace-Manufacturer Onboarding.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/Swim Lane Diagrams Federated Marketplace-Manufacturer Onboarding.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/Swim Lane Diagrams Federated Marketplace-Manufacturer Onboarding.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/Swim Lane Diagrams Federated Marketplace-Manufacturer Onboarding.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/Swim Lane Diagrams Federated Marketplace-Manufacturing Capability DT Provisioning.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/Swim Lane Diagrams Federated Marketplace-Manufacturing Capability DT Provisioning.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/Swim Lane Diagrams Federated Marketplace-Manufacturing Capability DT Provisioning.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/Swim Lane Diagrams Federated Marketplace-Manufacturing Capability DT Provisioning.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/System Scope.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/System Scope.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/System Scope.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/System Scope.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/Unbenanntes Diagramm.drawio.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/Unbenanntes Diagramm.drawio.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/Unbenanntes Diagramm.drawio.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/Unbenanntes Diagramm.drawio.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/Whitebox CDME-2nd level WB Manufacturing Network Registry.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/Whitebox CDME-2nd level WB Manufacturing Network Registry.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/Whitebox CDME-2nd level WB Manufacturing Network Registry.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/Whitebox CDME-2nd level WB Manufacturing Network Registry.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/bill_of_process_datamodel.drawio.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/bill_of_process_datamodel.drawio.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/bill_of_process_datamodel.drawio.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/bill_of_process_datamodel.drawio.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2023-11-2_11-9-27.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2023-11-2_11-9-27.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2023-11-2_11-9-27.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2023-11-2_11-9-27.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2023-11-2_11-9-8.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2023-11-2_11-9-8.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2023-11-2_11-9-8.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2023-11-2_11-9-8.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2023-11-2_13-54-35.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2023-11-2_13-54-35.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2023-11-2_13-54-35.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2023-11-2_13-54-35.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2023-11-2_14-7-37.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2023-11-2_14-7-37.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2023-11-2_14-7-37.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2023-11-2_14-7-37.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2023-11-2_15-54-33.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2023-11-2_15-54-33.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2023-11-2_15-54-33.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2023-11-2_15-54-33.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_11-16-17.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_11-16-17.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_11-16-17.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_11-16-17.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_11-29-3-1.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_11-29-3-1.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_11-29-3-1.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_11-29-3-1.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_16-21-12-1.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_16-21-12-1.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_16-21-12-1.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_16-21-12-1.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_16-21-24-1.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_16-21-24-1.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_16-21-24-1.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_16-21-24-1.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_16-39-0.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_16-39-0.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_16-39-0.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_16-39-0.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_16-46-38.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_16-46-38.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_16-46-38.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_16-46-38.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_16-48-15.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_16-48-15.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_16-48-15.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_16-48-15.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_16-8-26-1.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_16-8-26-1.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_16-8-26-1.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/image-2024-3-12_16-8-26-1.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/maasPortal.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/maasPortal.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/maasPortal.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/maasPortal.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/overview.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/overview.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/Software Development View/resources/overview.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/Software Development View/resources/overview.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/page_adoption-view.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/page_adoption-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/page_adoption-view.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/page_changelog.md b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/page_changelog.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/page_changelog.md rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/page_changelog.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/resources/Architekturteaser.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/resources/Architekturteaser.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/resources/Architekturteaser.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/resources/Architekturteaser.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/resources/MarketplaceUseCases.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/resources/MarketplaceUseCases.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/resources/MarketplaceUseCases.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/resources/MarketplaceUseCases.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/resources/image-2023-11-2_13-54-35.png b/docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/resources/image-2023-11-2_13-54-35.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Manufacturing as a Service Kit/resources/image-2023-11-2_13-54-35.png rename to docs-kits_versioned_docs/version-24.12/kits/Manufacturing as a Service Kit/resources/image-2023-11-2_13-54-35.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/Software Development View/Consumer/get-provide-production-forecast.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/Software Development View/Consumer/get-provide-production-forecast.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/Software Development View/Consumer/get-provide-production-forecast.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/Software Development View/Consumer/get-provide-production-forecast.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/Software Development View/Consumer/get-provide-production-tracking.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/Software Development View/Consumer/get-provide-production-tracking.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/Software Development View/Consumer/get-provide-production-tracking.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/Software Development View/Consumer/get-provide-production-tracking.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/Software Development View/Consumer/sidebar.js b/docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/Software Development View/Consumer/sidebar.js similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/Software Development View/Consumer/sidebar.js rename to docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/Software Development View/Consumer/sidebar.js diff --git a/docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/Software Development View/Provider/get-get-production-forecast.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/Software Development View/Provider/get-get-production-forecast.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/Software Development View/Provider/get-get-production-forecast.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/Software Development View/Provider/get-get-production-forecast.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/Software Development View/Provider/get-get-production-tracking.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/Software Development View/Provider/get-get-production-tracking.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/Software Development View/Provider/get-get-production-tracking.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/Software Development View/Provider/get-get-production-tracking.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/Software Development View/Provider/sidebar.js b/docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/Software Development View/Provider/sidebar.js similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/Software Development View/Provider/sidebar.js rename to docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/Software Development View/Provider/sidebar.js diff --git a/docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/Software Development View/Provider/unsubscribe.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/Software Development View/Provider/unsubscribe.api.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/Software Development View/Provider/unsubscribe.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/Software Development View/Provider/unsubscribe.api.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/Software Development View/page_software-development-view.md b/docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/Software Development View/page_software-development-view.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/Software Development View/page_software-development-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/Software Development View/page_software-development-view.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/page_adoption-view.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/page_adoption-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/page_adoption-view.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/page_changelog.md b/docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/page_changelog.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/page_changelog.md rename to docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/page_changelog.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/res/ISO.PNG b/docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/res/ISO.PNG similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/res/ISO.PNG rename to docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/res/ISO.PNG diff --git a/docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/res/SIS.Tracking-Parameter.svg b/docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/res/SIS.Tracking-Parameter.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/res/SIS.Tracking-Parameter.svg rename to docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/res/SIS.Tracking-Parameter.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/res/SIS_ProductionForecastData_Overview_Border30.svg b/docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/res/SIS_ProductionForecastData_Overview_Border30.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/res/SIS_ProductionForecastData_Overview_Border30.svg rename to docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/res/SIS_ProductionForecastData_Overview_Border30.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/res/SIS_ProductionForecastData_SequenceChart_Border25.svg b/docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/res/SIS_ProductionForecastData_SequenceChart_Border25.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/res/SIS_ProductionForecastData_SequenceChart_Border25.svg rename to docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/res/SIS_ProductionForecastData_SequenceChart_Border25.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/res/SIS_ProductionTrackingData_Overview_Border30.svg b/docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/res/SIS_ProductionTrackingData_Overview_Border30.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/res/SIS_ProductionTrackingData_Overview_Border30.svg rename to docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/res/SIS_ProductionTrackingData_Overview_Border30.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/res/SIS_ProductionTrackingData_SequenceChart_Border25.svg b/docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/res/SIS_ProductionTrackingData_SequenceChart_Border25.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/res/SIS_ProductionTrackingData_SequenceChart_Border25.svg rename to docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/res/SIS_ProductionTrackingData_SequenceChart_Border25.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/res/SIS_ProductionTrackingData_SequenceChart_Border30.svg b/docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/res/SIS_ProductionTrackingData_SequenceChart_Border30.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/res/SIS_ProductionTrackingData_SequenceChart_Border30.svg rename to docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/res/SIS_ProductionTrackingData_SequenceChart_Border30.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/res/SIS_ProduktionForecast_Overview.svg b/docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/res/SIS_ProduktionForecast_Overview.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/res/SIS_ProduktionForecast_Overview.svg rename to docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/res/SIS_ProduktionForecast_Overview.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/res/SIS_ProduktionForecast_SequenceChart.svg b/docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/res/SIS_ProduktionForecast_SequenceChart.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/res/SIS_ProduktionForecast_SequenceChart.svg rename to docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/res/SIS_ProduktionForecast_SequenceChart.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/res/modular-production-onboarding.pdf b/docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/res/modular-production-onboarding.pdf similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Modular Production Kit/res/modular-production-onboarding.pdf rename to docs-kits_versioned_docs/version-24.12/kits/Modular Production Kit/res/modular-production-onboarding.pdf diff --git a/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/OSim-Product-Documentation-EN.pdf b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/OSim-Product-Documentation-EN.pdf new file mode 100755 index 00000000000..191ddc49805 Binary files /dev/null and b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/OSim-Product-Documentation-EN.pdf differ diff --git a/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/Software Development View/01-osim-api.info.mdx b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/Software Development View/01-osim-api.info.mdx similarity index 56% rename from docs-kits_versioned_docs/version-24.05/kits/OSim Kit/Software Development View/01-osim-api.info.mdx rename to docs-kits_versioned_docs/version-24.12/kits/OSim Kit/Software Development View/01-osim-api.info.mdx index 0e0641e9c62..8749caa52b1 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/Software Development View/01-osim-api.info.mdx +++ b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/Software Development View/01-osim-api.info.mdx @@ -1,7 +1,7 @@ --- id: osim-api title: "OSim API" -description: "Osim API for requesting and receiving simulation results as well as for interactions related to scenario management." +description: "OSim API for requesting and receiving simulation results" sidebar_label: Introduction sidebar_position: 0 hide_title: true @@ -13,10 +13,13 @@ import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiDemoPanel/Export"; - - Version: 2.0.0 - +Version: 3.0.0 # OSim API -OSim API for requesting and receiving simulation results as well as for interactions related to scenario management. + + +OSim API for requesting and receiving simulation results + + + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/Software Development View/02-page_software-development-view.md b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/Software Development View/02-page_software-development-view.md new file mode 100644 index 00000000000..024639da235 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/Software Development View/02-page_software-development-view.md @@ -0,0 +1,226 @@ +--- +id: Specification OSim Kit +title: Specification +description: 'OSim Kit' +--- + +![osim kit banner](@site/static/img/OSimKitIcon.svg) + +### OSim Kit + +## Sample Data + +### Sample-1 + +The following example shows the payload used for exchange of simulation results between the OSim partners. The format corresponds with AAS format serialized as a JSON string. + +```json +{ + "materialFlowSimulationResult": { + "owner": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "dataQuality": 0, + "description": "Please simulate asap", + "comment": "successful simulation ", + "expirationTimestamp": "2023-03-24T09:15:24.000Z", + "runId": "0fece48b-c8d1-4180-1a9caca6d67e", + "shipments": [ + { + "handlingUnits": [ + { + "name": "Palette", + "volume": 1, + "weight": 189, + "batches": [ + { + "unitOfMeasurement": "KG", + "materialName": "KK1000GR-Gehäuse-Rot", + "quantity": 0, + "materialNumber": "KK1000GR", + "materialHazardousGoods": false, + "batchSerialNumber": "Batch_1", + "batchOrderId": "Order-0001", + "batchExpirationTimestamp": "2023-08-22T16:00:00.000Z", + "batchNumber": "45" + } + ], + "handlingUnitId": "HUT_1", + "amount": 1 + } + ], + "shipmentId": "DE51515151", + "recipientTimestampPlanned": "2023-04-19T09:00:00.000Z", + "destination": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "recipient": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "logistics": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "preceding": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "splittingAllowed": true, + "destinationTimestamp": "2023-03-19T09:00:00.000Z" + } + ], + "timestamp": "2023-03-09T14:13:42.806Z" + } +} +``` + +### Sample-2 + +The following example shows the payload used for exchange of scenario data between the OSim partners. The format corresponds with AAS format serialized as a JSON string. + +```json +{ + "materialFlowScenarioRequest": { + "scenarioSimResults": { + "resultOwnId": "916b5688-8bd8-4d7e-83b9-e0d40939274e", + "resultOwnSimRunInitial": { + "owner": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "dataQuality": 0, + "description": "Please simulate asap", + "comment": "successful simulation ", + "expirationTimestamp": "2023-03-24T09:15:24.000Z", + "runId": "0fece48b-c8d1-4180-1a9caca6d67e", + "shipments": [ + { + "handlingUnits": [ + { + "name": "Palette", + "volume": 1, + "weight": 189, + "batches": [ + { + "unitOfMeasurement": "KG", + "materialName": "KK1000GR-Gehäuse-Rot", + "quantity": 0, + "materialNumber": "KK1000GR", + "materialHazardousGoods": false, + "batchSerialNumber": "Batch_1", + "batchOrderId": "Order-0001", + "batchExpirationTimestamp": "2023-08-22T16:00:00.000Z", + "batchNumber": "45" + } + ], + "handlingUnitId": "HUT_1", + "amount": 1 + } + ], + "shipmentId": "DE51515151", + "recipientTimestampPlanned": "2023-04-19T09:00:00.000Z", + "destination": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "recipient": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "logistics": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "preceding": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "splittingAllowed": true, + "destinationTimestamp": "2023-03-19T09:00:00.000Z" + } + ], + "timestamp": "2023-03-09T14:13:42.806Z" + }, + "resultOwnSimRunUpdated": { + "owner": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "dataQuality": 0, + "description": "Please simulate asap", + "comment": "successful simulation ", + "expirationTimestamp": "2023-03-24T09:15:24.000Z", + "runId": "0fece48b-c8d1-4180-1a9caca6d67e", + "shipments": [ + { + "handlingUnits": [ + { + "name": "Palette", + "volume": 1, + "weight": 189, + "batches": [ + { + "unitOfMeasurement": "KG", + "materialName": "KK1000GR-Gehäuse-Rot", + "quantity": 0, + "materialNumber": "KK1000GR", + "materialHazardousGoods": false, + "batchSerialNumber": "Batch_1", + "batchOrderId": "Order-0001", + "batchExpirationTimestamp": "2023-08-22T16:00:00.000Z", + "batchNumber": "45" + } + ], + "handlingUnitId": "HUT_1", + "amount": 1 + } + ], + "shipmentId": "DE51515151", + "recipientTimestampPlanned": "2023-04-19T09:00:00.000Z", + "destination": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "recipient": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "logistics": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "preceding": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "splittingAllowed": true, + "destinationTimestamp": "2023-03-19T09:00:00.000Z" + } + ], + "timestamp": "2023-03-09T14:13:42.806Z" + } + }, + "scenarioParameter": [ + { + "unitOfMeasurement": "KG", + "parameterComment": "updated Delivery Date", + "materialName": "KK1000GR-Gehäuse-Rot", + "parameterQuantityUpdated": 1, + "parameterId": "847c71e5-614a-468b-a3a0-674bf2af3004", + "materialNumber": "KK1000GR", + "parameterDeliveryDateUpdated": "2023-10-10T09:00:00.000Z", + "parameterDeliveryDateInitial": "2023-10-09T10:00:00.000Z", + "parameterOrderId": "OID-011123546", + "parameterQuantityInitial": 1 + } + ], + "scenarioHeader": { + "scenarioOwnerRole": "Customer", + "scenarioCreationTimestamp": "2023-10-04T09:10:00.000Z", + "scenarioExpirationTimestamp": "2023-10-07T09:10:00.000Z", + "scenarioOwner": { + "bpnsProperty": "BPNS0123456789ZZ" + }, + "scenarioDescription": "Changes in Delivery Date", + "scenarioId": "8d464b8b-6977-4952-8a22-0489067ca081", + "scenarioTitle": "Delivery Modification" + } + } +} +``` + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Contributors of the Eclipse Foundation +- Source URL: [https://github.com/eclipse-tractusx/eclipse-tractusx.github.io](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io) diff --git a/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/Software Development View/03-request-latest-simulation-result.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/Software Development View/03-request-latest-simulation-result.api.mdx similarity index 90% rename from docs-kits_versioned_docs/version-24.05/kits/OSim Kit/Software Development View/03-request-latest-simulation-result.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/OSim Kit/Software Development View/03-request-latest-simulation-result.api.mdx index 5b864ed924a..54bb3c43705 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/Software Development View/03-request-latest-simulation-result.api.mdx +++ b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/Software Development View/03-request-latest-simulation-result.api.mdx @@ -5,7 +5,7 @@ description: "Request latest simulation result by referring the latest simulatio sidebar_label: "requestLatestSimulationResult" hide_title: true hide_table_of_contents: true -api: {"tags":["requestLatestSimulationResult"],"operationId":"requestLatestSimulationResult","description":"Request latest simulation result by referring the latest simulation run id available in own OSim Manager","parameters":[{"name":"requestId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"8d628899-3e6f-4666-91c3-74ee7ab88b2b"},{"name":"bpns","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"BPNS00000007OTZ3"},{"name":"simulationRunId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"50737df3-4237-4652-b092-1ef8649f6ca6"}],"responses":{"200":{"description":"OK","content":{"text":{"schema":{"type":"string","example":"The request has succeeded. The requestLatestSimulationResult has been successfully processed in the backend system."}}}},"400":{"description":"Bad request","content":{"text":{"schema":{"type":"string","example":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)."}}}},"401":{"description":"Unauthorized","content":{"text":{"schema":{"type":"string","example":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response."}}}},"402":{"description":"Unknown BPNS","content":{"text":{"schema":{"type":"string","example":"The BPNS which is given as parameter is not registered in the data provider database as a direct partner."}}}},"403":{"description":"Forbidden","content":{"text":{"schema":{"type":"string","example":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource."}}}},"404":{"description":"No simulation results are released","content":{"text":{"schema":{"type":"string","example":"Data provider doesn’t have any released simulation results"}}}},"405":{"description":"Method not allowed","content":{"text":{"schema":{"type":"string","example":"The method used to request the data was not GET"}}}},"406":{"description":"No newer simulation available","content":{"text":{"schema":{"type":"string","example":"The simulationRunId which is given as parameter is identical to the currently released simulation run in the data provider database"}}}},"407":{"description":"No shipments planned","content":{"text":{"schema":{"type":"string","example":"No shipments are currently planned for the requestor"}}}},"500":{"description":"Internal server error","content":{"text":{"schema":{"type":"string","example":"The server has encountered a situation it does not know how to handle."}}}},"501":{"description":"Service unavailable","content":{"text":{"schema":{"type":"string","example":"The server is not ready to handle the request."}}}}},"servers":[{"url":"https://{server-url}"}],"method":"get","path":"/api/requestLatestSimulationResult/bpns/{bpns}/requestId/{requestId}/simulationRunId/{simulationRunId}","info":{"title":"OSim API","description":"Osim API for requesting and receiving simulation results as well as for interactions related to scenario management.","version":"2.0.0"},"postman":{"name":"request Latest Simulation Result","description":{"content":"Request latest simulation result by referring the latest simulation run id available in own OSim Manager","type":"text/plain"},"url":{"path":["api","requestLatestSimulationResult","bpns",":bpns","requestId",":requestId","simulationRunId",":simulationRunId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"requestId"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"bpns"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"simulationRunId"}]},"header":[{"key":"Accept","value":"text"}],"method":"GET"}} +api: {"operationId":"requestLatestSimulationResult","tags":["requestLatestSimulationResult"],"description":"Request latest simulation result by referring the latest simulation run id available in own OSim Manager","parameters":[{"name":"requestId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"8d628899-3e6f-4666-91c3-74ee7ab88b2b"},{"name":"bpns","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"BPNS00000007OTZ3"},{"name":"simulationRunId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"50737df3-4237-4652-b092-1ef8649f6ca6"}],"responses":{"200":{"description":"OK","content":{"text":{"schema":{"type":"string","example":"The request has succeeded. The requestLatestSimulationResult has been successfully processed in the backend system."}}}},"400":{"description":"Bad request","content":{"text":{"schema":{"type":"string","example":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)."}}}},"401":{"description":"Unauthorized","content":{"text":{"schema":{"type":"string","example":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response."}}}},"402":{"description":"Unknown BPNS","content":{"text":{"schema":{"type":"string","example":"The BPNS which is given as parameter is not registered in the data provider database as a direct partner."}}}},"403":{"description":"Forbidden","content":{"text":{"schema":{"type":"string","example":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource."}}}},"404":{"description":"No simulation results are released","content":{"text":{"schema":{"type":"string","example":"Data provider doesn’t have any released simulation results"}}}},"405":{"description":"Method not allowed","content":{"text":{"schema":{"type":"string","example":"The method used to request the data was not GET"}}}},"406":{"description":"No newer simulation available","content":{"text":{"schema":{"type":"string","example":"The simulationRunId which is given as parameter is identical to the currently released simulation run in the data provider database"}}}},"407":{"description":"No shipments planned","content":{"text":{"schema":{"type":"string","example":"No shipments are currently planned for the requestor"}}}},"500":{"description":"Internal server error","content":{"text":{"schema":{"type":"string","example":"The server has encountered a situation it does not know how to handle."}}}},"501":{"description":"Service unavailable","content":{"text":{"schema":{"type":"string","example":"The server is not ready to handle the request."}}}}},"servers":[{"url":"https://{server-url}"}],"method":"get","path":"/api/requestLatestSimulationResult/bpns/{bpns}/requestId/{requestId}/simulationRunId/{simulationRunId}","info":{"title":"OSim API","description":"OSim API for requesting and receiving simulation results","version":"3.0.0"},"postman":{"name":"request Latest Simulation Result","description":{"content":"Request latest simulation result by referring the latest simulation run id available in own OSim Manager","type":"text/plain"},"url":{"path":["api","requestLatestSimulationResult","bpns",":bpns","requestId",":requestId","simulationRunId",":simulationRunId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"requestId"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"bpns"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"simulationRunId"}]},"header":[{"key":"Accept","value":"text"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: docs-kits/kits/OSim Kit/Software Development View//osim-api custom_edit_url: null diff --git a/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/Software Development View/04-receive-latest-simulation-result.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/Software Development View/04-receive-latest-simulation-result.api.mdx new file mode 100644 index 00000000000..2b005630c28 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/Software Development View/04-receive-latest-simulation-result.api.mdx @@ -0,0 +1,102 @@ +--- +id: receive-latest-simulation-result +title: "receiveLatestSimulationResult" +description: "Receive latest simulation result which can be stored in own OSim Manager instance" +sidebar_label: "receiveLatestSimulationResult" +hide_title: true +hide_table_of_contents: true +api: {"tags":["receiveLatestSimulationResult"],"description":"Receive latest simulation result which can be stored in own OSim Manager instance","operationId":"receiveLatestSimulationResult","parameters":[{"name":"requestId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"8d628899-3e6f-4666-91c3-74ee7ab88b2b"}],"requestBody":{"content":{"application/json":{"schema":{"required":["comment","dataQuality","description","expirationTimestamp","owner","runId","shipments","timestamp"],"type":"object","properties":{"description":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"runId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"comment":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"expirationTimestamp":{"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))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"owner":{"type":"object","description":"Site identifier of the simulation originator","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#OwnerCharacteristic"},"dataQuality":{"minimum":0,"type":"number","description":"Possible values determining data quality","enum":[0,1,2,3,4,5],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#DataQualityOptions"},"shipments":{"type":"array","description":"List of shipments contained in the simulation","items":{"required":["destination","destinationTimestamp","handlingUnits","logistics","preceding","recipient","recipientTimestampPlanned","shipmentId","splittingAllowed"],"type":"object","properties":{"shipmentId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text"},"destination":{"type":"object","description":"Address where the shipment is immediately delivered to (by logistician) or provided for pickup (by producer)","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#DestinationCharacteristic"},"destinationTimestamp":{"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))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"recipient":{"type":"object","description":"Location identifier of the final recipient of the shipment","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#RecipientCharacteristic"},"recipientTimestampPlanned":{"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))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"splittingAllowed":{"type":"boolean","description":"Represents a boolean value (i.e. a \"flag\").","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Boolean"},"logistics":{"type":"object","description":"Site identifier of the logistician executing the shipment","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#LogisticsCharacteristic"},"preceding":{"type":"object","description":"Reference of preceding shipments","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#PrecedingCharacteristic"},"handlingUnits":{"type":"array","description":"List of handling units included in the shipment","items":{"required":["amount","batches","handlingUnitId","name","volume","weight"],"type":"object","properties":{"handlingUnitId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"name":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"volume":{"type":"number","description":"Volumetric value determining the volume of the handling unit","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#VolumeCharacteristic"},"weight":{"type":"number","description":"Amount of weight of the handling unit","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#WeightCharacteristic"},"amount":{"minimum":1,"type":"number","description":"Number describing handling units with identical pieces","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#AmountCharacteristic"},"batches":{"type":"array","description":"List of material batches","items":{"required":["batchExpirationTimestamp","batchNumber","batchOrderId","batchSerialNumber","materialHazardousGoods","materialName","materialNumber","quantity","unitOfMeasurement"],"type":"object","properties":{"batchSerialNumber":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"materialNumber":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"materialName":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"materialHazardousGoods":{"type":"boolean","description":"Represents a boolean value (i.e. a \"flag\").","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Boolean"},"batchExpirationTimestamp":{"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))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"quantity":{"type":"number","description":"Number of materials contained within a handling unit","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#QuantityCharacteristic"},"unitOfMeasurement":{"type":"string","description":"Possible options for units of measurement","enum":["KG","Liter","Piece"],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#UnitOfMeasurementCharacteristic"},"batchNumber":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"batchOrderId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"}},"description":"Material Batches are part of a handling unit","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#MaterialBatch"},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#BatchList"}},"description":"Handling Unit is the smallest shipment unit and cannot be divided into several shipments","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#HandlingUnit"},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#HandlingUnitList"}},"description":"Delivery item from a sender to a recipient containing goods","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Shipment"},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#ShipmentList"},"timestamp":{"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))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"}},"description":"Characteristic describing the property for a Material Flow Simulation Result","example":{"materialFlowSimulationResult":{"owner":{"bpnsProperty":"BPNS0123456789ZZ"},"dataQuality":0,"description":"Please simulate asap","comment":"successful simulation ","expirationTimestamp":"2023-03-24T09:15:24.000Z","runId":"0fece48b-c8d1-4180-1a9caca6d67e","shipments":[{"handlingUnits":[{"name":"Palette","volume":1,"weight":189,"batches":[{"unitOfMeasurement":"KG","materialName":"KK1000GR-Gehäuse-Rot","quantity":50,"materialNumber":"KK1000GR","materialHazardousGoods":false,"batchSerialNumber":"Batch_1","batchOrderId":"Order-0001","batchExpirationTimestamp":"2023-08-22T16:00:00.000Z","batchNumber":"45"}],"handlingUnitId":"HUT_1","amount":1}],"shipmentId":"DE51515151","recipientTimestampPlanned":"2023-04-19T09:00:00.000Z","destination":{"bpnsProperty":"BPNS0123456789ZZ"},"recipient":{"bpnsProperty":"BPNS0123456789ZZ"},"logistics":{"bpnsProperty":"BPNS0123456789ZZ"},"preceding":{"bpnsProperty":"BPNS0123456789ZZ"},"splittingAllowed":true,"destinationTimestamp":"2023-03-19T09:00:00.000Z"}],"timestamp":"2023-03-09T14:13:42.806Z"}},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#SimResult"}}}},"responses":{"200":{"description":"OK","content":{"text":{"schema":{"type":"string","example":"The POST has succeeded. The receiveLatestSimulationResult has been successfully processed in the backend system."}}}},"400":{"description":"Bad request","content":{"text":{"schema":{"type":"string","example":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)."}}}},"401":{"description":"Unauthorized","content":{"text":{"schema":{"type":"string","example":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response."}}}},"402":{"description":"Payload is empty","content":{"text":{"schema":{"type":"string","example":"The payload of the API call is empty."}}}},"403":{"description":"Forbidden","content":{"text":{"schema":{"type":"string","example":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource."}}}},"404":{"description":"Payload structure unknown","content":{"text":{"schema":{"type":"string","example":"The payload structure is unknown or correspond not to the defined semantic model"}}}},"405":{"description":"Method not allowed","content":{"text":{"schema":{"type":"string","example":"The method used to receive the data was not POST"}}}},"406":{"description":"Payload content invalid","content":{"text":{"schema":{"type":"string","example":"The content of the payload is invalid. E.g. “owner unknown”"}}}},"500":{"description":"Internal server error","content":{"text":{"schema":{"type":"string","example":"The server has encountered a situation it does not know how to handle."}}}},"501":{"description":"Service unavailable","content":{"text":{"schema":{"type":"string","example":"The server is not ready to handle the request."}}}}},"servers":[{"url":"https://{server-url}"}],"method":"post","path":"/api/receiveLatestSimulationResult/requestId/{requestId}","jsonRequestBodyExample":{"materialFlowSimulationResult":{"owner":{"bpnsProperty":"BPNS0123456789ZZ"},"dataQuality":0,"description":"Please simulate asap","comment":"successful simulation ","expirationTimestamp":"2023-03-24T09:15:24.000Z","runId":"0fece48b-c8d1-4180-1a9caca6d67e","shipments":[{"handlingUnits":[{"name":"Palette","volume":1,"weight":189,"batches":[{"unitOfMeasurement":"KG","materialName":"KK1000GR-Gehäuse-Rot","quantity":50,"materialNumber":"KK1000GR","materialHazardousGoods":false,"batchSerialNumber":"Batch_1","batchOrderId":"Order-0001","batchExpirationTimestamp":"2023-08-22T16:00:00.000Z","batchNumber":"45"}],"handlingUnitId":"HUT_1","amount":1}],"shipmentId":"DE51515151","recipientTimestampPlanned":"2023-04-19T09:00:00.000Z","destination":{"bpnsProperty":"BPNS0123456789ZZ"},"recipient":{"bpnsProperty":"BPNS0123456789ZZ"},"logistics":{"bpnsProperty":"BPNS0123456789ZZ"},"preceding":{"bpnsProperty":"BPNS0123456789ZZ"},"splittingAllowed":true,"destinationTimestamp":"2023-03-19T09:00:00.000Z"}],"timestamp":"2023-03-09T14:13:42.806Z"}},"info":{"title":"OSim API","description":"OSim API for requesting and receiving simulation results","version":"3.0.0"},"postman":{"name":"receive Latest Simulation Result","description":{"content":"Receive latest simulation result which can be stored in own OSim Manager instance","type":"text/plain"},"url":{"path":["api","receiveLatestSimulationResult","requestId",":requestId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"requestId"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: docs-kits/kits/OSim Kit/Software Development View//osim-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## receiveLatestSimulationResult + + + +Receive latest simulation result which can be stored in own OSim Manager instance + +
          Path Parameters
          Request Body
            owner object
            + +Characteristic describing the Scenario Owner + +
            shipments object[] required
            + +List of shipments contained in the simulation + +
            destination object
            + +Characteristic describing the Scenario Owner + +
            recipient object
            + +Characteristic describing the Scenario Owner + +
            logistics object
            + +Characteristic describing the Scenario Owner + +
            preceding object
            + +Characteristic describing the Scenario Owner + +
            handlingUnits object[] required
            + +List of handling units included in the shipment + +
            = 1`"} defaultValue={undefined}>
            batches object[] required
            + +List of material batches + +
          + +OK + +
          Schema
          • string
          + +Bad request + +
          Schema
          • string
          + +Unauthorized + +
          Schema
          • string
          + +Payload is empty + +
          Schema
          • string
          + +Forbidden + +
          Schema
          • string
          + +Payload structure unknown + +
          Schema
          • string
          + +Method not allowed + +
          Schema
          • string
          + +Payload content invalid + +
          Schema
          • string
          + +Internal server error + +
          Schema
          • string
          + +Service unavailable + +
          Schema
          • string
          + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/Software Development View/05-request-scenario-feedback.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/Software Development View/05-request-scenario-feedback.api.mdx new file mode 100644 index 00000000000..abca7415abc --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/Software Development View/05-request-scenario-feedback.api.mdx @@ -0,0 +1,154 @@ +--- +id: request-scenario-feedback +title: "requestScenarioFeedback" +description: "The requestScenarioFeedback is a request from a OSim partner for feedback on the possible fulfillment of the described scenario." +sidebar_label: "requestScenarioFeedback" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"requestScenarioFeedback","tags":["requestScenarioFeedback"],"description":"The requestScenarioFeedback is a request from a OSim partner for feedback on the possible fulfillment of the described scenario.","parameters":[{"name":"bpns","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"BPNS00000007OTZ3"}],"requestBody":{"content":{"application/json":{"schema":{"required":["materialFlowScenarioRequest"],"type":"object","properties":{"materialFlowScenarioRequest":{"required":["scenarioHeader","scenarioSimResults"],"type":"object","properties":{"scenarioHeader":{"required":["scenarioCreationTimestamp","scenarioExpirationTimestamp","scenarioId","scenarioOwner","scenarioOwnerRole","scenarioTitle"],"type":"object","properties":{"scenarioId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text"},"scenarioTitle":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text"},"scenarioCreationTimestamp":{"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))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"scenarioExpirationTimestamp":{"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))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"scenarioOwner":{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"},"scenarioOwnerRole":{"type":"string","description":"Characteristic describing possible values for the role of the scenario owner","enum":["Customer","Supplier","LogisticianReceiving","LogisticianSending"],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerRoleCharacteristic"},"scenarioDescription":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text"}},"description":"Characteristic describing the parameter for a scenario header","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioHeaderCharacteristic"},"scenarioParameter":{"type":"array","description":"Characteristic describing the scenario parameter","items":{"required":["materialName","materialNumber","parameterComment","parameterDeliveryDateInitial","parameterDeliveryDateUpdated","parameterId","parameterOrderId","parameterQuantityInitial","parameterQuantityUpdated","unitOfMeasurement"],"type":"object","properties":{"parameterId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text"},"parameterDeliveryDateInitial":{"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))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"parameterDeliveryDateUpdated":{"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))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"parameterQuantityInitial":{"type":"number","description":"Describes a property which is a Float","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#QuantityCharacteristic"},"parameterQuantityUpdated":{"type":"number","description":"Describes a property which is a Float","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#QuantityCharacteristic"},"parameterOrderId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text"},"parameterComment":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text"},"materialNumber":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"materialName":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"unitOfMeasurement":{"type":"string","description":"Possible options for units of measurement","enum":["KG","Liter","Piece"],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#UnitOfMeasurementCharacteristic"}},"description":"Parameters which are used to describe a material flow scenario request","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioParameter"},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioParameterCharacteristic"},"scenarioSimResults":{"required":["resultOwnId"],"type":"object","properties":{"resultOwnId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text"},"resultOwnSimRunInitial":{"required":["comment","dataQuality","description","expirationTimestamp","owner","runId","shipments","timestamp"],"type":"object","properties":{"description":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"runId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"comment":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"expirationTimestamp":{"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))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"owner":{"type":"object","description":"Site identifier of the simulation originator","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#OwnerCharacteristic"},"dataQuality":{"minimum":0,"type":"number","description":"Possible values determining data quality","enum":[0,1,2,3,4,5],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#DataQualityOptions"},"shipments":{"type":"array","description":"List of shipments contained in the simulation","items":{"required":["destination","destinationTimestamp","handlingUnits","logistics","preceding","recipient","recipientTimestampPlanned","shipmentId","splittingAllowed"],"type":"object","properties":{"shipmentId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text"},"destination":{"type":"object","description":"Address where the shipment is immediately delivered to (by logistician) or provided for pickup (by producer)","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#DestinationCharacteristic"},"destinationTimestamp":{"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))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"recipient":{"type":"object","description":"Location identifier of the final recipient of the shipment","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#RecipientCharacteristic"},"recipientTimestampPlanned":{"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))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"splittingAllowed":{"type":"boolean","description":"Represents a boolean value (i.e. a \"flag\").","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Boolean"},"logistics":{"type":"object","description":"Site identifier of the logistician executing the shipment","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#LogisticsCharacteristic"},"preceding":{"type":"object","description":"Reference of preceding shipments","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#PrecedingCharacteristic"},"handlingUnits":{"type":"array","description":"List of handling units included in the shipment","items":{"required":["amount","batches","handlingUnitId","name","volume","weight"],"type":"object","properties":{"handlingUnitId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"name":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"volume":{"type":"number","description":"Volumetric value determining the volume of the handling unit","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#VolumeCharacteristic"},"weight":{"type":"number","description":"Amount of weight of the handling unit","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#WeightCharacteristic"},"amount":{"minimum":1,"type":"number","description":"Number describing handling units with identical pieces","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#AmountCharacteristic"},"batches":{"type":"array","description":"List of material batches","items":{"required":["batchExpirationTimestamp","batchNumber","batchOrderId","batchSerialNumber","materialHazardousGoods","materialName","materialNumber","quantity","unitOfMeasurement"],"type":"object","properties":{"batchSerialNumber":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"materialNumber":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"materialName":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"materialHazardousGoods":{"type":"boolean","description":"Represents a boolean value (i.e. a \"flag\").","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Boolean"},"batchExpirationTimestamp":{"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))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"quantity":{"type":"number","description":"Number of materials contained within a handling unit","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#QuantityCharacteristic"},"unitOfMeasurement":{"type":"string","description":"Possible options for units of measurement","enum":["KG","Liter","Piece"],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#UnitOfMeasurementCharacteristic"},"batchNumber":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"batchOrderId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"}},"description":"Material Batches are part of a handling unit","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#MaterialBatch"},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#BatchList"}},"description":"Handling Unit is the smallest shipment unit and cannot be divided into several shipments","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#HandlingUnit"},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#HandlingUnitList"}},"description":"Delivery item from a sender to a recipient containing goods","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Shipment"},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#ShipmentList"},"timestamp":{"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))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"}},"description":"Characteristic describing the property for a Material Flow Simulation Result","example":{"materialFlowSimulationResult":{"owner":{"bpnsProperty":"BPNS0123456789ZZ"},"dataQuality":0,"description":"Please simulate asap","comment":"successful simulation ","expirationTimestamp":"2023-03-24T09:15:24.000Z","runId":"0fece48b-c8d1-4180-1a9caca6d67e","shipments":[{"handlingUnits":[{"name":"Palette","volume":1,"weight":189,"batches":[{"unitOfMeasurement":"KG","materialName":"KK1000GR-Gehäuse-Rot","quantity":50,"materialNumber":"KK1000GR","materialHazardousGoods":false,"batchSerialNumber":"Batch_1","batchOrderId":"Order-0001","batchExpirationTimestamp":"2023-08-22T16:00:00.000Z","batchNumber":"45"}],"handlingUnitId":"HUT_1","amount":1}],"shipmentId":"DE51515151","recipientTimestampPlanned":"2023-04-19T09:00:00.000Z","destination":{"bpnsProperty":"BPNS0123456789ZZ"},"recipient":{"bpnsProperty":"BPNS0123456789ZZ"},"logistics":{"bpnsProperty":"BPNS0123456789ZZ"},"preceding":{"bpnsProperty":"BPNS0123456789ZZ"},"splittingAllowed":true,"destinationTimestamp":"2023-03-19T09:00:00.000Z"}],"timestamp":"2023-03-09T14:13:42.806Z"}},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#SimResult"},"resultOwnSimRunUpdated":{"required":["comment","dataQuality","description","expirationTimestamp","owner","runId","shipments","timestamp"],"type":"object","properties":{"description":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"runId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"comment":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"expirationTimestamp":{"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))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"owner":{"type":"object","description":"Site identifier of the simulation originator","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#OwnerCharacteristic"},"dataQuality":{"minimum":0,"type":"number","description":"Possible values determining data quality","enum":[0,1,2,3,4,5],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#DataQualityOptions"},"shipments":{"type":"array","description":"List of shipments contained in the simulation","items":{"required":["destination","destinationTimestamp","handlingUnits","logistics","preceding","recipient","recipientTimestampPlanned","shipmentId","splittingAllowed"],"type":"object","properties":{"shipmentId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text"},"destination":{"type":"object","description":"Address where the shipment is immediately delivered to (by logistician) or provided for pickup (by producer)","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#DestinationCharacteristic"},"destinationTimestamp":{"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))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"recipient":{"type":"object","description":"Location identifier of the final recipient of the shipment","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#RecipientCharacteristic"},"recipientTimestampPlanned":{"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))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"splittingAllowed":{"type":"boolean","description":"Represents a boolean value (i.e. a \"flag\").","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Boolean"},"logistics":{"type":"object","description":"Site identifier of the logistician executing the shipment","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#LogisticsCharacteristic"},"preceding":{"type":"object","description":"Reference of preceding shipments","allOf":[{"required":["bpnsProperty"],"type":"object","properties":{"bpnsProperty":{"pattern":"^BPNS[a-zA-Z0-9]{12}$","type":"string","description":"The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two alphanumeric letters.","x-samm-aspect-model-urn":"urn:samm:io.catenax.shared.business_partner_number:2.0.0#BpnsTrait"}},"description":"Characteristic describing the Scenario Owner","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioOwnerCharacteristic"}],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#PrecedingCharacteristic"},"handlingUnits":{"type":"array","description":"List of handling units included in the shipment","items":{"required":["amount","batches","handlingUnitId","name","volume","weight"],"type":"object","properties":{"handlingUnitId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"name":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"volume":{"type":"number","description":"Volumetric value determining the volume of the handling unit","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#VolumeCharacteristic"},"weight":{"type":"number","description":"Amount of weight of the handling unit","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#WeightCharacteristic"},"amount":{"minimum":1,"type":"number","description":"Number describing handling units with identical pieces","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#AmountCharacteristic"},"batches":{"type":"array","description":"List of material batches","items":{"required":["batchExpirationTimestamp","batchNumber","batchOrderId","batchSerialNumber","materialHazardousGoods","materialName","materialNumber","quantity","unitOfMeasurement"],"type":"object","properties":{"batchSerialNumber":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"materialNumber":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"materialName":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"materialHazardousGoods":{"type":"boolean","description":"Represents a boolean value (i.e. a \"flag\").","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Boolean"},"batchExpirationTimestamp":{"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))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"},"quantity":{"type":"number","description":"Number of materials contained within a handling unit","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#QuantityCharacteristic"},"unitOfMeasurement":{"type":"string","description":"Possible options for units of measurement","enum":["KG","Liter","Piece"],"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#UnitOfMeasurementCharacteristic"},"batchNumber":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"},"batchOrderId":{"type":"string","description":"Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc.","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Text"}},"description":"Material Batches are part of a handling unit","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#MaterialBatch"},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#BatchList"}},"description":"Handling Unit is the smallest shipment unit and cannot be divided into several shipments","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#HandlingUnit"},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#HandlingUnitList"}},"description":"Delivery item from a sender to a recipient containing goods","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#Shipment"},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_simulation_result:3.0.0#ShipmentList"},"timestamp":{"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))?","type":"string","description":"Describes a Property which contains the date and time with an optional timezone.","x-samm-aspect-model-urn":"urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp"}},"description":"Characteristic describing the property for a Material Flow Simulation Result","example":{"materialFlowSimulationResult":{"owner":{"bpnsProperty":"BPNS0123456789ZZ"},"dataQuality":0,"description":"Please simulate asap","comment":"successful simulation ","expirationTimestamp":"2023-03-24T09:15:24.000Z","runId":"0fece48b-c8d1-4180-1a9caca6d67e","shipments":[{"handlingUnits":[{"name":"Palette","volume":1,"weight":189,"batches":[{"unitOfMeasurement":"KG","materialName":"KK1000GR-Gehäuse-Rot","quantity":50,"materialNumber":"KK1000GR","materialHazardousGoods":false,"batchSerialNumber":"Batch_1","batchOrderId":"Order-0001","batchExpirationTimestamp":"2023-08-22T16:00:00.000Z","batchNumber":"45"}],"handlingUnitId":"HUT_1","amount":1}],"shipmentId":"DE51515151","recipientTimestampPlanned":"2023-04-19T09:00:00.000Z","destination":{"bpnsProperty":"BPNS0123456789ZZ"},"recipient":{"bpnsProperty":"BPNS0123456789ZZ"},"logistics":{"bpnsProperty":"BPNS0123456789ZZ"},"preceding":{"bpnsProperty":"BPNS0123456789ZZ"},"splittingAllowed":true,"destinationTimestamp":"2023-03-19T09:00:00.000Z"}],"timestamp":"2023-03-09T14:13:42.806Z"}},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#SimResult"}},"description":"Characteristic for simulation results","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#ScenarioSimResultsCharacteristic"}},"description":"Characteristic describing the aspect Material Flow Scenario Request","example":{"materialFlowScenarioRequest":{"scenarioSimResults":{"resultOwnId":"916b5688-8bd8-4d7e-83b9-e0d40939274e","resultOwnSimRunInitial":{"owner":{"bpnsProperty":"BPNS0123456789ZZ"},"dataQuality":0,"description":"Please simulate asap","comment":"successful simulation ","expirationTimestamp":"2023-03-24T09:15:24.000Z","runId":"0fece48b-c8d1-4180-1a9caca6d67e","shipments":[{"handlingUnits":[{"name":"Palette","volume":1,"weight":189,"batches":[{"unitOfMeasurement":"KG","materialName":"KK1000GR-Gehäuse-Rot","quantity":50,"materialNumber":"KK1000GR","materialHazardousGoods":false,"batchSerialNumber":"Batch_1","batchOrderId":"Order-0001","batchExpirationTimestamp":"2023-08-22T16:00:00.000Z","batchNumber":"45"}],"handlingUnitId":"HUT_1","amount":1}],"shipmentId":"DE51515151","recipientTimestampPlanned":"2023-04-19T09:00:00.000Z","destination":{"bpnsProperty":"BPNS0123456789ZZ"},"recipient":{"bpnsProperty":"BPNS0123456789ZZ"},"logistics":{"bpnsProperty":"BPNS0123456789ZZ"},"preceding":{"bpnsProperty":"BPNS0123456789ZZ"},"splittingAllowed":true,"destinationTimestamp":"2023-03-19T09:00:00.000Z"}],"timestamp":"2023-03-09T14:13:42.806Z"},"resultOwnSimRunUpdated":{"owner":{"bpnsProperty":"BPNS0123456789ZZ"},"dataQuality":0,"description":"Please simulate asap","comment":"successful simulation ","expirationTimestamp":"2023-03-24T09:15:24.000Z","runId":"0fece48b-c8d1-4180-1a9caca6d67e","shipments":[{"handlingUnits":[{"name":"Palette","volume":1,"weight":189,"batches":[{"unitOfMeasurement":"KG","materialName":"KK1000GR-Gehäuse-Rot","quantity":50,"materialNumber":"KK1000GR","materialHazardousGoods":false,"batchSerialNumber":"Batch_1","batchOrderId":"Order-0001","batchExpirationTimestamp":"2023-08-22T16:00:00.000Z","batchNumber":"45"}],"handlingUnitId":"HUT_1","amount":1}],"shipmentId":"DE51515151","recipientTimestampPlanned":"2023-04-19T09:00:00.000Z","destination":{"bpnsProperty":"BPNS0123456789ZZ"},"recipient":{"bpnsProperty":"BPNS0123456789ZZ"},"logistics":{"bpnsProperty":"BPNS0123456789ZZ"},"preceding":{"bpnsProperty":"BPNS0123456789ZZ"},"splittingAllowed":true,"destinationTimestamp":"2023-03-19T09:00:00.000Z"}],"timestamp":"2023-03-09T14:13:42.806Z"}},"scenarioParameter":[{"unitOfMeasurement":"KG","parameterComment":"updated Delivery Date","materialName":"KK1000GR-Gehäuse-Rot","parameterQuantityUpdated":1,"parameterId":"847c71e5-614a-468b-a3a0-674bf2af3004","materialNumber":"KK1000GR","parameterDeliveryDateUpdated":"2023-10-10T09:00:00.000Z","parameterDeliveryDateInitial":"2023-10-09T10:00:00.000Z","parameterOrderId":"OID-011123546","parameterQuantityInitial":1}],"scenarioHeader":{"scenarioOwnerRole":"Customer","scenarioCreationTimestamp":"2023-10-04T09:10:00.000Z","scenarioExpirationTimestamp":"2023-10-07T09:10:00.000Z","scenarioOwner":{"bpnsProperty":"BPNS0123456789ZZ"},"scenarioDescription":"Changes in Delivery Date","scenarioId":"8d464b8b-6977-4952-8a22-0489067ca081","scenarioTitle":"Delivery Modification"}}},"x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#MaterialFlowScenarioRequestCharacteristic"}},"description":"Aspect model describing the Material Flow Scenario Request","x-samm-aspect-model-urn":"urn:samm:io.catenax.material_flow_scenario_request:2.0.0#MaterialFlowScenarioRequestAspect"}}}},"responses":{"200":{"description":"OK","content":{"text":{"schema":{"type":"string","example":"The request has succeeded. The requestScenarioFeedback has been successfully processed in the backend system."}}}},"400":{"description":"Bad request","content":{"text":{"schema":{"type":"string","example":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)."}}}},"401":{"description":"Unauthorized","content":{"text":{"schema":{"type":"string","example":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response."}}}},"402":{"description":"Unknown BPNS","content":{"text":{"schema":{"type":"string","example":"The BPNS which is given as parameter is not registered in the data provider database as a direct partner."}}}},"403":{"description":"Forbidden","content":{"text":{"schema":{"type":"string","example":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource."}}}},"405":{"description":"Method not allowed","content":{"text":{"schema":{"type":"string","example":"The method used to request a scenario feedback was not POST"}}}},"500":{"description":"Internal server error","content":{"text":{"schema":{"type":"string","example":"The server has encountered a situation it does not know how to handle."}}}},"501":{"description":"Service unavailable","content":{"text":{"schema":{"type":"string","example":"The server is not ready to handle the request."}}}}},"servers":[{"url":"https://{server-url}"}],"method":"post","path":"/api/requestScenarioFeedback/bpns/{bpns}","jsonRequestBodyExample":{"materialFlowScenarioRequest":{"materialFlowScenarioRequest":{"scenarioSimResults":{"resultOwnId":"916b5688-8bd8-4d7e-83b9-e0d40939274e","resultOwnSimRunInitial":{"owner":{"bpnsProperty":"BPNS0123456789ZZ"},"dataQuality":0,"description":"Please simulate asap","comment":"successful simulation ","expirationTimestamp":"2023-03-24T09:15:24.000Z","runId":"0fece48b-c8d1-4180-1a9caca6d67e","shipments":[{"handlingUnits":[{"name":"Palette","volume":1,"weight":189,"batches":[{"unitOfMeasurement":"KG","materialName":"KK1000GR-Gehäuse-Rot","quantity":50,"materialNumber":"KK1000GR","materialHazardousGoods":false,"batchSerialNumber":"Batch_1","batchOrderId":"Order-0001","batchExpirationTimestamp":"2023-08-22T16:00:00.000Z","batchNumber":"45"}],"handlingUnitId":"HUT_1","amount":1}],"shipmentId":"DE51515151","recipientTimestampPlanned":"2023-04-19T09:00:00.000Z","destination":{"bpnsProperty":"BPNS0123456789ZZ"},"recipient":{"bpnsProperty":"BPNS0123456789ZZ"},"logistics":{"bpnsProperty":"BPNS0123456789ZZ"},"preceding":{"bpnsProperty":"BPNS0123456789ZZ"},"splittingAllowed":true,"destinationTimestamp":"2023-03-19T09:00:00.000Z"}],"timestamp":"2023-03-09T14:13:42.806Z"},"resultOwnSimRunUpdated":{"owner":{"bpnsProperty":"BPNS0123456789ZZ"},"dataQuality":0,"description":"Please simulate asap","comment":"successful simulation ","expirationTimestamp":"2023-03-24T09:15:24.000Z","runId":"0fece48b-c8d1-4180-1a9caca6d67e","shipments":[{"handlingUnits":[{"name":"Palette","volume":1,"weight":189,"batches":[{"unitOfMeasurement":"KG","materialName":"KK1000GR-Gehäuse-Rot","quantity":50,"materialNumber":"KK1000GR","materialHazardousGoods":false,"batchSerialNumber":"Batch_1","batchOrderId":"Order-0001","batchExpirationTimestamp":"2023-08-22T16:00:00.000Z","batchNumber":"45"}],"handlingUnitId":"HUT_1","amount":1}],"shipmentId":"DE51515151","recipientTimestampPlanned":"2023-04-19T09:00:00.000Z","destination":{"bpnsProperty":"BPNS0123456789ZZ"},"recipient":{"bpnsProperty":"BPNS0123456789ZZ"},"logistics":{"bpnsProperty":"BPNS0123456789ZZ"},"preceding":{"bpnsProperty":"BPNS0123456789ZZ"},"splittingAllowed":true,"destinationTimestamp":"2023-03-19T09:00:00.000Z"}],"timestamp":"2023-03-09T14:13:42.806Z"}},"scenarioParameter":[{"unitOfMeasurement":"KG","parameterComment":"updated Delivery Date","materialName":"KK1000GR-Gehäuse-Rot","parameterQuantityUpdated":1,"parameterId":"847c71e5-614a-468b-a3a0-674bf2af3004","materialNumber":"KK1000GR","parameterDeliveryDateUpdated":"2023-10-10T09:00:00.000Z","parameterDeliveryDateInitial":"2023-10-09T10:00:00.000Z","parameterOrderId":"OID-011123546","parameterQuantityInitial":1}],"scenarioHeader":{"scenarioOwnerRole":"Customer","scenarioCreationTimestamp":"2023-10-04T09:10:00.000Z","scenarioExpirationTimestamp":"2023-10-07T09:10:00.000Z","scenarioOwner":{"bpnsProperty":"BPNS0123456789ZZ"},"scenarioDescription":"Changes in Delivery Date","scenarioId":"8d464b8b-6977-4952-8a22-0489067ca081","scenarioTitle":"Delivery Modification"}}}},"info":{"title":"OSim API","description":"OSim API for requesting and receiving simulation results","version":"3.0.0"},"postman":{"name":"request Scenario Feedback","description":{"content":"The requestScenarioFeedback is a request from a OSim partner for feedback on the possible fulfillment of the described scenario.","type":"text/plain"},"url":{"path":["api","requestScenarioFeedback","bpns",":bpns"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"bpns"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +sidebar_class_name: "post api-method" +info_path: docs-kits/kits/OSim Kit/Software Development View//osim-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import TabItem from "@theme/TabItem"; + +## requestScenarioFeedback + + + +The requestScenarioFeedback is a request from a OSim partner for feedback on the possible fulfillment of the described scenario. + +
          Path Parameters
          Request Body
            materialFlowScenarioRequest object required
            + +Characteristic describing the aspect Material Flow Scenario Request + +
            scenarioHeader object required
            + +Characteristic describing the parameter for a scenario header + +
            scenarioOwner object required
            + +Characteristic describing the Scenario Owner + +
            scenarioParameter object[]
            + +Characteristic describing the scenario parameter + +
            scenarioSimResults object required
            + +Characteristic for simulation results + +
            resultOwnSimRunInitial object
            + +Characteristic describing the property for a Material Flow Simulation Result + +
            owner object
            + +Characteristic describing the Scenario Owner + +
            shipments object[] required
            + +List of shipments contained in the simulation + +
            destination object
            + +Characteristic describing the Scenario Owner + +
            recipient object
            + +Characteristic describing the Scenario Owner + +
            logistics object
            + +Characteristic describing the Scenario Owner + +
            preceding object
            + +Characteristic describing the Scenario Owner + +
            handlingUnits object[] required
            + +List of handling units included in the shipment + +
            = 1`"} defaultValue={undefined}>
            batches object[] required
            + +List of material batches + +
            resultOwnSimRunUpdated object
            + +Characteristic describing the property for a Material Flow Simulation Result + +
            owner object
            + +Characteristic describing the Scenario Owner + +
            shipments object[] required
            + +List of shipments contained in the simulation + +
            destination object
            + +Characteristic describing the Scenario Owner + +
            recipient object
            + +Characteristic describing the Scenario Owner + +
            logistics object
            + +Characteristic describing the Scenario Owner + +
            preceding object
            + +Characteristic describing the Scenario Owner + +
            handlingUnits object[] required
            + +List of handling units included in the shipment + +
            = 1`"} defaultValue={undefined}>
            batches object[] required
            + +List of material batches + +
          + +OK + +
          Schema
          • string
          + +Bad request + +
          Schema
          • string
          + +Unauthorized + +
          Schema
          • string
          + +Unknown BPNS + +
          Schema
          • string
          + +Forbidden + +
          Schema
          • string
          + +Method not allowed + +
          Schema
          • string
          + +Internal server error + +
          Schema
          • string
          + +Service unavailable + +
          Schema
          • string
          + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/Software Development View/06-receive-scenario-feedback.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/Software Development View/06-receive-scenario-feedback.api.mdx similarity index 90% rename from docs-kits_versioned_docs/version-24.05/kits/OSim Kit/Software Development View/06-receive-scenario-feedback.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/OSim Kit/Software Development View/06-receive-scenario-feedback.api.mdx index 102bb1861e4..880ebbd4405 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/Software Development View/06-receive-scenario-feedback.api.mdx +++ b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/Software Development View/06-receive-scenario-feedback.api.mdx @@ -5,7 +5,7 @@ description: "The receiveScenarioFeedback enables the requestor to transmit the sidebar_label: "receiveScenarioFeedback" hide_title: true hide_table_of_contents: true -api: {"tags":["receiveScenarioFeedback"],"operationId":"receiveScenarioFeedback","description":"The receiveScenarioFeedback enables the requestor to transmit the result of his scenario-based evaluation to the requestor","parameters":[{"name":"bpns","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"BPNS00000007OTZ3"},{"name":"scenarioId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"50737df3-4237-4652-b092-1ef8649f6ca6"},{"name":"feedback","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["Realizable","NotRealizable"]},"example":"Realizable"}],"responses":{"200":{"description":"OK","content":{"text":{"schema":{"type":"string","example":"The GET request has succeeded. The receiveScenarioFeedback has been successfully processed in the backend system."}}}},"400":{"description":"Bad request","content":{"text":{"schema":{"type":"string","example":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)."}}}},"401":{"description":"Unauthorized","content":{"text":{"schema":{"type":"string","example":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response."}}}},"402":{"description":"Unknown BPNS","content":{"text":{"schema":{"type":"string","example":"The BPNS which is given as parameter is not registered in the data provider database as a direct partner."}}}},"403":{"description":"Forbidden","content":{"text":{"schema":{"type":"string","example":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource."}}}},"405":{"description":"Method not allowed","content":{"text":{"schema":{"type":"string","example":"The method used to request a scenario feedback was not GET"}}}},"406":{"description":"Unknown Scenario","content":{"text":{"schema":{"type":"string","example":"The scenarioID which is given as parameter is not registered."}}}},"407":{"description":"Unknown State","content":{"text":{"schema":{"type":"string","example":"The feedbackState value is unknown."}}}},"500":{"description":"Internal server error","content":{"text":{"schema":{"type":"string","example":"The server has encountered a situation it does not know how to handle."}}}},"501":{"description":"Service unavailable","content":{"text":{"schema":{"type":"string","example":"The server is not ready to handle the request."}}}}},"servers":[{"url":"https://{server-url}"}],"method":"get","path":"/api/receiveScenarioFeedback/bpns/{bpns}/scenarioId/{scenarioId}/feedback/{feedback}","info":{"title":"OSim API","description":"Osim API for requesting and receiving simulation results as well as for interactions related to scenario management.","version":"2.0.0"},"postman":{"name":"receive Scenario Feedback","description":{"content":"The receiveScenarioFeedback enables the requestor to transmit the result of his scenario-based evaluation to the requestor","type":"text/plain"},"url":{"path":["api","receiveScenarioFeedback","bpns",":bpns","scenarioId",":scenarioId","feedback",":feedback"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"bpns"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"scenarioId"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"feedback"}]},"header":[{"key":"Accept","value":"text"}],"method":"GET"}} +api: {"operationId":"receiveScenarioFeedback","tags":["receiveScenarioFeedback"],"description":"The receiveScenarioFeedback enables the requestor to transmit the result of his scenario-based evaluation to the requestor","parameters":[{"name":"bpns","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"BPNS00000007OTZ3"},{"name":"scenarioId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"50737df3-4237-4652-b092-1ef8649f6ca6"},{"name":"feedback","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["Realizable","NotRealizable"]},"example":"Realizable"}],"responses":{"200":{"description":"OK","content":{"text":{"schema":{"type":"string","example":"The GET request has succeeded. The receiveScenarioFeedback has been successfully processed in the backend system."}}}},"400":{"description":"Bad request","content":{"text":{"schema":{"type":"string","example":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)."}}}},"401":{"description":"Unauthorized","content":{"text":{"schema":{"type":"string","example":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response."}}}},"402":{"description":"Unknown BPNS","content":{"text":{"schema":{"type":"string","example":"The BPNS which is given as parameter is not registered in the data provider database as a direct partner."}}}},"403":{"description":"Forbidden","content":{"text":{"schema":{"type":"string","example":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource."}}}},"405":{"description":"Method not allowed","content":{"text":{"schema":{"type":"string","example":"The method used to request a scenario feedback was not GET"}}}},"406":{"description":"Unknown Scenario","content":{"text":{"schema":{"type":"string","example":"The scenarioID which is given as parameter is not registered."}}}},"407":{"description":"Unknown State","content":{"text":{"schema":{"type":"string","example":"The feedbackState value is unknown."}}}},"500":{"description":"Internal server error","content":{"text":{"schema":{"type":"string","example":"The server has encountered a situation it does not know how to handle."}}}},"501":{"description":"Service unavailable","content":{"text":{"schema":{"type":"string","example":"The server is not ready to handle the request."}}}}},"servers":[{"url":"https://{server-url}"}],"method":"get","path":"/api/receiveScenarioFeedback/bpns/{bpns}/scenarioId/{scenarioId}/feedback/{feedback}","info":{"title":"OSim API","description":"OSim API for requesting and receiving simulation results","version":"3.0.0"},"postman":{"name":"receive Scenario Feedback","description":{"content":"The receiveScenarioFeedback enables the requestor to transmit the result of his scenario-based evaluation to the requestor","type":"text/plain"},"url":{"path":["api","receiveScenarioFeedback","bpns",":bpns","scenarioId",":scenarioId","feedback",":feedback"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"bpns"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"scenarioId"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"feedback"}]},"header":[{"key":"Accept","value":"text"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: docs-kits/kits/OSim Kit/Software Development View//osim-api custom_edit_url: null diff --git a/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/Software Development View/07-push-scenario-state.api.mdx b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/Software Development View/07-push-scenario-state.api.mdx similarity index 66% rename from docs-kits_versioned_docs/version-24.05/kits/OSim Kit/Software Development View/07-push-scenario-state.api.mdx rename to docs-kits_versioned_docs/version-24.12/kits/OSim Kit/Software Development View/07-push-scenario-state.api.mdx index e844d14f913..872564bce85 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/Software Development View/07-push-scenario-state.api.mdx +++ b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/Software Development View/07-push-scenario-state.api.mdx @@ -5,8 +5,8 @@ description: "The pushScenarioState enables distribution of a new scenario statu sidebar_label: "pushScenarioState" hide_title: true hide_table_of_contents: true -api: {"tags":["pushScenarioState"],"operationId":"pushScenarioState","description":"The pushScenarioState enables distribution of a new scenario status and thus a notification of the procedure with the planned scenario","parameters":[{"name":"bpns","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"BPNS00000007OTZ3"},{"name":"scenarioId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"50737df3-4237-4652-b092-1ef8649f6ca6"},{"name":"state","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["InRealization","Processed","Canceled"]},"example":"InRealization"}],"responses":{"200":{"description":"OK","content":{"text":{"schema":{"type":"string","example":"The GET has succeeded. The pushScenarioState has been successfully processed in the backend system."}}}},"400":{"description":"Bad request","content":{"text":{"schema":{"type":"string","example":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)."}}}},"401":{"description":"Unauthorized","content":{"text":{"schema":{"type":"string","example":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response."}}}},"402":{"description":"Unknown BPNS","content":{"text":{"schema":{"type":"string","example":"The BPNS which is given as parameter is not registered in the data provider database as a direct partner."}}}},"403":{"description":"Forbidden","content":{"text":{"schema":{"type":"string","example":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource."}}}},"405":{"description":"Method not allowed","content":{"text":{"schema":{"type":"string","example":"The method used to request a scenario feedback was not GET"}}}},"406":{"description":"Unknown Scenario","content":{"text":{"schema":{"type":"string","example":"The scenarioID which is given as parameter is not registered."}}}},"407":{"description":"Unknown State","content":{"text":{"schema":{"type":"string","example":"The scenarioState value is unknown."}}}},"500":{"description":"Internal server error","content":{"text":{"schema":{"type":"string","example":"The server has encountered a situation it does not know how to handle."}}}},"501":{"description":"Service unavailable","content":{"text":{"schema":{"type":"string","example":"The server is not ready to handle the request."}}}}},"servers":[{"url":"https://{server-url}"}],"method":"get","path":"/api/pushScenarioState/bpns/{bpns}/scenarioId/{scenarioId}/state/{state}","info":{"title":"OSim API","description":"Osim API for requesting and receiving simulation results as well as for interactions related to scenario management.","version":"2.0.0"},"postman":{"name":"push Scenario State","description":{"content":"The pushScenarioState enables distribution of a new scenario status and thus a notification of the procedure with the planned scenario","type":"text/plain"},"url":{"path":["api","pushScenarioState","bpns",":bpns","scenarioId",":scenarioId","state",":state"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"bpns"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"scenarioId"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"state"}]},"header":[{"key":"Accept","value":"text"}],"method":"GET"}} -sidebar_class_name: "get api-method" +api: {"operationId":"pushScenarioState","tags":["pushScenarioState"],"description":"The pushScenarioState enables distribution of a new scenario status and thus a notification of the procedure with the planned scenario","parameters":[{"name":"bpns","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"BPNS00000007OTZ3"},{"name":"scenarioId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"50737df3-4237-4652-b092-1ef8649f6ca6"},{"name":"state","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["InRealization","Processed","Canceled"]},"example":"InRealization"}],"requestBody":{"content":{"text/plain":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"OK","content":{"text":{"schema":{"type":"string","example":"The GET has succeeded. The pushScenarioState has been successfully processed in the backend system."}}}},"400":{"description":"Bad request","content":{"text":{"schema":{"type":"string","example":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing)."}}}},"401":{"description":"Unauthorized","content":{"text":{"schema":{"type":"string","example":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response."}}}},"402":{"description":"Unknown BPNS","content":{"text":{"schema":{"type":"string","example":"The BPNS which is given as parameter is not registered in the data provider database as a direct partner."}}}},"403":{"description":"Forbidden","content":{"text":{"schema":{"type":"string","example":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource."}}}},"405":{"description":"Method not allowed","content":{"text":{"schema":{"type":"string","example":"The method used to request a scenario feedback was not GET"}}}},"406":{"description":"Unknown Scenario","content":{"text":{"schema":{"type":"string","example":"The scenarioID which is given as parameter is not registered."}}}},"407":{"description":"Unknown State","content":{"text":{"schema":{"type":"string","example":"The scenarioState value is unknown."}}}},"500":{"description":"Internal server error","content":{"text":{"schema":{"type":"string","example":"The server has encountered a situation it does not know how to handle."}}}},"501":{"description":"Service unavailable","content":{"text":{"schema":{"type":"string","example":"The server is not ready to handle the request."}}}}},"servers":[{"url":"https://{server-url}"}],"method":"post","path":"/api/pushScenarioState/bpns/{bpns}/scenarioId/{scenarioId}/state/{state}","info":{"title":"OSim API","description":"OSim API for requesting and receiving simulation results","version":"3.0.0"},"postman":{"name":"push Scenario State","description":{"content":"The pushScenarioState enables distribution of a new scenario status and thus a notification of the procedure with the planned scenario","type":"text/plain"},"url":{"path":["api","pushScenarioState","bpns",":bpns","scenarioId",":scenarioId","state",":state"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"bpns"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"scenarioId"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"state"}]},"header":[{"key":"Content-Type","value":"text/plain"},{"key":"Accept","value":"text"}],"method":"POST","body":{"mode":"raw","raw":"\"\""}}} +sidebar_class_name: "post api-method" info_path: docs-kits/kits/OSim Kit/Software Development View//osim-api custom_edit_url: null --- @@ -26,7 +26,7 @@ import TabItem from "@theme/TabItem"; The pushScenarioState enables distribution of a new scenario status and thus a notification of the procedure with the planned scenario -
          Path Parameters
          +
          Path Parameters
          Request Body
          • string
          OK diff --git a/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/Software Development View/sidebar.js b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/Software Development View/sidebar.js new file mode 100644 index 00000000000..78d82355043 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/Software Development View/sidebar.js @@ -0,0 +1,88 @@ +module.exports = [ + { type: "doc", id: "kits/OSim Kit/Software Development View//osim-api" }, + { + type: "category", + label: "requestLatestSimulationResult", + link: { + type: "generated-index", + title: "requestLatestSimulationResult", + slug: "/category/kits/OSim Kit/Software Development View/request-latest-simulation-result", + }, + items: [ + { + type: "doc", + id: "kits/OSim Kit/Software Development View//", + label: "Missing summary", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "receiveLatestSimulationResult", + link: { + type: "generated-index", + title: "receiveLatestSimulationResult", + slug: "/category/kits/OSim Kit/Software Development View/receive-latest-simulation-result", + }, + items: [ + { + type: "doc", + id: "kits/OSim Kit/Software Development View//", + label: "Missing summary", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "requestScenarioFeedback", + link: { + type: "generated-index", + title: "requestScenarioFeedback", + slug: "/category/kits/OSim Kit/Software Development View/request-scenario-feedback", + }, + items: [ + { + type: "doc", + id: "kits/OSim Kit/Software Development View//", + label: "Missing summary", + className: "api-method post", + }, + ], + }, + { + type: "category", + label: "receiveScenarioFeedback", + link: { + type: "generated-index", + title: "receiveScenarioFeedback", + slug: "/category/kits/OSim Kit/Software Development View/receive-scenario-feedback", + }, + items: [ + { + type: "doc", + id: "kits/OSim Kit/Software Development View//", + label: "Missing summary", + className: "api-method get", + }, + ], + }, + { + type: "category", + label: "pushScenarioState", + link: { + type: "generated-index", + title: "pushScenarioState", + slug: "/category/kits/OSim Kit/Software Development View/push-scenario-state", + }, + items: [ + { + type: "doc", + id: "kits/OSim Kit/Software Development View//", + label: "Missing summary", + className: "api-method post", + }, + ], + }, +]; diff --git a/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/architecture.png b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/architecture.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/OSim Kit/architecture.png rename to docs-kits_versioned_docs/version-24.12/kits/OSim Kit/architecture.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/businessProcess.png b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/businessProcess.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/OSim Kit/businessProcess.png rename to docs-kits_versioned_docs/version-24.12/kits/OSim Kit/businessProcess.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/page_adoption-view.md similarity index 90% rename from docs-kits_versioned_docs/version-24.05/kits/OSim Kit/page_adoption-view.md rename to docs-kits_versioned_docs/version-24.12/kits/OSim Kit/page_adoption-view.md index 9f9cb68f409..666e9065989 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/page_adoption-view.md +++ b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/page_adoption-view.md @@ -1,7 +1,7 @@ --- id: Adoption View OSim Kit title: Adoption View -description: 'OSim Kit' +description: "OSim Kit" sidebar_position: 2 --- @@ -12,6 +12,7 @@ sidebar_position: 2 ## Vision & Mission + **Gain increased supply chain transparency through collaborative simulation across all stakeholders**. **Combine simulations of plants internally with simulations of external logistics over multiple tiers**. @@ -22,7 +23,7 @@ An open architecture for integrating partners of all kinds together with standar **Integrate any supply chain partner**. -Even partners that do not use any simulation tool can contribute to the overall transparency through the well-defined information requirements. +Even partners that do not use any simulation tool can contribute to the overall transparency through the well-defined information requirements. **Integrate any simulation tool**. @@ -69,9 +70,9 @@ See also the following publications for more detailed description of the process The Semantic Model MaterialFlowSimulationResult summarizes simulation results of the individual partners and is used for data exchange along the supply chain. -The *MaterialFlowSimulationResult* object will be sent by OSim partner to another OSim partner on a higher tier level. OSim partner can be a producing company as well as a logistics company. +The _MaterialFlowSimulationResult_ object will be sent by OSim partner to another OSim partner on a higher tier level. OSim partner can be a producing company as well as a logistics company. -Every *MaterialFlowSimulationResult* includes information about delivery readiness of packaged material goods, like material identifier, amount, delivery time and destination. +Every _MaterialFlowSimulationResult_ includes information about delivery readiness of packaged material goods, like material identifier, amount, delivery time and destination. #### Structure of the Materialflow Simulation Result @@ -82,7 +83,7 @@ The MaterialFlowSimulationResult semantic model contains 4 hierarchical entities - HandlingUnit - MaterialBatch -One *MaterialFlowSimulationResult* refers to one or more Shipments. +One _MaterialFlowSimulationResult_ refers to one or more Shipments. **Shipment** describes a delivery approach with information about source, destination and delivery time. One Shipment refers to one or more HandlingUnits. @@ -92,19 +93,19 @@ One *MaterialFlowSimulationResult* refers to one or more Shipments. #### Aspect Model -Github Link to semantic data model: +Github Link to semantic data model: ### Materialflow Scenario Request (MaterialFlowScenarioRequest) -The Semantic Model *MaterialFlowScenarioRequest* includes scenario related information of the individual partners and is used for data exchange along the supply chain in regard to “What-If” scenarios. +The Semantic Model _MaterialFlowScenarioRequest_ includes scenario related information of the individual partners and is used for data exchange along the supply chain in regard to “What-If” scenarios. -The *MaterialFlowScenarioRequest* object will be sent by OSim partner to another OSim partner (possible in both directions: up and down). OSim partner can be a producing company as well as a logistics company. +The _MaterialFlowScenarioRequest_ object will be sent by OSim partner to another OSim partner (possible in both directions: up and down). OSim partner can be a producing company as well as a logistics company. -Every *MaterialFlowScenarioRequest* includes information about the scenario description, scenario parameters (optional) and two simulation results analogues to the MaterialFlowSimulationResult (one with the unchanged and another one with the changed situation, allowing verification of scenario impact through comparison). +Every _MaterialFlowScenarioRequest_ includes information about the scenario description, scenario parameters (optional) and two simulation results analogues to the MaterialFlowSimulationResult (one with the unchanged and another one with the changed situation, allowing verification of scenario impact through comparison). #### Structure of the Materialflow Scenario Request -The *MaterialFlowScenarioRequest* semantic model contains 4 entities: +The _MaterialFlowScenarioRequest_ semantic model contains 4 entities: - Scenario Header - Scenario Parameters (optional) @@ -121,7 +122,7 @@ The *MaterialFlowScenarioRequest* semantic model contains 4 entities: #### Aspect Model -Github Link to semantic data model: +Github Link to semantic data model: ## Logic & Schema @@ -228,12 +229,12 @@ To verify the participants Catena-X membership, the Membership verifiable creden ```json { - "@type": "Constraint", - "odrl:leftOperand": "Membership", - "odrl:operator": { - "@id": "odrl:eq" - }, - "odrl:rightOperand": "active" + "@type": "Constraint", + "odrl:leftOperand": "Membership", + "odrl:operator": { + "@id": "odrl:eq" + }, + "odrl:rightOperand": "active" } ``` @@ -241,15 +242,21 @@ To verify the participants Catena-X membership, the Membership verifiable creden Our relevant standards can be downloaded from the official [Catena-X Standard Library](https://catena-x.net/de/standard-library): -- [CX - 0072 OSim Process and Core Business Logic v1.0.0](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_September23/CX-0072-OSimProcessAndCoreBusinessLogic-v1.0.0.pdf) -- [CX - 0073 OSim API v1.0.0](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_September23/CX-0073-OSimAPI-v1.0.0.pdf) -- [CX - 0087 OSim Data Model Materialflow Simulation Result v1.0.0](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_September23/CX-0087-OSimDataModelMaterialFlowSimulationResult-v1.0.0.pdf) -- [CX - 0133 Online Control and Simulation v1.0.0](https://catena-x.net/de/standard-library) +- [CX - 0133 Online Control and Simulation v2.0.0](https://catenax-ev.github.io/docs/next/standards/CX-0133-OnlineControlandSimulation) + +## Product Documentation + +A deeper understanding of the basic Online Control and Simulation use case can be gained from the following linked document. While in the OSIM-KIT only the standardized partner interface of OSim is considered, the OSim product documentation represents the complete technical specification of the use case. + +- [OSim - Product Documentation_EN](./OSim-Product-Documentation-EN.pdf) ## Notice This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). - SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024,Fraunhofer Institute for Manufacturing Engineering and Automation IPA - SPDX-FileCopyrightText: 2024,Fraunhofer Institute for Factory Operation and Automation IFF +- SPDX-FileCopyrightText: 2024,German Edge Cloud GmbH & Co.KG - SPDX-FileCopyrightText: 2024,Siemens AG +- Source URL: [https://github.com/eclipse-tractusx/eclipse-tractusx.github.io](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io) diff --git a/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/page_changelog.md b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/page_changelog.md new file mode 100644 index 00000000000..70fc703cb37 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/page_changelog.md @@ -0,0 +1,76 @@ +--- +id: OSim Kit Changelog +title: Changelog +description: 'OSim Kit' +sidebar_position: 1 +--- + +![osim kit banner](@site/static/img/OSimKitIcon.svg) + +### OSim Kit + +All notable changes to this Kit will be documented in this file. + +## [3.0.0] - 2024-08-01 + +### Added + +- Adoption View: + - Added new Chapter Product documentation with a link to the document. + +### Changed + +- Adoption View: + - Updated the aspect model references to the newest version. +- Development View: + - Updated the API descriptions in accordance with the newest OSim standardization document CX-133 + +### Removed + +- Adoption View: + - References to the obsolete OSim Standards. + +## [2.0.0] – 2024-03-08 + +### Added + +Additionally to the “simulation flow” released in the version 1.0.0 this version was extended by “scenario flow” + +- Adoption View: + - Business process for scenario related data exchange + - MaterialFlowScenarioRequest aspect model +- Development View: + - requestScenarioFeedback API + - receiveScenarioFeedback API + - pushScenarioState API + +### Changed + +- n/a + +### Removed + +- n/a + +## [1.0.0] - 2023-08-18 + +### Added + +- Initial version of the Kit including adoption and development view + +### Changed + +- ./. + +### Removed + +- ./. + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024,Fraunhofer Institute for Factory Operation and Automation IFF +- SPDX-FileCopyrightText: 2024,Siemens AG +- Source URL: [https://github.com/eclipse-tractusx/eclipse-tractusx.github.io](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io) diff --git a/docs-kits_versioned_docs/version-24.05/kits/OSim Kit/werk76.png b/docs-kits_versioned_docs/version-24.12/kits/OSim Kit/werk76.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/OSim Kit/werk76.png rename to docs-kits_versioned_docs/version-24.12/kits/OSim Kit/werk76.png diff --git a/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/Software Development View/page_software-development-view.md b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/Software Development View/page_software-development-view.md new file mode 100644 index 00000000000..4d4af0fdc35 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/Software Development View/page_software-development-view.md @@ -0,0 +1,396 @@ +--- +id: Specification +title: Specification +description: 'PCF-Exchange-KIT' +sidebar_position: 3 +--- + +![PCF Exchange kit banner](/img/kit-icons/pcf-kit-icon.svg) + +## Introduction + +The developer view provides a detailed guide on how to utilize the PCF exchange KIT effectively. Developers will learn how to integrate the KIT into their applications and make use of the feature of exchanging PCF values via the Catena-X network. +IT-administrators will learn how they need to provide PCF data and which components are required. + +This KIT covers various aspects, starting from how to utilize the available API endpoints, the used data models and how to make them available to the Catena-X network. + +## Building Block View + +The following figure shows the current high level architecture of the PCF Exchange use case. It is build on an asynchronous data exchange. + +![Building Block View](../resources/development-view/BuildingblockView.png) + +## Sequence View + +The following chapter illustrates the process from searching for an EDC point, to querying a PCF value, and finally transmitting the requested value. + +### EDC Discovery and dDTR Access + +In order to receive the EDC endpoints for a requested partner, the EDC Discovery Service is used, following the [CX-0001](https://catenax-ev.github.io/docs/next/standards/CX-0001-EDCDiscoveryAPI) EDC Discovery API standard. Therefor, at least the BPNL (Business Partner Number Legal) entity needs to be known. For more details please refer to the Catena-X standard above. + +![EDCDiscoveryAndDTRAccess](../resources/development-view/EDCDiscoveryanddDTRAccess.png) + +### PCF Request + +In order to request PCF values via the PCF API endpoint first of all the EDC PCF asset needs to be identified. Therefor, the decentralized Digital Twin Registry (dDTR) is used. Data providers must register their dDTR(s) as EDC assets following the [CX-0002](https://catenax-ev.github.io/docs/next/standards/CX-0002-DigitalTwinsInCatenaX) Digital Twins in Catena-X standard. After identifying the dDTR, the digital twin with the related PCF submodel can be looked up (see [API calls [0003 +0004]](#api-calls)). An example is documented [here](#payload-for-requesting-pcf-sub-model). + +After successfully locating the corresponding material twin containing a PCF submodel, the EDC asset containing the PCF request endpoint can be extracted (example payload can be found [here](#payload-for-edc-data-asset-pcf)) and the query for a PCF dataset can be initiated, as illustrated in the attached sequence diagram. + +![PCF Request](../resources/development-view/PCFRequestthroughAAS.png) + +In case no matching material twin or PCF submodel exists, the flow falls back to a direct lookup of an EDC asset containing the PCF request endpoint provided within the offers of any EDC registered for the data provider's BPNL. + +![PCF Request without Twin or Submodel](../resources/development-view/PCFRequestWithoutTwinOrSubmodel.png) + +>**Note** +>The API wrapper shown in the sequence diagrams is optional. The management API of the EDC can also be used directly. + +### PCF Update + +The sequence diagram provided below presents an example of a PCF update flow. An update is feasible only for assets that have been previously requested at least once, as demonstrated in [PCF Request](#pcf-request). Proactive updates without a prior request are not achievable with the current version. + +![PCF Update](../resources/development-view/PCFUpdatePushedThroughEDC.png) + +#### API Calls + +| Call | Method | Path | Parameter | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------|------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------| +| [001](https://eclipse-tractusx.github.io/docs-kits/next/kits/Digital%20Twin%20Kit/Software%20Development%20View/API%20EDC%20Discovery/post-list-of-bpns-or-an-empty-array-to-retrieve-available-company-connector-authorization-required-roles-view-connectors) (Lookup EDC endpoints) | POST | /api/administration/Connectors/discovery/ | `[]` | +| [002](https://eclipse-tractusx.github.io/docs-kits/next/kits/tractusx-edc/docs/samples/management-api-v2-walkthrough/catalog) (Look up dDTR) | POST | /v2/catalog/request | --> Lookup Asset in the EDC catalog (EDC asset type data.core.digitalTwinRegistry) | +| [003](https://eclipse-tractusx.github.io/docs-kits/next/kits/Digital%20Twin%20Kit/Software%20Development%20View/API%20AAS%20Discovery/get-all-asset-administration-shell-ids-by-asset-link) (Lookup Twin ID) | GET | /lookup/shells | `assetIds= [{"key": "manufacturerPartId", "value":"mat345",{"key":"digitalTwinType", "value": "PartType"}}]` | +| [004](https://eclipse-tractusx.github.io/docs-kits/next/kits/Digital%20Twin%20Kit/Software%20Development%20View/API%20AAS%20Registry/get-all-asset-administration-shell-descriptors) (Lookup PCF submodel/EDC asset ID) | GET | /shell-descriptors | `{DIGITAL TWIN ID}` | +| [005](../resources/development-view/catena-x-pcf-endpoint-1_1_1.yaml) (Requesting PCF value) | GET | /productIds | {productId} | +| [006](../resources/development-view/catena-x-pcf-endpoint-1_1_1.yaml) (Sending PCF value) | PUT | /productIds | {productId} | + +- The assetIds under [003] must be base64 encoded! +- When responding an PCF exchange request, the "requestID" is mandatory in the PUT call. +- When sharing a PCF update, the "requestID" is NOT allowed in the PUT call. +- The EDC asset used to receive a PCF is NOT looked up through AAS, but identified by type ("data.pcf.exchangeEndpoint"). +- The Open API specification defining all mandatory PCF Exchange endpoints and the data structures transfered through those can be found [here](../resources/development-view/catena-x-pcf-endpoint-1_1_1.yaml) + +##### Payload for Requesting PCF Sub Model + +The following JSON shows the structure of a registered PCF submodel in the DTR. The subprotocolBody is used for asset bundling. For this, the [CX-0002](https://catenax-ev.github.io/docs/next/standards/CX-0002-DigitalTwinsInCatenaX) Digital Twins in Catena-X standard needs to be followed. + +The digital twin id can be searched via the `manufacturerPartId` and the ``digitalTwinType:"PartType"``. + +The PCF submodel must be registered with the ``idshort: PCFExchangeEndpoint``. +
          + PCFExchange Endpoint of a DigitalTwin (JSON) + +```json +{ + "description": [ + { + "language": "en", + "text": "PCF endpoint for material 'mat345'" + } + ], + "idShort": "PCFExchangeEndpoint", + "identification": "urn:uuid:205cf8d1-8f07-483c-9c5b-c8d706c7d05d", + "semanticId": { + "type": "ExternalReference", + "keys": [ + { + "type": "GlobalReference", + "value": "urn:samm:io.catenax.pcf:7.0.0#Pcf" + } + ] + }, + "endpoints": [ + { + "interface": "PCF-1.1", + "protocolInformation": { + "href": "https://edc.data.plane/productIds/mat345", + "endpointProtocol": "HTTP", + "endpointProtocolVersion": ["1.1"], + "subprotocol": "DSP", + "subprotocolBody": "id=c34018ab-5820-4065-9087-416d78e1ab60;dspEndpoint=https://some.controlplane.url:7173/api/v1/dsp", + "subprotocolBodyEncoding": "plain" + } + } + ] +} +``` + +
          + +#### Payloads for EDC Asset + +##### Payload for EDC Data Asset PCF + +The following JSON shows the EDC Asset for a PCF defined in the EDC using the asset bundling mentioned under [Payload for Requesting PCF Sub Model](#api-calls). +
          + PCFExchange Asset Definition (JSON) + +```json +{ + "@context": { + "edc": "https://w3id.org/edc/v0.0.1/ns/", + "odrl": "http://www.w3.org/ ns/odrl/2/", + "dcat": "http://www.w3.org/ns/dcat#", + "dct": "http://purl.org/dc/terms/", + "rdfs": "http://www.w3.org/2000/01/rdf-schema#", + "cx-taxo": "https://w3id.org/catenax/taxonomy#", + "cx-common": "https://w3id.org/catenax/ontology/common#", + "aas-semantics": "https://admin-shell.io/aas/3/0/HasSemantics/" + }, + "@id": "c34018ab-5820-4065-9087-416d78e1ab60", + "@type": "edc:Asset", + "edc:properties": { + "rdfs:label": "PCF Data", + "rdfs:comment": "Endpoint for PCF data", + "cx-common:version": "1.1", + "aas-semantics:semanticId": {"@id":"urn:samm:io.catenax.pcf:7.0.0#Pcf"}, + "edc:contentType": "application/json", + "dct:type": {"@id":"cx-taxo:PcfExchange"} + }, + "edc:dataAddress": { + "edc:type": "HttpData", + "edc:baseUrl": "https://some.url/service", + "edc:proxyBody": "true", + "edc:proxyPath": "true", + "edc:proxyQueryParams": "true", + "edc:proxyMethod": "true", + "edc:contentType": "application/json" + } +} +``` + +
          + +#### Payload for EDC Policy + +The following JSON is a policy definition including the *mandatory* policy constraints for "active membership", "signed frameworkagreement" and "pcf base usage purpose". The [framework agreement document](https://catenax-ev.github.io/docs/next/regulatory-framework/20000ft/use-case-pcf-exchange) is published via the association and available via the Catena-X homepage. The membership credential is automatically created after successfully finishing the onboarding process. + +In addition an *optional* constraint for an existing tenant-specific bilateral contract can be added. It should reference the contract number and is NOT backed up by verifiable credentials. Nevertheless it will be checked on a syntactical level during contract negotiation. If such a contract refererence should be used, a specific usage policy per tenant is needed, as constraint concatenation via OR is not recommended. + +>**Note** +>More informations can be found in the official [ODRL Profile Definition](https://github.com/catenax-eV/cx-odrl-profile/blob/main/profile.md). + +##### Payload to create a SSI based Policy + +
          + SSI based Policy (JSON) + +```json +{ + "@context": { + "@vocab": "https://w3id.org/edc/v0.0.1/ns/" + }, + "@id": "a343fcbf-99fc-4ce8-8e9b-148c97605aab", + "policy": { + "@context": [ + "https://www.w3.org/ns/odrl.jsonld", + { + "cx-policy": "https://w3id.org/catenax/policy/v1.0.0/" + } + ], + "@type": "Policy", + "profile": "cx-policy:profile2405", + "permission": [ + { + "action": "use", + "constraint": { + "and": [ + { + "leftOperand": "cx-policy:ContractReference", + "operator": "eq", + "rightOperand": "" + }, + { + "leftOperand": "cx-policy:FrameworkAgreement", + "operator": "eq", + "rightOperand": "DataExchangeGovernance:1.0" + }, + { + "leftOperand": "cx-policy:Membership", + "operator": "eq", + "rightOperand": "active" + }, + { + "leftOperand": "cx-policy:UsagePurpose", + "operator": "eq", + "rightOperand": "cx.pcf.base:1" + } + ] + } + } + ] + } +} +``` + +
          + +>**Note** +>Be aware that - due to an open issue in EDC version 0.7.x - all criterias must be added in fixed (alphabetical) order! + +For more examples on how to define policies with SSI have a look [here](https://github.com/eclipse-tractusx/ssi-docu/blob/main/docs/architecture/cx-3-2/edc/policy.definitions.md). + +#### Payload Contract Definition + +
          + Sample Contract (JSON) + +```json +{ + "@id": "54ef3326-42b2-4221-8c5a-3a6270d54db8", + "edc:accessPolicyId": "7cb20eb1-08db-4532-bd74-ad480f551654", + "edc:contractPolicyId": "a343fcbf-99fc-4ce8-8e9b-148c97605aab", + "edc:assetsSelector":[ + { + "@type": "Criterion", + "edc:operandLeft": "@id", + "edc:operator": "=", + "edc:operandRight": "c34018ab-5820-4065-9087-416d78e1ab60" + } + ] +} +``` + +
          + +Inside the contract definition, an access policy and a usage policy must be referenced. A sample for a usage policy (incl. mandatory and optional criterias) is given in the [section above](#payload-to-create-a-ssi-based-policy). + +The content of the access policy depends on the criterias used within the usage policy. The configuration MUST ensure that only one offer (per version) for a PCF Exchange asset is visible to a client when querying the catalog. + +The following paragraphs give options how to achieve this. These options can always be replaced by corresponding (or even more restictive) policies, as long as the requirement of delivering only one offer per PCF Exchange asset version is met: +If *no bilateral contract* reference criteria are used *in any usage policy* attached to the PCF Exchange asset, an empty access policy can be used:

          +![Tier1Supplier without bilateral contracts](../resources/development-view/Tier1AOpenUP.png) + +
          + Empty Access Policy (JSON) + +```json +{ + "@context": { + "@vocab": "https://w3id.org/edc/v0.0.1/ns/" + }, + "@id": "7cb20eb1-08db-4532-bd74-ad480f551654", + "policy": { + "@context": [ + "https://www.w3.org/ns/odrl.jsonld", + { + "cx-policy": "https://w3id.org/catenax/policy/v1.0.0/" + } + ], + "@type": "Policy", + "profile": "cx-policy:profile2405", + "permission": [] + } +} +``` + +
          + +If a *bilateral contract* reference criteria is used *in a usage policy*, an access policy restricting access to the contract partners BPNL *MUST* be used for every usage policy holding a contract reference:

          +![Tier1Supplier using bilateral contracts and an open policy](../resources/development-view/Tier1ABCOnlyUP.png) + +
          + BPN restricted Access Policy to be used with a Usage Policy containing a contract reference (JSON) + +```json +{ + "@context": { + "@vocab": "https://w3id.org/edc/v0.0.1/ns/" + }, + "@id": "7cb20eb1-08db-4532-bd74-ad480f551654", + "policy": { + "@context": [ + "https://www.w3.org/ns/odrl.jsonld", + { + "cx-policy": "https://w3id.org/catenax/policy/v1.0.0/" + } + ], + "@type": "Policy", + "profile": "cx-policy:profile2405", + "permission": [ + { + "action": "use", + "constraint": { + "leftOperand": "BusinessPartnerNumber", + "operator": "eq", + "rightOperand": "BPNL00000000XXXX" + } + } + ] + } +} +``` + +
          + +If *bilateral contract reference* criterias are used *in usage policies* and *in addition* a usage policy *without bilateral contract references* should be provided, an access policy restricting access to all partners without a bilateral contract reference *MUST* be used for the usage policy holding no contract references.

          +![Tier1Supplier using bilateral contracts and an open policy](../resources/development-view/Tier1ABCUP.png) +

          The following example uses BusinessPartnerGroups to achieve this:

          + +
          + BPN restricted Access Policy to be used with the "global" Usage Policy containing NO contract references (JSON) + +```json +{ + "@context": { + "@vocab": "https://w3id.org/edc/v0.0.1/ns/", + "odrl": "http://www.w3.org/ns/odrl/2/" + }, + "@type": "PolicyDefinitionRequestDto", + "policy": { + "@type": "odrl:Set", + "odrl:permission": [ + { + "odrl:action": "USE", + "odrl:constraint": { + "@type": "Constraint", + "odrl:leftOperand": "https://w3id.org/tractusx/v0.0.1/ns/BusinessPartnerGroup", + "odrl:operator": { + "@id": "odrl:eq" + }, + "odrl:rightOperand": "BusinessPartnerWithoutBilateralContract" + } + } + ] + } +} +``` + +
          + +## Error Handling + +In case no material twin or no PCF submodel is found, EDC asset type has to be used to find the endpoint needed to perform the PCF request. + +## Standards + +### Used CX Standards + +- [CX-0001 EDC Discovery API v1.0.2](https://catenax-ev.github.io/docs/next/standards/CX-0001-EDCDiscoveryAPI) +- [CX-0002 Digital Twins in Catena-X v2.2.0](https://catenax-ev.github.io/docs/next/standards/CX-0002-DigitalTwinsInCatenaX) +- [CX-0003 SAMMSemanticAspectMetaModel v1.1.0](https://catenax-ev.github.io/docs/next/standards/CX-0003-SAMMSemanticAspectMetaModel) +- [CX-0018 Dataspace Connectivity v3.1.0](https://catenax-ev.github.io/docs/next/standards/CX-0018-DataspaceConnectivity) +- [CX-0126 Industry Core: Part Type v2.0.0](https://catenax-ev.github.io/docs/next/standards/CX-0126-IndustryCorePartType) +- [CX-0136 PCF UseCase v2.0.0](https://catenax-ev.github.io/docs/next/standards/CX-0136-UseCasePCF) + +## Other Standards + +- [Pathfinder Framework - v2.0.0](https://wbcsd.github.io/tr/2023/data-exchange-protocol-20230221) + +## NOTICE + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023, 2024 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023, 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023, 2024 T-Systems International GmbH +- SPDX-FileCopyrightText: 2023, 2024 SAP SE +- SPDX-FileCopyrightText: 2023, 2024 SIEMENS AG +- SPDX-FileCopyrightText: 2023, 2024 SUPPLY ON AG +- SPDX-FileCopyrightText: 2023, 2024 Volkswagen AG +- SPDX-FileCopyrightText: 2023, 2024 Robert Bosch GmbH +- SPDX-FileCopyrightText: 2023, 2024 Mercedes Benz Group +- SPDX-FileCopyrightText: 2023, 2024 BASF SE +- SPDX-FileCopyrightText: 2023, 2024 CCT +- SPDX-FileCopyrightText: 2023, 2024 Gris Group +- SPDX-FileCopyrightText: 2023, 2024 Contributors to the Eclipse Foundation +- [Source URL](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/PCF%20Exchange%20Kit) diff --git a/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/sidebar.js b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/sidebar.js new file mode 100644 index 00000000000..744c39bc9a7 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/sidebar.js @@ -0,0 +1 @@ +module.exports = []; \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/changelog.md b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/changelog.md similarity index 56% rename from docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/changelog.md rename to docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/changelog.md index 57224f0a63b..61dcc81e83b 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/changelog.md +++ b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/changelog.md @@ -11,6 +11,41 @@ sidebar_position: 1 All notable changes to this Kit will be documented in this file. +## [1.2.0] - 2024-08-01 + +### Added + +#### Adoption View + +* References to available PCF exchange solutions (moved from CX-0136 PCF Use Case standard) +* Comprehensive illustration of latest PCF data model (overview plus details) + +#### Development View + +* Specification for bilateral contracts + +### Changed + +#### Adoption View + +* Exemplary PCF data model payload to PCF data model version 7.0.0 (Rel. 24.08) +* References to relevant standards in their latest versions (Rel. 24.08) +* Several typos and link errors +* Reference to Framework Agreement + +#### Development View + +* PCF Exchange API to Rel. 24.08 (e.g. data format) +* Several illustrations to reflect latest changes in Rel. 24.08 +* Policy adapted to latest standards (incl. new Framework Agreement and bilateral contracts) +* Referenced standard updated + +### Removed + +#### Development View + +* Inlined Open-API (MDX) removed + ## [1.1.0] - 2024-05-17 ### Added diff --git a/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/page_adoption-view.md new file mode 100644 index 00000000000..3b3c05101df --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/page_adoption-view.md @@ -0,0 +1,650 @@ +--- +id: Adoption View +title: Adoption View +description: 'PCF-Exchange-KIT' +sidebar_position: 2 +--- + +![PCF Exchange kit banner](/img/kit-icons/pcf-kit-icon.svg) + +## Introduction + +Sustainability has become increasingly important in the automotive industry in recent years. In particular, the topic of CO2 emissions is the focus of interest, and the product-specific CO2 footprint (PCF: product carbon footprint) has developed into a key indicator for sustainable product design and supply chains. Accordingly, there is a need to determine this data as precisely as possible across the automotive supply chain and to exchange it among partners in the network. This requires appropriate standards for calculation and exchange of data. + +In this context, Catena-X offers a decentralized ecosystem supported by standards and principles like data sovereignty, which can effectively implement such a PCF data exchange. The PCF KIT will be the key enabler for various stakeholders to calculate and exchange PCF data in a standardized format. The objective of the PCF KIT is therefore to: + +- Provide a comprehensive overview about the methods and tools for a PCF data exchange in the Catena-X dataspace. +- Offer various standards and guidelines for industry stakeholders. +- Provide a detailed description of the essential components required. + +## Vision & Mission + +### Vision + +Report and steer the de-carbonization of our value chain with dedicated measures based on real PCF values, without compromising upstream data sovereignity. + +### Mission + +Addressing supply chain carbon emissions today is missing reliable data about baseline emissions, effect of reductions and best practices. This is due to three reasons: + +- Complexity of supply chains leading to huge amount of data: complex supply chains spanning different countries and actors from many industries lead to huge amounts of data. + +- Lack of trust: unwillingness to share data due to the risk of losing competitive advantage (data is shared with competitors). + +- Missing standards for measuring carbon emissions in a comparable way. + +At the core of our project is the recognition of a current challenge - the lack of transparency and accessibility to real PCF information in supply chains. Through our project, we strive to bridge this information gap by establishing a trusted and collaborative and interoperable environment. Suppliers will have the opportunity to share their PCF data with confidence, knowing that it remains sovereign and under their control. + +We will address this by working on a trustworthy ecosystem that prioritizes data sovereignity, security and collaboration on standards. Therefore, our mission is to revolutionize the supply chain industry by providing a platform where suppliers can securely share their primary PCF data throughout the supply chain. + +We are guided by the following principles: + +- **Building trust** by making clear rules for data exchange and by pre-agreed data contracts between partners in the value chain. +- Building trust through **data sovereignty and data security**. We will build an ecosystem to share minimal data on a need-to-know basis, incorporating 3rd party verification by trusted partners. Decentralized architectures ensure that data remains within companies and is only shared with authorized persons as needed. +- **Governance** on the principles of mutual collaboration in the automotive industry and across with all relevant actors of the value chain on the principle of equality between partners, involving relevant outside stakeholders and the scientific community. +- **Flexibility and interoperability** by building an ecosystem of interoperable apps based on open standards. Collaborative standards for collecting, calculating and sharing emission and product data make these processes more efficient and comparable. +- **Scalability** and manageability of large amounts of data. Decentralized data ecosystems can handle and scale large amounts of data, as decentralized structures are created as required by participating companies. + +## Business Process + +### Premises and assumptions + +We assume that the calculation and exchange of PCF data is “new territory” for many companies. In large or larger enterprises (e.g., OEM or Tier-1 suppliers) the topic of sustainability with its various facets has been on the agenda for several years now. Appropriate structures and organizations were set up there. In this respect, it can be assumed that they have the expertise and resources for a PCF calculation. Corresponding, self-developed IT tools can also be found there. We cannot expect this for small and medium-sized enterprises (SMEs). In particular small companies often lack the knowledge and resources to calculate a PCF. + +These premises are therefore relevant for the following customer journeys: + +- A PCF calculation requires expert or at least in-depth knowledge. +- A PCF calculation is currently mostly created manually; automation is not common or possible in most cases. +- Automation is also not yet feasible because there are no concepts or standards for verifying PCF data. +- Due to the (manual) effort, PCF calculation and data exchange will initially only be carried out for selected products. + +Accordingly, the presented customer journeys are characterized by manual process steps. However, as the topic becomes more widely known in the automotive supply chain (especially among SMEs), greater automation should be sought. This is the only way to represent a larger (ideally the entire) range of products. + +### Overview + +The scope of our business process is the calculation and the exchange of PCF data across the supply chain for parts/components that are already in series production (→ "after start of production (SOP)"). One can therefore assume that a real supply chain already exists for this part/component. + +To describe the process, we defined two customer journeys: + +1. The customer journey “PCF data exchange” describes an asynchronous communication process: a customer requests the PCF from their supplier for a component (“PCF Request”), and the supplier provides the requested data (“PCF Response”). +2. If necessary, the requested PCF data must first be determined; this leads to the second customer journey “PCF calculation”. + +The exchange-process is initiated top-down (e.g., at the OEM; but it can also start at any level of the supply chain), starting with a request of a customer to the supplier. It could then be continued step by step throughout the entire tier-n supply chain. Ideally, the entire supply chain (or actually: the entire supply tree) would be covered via this cascading request/response process. The result would be a PCF that is 100% based on requested and reported data. + +![PCF Request and Response](resources/adoption-view/PCFRequestandResponse.png) + +In the real world, this will not be implemented this way, at least in the short and medium term. It can be assumed that this process and information chain will break down at certain points in the supply chain. There, data is not requested, but calculated using secondary data, as is standard procedure these days. There can be various reasons for this: + +- The affected part of the supply chain is only of minor relevance to the PCF; the effort required to determine the real data would therefore not be worthwhile. +- The supplier cannot or does not want to provide corresponding data. + +However, it is important that a PCF value reported from a supplier to its customer always represents the entire supply chain behind it. Therefore, the following data is recorded in a PCF calculation and aggregated to form the resulting PCF: + +- direct emissions that are generated in the supplier's own production system ("Scope 1") +- indirect emissions from purchased energy ("Scope 2") +- upstream emissions caused by purchased products from the upstream supply chain ("Scope 3") + +![Scope of Catena-X Use Case](resources/adoption-view/ScopeofCatena-XUseCase.png) + +The data for direct and indirect emissions will usually come from internal data sources, as these emission-shares are generated in the supplier's own production system. The upstream emissions ("Scope 3") can either be requested from the respective sub-supplier or could be calculated, e.g. by using information from eco-databases. Putting all together, the transparency on the PCF for a given part or component is created through a cascade of top-to-bottom PCF requests, and a cascade of aggregated PCF data from bottom to top. + +### Customer Journey "PCF Data Exchange" + +This customer journey describes the exchange of PCF data in an asynchronous request/response process. + +![PCF Data Exchange Overview](resources/adoption-view/PCFDataExchangeOverview.png) + +PCF data is exchanged between a data consumer (e.g., supplier on tier n) and a data provider (e.g., supplier on tier n+1). It is basically an asynchronous request/response process that is started by the data consumer: + +- The data consumer realizes that he needs the PCF for a specific component and that this data is not available in his local data (or is not of sufficient quality). +- With his PCF data exchange tool, the data consumer checks whether the required PCF data is available via Catena-X (from a technical perspective, this means that there is already a digital twin for the component and that the PCF submodel is available for this twin). If so, the tool would “fetch up” this data. If not, the user can request this data from the supplier as described in the next steps. +- The data consumer submits a “PCF request” (according to the standardized API [CX-0136](https://catenax-ev.github.io/docs/next/standards/CX-0136-UseCasePCF)) to his supplier. In doing so, he asks the supplier to provide PCF data for the specific component, which was determined in accordance with the requirements of the Catena-X PCF Rulebook ([CX-0029](https://catenax-ev.github.io/docs/next/standards/CX-0029-ProductCarbonFootprintRulebook)). + +With this request, the process temporarily ends for the data consumer. The ball is now in the data provider's playing field: + +- The data provider receives the PCF request (message/display in his PCF data exchange tool). +- The data provider checks whether the requested data is already available (i.e., whether the PCF has already calculated in the past but has not yet been provided to the customer yet). +- If the data is not yet available, the data provider must create it first. At this point, he starts the “PCF Calculation” subjourney (see [below](#customer-journey-pcf-calculation)). At the end of this subjourney, the PCF data is available, and the provider can answer the original request with the next steps. +- The data provider sends a PCF response (according to the standardized API see [CX-0136](https://catenax-ev.github.io/docs/next/standards/CX-0136-UseCasePCF)) to the data consumer. At the same time, the data is made available in Catena-X (which means from a technical perspective, that a PCF submodel is attached to the corresponding digital twin of the component). + +For the data provider, the process is now over, and the consumer's request has been answered with the response. On the consumer side, a few more steps follow: + +- The data consumer, who sent the initial PCF request, receives the PCF response (message/display in his PCF data exchange tool). +- With the data exchange tool, the consumer can access and “pick up” the PCF data, according to the standardized PCF data model (see [Semantic Model](#semantic-models)). + +>**Remark:** +>There are currently no options for data verification or acceptance/rejection of transmitted data at this stage in the process. These topics are currently still being discussed on Catena-X association level and are therefore not yet covered in the processes and tools. This might happen with later releases. + +- The data consumer can now transfer this data to his internal systems/databases (e.g., a PCF calculation tool), and use it for the internal business processes (e.g., PCF calculation or reporting). +This ends this customer journey. + +### Customer Journey “PCF Calculation” + +This customer journey describes the calculation of a PCF in compliance with the Catena-X PCF Rulebook ([CX-0029](https://catenax-ev.github.io/docs/next/standards/CX-0029-ProductCarbonFootprintRulebook)), with some of the required data obtained via the Catena-X network. + +![PCF Calculation](resources/adoption-view/PCFCalculation.png) + +The calculation process will often be triggered by an incoming PCF request (see subjourney "[PCF data exchange](#customer-journey-pcf-data-exchange)"). But of course, a PCF calculation can also be carried out proactively without a corresponding request via PCF Request. +To determine a PCF, an appropriate calculation tool is usually used, which guides the user through the process and ensures that all relevant data is taken into account. We will limit ourselves here to a generic, tool-independent presentation of the most important steps. + +1. Make a plan: What are the different components of the PCF? Where can I get the relevant data from? +→ This structuring should be supported by an appropriate process in the calculation tool. +2. Put the direct emissions from the production site (e.g., use of natural gas or fuels) into the calculation. +→ Get the raw data from internal data sources and enter them in the calculation tool. +3. Put the indirect emissions from purchased energy into the calculation. +→ Get the raw data (consumption values, energy mix, …) from internal data sources and from the energy supplier, and enter it in the calculation tool. +4. Upstream emissions: + - For sub-components with a (expected) relevant share on the PCF, the aim is to use real data (or primary data) for the calculation. Therefore, a PCF request is sent to the suppliers of these sub-components, to obtain appropriate real data (see subjourney ["PCF data exchange"](#customer-journey-pcf-data-exchange)). As soon as the data is available (via PCF Response), it can be used as input for the calculation. + - For other sub-components, which only make up a small proportion of the upstream emissions, there will be no request of data to the supplier. Instead, the data will be obtained from a database for secondary data. +5. If necessary, put other emissions and further data into the calculation (e.g., transport emissions, waste, recycling quotas, ...). +6. Put it all together and get the overall PCF. +7. Transfer PCF to the exchange tool (or in general: make the PCF data available). + +### PCF Personas + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          PersonaRole and Task (in larger companies)Specifics for SME ChallengesCatena-X Contribution
          Purchaser In general, the purchaser will not be a sustainability expert! + For him, sustainability is just an additional dimension (as cost, quality, ...). +
            +
          • He requests sustainability data for purchased (sub)products from his suppliers.
            • +
          • In the sourcing process he evaluates the incoming offers (which will include more and more sustainability data).
            • +
          • He negotiates PCF targets with his suppliers.
            • +
          • He checks compliance with agreements and targets and evaluates the supplier's performance.
            • +
          • He will be often the one, who detects incidents (e.g., non-fulfillment of targets, missing certificates, ...).
            • +
          + Different responsibilities and views possible: +
            +
          • A part/component/material-oriented view
            • +
          • A supplier/commodity-oriented view
            • +
          +           		+

          We assume, that a SME will have a weaker negotiating position and assertiveness (as a large company), so it may be more difficult to …

          +
            +
          • request PCF data from (sub)suppliers.
            • +
          • forward customers' CO2 targets to (sub)suppliers.
            • +
          • negotiate own objectives/targets.
            • +
          +           		+

          He requires sustainability data of parts/materials (e.g., PCF) for various purposes.

          +

          He requires standardized data.

          +

          He also requires product-unspecific sustainability data of suppliers (e.g., production site-specific certificates).

          +

          He needs data in different phases (e.g., product development, procurement, industrialization, series production).

          +           		+

          Catena-X defines standards for sustainability data.

          +

          Catena-X provides up-to-date and reliable sustainability data

          +
            +
          • of parts / materials
            • +
          • of suppliers
            • +
          +

          Catena-X provides phase-specific data.

          +

          Catena-X provides (standard) reports.

          +

          Catena-X provides apps and services for data exchange.

          +
          PCF Calculator + He is an expert for PCF calculation. He could be described as a “PCF Engineer,” analogous to the role of a “Cost Engineer” established in many companies. +
            +
          • He has in-depth knowledge of PCF-, CCF- and LCA-methods.
            • +
          • He is responsible for the calculation of the own scope 1 and 2 values of a PCF
            • +
          • From this data and with the scope 3 data reported by suppliers (or obtained from databases), he calculates the PCF of his own products.
            • +
          • He hands the result over to the PCF Controller
            • +
          • He is a consultant in "costs vs. PCF" discussions (with internal, but also with external partners)
            • +
          • He analyzes customer incident requests (on behalf of the PCF controller).
            • +
          • If there are any discrepancies in reported PCF data, he initiates incident requests at the respective supplier (via the PCF controller).
            • +
          +           		+

          We assume, that at a SME there will be often a combined role: (Sustainability) Manager Product

          +
            +
          • He is no sustainability expert! So, he must draw on external expertise if necessary
            • +
          • He must handle internal and external topics
            • +
          +

          Customer view:

          +
            +
          • He is a key account for sustainability data (PCF and ESS) and an “interface” in both directions: customers and suppliers.
            • +
          • He releases sustainability data (esp. PCF) to customers
            • +
          • He receives PCF data from suppliers.
            • +
          • He is the addressee for (PCF) incidents
            • +
          +

          Internal View:

          +
            +
          • He knows the product BoM (Bill of Material)
            • +
          • He steers “PCF vs. cost" objectives at product levels.
            • +
          • He collaborates with external auditors.
            • +
          • He analyzes incoming incident request of customers
            • +
          +           		Requires standardized PCF calculation method. +

          Needs scope 3 values from suppliers, to calculate own PCF with this data.

          +

          May need a calculation tool for scope 1 and 2 values.

          +

          Requires access to eco-data (secondary data).

          +

          Needs BoM data for calculation and analysis.

          +           		+

          Catena-X defines standards for PCF calculation.

          +

          Catena-X provides up-to-date and reliable sustainability data of parts/materials.

          +

          Catena-X provides apps and services for data exchange.

          +

          Catena-X provides calculation tools.

          +

          Catena-X provides access to eco-data(bases) for secondary data.

          +
          PCF Controller (product) +

          He has an operational role (as opposed to the Sustainability Manager). As a PCF expert who works with many internal and external partners.

          +

          He is the first point of contact for the purchaser on PCF topics.

          +

          External/customer view:

          +
            +
          • He is a key account for PCF data and, in this regard, the central interface to customers/suppliers.
            • +
          • He releases calculated PCF data to customers.
            • +
          • He receives PCF data from the suppliers.
            • +
          • He triggers incident management.
            • +
          • He initiates collaborative PCF optimization.
            • +
          +

          Internal View:

          +
            +
          • He is the PCF data owner in the company.
            • +
          • He acts as a PCF data collector.
            • +
          • He receives PCF targets from the Sustainability Manager, evaluates them, and is consulted as a CO2 expert in negotiations.
            • +
          • He tracks PCF targets for purchased parts, and detects incidents in terms of non-fulfillment of targets.
            • +
          • He makes supplier performance reviews about PCF.
            • +
          +           		+ +

          He requires up-to-date and reliable PCF data of parts/materials.

          +

          He needs data in different phases of the product lifecycle (e.g., in product development, sourcing, industrialization, series production).

          +

          He requires standardized data.

          +

          He needs a tool to exchange PCF data with internal and external partners.

          +

          He needs reports for tracking and monitoring of PCF data and targets.

          +           		+

          Catena-X defines standards for PCF data.

          +

          Catena-X provides apps and services for PCF data exchange.

          +

          Catena-X provides up-to-date and reliable PCF data of parts / materials.

          +

          Catena-X provides phase-specific data.

          +
          Sustainability Manager (product) +

          His role is more strategic than operational.

          +

          He is responsible for the coordination and steering of PCF and cost objectives at product level.

          +

          He ensures the consistency of product objectives with corporate objectives.

          +

          He defines PCF targets for products and breaks them down on part/component/material level.

          +

          He receives sustainability targets from customers.

          +

          He takes care of how sustainability targets (especially PCF) can be implemented and achieved.

          +

          He performs analyses in the context of sustainability.

          +

          He collaborates with external auditors.

          +           		+ +

          He collaborates with external auditors.

          +

          He requires standardized data.

          +

          He needs data in different phases of the product lifecycle (e.g., in product development, sourcing, industrialization, series production).

          +

          He needs reports for tracking and monitoring of sustainability data.

          +

          He needs a tool to exchange sustainability data with internal and external partners.

          + He needs tools for: +
            +
          • PCF target breakdown.
            • +
          • PCF optimization (e.g., “what if analysis”).
            • +
          • Controlling of competing targets (sustainability vs. costs vs. quality …).
            • +
          +           		+

          Catena-X defines standards for sustainability data (esp. PCF).

          +

          Catena-X provides apps and services for data exchange.

          +

          Catena-X provides up-to-date and reliable sustainability data of parts / materials.

          +

          Catena-X provides phase-specific data.

          +

          Catena-X provides (standard) reports.

          +

          Catena-X provides analysis tools.

          +
          Sustainability Manager (corporate) +

          He has no active role in Catena-X (e.g.: getting reports is a passive, not an active role in this sense).

          +

          He sets corporate goals and breaks them down for different sectors and functions in the company.

          +

          He gets input from the Sustainability Manager (product).

          +           		+

          The role exists in principle; it is rather the question of who will take it over (e.g., personal union with management, or possibly Sustainability Manager).

          +

          Thesis: an SME does CCF rather than PCF.

          +           		+

          He requires (aggregated) sustainability data.

          +

          He requires “high level” (standard) reports.

          +           		Catena-X provides up-to-date and reliable sustainability data.
          Salespeople +

          He is the central interface to the customer.

          +

          He is the owner of the customer quotation process.

          +

          He negotiates PCF targets with customers (→purchaser).

          +

          He presents sustainability data (esp. PCF) to customers.

          +

          He is accountable for incident management with customers.

          +           		+ +

          He needs sustainability data (e.g., PCF) of own products (or parts/materials)

          +

          He requires tools for information or data exchange (with both internal partners and external customers).

          +           		+

          Catena-X provides sustainability data of own products.

          +

          Catena-X provides apps and services for data exchange.

          +
          Auditor (external) +

          He does a yearly audit of conformity with Catena-X methodology.

          +

          At the beginning (before go-live) there is a one-time audit of the use of the Catena-X network and methods in the company to be audited.

          +

          The onboarding of suppliers requires a self-declaration of applying Catena-X methodology.

          +

          The auditor has a clearing role in case of escalated incidents.

          +           		He needs additional information and data to be able to verify the reported PCF data. +

          Catena-X provides up-to-date and verifiable sustainability data.

          +

          Catena-X provides access to metadata that allows the reported PCF data to be verified.

          +
          Sustainability Associations / InstitutionsThey provide industry-specific averages and benchmarks of PCF values.
          + +## Semantic Models + +Depending on the use case and related KIT, Catena-X provides different semantic models that help to structure and make use of data via semantic information. These models help to provide a basic meaning to the data and their relationship, thereby enabling interoperability between data sets. Catena-X data models rely on principles as understandability, standardization, accuracy, differentiation, audibility, comprehensiveness, and provision of insights to drive improvement actions. + +### PCF + +#### Introduction PCF Data Model + +In an era defined by growing environmental consciousness and sustainability imperatives, the concept of measuring and reducing carbon footprints has become paramount across industries. A pivotal key in this pursuit is an aligned and standardized PCF data model. This data model not only facilitates the systematic calculation and comparison of carbon footprints but also offers a structured approach to managing environmental impact data. + +As the global community grapples with the impacts of climate change, consumers, businesses, and governments are seeking actionable ways to mitigate their carbon emissions. The need for a consistent and universally accepted method of quantifying these emissions from diverse products has given rise to the significance of a standardized PCF data model. This model acts as a lingua franca, enabling stakeholders to communicate and analyze carbon footprint information transparently and comprehensively. + +For this KIT only the PCF data model is used. The PCF data model follows the [CX-0136](https://catenax-ev.github.io/docs/next/standards/CX-0136-UseCasePCF) Use Case PCF standard and is implemented in compliance with the [CX-0003](https://catenax-ev.github.io/docs/next/standards/CX-0003-SAMMSemanticAspectMetaModel) SAMM Aspect Meta Model standard. + +#### Data Model Overview + +The Catena-X PCF data model has been developed in accordance with the "Technical Specifications for PCF Data Exchange" from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. The basis for the specification of the Catena-X PCF data model is the PCF Rulebook V3.0.0 (see [CX-0029](https://catenax-ev.github.io/docs/next/standards/CX-0029-ProductCarbonFootprintRulebook)). + +The following illustration describes the logical structure of the Catena-X PCF data model: + +
          + PCF Data Model structure + +![PCF Data Model Structure Rel. 24.08](resources/adoption-view/PCF%20Data%20Model%20Structure%20Rel.%2024.08.png) + +
          + +The table below shows the details of each data field in the Catena-X PCF data model: + +
          + PCF Data Model details + +M - Mandatory, O - Optional, O* - Mandatory starting 2025 + +| Property | Technical Name | PCF Exchange | PCF Calculation | Data Type Specification | Example | Technical Data Type | Description | +|--------------------------------------------------------------------|-------------------------------------------------------|-----------------------------|--------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **(General)** | | | | | | | | +| ***(Version Information)*** | | | | | | | | +| Product Footprint Identifier | id | M | O | String; must be a UUID v4 | 3893bb5d-da16-4dc1-9185-11d97476c254 | PfId | The PCF identifier. | +| Product Footprint Specification Version | specVersion | M | M | Text | urn:io.catenax.pcf:datamodel:version:7.0.0 | String | Version of the PCF data specification. | +| Partial Or Full PCF | partialFullPcf | M | M | Enumeration; "Cradle-to-gate",
          "Cradle-to-grave" | Cradle-to-gate | String | Indicator for partial or full PCF declaration. | +| Previous PCF Identifiers | precedingPfIds | O | O | Non-empty set of strings | 9c5b94b1-35ad-49bb-b118-8e8fc24abf8 | Array of PfId | Set of preceding PCF identifiers without duplicates. Declared as "optional" in WBCSD, needs to be covered by application. | +| Product (Carbon) Footprint Version | version | M | O | Integer in inclusive rage of 0..2^31-1; per default "0" in Catena-X | 0 | Number | Version of the PCF. In Catena-X for example set to "0" per default. | +| Creation of the Product (Carbon) Footprint | created | M | M | Time stamp; must be in UTC (Coordinated Universal Time) conforming to ISO 8601 | 2020-03-01T00:00:00Z | DateTime | Timestamp of the creation of the PCF. | +| Status | status | M | O | Enumeration; "Active", "Deprecated"; per default "Active" in Catena-X | Active | String | Status indicator of a PCF. WBCSD specific extension, in Catena-X for example set to "Active" per default. | +| Validity Period Start | validityPeriodStart | O | O | Time stamp; if defined, must be equal to or greater than referencePeriodEnd | 2022-01-01T00:00:01Z | DateTime | Start of interval during which the PCF is declared as valid. If specified, the validity period start must be equal to or greater than the reference period end. | +| Validity Period End | validityPeriodEnd | O | O | Time stamp | 2022-12-31T23:59:59Z | DateTime | End of interval during which the PCF is declared as valid. | +| Comment | comment | O | O | Text | Additional explanatory information not reflected by other attributes | String | Additional information and instructions related to the calculation of the PCF. | +| PCF Legal Statement | pcfLegalStatement | O | O | Text | This PCF (Product Carbon Footprint) is for information purposes only. It is based upon the standards mentioned above. | String | Option for legal statement/ disclaimer. | +| ***(Company Information)*** | | | | | | | | +| Company Name | companyName | M | O | String with 1 or more characters | My Corp | NonEmptyString | Name of the PCF data owner. | +| Company Ids | companyIds | M | O | Non-empty set of URN (Uniform Resource Name); array of strings (<URN> ::= "urn:" <NID> ":" <NSS>) | urn:bpn:id:BPNL000000000DWF | CompanyIdSet | Non-empty set of Uniform Resource Names (URN). Each value is supposed to uniquely identify the PCF data owner. For Catena-X Industry Core compliance the set of URNs must contain at least the Business Partner Number Legal Entity (BPNL) in the specified format urn:bpn:id:BPNL[a-zA-Z0-9]{12}. | +| ***(Product Information)*** | | | | | | | | +| Product Description | productDescription | O | O | Text | Ethanol, 95% solution | String | Free-form description of the product. | +| Product Ids | productIds | M | M | Non-empty set of URN; array of strings (<URN>, ::= "urn:" <NID> ":" <NSS>) | urn:gtin:4712345060507 | ProductIdSet | Non-empty set of product identifiers. Each value is supposed to uniquely identify the product. In Catena-X productId corresponds with Industry Core manufacturerPartId. | +| Product Category | productCategoryCpc | M | O | String; UN CPC Code version 2.1;
          per default "011-99000" in Catena-X | 011-99000 | CpcCode | UN (United Nations) Product Classification Code (CPC - Central Classification Code) of a given product. WBCSD specific extension, which will probably be declared as "optional" in a later WBCSD specification version. In Catena-X for example specified with default value "011-99000". | +| Product Trade Name | productNameCompany | M | O | String with 1 or more characters | My Product Name | NonEmptyString | Non-empty trade name of a product. In Catena-X productNameCompany corresponds with Industry Core nameAtManufacturer. | +| **(PCF)** | | | | | | | | +| ***(Unit Information)*** | | | | | | | | +| Unit of measurement | declaredUnit | M | M | String; enumeration as specified by WBCSD plus "piece" for Catena-X | kilogram | DeclaredUnit | Unit of analysis of a product in context of the PCF. In Catena-X for example list of valid units includes "piece". | +| Unitary Product Amount | unitaryProductAmount | M | M | Positive, non-zero decimal number | 1000.0 | StrictlyPositiveDecimal | Amount of units contained within a product in context of the PCF. | +| Product Mass Per Declared Unit | productMassPerDeclaredUnit | M | M | Positive, non-zero decimal number | 0.456 | StrictlyPositiveDecimal | Mass of a product per declared unit (net, unpackaged) in context of the PCF. | +| ***(PCF Assessment & Methodology)*** | | | | | | | | +| ***(PCF Assessment Information)*** | | | | | | | | +| *(Boundary Specifications)* | | | | | | | | +| Exempted Emissions Percent | exemptedEmissionsPercent | M | M | Decimal number between 0.0 and 5 including | 0.0 | ExemptedEmissionPercent | Applied cut-off percentage of emissions excluded from PCF.
          For accordance with Catena-X PCF Rulebook (Version 3.0.0) <3%. | +| Exempted Emissions Description | exemptedEmissionsDescription | O | O | Text; can be empty | No exemption | String | Rationale behind exclusion of specific PCF emissions. | +| Packaging Emissions Included | packagingEmissionsIncluded | M | M | Boolean; can be "TRUE" or "FALSE" | TRUE | Boolean | The Catena-X PCF Rulebook (Version 3.0.0) requires to include packaging from a system boundary perspective. "FALSE" is only possible due to the application of the cut-off rule. Flag indicating whether packaging emissions are included in a PCF. WBCSD specific extension. | +| *(Technology)* | | | | | | | | +| Boundary Processes Description | boundaryProcessesDescription | O | O | Text | Electricity consumption included as an input in the production phase | String | Processes attributable to each lifecycle stage. | +| *(Geography)* | | | | | | | | +| Geography Country Subdivision | geographyCountrySubdivision | O | O | String; if defined must be ISO 3166-2 Subdivision Code | US-NY | GeographyCountrySubdivision | Subdivision of a country which must be an ISO 3166-2 subdivision code. | +| Geography Country | geographyCountry | O | O | String; if defined must be an ISO 3166-2 alpha-2 code | FR | GeographyCountry | Two letter country code that must conform to data type ISO 3166CC. | +| Region | geographyRegionOrSubregion | M | O | String with 1 or more characters; enumeration as specified by WBCSD plus "Global" and "Several" for
          Catena-X | Africa | String | Region according to list specified in Catena-X PCF Rulebook (Version 3.0.0). | +| *(Time)* | | | | | | | | +| Reference Period Start | referencePeriodStart | M | M | Time stamp; must be in UTC conforming to ISO 8601 | 2022-01-01T00:00:01Z | DateTime | Start of time boundary for which a PCF value is considered to be representative. | +| Reference Period End | referencePeriodEnd | M | M | Time stamp; must be in UTC conforming to ISO 8601 | 2022-12-31T23:59:59Z | DateTime | End of time boundary for which a PCF value is considered to be representative. | +| ***(PCF Methodology)*** | | | | | | | | +| *(Standards)* | | | | | | | | +| Cross Sectoral Standard | crossSectoralStandardsUsed:
          crossSectoralStandard | M | M | Object crossSectoralStandardsUsed: set of Cross Sectoral Standard entries.
          For each crossSectoralStandard: Enumeration "ISO 14067", "Pathfinder v1", "Pathfinder v2", "GHG Protocol Product Standard", "PAS 2050", "ISO 14040-44", "PEF", "Other" | GHG Protocol Product Standard | CrossSectoralStandardsUsedEnumeration | Discloses a cross-sectoral standard applied for calculating or allocating GHG (Greenhouse Gas) emissions. | +| Operator or Publisher of Sector Specific Rules | productOrSectorSpecificRules:
          operator | M | M | Object productOrSectorSpecificRules; set of Product or Sector Specific Rule entries (each including Operator, Rule Names and Other Operator Name)
          For each operator: enumeration "PEF", "EPD International", "Other"; per default "Other" in Catena-X | Other | ProductOrSectorSpecificRuleOperator | Operator of PCR (Product Category Rule)/ PSR (Product Specific Rule). WBCSD specific extension, in Catena-X for example must always be "Other". | +| Product or Sector Specific Rule Names | productOrSectorSpecificRules:
          ruleNames | M | M | Object productOrSectorSpecificRules; set of Product or Sector Specific Rule entries (each including Operator, Rule Names and Other Operator Name)
          For all rulenames: set of RuleName entries | urn:tfs-initiative.com:PCR:The Product Carbon Footprint Guideline for the Chemical Industry:version:v2.0 | NonEmptyString Vector | Non-empty set of rules applied by the specified operator. | +| Other Operator Name | productOrSectorSpecificRules:
          otherOperatorName | O | O | Object productOrSectorSpecificRules; set of Product or Sector Specific Rule entries (each including Operator, Rule Names and Other Operator Name)
          For each otherOperatorName: Non-empty string | NSF | NonEmptyString | Other operator of PCR (Product Category Rule)/ PSR (Product Specific Rule). WBCSD specific extension, in Catena-X for example specified by a default value. | +| *(GWP Characterization Factor Details)* | | | | | | | | +| Characterization Factors | characterizationFactors | M | M | Enumeration "AR6", "AR5"; per default "AR6" in Catena-X | AR6 | CharacterizationFactors | IPCC (Intergovernmental Panel on Climate Change) version of the GWP (Global Warming Potential) characterization factors used for calculating the PCF. WBCSD specific extension, in Catena-X for example specified by default with value "AR6". Default value can be overwritten. | +| *(Data Sources and Quality)* | | | | | | | | +| *(Allocation in Foreground (Own Processes))* | | | | | | | | +| Allocation Rules Description | allocationRulesDescription | O | O | Text; per default "In accordance with Catena-X PCF Rulebook" in Catena-X | In accordance with Catena-X PCF Rulebook | String | Allocation rules used and underlying reasoning in context of a PCF. WBCSD specific extension, in Catena-X for example specified by default with value "In accordance with Catena-X PCF Rulebook". | +| Allocation Waste Incineration | allocationWasteIncineration | M | M | Enumeration "cut-off", "reverse cut-off", "system expansion"; per default "cut-off" in Catena-X | cut-off | AllocationWasteIncineration | Allocation approach used for waste incineration with energy recovery as specified by the TFS (Together For Sustainability) initiative. In Catena-X for example must be specified by value "cut-off". | +| *(Data Sources)* | | | | | | | | +| Primary Data Share | primaryDataShare | O* | O* | Decimal number in range of and including 0..100 | 7.183924 | Percent | Share of primary data in percent. | +| Emission Factor Data Source | secondaryEmissionFactorSources:
          emissionFactorDS | M | M | Object; set of EmissionFactorDataSources | ecoinvent 3.8 | Set of strings, each with 1 or more characters | Emission factor data sources used to calculate a PCF. | +| *(Data Quality)* | | | | | | | | +| Coverage Percent | dqi:coveragePercent | O* | O* | Decimal number in range of and including 0..100; per default "100" in Catena-X | 100 | Percent | Percentage of PCF included in the data quality assessment based on the >5% emissions threshold. In Catena-X for example set to "100" per default. | +| Technological DQR (Data Quality Rating) | dqi:technologicalDQR | O | O | Decimal number in range of and including 1..3 | 2.0 | DqiNumber | Technological representativeness of the sources used for PCF calculation based on weighted average of all inputs representing >5% of PCF emissions. | +| Temporal DQR (Data Quality Rating) | dqi:temporalDQR | O | O | Decimal number in range of and including 1..3 | 2.0 | DqiNumber | Temporal representativeness of the sources used for PCF calculation based on weighted average of all inputs representing >5% of PCF emissions. | +| Geographical DQR (Data Quality Rating) | dqi:geographicalDQR | O | O | Decimal number in range of and including 1..3 | 2.0 | DqiNumber | Geographical representativeness of the sources used for PCF calculation based on weighted average of all inputs representing >5% of PCF emissions. | +| Completeness DQR (Data Quality Rating) | dqi:completenessDQR | O | O | Decimal number in range of and including 1..3 | 2.0 | DqiNumber | Completeness of the data collected for PCF calculation based on weighted average of all inputs representing >5% of PCF emissions. | +| Reliability DQR (Data Quality Rating) | dqi:reliabilityDQR | O | O | Decimal number in range of and including 1..3 | 2.0 | DqiNumber | Reliability of the data collected for PCF calculation based on weighted average of all inputs representing >5% of PCF emissions. | +| ***(Life Cycle Inventory Results)*** | | | | | | | | +| ***(Production Stage)*** | | | | | | | | +| PCF Excluding Biogenic | pcfExcludingBiogenic | M | M | Must be calculated per declared unit with
          kgCO2e / declaredUnit equal to or greater zero | 2.0 | PositiveDecimal | PCF of a product excluding biogenic emissions. | +| PCF Including Biogenic | pcfIncludingBiogenic | O* | O* | Must be calculated per declared unit with
          kgCO2e / declaredUnit | 1.0 | Decimal | PCF of a product including biogenic emissions. Optional value in current specification version but will be mandatory in future version. | +| Fossil Emissions | fossilGhgEmissions | O* | O* | Must be calculated per declared unit with
          kgCO2e / declaredUnit equal to or greater zero | 0.5 | PositiveDecimal | Emissions from combustion of fossil sources. Identical to "pcfExcludingBiogenic", will be removed in later version. | +| Biogenic Carbon Emissions Other Than CO2 | biogenicCarbonEmissionsOtherThanCO2 | O* | O* | Must be calculated per declared unit with
          kgCO2e / declaredUnit equal to or greater zero | 1.0 | PositiveDecimal | GWP (Global Warming Potential) of biogenic CO2e-emissions in production phase which contain only GHG (Greenhouse Gas) emissions other than CO2 - excludes biogenic CO2. | +| Biogenic Carbon Withdrawal | biogenicCarbonWithdrawal | O* | O* | Must be calculated per declared unit in kgCO2e / declaredUnit equal to or less than zero | 0.0 | NegativeDecimal | Biogenic carbon content in the product converted to CO2e. | +| Direct land use change Greenhouse Gas Emissions | dlucGhgEmissions | O* | O* | Must be calculated per declared unit with
          kgCO2e / declaredUnit equal to or greater zero | 0.4 | PositiveDecimal | Direct land use change CO2e emissions in context of a PCF. | +| Land use Greenhouse Gas Emissions | luGhgEmissions | O* | O* | Must be calculated per declared unit with
          kgCO2e / declaredUnit | 0.3 | Decimal | Land use CO2 emissions in context of a PCF as specified by the TFS (Together For Sustainability) initiative. TFS specific extension. | +| Aircraft Greenhouse Gas Emissions | aircraftGhgEmissions | O* | O* | Must be calculated per declared unit with
          kgCO2e / declaredUnit equal to or greater zero | 0.0 | PositiveDecimal | GHG (Greenhouse Gas) emissions resulting from aircraft engine usage for the transport of the product. | +| Packaging Greenhouse Gas Emissions | packagingGhgEmissions | O | O | Must be calculated per declared unit with
          kgCO2e / declaredUnit equal to or greater zero | 0.0 | PositiveDecimal | Emissions resulting from the packaging of the product. WBCSD specific extension. In Catena-X not relevant to be reported separately. | +| ***(Distribution Stage)*** | | | | | | | | +| Distribution Stage PCF Excluding Biogenic | distributionStagePcfExcludingBiogenic | O | O | Must be calculated per declared unit with
          kgCO2e / declaredUnit equal to or greater zero | 1.5 | PositiveDecimal | PCF for the distribution stage of a product excluding biogenic emissions. | +| Distribution Stage PCF Including Biogenic | distributionStagePcfIncludingBiogenic | O | O | Must be calculated per declared unit with
          kgCO2e / declaredUnit | 0.0 | Decimal | PCF for the distribution stage of a product including biogenic emissions. | +| Distribution Stage Fossil Greenhouse Gas Emissions | distributionStageFossilGhgEmissions | O | O | Must be calculated per declared unit with
          kgCO2e / declaredUnit equal to or greater zero | 0.5 | PositiveDecimal | Emissions from the combustion of fossil sources in the distribution stage. | +| Distribution Stage Biogenic Carbon Emissions Other Than CO2 | distributionStageBiogenicCarbonEmissionsOtherThanCO2 | O | O | Must be calculated per declared unit with
          kgCO2e / declaredUnit equal to or greater zero | 1.0 | PositiveDecimal | GWP (Global Warming Potential) of biogenic CO2e-emissions in distribution phase which contain only GHG (Greenhouse Gas) emissions other than CO2. Excludes biogenic CO2. | +| Distribution Stage Biogenic Carbon Withdrawal | distributionStageBiogenicCarbonWithdrawal | O | O | Must be calculated per declared unit in kgCO2e / declaredUnit equal to or less than zero | 0.0 | NegativeDecimal | GWP (Global Warming Potential) of biogenic CO2-withdrawal in distribution stage (biogenic CO2 contained in the product). | +| Distribution Stage direct land use change Greenhouse Gas Emissions | distributionStageDlucGhgEmissions | O | O | Must be calculated per declared unit with
          kgCO2e / declaredUnit equal to or greater zero | 1.0 | PositiveDecimal | Direct land use change CO2e emissions for the distribution stage in context of a PCF. | +| Distribution Stage land use Greenhouse Gas Emissions | distributionStageLuGhgEmissions | O | O | Must be calculated per declared unit with
          kgCO2e / declaredUnit | 1.1 | Decimal | Land use CO2 emissions for the distribution stage in context of a PCF as specified by the TFS (Together For Sustainability) initiative. TFS specific extension. | +| Distribution Stage Aircraft Greenhouse Gas Emissions | distributionStageAircraftGhgEmissions | O | O | Must be calculated per declared unit with
          kgCO2e / declaredUnit equal to or greater zero | 0.0 | PositiveDecimal | GHG (Greenhouse Gas) emissions for the distribution stage resulting from aircraft engine usage for the transport of the product. | +| ***(Carbon Content)*** | | | | | | | | +| Carbon Content Total | carbonContentTotal | O* | O* | Must be calculated per declared unit with
          kgCO2e / declaredUnit equal to or greater zero | 2.5 | PositiveDecimal | Total carbon content per declared unit in context of a PCF. | +| Fossil Carbon Content | fossilCarbonContent | O* | O* | Must be calculated per declared unit with
          kgC / declaredUnit equal to or greater zero; per default calculated in Catena-X (Total - Biogenic) | 0.1 | PositiveDecimal | Fossil carbon amount embodied in a product. Must be calculated with kgC (kilogram Carbon) / declaredUnit equal to or greater zero; WBCSD specific extension, in Catena-X specified by a calculated value. | +| Biogenic Carbon Content | biogenicCarbonContent | O* | O* | Must be calculated per declared unit with
          kgC / declaredUnit equal to or greater zero | 0.0 | PositiveDecimal | Biogenic carbon amount embodied in a product. Must be calculated with kgC (kilogram Carbon) / declaredUnit equal to or greater zero. | + +
          + +#### Example Payload + +The following json shows an exemplary payload for a requested PCF value. + +
          + Payload + +```json +{ + "specVersion" : "urn:io.catenax.pcf:datamodel:version:7.0.0", + "companyIds" : [ "urn:bpn:id:BPNL000000000DWF", "urn:vat:id:DE123456789"], + "extWBCSD_productCodeCpc" : "011-99000", + "created" : "2022-05-22T21:47:32Z", + "companyName" : "My Corp", + "extWBCSD_pfStatus" : "Active", + "version" : 0, + "productName" : "My Product Name", + "pcf" : { + "biogenicCarbonEmissionsOtherThanCO2" : 1.0, + "distributionStagePcfExcludingBiogenic" : 1.5, + "biogenicCarbonWithdrawal" : 0.0, + "distributionStageBiogenicCarbonEmissionsOtherThanCO2" : 1.0, + "extWBCSD_allocationRulesDescription" : "In accordance with Catena-X PCF Rulebook", + "exemptedEmissionsDescription" : "No exemption", + "distributionStageFossilGhgEmissions" : 0.5, + "exemptedEmissionsPercent" : 0.0, + "geographyCountrySubdivision" : "US-NY", + "extTFS_luGhgEmissions" : 0.3, + "distributionStageBiogenicCarbonWithdrawal" : 0.0, + "pcfIncludingBiogenic" : 1.0, + "aircraftGhgEmissions" : 0.0, + "productMassPerDeclaredUnit" : 0.456, + "productOrSectorSpecificRules" : [ { + "extWBCSD_operator" : "PEF", + "productOrSectorSpecificRules" : [ { + "ruleName" : "urn:tfs-initiative.com:PCR:The Product Carbon Footprint Guideline for the Chemical Industry:version:v2.0" + } ], + "extWBCSD_otherOperatorName" : "NSF" + } ], + "extTFS_allocationWasteIncineration" : "cut-off", + "pcfExcludingBiogenic" : 2.0, + "referencePeriodEnd" : "2022-12-31T23:59:59Z", + "extWBCSD_characterizationFactors" : "AR5", + "secondaryEmissionFactorSources" : [ { + "secondaryEmissionFactorSource" : "ecoinvent 3.8" + } ], + "unitaryProductAmount" : 1000.0, + "declaredUnit" : "liter", + "referencePeriodStart" : "2022-01-01T00:00:01Z", + "geographyRegionOrSubregion" : "Africa", + "fossilGhgEmissions" : 0.5, + "distributionStageAircraftGhgEmissions" : 0.0, + "boundaryProcessesDescription" : "Electricity consumption included as an input in the production phase", + "geographyCountry" : "DE", + "extWBCSD_packagingGhgEmissions" : 0, + "dlucGhgEmissions" : 0.4, + "carbonContentTotal" : 2.5, + "extTFS_distributionStageLuGhgEmissions" : 1.1, + "primaryDataShare" : 56.12, + "dataQualityRating" : { + "completenessDQR" : 2.0, + "technologicalDQR" : 2.0, + "geographicalDQR" : 2.0, + "temporalDQR" : 2.0, + "reliabilityDQR" : 2.0, + "coveragePercent" : 100 + }, + "extWBCSD_packagingEmissionsIncluded" : true, + "extWBCSD_fossilCarbonContent" : 0.1, + "crossSectoralStandardsUsed" : [ { + "crossSectoralStandard" : "ISO Standard 14067" + } ], + "extTFS_distributionStageDlucGhgEmissions" : 1.0, + "distributionStagePcfIncludingBiogenic" : 0.0, + "carbonContentBiogenic" : 0.0 + }, + "partialFullPcf" : "Cradle-to-gate", + "productIds" : [ "urn:gtin:4712345060507", "urn:id:9587654", "urn:uuid4:id:9885a472-2cbf-4f89-9650-e83a44e7bdf1" ], + "validityPeriodStart" : "2022-01-01T00:00:01Z", + "comment" : "Additional explanatory information not reflected by other attributes", + "id" : "3893bb5d-da16-4dc1-9185-11d97476c254", + "validityPeriodEnd" : "2022-12-31T23:59:59Z", + "pcfLegalStatement" : "This PCF (Product Carbon Footprint) is for information purposes only. It is based upon the standards mentioned above.", + "productDescription" : "Ethanol, 95% solution", + "precedingPfIds" : [ { + "id" : "3893bb5d-da16-4dc1-9185-11d97476c254" + } ] +} +``` + +
          + +The entire PCF data model is available as open source through the following link: +[Catena-X PCF Datamodel](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.pcf/7.0.0) + +## Business Architecture + +The PCF Exchange KIT can be used to exchange PCF data within the Catena-X ecosystem in a decentralized and interoperable manner, while maintaining a high level of data sovereignty. To achieve this, the PCF Exchange KIT leverages other KITs (particularly the platform-related ones), standardized data models, and an Identity and Access Management (IAM) system based on OAuth and Self-Sovereign Identity (SSI) technology. + +In order to ensure **interoperability**, as described in the section on [Semantic Models](#semantic-models), a standardized data model is essential. However, it's not only the data model but also the standardized interfaces (both the PCF Exchange API and the standardized API provided by the Connector Kit) that contribute to interoperability. + +To enable **data sovereignty**, Catena-X relies on **Self-Sovereign-Identity** (SSI). This allows data providers to precisely specify the conditions that must be met before requested data is transmitted. In the context of the PCF KIT, the "PCF Credential" and "Membership Credential" are mandatory. The PCF Credential references the [PCF Framework Agreement](https://catena-x.net/fileadmin/user_upload/04_Einfuehren_und_umsetzen/Governance_Framework/231016_Catena-X_Use_Case_Framework_PCF.pdf) signed by a data consumer. The Membership Credential additionally ensures that the requester is an active member of Catena-X. + +The diagram shown here illustrates the interaction between the PCF KIT and the other Catena-X components. +![Business Architecture](resources/adoption-view/BusinessArchitecture.png) + +## STANDARDS + +The relevant standards can be downloaded from the official [Catena-X Standard Library](https://catenax-ev.github.io/docs/next/standards/overview): + +- [CX-0136 Product Carbon Footprint UseCase (Version 2.0.0)](https://catenax-ev.github.io/docs/next/standards/CX-0136-UseCasePCF) +- [CX-0029 Product Carbon Footprint Rulebook (Version 3.0.0)](https://catenax-ev.github.io/docs/next/standards/CX-0029-ProductCarbonFootprintRulebook) + +## REFERENCE IMPLEMENTATIONS + +Currently there is no reference FOSS (Free and Open-Source Software) implementation. Several COTS (Commercial Of-The-Shelf) solutions are available, e.g. offered by the following providers: + +- [SiGREEN (Siemens)](https://www.siemens.com/de/de/unternehmen/themenfelder/product-carbon-footprint.html) +- [SDX (SAP)](https://www.sap.com/sustainability/climate-action.html) +- [SPF (SupplyOn)](https://www.supplyon.com/en/solutions/sustainability/product-carbon-footprint/#contactform) +- [SDE (T-Systems)](https://dih.telekom.com/de/catena-x) + +## NOTICE + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2023,2024 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023,2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023,2024 T-Systems International GmbH +- SPDX-FileCopyrightText: 2023,2024 SAP SE +- SPDX-FileCopyrightText: 2023,2024 SIEMENS AG +- SPDX-FileCopyrightText: 2023,2024 SUPPLY ON AG +- SPDX-FileCopyrightText: 2023,2024 Volkswagen AG +- SPDX-FileCopyrightText: 2023,2024 Robert Bosch GmbH +- SPDX-FileCopyrightText: 2023,2024 Mercedes Benz Group +- SPDX-FileCopyrightText: 2023,2024 BASF SE +- SPDX-FileCopyrightText: 2023,2024 CCT +- SPDX-FileCopyrightText: 2023,2024 Gris Group +- SPDX-FileCopyrightText: 2023,2024 Contributors to the Eclipse Foundation +- [Source URL](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/PCF%20Exchange%20Kit) diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/page_documentation.md b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/page_documentation.md similarity index 87% rename from docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/page_documentation.md rename to docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/page_documentation.md index ea6b7003049..abc7feb8ab9 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/page_documentation.md +++ b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/page_documentation.md @@ -18,4 +18,4 @@ title: Documentation Overview - SPDX-FileCopyrightText: 2023,2023,2024 CCT - SPDX-FileCopyrightText: 2023,2023,2024 Gris Group - SPDX-FileCopyrightText: 2023,2023,2024 Contributors to the Eclipse Foundation -- [Source URL]() +- [Source URL](https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/PCF%20Exchange%20Kit) diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/page_software-operation-view.md b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/page_software-operation-view.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/page_software-operation-view.md rename to docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/page_software-operation-view.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/adoption-view/BusinessArchitecture.png b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/adoption-view/BusinessArchitecture.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/adoption-view/BusinessArchitecture.png rename to docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/adoption-view/BusinessArchitecture.png diff --git a/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/adoption-view/PCF Data Model Structure Rel. 24.08.png b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/adoption-view/PCF Data Model Structure Rel. 24.08.png new file mode 100644 index 00000000000..222e5c2c131 Binary files /dev/null and b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/adoption-view/PCF Data Model Structure Rel. 24.08.png differ diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/adoption-view/PCFCalculation.png b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/adoption-view/PCFCalculation.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/adoption-view/PCFCalculation.png rename to docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/adoption-view/PCFCalculation.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/adoption-view/PCFDataExchangeOverview.png b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/adoption-view/PCFDataExchangeOverview.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/adoption-view/PCFDataExchangeOverview.png rename to docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/adoption-view/PCFDataExchangeOverview.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/adoption-view/PCFRequestandResponse.png b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/adoption-view/PCFRequestandResponse.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/adoption-view/PCFRequestandResponse.png rename to docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/adoption-view/PCFRequestandResponse.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/adoption-view/ScopeofCatena-XUseCase.png b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/adoption-view/ScopeofCatena-XUseCase.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/adoption-view/ScopeofCatena-XUseCase.png rename to docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/adoption-view/ScopeofCatena-XUseCase.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/adoption-view/src/Customer Journeys PCF Data -- PCF KIT 24-03.pptx b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/adoption-view/src/Customer Journeys PCF Data -- PCF KIT 24-03.pptx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/adoption-view/src/Customer Journeys PCF Data -- PCF KIT 24-03.pptx rename to docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/adoption-view/src/Customer Journeys PCF Data -- PCF KIT 24-03.pptx diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/adoption-view/src/PCF Workflow -- Business Context -- PCF KIT 24-03.pptx b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/adoption-view/src/PCF Workflow -- Business Context -- PCF KIT 24-03.pptx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/adoption-view/src/PCF Workflow -- Business Context -- PCF KIT 24-03.pptx rename to docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/adoption-view/src/PCF Workflow -- Business Context -- PCF KIT 24-03.pptx diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/BuildingblockView.png b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/BuildingblockView.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/BuildingblockView.png rename to docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/BuildingblockView.png diff --git a/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/EDCDiscoveryanddDTRAccess.png b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/EDCDiscoveryanddDTRAccess.png new file mode 100644 index 00000000000..9aea8527ad4 Binary files /dev/null and b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/EDCDiscoveryanddDTRAccess.png differ diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/PCFRequestWithoutTwinOrSubmodel.png b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/PCFRequestWithoutTwinOrSubmodel.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/PCFRequestWithoutTwinOrSubmodel.png rename to docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/PCFRequestWithoutTwinOrSubmodel.png diff --git a/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/PCFRequestthroughAAS.png b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/PCFRequestthroughAAS.png new file mode 100644 index 00000000000..a912f234668 Binary files /dev/null and b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/PCFRequestthroughAAS.png differ diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/PCFUpdatePushedThroughEDC.png b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/PCFUpdatePushedThroughEDC.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/PCFUpdatePushedThroughEDC.png rename to docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/PCFUpdatePushedThroughEDC.png diff --git a/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/Tier1ABCOnlyUP.png b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/Tier1ABCOnlyUP.png new file mode 100644 index 00000000000..4e66fb8b2ed Binary files /dev/null and b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/Tier1ABCOnlyUP.png differ diff --git a/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/Tier1ABCUP.png b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/Tier1ABCUP.png new file mode 100644 index 00000000000..df003ab6a76 Binary files /dev/null and b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/Tier1ABCUP.png differ diff --git a/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/Tier1AOpenUP.png b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/Tier1AOpenUP.png new file mode 100644 index 00000000000..58f7d7859a6 Binary files /dev/null and b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/Tier1AOpenUP.png differ diff --git a/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/catena-x-pcf-endpoint-1_1_1.yaml b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/catena-x-pcf-endpoint-1_1_1.yaml new file mode 100644 index 00000000000..0401c7b8187 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/catena-x-pcf-endpoint-1_1_1.yaml @@ -0,0 +1,676 @@ +openapi: 3.0.0 +info: + title: Catena-X-pcf-request-endpoint + version: 1.1.1 +paths: + /productIds/{productId}: + get: + operationId: get_pcf + parameters: + - name: Edc-Bpn + description: The caller's Catena-X BusinessPartnerNumber + example: BPNL0000005AMPL3 + in: header + required: true + schema: + type: string + - name: productId + description: ID of the product/materiual the PCF is requested for + example: urn:id:8534x67 + in: path + required: true + schema: + type: string + - name: requestId + description: ID identifying the call (will be referenced in corresponding PCF response) + example: 2daa49aa-ee16-4df3-bca3-69ddead40419 + in: query + required: true + schema: + type: string + - name: message + in: query + required: false + description: URL encoded, max 250 chars + example: No%20offset%20included%2C%20please%21 + schema: + type: string + responses: + '202': + description: PCF was accepted. PCF will be sent later via to POST endpoint. + put: + operationId: set_pcf + parameters: + - name: Edc-Bpn + description: The caller's Catena-X BusinessPartnerNumber + example: BPNL0000005AMPL3 + in: header + required: true + schema: + type: string + - name: productId + description: ID of the product/materiual the PCF referring to + example: urn:id:8534x67 + in: path + required: true + schema: + type: string + - name: requestId + description: ID identifying the request call (same as within original PCF request), if the PUT is responing to a call. Can be dismissed in a PCF update call. + example: 2daa49aa-ee16-4df3-bca3-69ddead40419 + in: query + required: false + schema: + type: string + requestBody: + description: The requested PCF in WBCSD format + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ProductFootprintResponse' + responses: + '200': + description: '' +components: + schemas: + ProductFootprintResponse: + description: A Product (Carbon) Footprint represents the carbon footprint of a product with values as specified in the Catena-X PCF Rulebook in accordance with the WBCSD (World Business Council for Sustainable Development) Pathfinder framework and the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD/ PACT initiative. + type: object + properties: + id: + description: 'Mandatory: The product footprint identifier as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#id + $ref: '#/components/schemas/UuidV4Trait' + specVersion: + description: 'Mandatory: Version of the product footprint data specification as defined in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#specVersion + $ref: '#/components/schemas/Text' + partialFullPcf: + description: 'Mandatory: Indicator for partial or full PCF (Product Carbon Footprint) declaration as specified in the Catena-X PCF Rulebook (Version 3.0.0).' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#partialFullPcf + $ref: '#/components/schemas/PartialFullPcfCharacteristic' + precedingPfIds: + description: 'Optional: Set of preceding PCF (Product Carbon Footprint) identifiers without duplicates as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the WBCSD (World Business Council for Sustainable Development) Pathfinder framework and the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD/ PACT initiative. Declared as "optional" in WBCSD, needs to be covered by application.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#precedingPfIds + $ref: '#/components/schemas/PrecedingPfIdsCharacteristic' + version: + description: 'Mandatory: Version of the product (carbon) footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example set to "0" per default.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#version + $ref: '#/components/schemas/ProductFootprintVersion' + created: + description: 'Mandatory: Timestamp of the creation of the Product (Carbon) Footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#created + $ref: '#/components/schemas/Timestamp' + extWBCSD_pfStatus: + description: 'Mandatory: Status indicator of a product (carbon) footprint as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example set to "Active" per default.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#status + $ref: '#/components/schemas/PfStatusCharacteristic' + validityPeriodStart: + description: 'Optional: Start of interval during which the product (carbon) footprint is declared as valid as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. If specified, the validity period start must be equal to or greater than the reference period end.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#validityPeriodStart + $ref: '#/components/schemas/Timestamp' + validityPeriodEnd: + description: 'Optional: End of interval during which the product (carbon) footprint is declared as valid as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#validityPeriodEnd + $ref: '#/components/schemas/Timestamp' + comment: + description: 'Optional: Additional information and instructions related to the calculation of the product (carbon) footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#comment + $ref: '#/components/schemas/Text' + companyName: + description: 'Mandatory: Name of the product (carbon) footprint data owner as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#companyName + $ref: '#/components/schemas/NonEmptyStringTrait' + companyIds: + description: "Mandatory: Non-empty set of Uniform Resource Names (URN). Each value is supposed to uniquely identify the product (carbon) footprint data owner as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. For Catena-X Industry Core compliance the set of URNs must contain at least the Business Partner Number Legal Entity (BPNL) in the specified format urn:bpn:id:BPNL[a-zA-Z0-9]{12}.\_" + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#companyIds + $ref: '#/components/schemas/IdsTrait' + productDescription: + description: 'Optional: Free-form description of the product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#productDescription + $ref: '#/components/schemas/Text' + productIds: + description: 'Mandatory: Non-empty set of product identifiers. Each value is supposed to uniquely identify the product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X productId corresponds with Industry Core manufacturerPartId.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#productIds + $ref: '#/components/schemas/IdsTrait' + extWBCSD_productCodeCpc: + description: 'Mandatory: UN (United Nations) Product Classification Code (CPC - Central Classification Code) of a given product as specified the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, which will probably be declared as "optional" in a later WBCSD specification version. In Catena-X for example specified with default value "011-99000".' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#productCategoryCpc + $ref: '#/components/schemas/Text' + productName: + description: "Mandatory: Non-empty trade name of a product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X productNameCompany corresponds with Industry Core nameAtManufacturer.\_" + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#productNameCompany + $ref: '#/components/schemas/NonEmptyStringTrait' + pcf: + description: A PCF (Product Carbon Footprint) represents the carbon footprint of a product and related data as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#pcf + $ref: '#/components/schemas/CarbonFootprint' + pcfLegalStatement: + description: 'Optional: Option for legal statement/ disclaimer as specified in the Catena-X PCF Rulebook (Version 3.0.0).' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#pcfLegalStatement + $ref: '#/components/schemas/Text' + required: + - id + - specVersion + - partialFullPcf + - version + - created + - extWBCSD_pfStatus + - companyName + - companyIds + - productIds + - extWBCSD_productCodeCpc + - productName + - pcf + UuidV4Trait: + type: string + x-samm-aspect-model-urn: urn:samm:io.catenax.shared.uuid:2.0.0#UuidV4Trait + 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}$) + Text: + type: string + x-samm-aspect-model-urn: urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Text + description: Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc. + PartialFullPcfCharacteristic: + type: string + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#PartialFullPcfCharacteristic + description: Characteristic for defining an indicator for partial or full PCF (Product Carbon Footprint) declaration as specified in the Catena-X PCF Rulebook (Version 3.0.0). + enum: + - Cradle-to-gate + - Cradle-to-grave + PrecedingPfId: + description: Entity for defining a preceding PCF (Product Carbon Footprint) identifier entity as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#PrecedingPfId + type: object + properties: + id: + description: 'Mandatory: The product footprint identifier as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#id + $ref: '#/components/schemas/UuidV4Trait' + required: + - id + PrecedingPfIdsCharacteristic: + description: Characteristic for defining a non-empty set of product (carbon) footprint identifiers as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the WBCSD (World Business Council for Sustainable Development) Pathfinder framework and the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD/ PACT initiative. + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#PrecedingPfIdsCharacteristic + type: array + items: + $ref: '#/components/schemas/PrecedingPfId' + ProductFootprintVersion: + type: number + minimum: 0 + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#ProductFootprintVersion + description: Characteristic for defining a product footprint version as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + 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))?' + x-samm-aspect-model-urn: urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Timestamp + description: Describes a Property which contains the date and time with an optional timezone. + PfStatusCharacteristic: + type: string + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#PfStatusCharacteristic + description: Characteristic for defining a status indicator of a product (carbon) footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Enumeration with possible "Active" and "Deprecated". + enum: + - Active + - Deprecated + NonEmptyStringTrait: + type: string + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#NonEmptyStringTrait + description: Constraint for ensuring that a string has at least one character. + minLength: 1 + IdsTrait: + description: Constraint for defining a non-empty set of URIs (Uniform Resource Identifieres). + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#IdsTrait + type: array + items: + type: string + format: uri + minItems: 1 + DeclaredUnitCharacteristic: + type: string + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#DeclaredUnitCharacteristic + description: Unit of analysis of the product with accepted values as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. For countable products/ components/ materials, Catena-X for example adds the unit "piece" to the value list specified by WBCSD. + enum: + - liter + - kilogram + - cubic meter + - kilowatt hour + - megajoule + - ton kilometer + - square meter + - piece + StrictlyPositiveDecimalTrait: + type: number + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#StrictlyPositiveDecimalTrait + description: Constraint for defining a positive, non-zero decimal. + minimum: 0 + exclusiveMinimum: true + PositiveDecimalWeightTrait: + type: number + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#PositiveDecimalWeightTrait + description: Constraint for defining a decimal equal to or greater than zero. + minimum: 0 + exclusiveMinimum: false + ExemptedEmissionsPercentTrait: + type: number + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#ExemptedEmissionsPercentTrait + description: Characteristic for defining the percentage of emissions excluded from a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + maximum: 5 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + GeographyCountrySubdivisionTrait: + type: string + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#GeographyCountrySubdivisionTrait + description: Constraint for defining a geography country subdivision in compliance to ISO 3166-2 as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + pattern: ([A-Z]{2}-[A-Z0-9]{1,3}|) + GeographyCountryTrait: + type: string + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#GeographyCountryTrait + description: Constraint for defining a geography country conform to ISO 3166CC as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + pattern: ([A-Z]{2}) + GeographyRegionOrSubregionCharacteristic: + type: string + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#GeographyRegionOrSubregionCharacteristic + description: Characteristic for defining a list of valid geographic regions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example "Global" has been added to the value list. + enum: + - Africa + - Americas + - Asia + - Europe + - Oceania + - Australia and New Zealand + - Central Asia + - Eastern Asia + - Eastern Europe + - Latin America and the Caribbean + - Melanesia + - Micronesia + - Northern Africa + - Northern America + - Northern Europe + - Polynesia + - South-eastern Asia + - Southern Asia + - Southern Europe + - Sub-Saharan Africa + - Western Asia + - Western Europe + - Global + - Several + CrossSectoralStandardsUsedEnumerationCharacteristic: + type: string + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#CrossSectoralStandardsUsedEnumerationCharacteristic + description: Characteristic for defining the enumeration of valid accounting standards used for product carbon footprint calculation as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + enum: + - ISO Standard 14067 + - ISO Standard 14044 + - Pathfinder v1 + - Pathfinder v2 + - PAS 2050 + - ISO Standard 14040 + - ISO Standard 14041 + - ISO Standard 14042 + - ISO Standard 14043 + - PEF + - Other + - GHG Protocol Product Standard + CrossSectoralStandard: + description: Entity for defining an accounting standard used for product carbon footprint calculation as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#CrossSectoralStandard + type: object + properties: + crossSectoralStandard: + description: 'Mandatory: Discloses a cross-sectoral standard applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#crossSectoralStandard + $ref: '#/components/schemas/CrossSectoralStandardsUsedEnumerationCharacteristic' + required: + - crossSectoralStandard + CrossSectoralStandardSet: + description: Characteristic for defining the list of valid accounting standards used for product carbon footprint calculation as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#CrossSectoralStandardSet + type: array + items: + $ref: '#/components/schemas/CrossSectoralStandard' + ProductOrSectorSpecificRuleOperator: + type: string + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#ProductOrSectorSpecificRuleOperator + description: Enumeration of PCR (Product Category Rule) operators as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension for example in Catena-X. + enum: + - PEF + - EPD International + - Other + RuleName: + description: Name of a rule applied by a specified operator as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#RuleName + type: object + properties: + ruleName: + description: Name of a rule applied by a specific operator as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#ruleName + $ref: '#/components/schemas/NonEmptyStringTrait' + required: + - ruleName + RuleNamesTrait: + description: Constraint for defining a non-empty set of rule names as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#RuleNamesTrait + type: array + items: + $ref: '#/components/schemas/RuleName' + uniqueItems: true + minItems: 1 + ProductOrSectorSpecificRule: + description: Entity for defining a product or sector specific rule of a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#ProductOrSectorSpecificRule + type: object + properties: + extWBCSD_operator: + description: 'Mandatory: Operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example must always be "Other".' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#operator + $ref: '#/components/schemas/ProductOrSectorSpecificRuleOperator' + productOrSectorSpecificRules: + description: 'Mandatory: Product-specific or sector-specific set of rules used for calculating or allocating GHG (Greenhouse Gas) emissions applied from the specified operator as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#ruleNames + $ref: '#/components/schemas/RuleNamesTrait' + extWBCSD_otherOperatorName: + description: 'Optional: Other operator of PCR (Product Category Rule)/ PSR (Product Specific Rule) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by a default value.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#otherOperatorName + $ref: '#/components/schemas/NonEmptyStringTrait' + required: + - extWBCSD_operator + - productOrSectorSpecificRules + ProductOrSectorSpecificRuleSet: + description: Characteristic for defining the set of product or sector specific rules of a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#ProductOrSectorSpecificRuleSet + type: array + items: + $ref: '#/components/schemas/ProductOrSectorSpecificRule' + uniqueItems: true + CharacterizationFactorsCharacteristic: + type: string + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#CharacterizationFactorsCharacteristic + description: Characteristic for defining the characterization factors of a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example specified by a default value. + enum: + - AR5 + - AR6 + AllocationWasteIncinerationCharacteristic: + type: string + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#AllocationWasteIncinerationCharacteristic + description: Characteristic for defining the allocation approach used for waste incineration as specified by the TFS (Together For Sustainability) initiative. + enum: + - cut-off + - reverse cut-off + - system expansion + PercentTrait: + type: number + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#PercentTrait + description: Constraint for a decimal number in the range of and including 0 and 100. + maximum: 100 + exclusiveMaximum: false + minimum: 0 + exclusiveMinimum: false + EmissionFactorDS: + description: Entity for defining an emission factor data source used to calculate a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#EmissionFactorDS + type: object + properties: + secondaryEmissionFactorSource: + description: 'Mandatory: Emission factor data source used to calculate a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#emissionFactorDS + $ref: '#/components/schemas/Text' + required: + - secondaryEmissionFactorSource + EmissionFactorDSSet: + description: Characteristic for defining a set of emission factor sources used for calculating a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#EmissionFactorDSSet + type: array + items: + $ref: '#/components/schemas/EmissionFactorDS' + uniqueItems: true + DqiNumberTrait: + type: number + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#DqiNumberTrait + description: Constraint for defining a decimal between 1 and 3 including. + maximum: 3 + exclusiveMaximum: false + minimum: 1 + exclusiveMinimum: false + DataQualityIndicators: + description: Characteristic for defining the quantitative data quality indicators of a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#DataQualityIndicators + type: object + properties: + coveragePercent: + description: 'Mandatory starting 2025: Percentage of PCF (Product Carbon Footprint) included in the data quality assessment based on the >5% emissions threshold as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example set to "100" per default.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#coveragePercent + $ref: '#/components/schemas/PercentTrait' + technologicalDQR: + description: 'Optional: Technological representativeness of the sources used for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#technologicalDQR + $ref: '#/components/schemas/DqiNumberTrait' + temporalDQR: + description: 'Optional: Temporal representativeness of the sources used for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#temporalDQR + $ref: '#/components/schemas/DqiNumberTrait' + geographicalDQR: + description: 'Optional: Geographical representativeness of the sources used for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#geographicalDQR + $ref: '#/components/schemas/DqiNumberTrait' + completenessDQR: + description: 'Optional: Completeness of the data collected for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#completenessDQR + $ref: '#/components/schemas/DqiNumberTrait' + reliabilityDQR: + description: 'Optional: Reliability of the data collected for PCF (Product Carbon Footprint) calculation based on weighted average of all inputs representing >5% of PCF emissions. Specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#reliabilityDQR + $ref: '#/components/schemas/DqiNumberTrait' + Boolean: + type: boolean + x-samm-aspect-model-urn: urn:samm:org.eclipse.esmf.samm:characteristic:2.1.0#Boolean + description: Represents a boolean value (i.e. a "flag"). + PositiveEmissionsTrait: + type: number + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#PositiveEmissionsTrait + description: 'Only positive emission values (>0) are valid ' + minimum: 0 + exclusiveMinimum: false + PositiveOrNegativeEmission: + type: number + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#PositiveOrNegativeEmission + description: Characteristic for defining (positive or negative) emissions in context of a PCF (Product Carbon Footprint) as specified by the WBCSD (World Business Council for Sustainable Development) Pathfinder initiative. + NegativeEmissionsTrait: + type: number + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#NegativeEmissionsTrait + description: Only negative emission values (<=0) are valid. + maximum: 0 + exclusiveMaximum: false + PcfEntity: + description: Entity for defining a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#PcfEntity + type: object + properties: + declaredUnit: + description: 'Mandatory: Unit of analysis of a product in context of the PCF (product carbon footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. In Catena-X for example list of valid units includes "piece".' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#declaredUnit + $ref: '#/components/schemas/DeclaredUnitCharacteristic' + unitaryProductAmount: + description: 'Mandatory: Amount of units contained within a product in context of the PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#unitaryProductAmount + $ref: '#/components/schemas/StrictlyPositiveDecimalTrait' + productMassPerDeclaredUnit: + description: 'Mandatory: Mass of a product per declared unit (net, unpackaged) in context of the PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0).' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#productMassPerDeclaredUnit + $ref: '#/components/schemas/PositiveDecimalWeightTrait' + exemptedEmissionsPercent: + description: |- + Mandatory: Applied cut-off percentage of emissions excluded from PCF (Product Carbon Footprint). + For accordance with Catena-X PCF Rulebook (Version 3.0.0) <3%. + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#exemptedEmissionsPercent + $ref: '#/components/schemas/ExemptedEmissionsPercentTrait' + exemptedEmissionsDescription: + description: 'Optional: Rationale behind exclusion of specific PCF (Product Carbon Footprint) emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#exemptedEmissionsDescription + $ref: '#/components/schemas/Text' + boundaryProcessesDescription: + description: 'Optional: Processes attributable to each lifecycle stage as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#boundaryProcessesDescription + $ref: '#/components/schemas/Text' + geographyCountrySubdivision: + description: 'Optional: Subdivision of a country which must be an ISO 3166-2 subdivision code as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#geographyCountrySubdivision + $ref: '#/components/schemas/GeographyCountrySubdivisionTrait' + geographyCountry: + description: 'Optional: Two letter country code that must conform to data type ISO 3166CC as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#geographyCountry + $ref: '#/components/schemas/GeographyCountryTrait' + geographyRegionOrSubregion: + description: 'Mandatory: Region according to list as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#geographyRegionOrSubregion + $ref: '#/components/schemas/GeographyRegionOrSubregionCharacteristic' + referencePeriodStart: + description: 'Mandatory: Start of time boundary for which a PCF (Product Carbon Footprint) value is considered to be representative as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#referencePeriodStart + $ref: '#/components/schemas/Timestamp' + referencePeriodEnd: + description: 'Mandatory: End of time boundary for which a PCF (Product Carbon Footprint) value is considered to be representative as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#referencePeriodEnd + $ref: '#/components/schemas/Timestamp' + crossSectoralStandardsUsed: + description: 'Mandatory: Discloses the cross-sectoral standards applied for calculating or allocating GHG (Greenhouse Gas) emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#crossSectoralStandardsUsed + $ref: '#/components/schemas/CrossSectoralStandardSet' + productOrSectorSpecificRules: + description: 'Mandatory: Product or sector specific rules applied for calculating or allocating GHG (Greenhouse Gas) emissions, e.g. PCRs (Product Category Rules), including operators or publishers and according rule names as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#productOrSectorSpecificRules + $ref: '#/components/schemas/ProductOrSectorSpecificRuleSet' + extWBCSD_characterizationFactors: + description: 'Mandatory: IPCC (Intergovernmental Panel on Climate Change) version of the GWP (Global Warming Potential) characterization factors used for calculating the PCF (Product Carbon Footprint) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by default with value \"AR6\". Default value can be overwritten.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#characterizationFactors + $ref: '#/components/schemas/CharacterizationFactorsCharacteristic' + extWBCSD_allocationRulesDescription: + description: 'Optional: Allocation rules used and underlying reasoning in context of a product carbon footprint as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension, in Catena-X for example specified by default with value "In accordance with Catena-X PCF Rulebook (Version 3.0.0)".' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#allocationRulesDescription + $ref: '#/components/schemas/Text' + extTFS_allocationWasteIncineration: + description: 'Mandatory: Allocation approach used for waste incineration with energy recovery as specified by the TFS (Together For Sustainability) initiative. In Catena-X for example must be specified by value "cut-off".' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#allocationWasteIncineration + $ref: '#/components/schemas/AllocationWasteIncinerationCharacteristic' + primaryDataShare: + description: 'Mandatory starting 2025: Share of primary data in percent as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#primaryDataShare + $ref: '#/components/schemas/PercentTrait' + secondaryEmissionFactorSources: + description: 'Mandatory: Emission factors used for the PCF (Product Carbon Footprint) calculation as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#secondaryEmissionFactorSources + $ref: '#/components/schemas/EmissionFactorDSSet' + dataQualityRating: + description: 'Mandatory starting 2025: Quantitative data quality indicators of a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#dqi + $ref: '#/components/schemas/DataQualityIndicators' + extWBCSD_packagingEmissionsIncluded: + description: |- + Mandatory: The Catena-X PCF Rulebook requires to include packaging from a system boundary perspective. "FALSE" is only possible due to the application of the cut-off rule. + Flag indicating whether packaging emissions are included in a PCF (Product Carbon Footprint) as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension. + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#packagingEmissionsIncluded + $ref: '#/components/schemas/Boolean' + pcfExcludingBiogenic: + description: 'Mandatory: Product carbon footprint of a product excluding biogenic emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#pcfExcludingBiogenic + $ref: '#/components/schemas/PositiveEmissionsTrait' + pcfIncludingBiogenic: + description: 'Mandatory starting 2025: Product carbon footprint of a product including biogenic emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Optional value in current specification version but will be mandatory in future version.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#pcfIncludingBiogenic + $ref: '#/components/schemas/PositiveOrNegativeEmission' + fossilGhgEmissions: + description: 'Mandatory starting 2025: Emissions from combustion of fossil sources as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Identical to "pcfExcludingBiogenic", will be removed in later version.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#fossilGhgEmissions + $ref: '#/components/schemas/PositiveEmissionsTrait' + biogenicCarbonEmissionsOtherThanCO2: + description: 'Mandatory starting 2025: GWP (Global Warming Potential) of biogenic CO2e-emissions in production phase which contain only GHG (Greenhouse Gas) emissions other than CO2 - excludes biogenic CO2. For specification see Catena-X PCF Rulebook (Version 3.0.0).' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#biogenicCarbonEmissionsOtherThanCO2 + $ref: '#/components/schemas/PositiveEmissionsTrait' + biogenicCarbonWithdrawal: + description: 'Mandatory starting 2025: Biogenic carbon content in the product converted to CO2e as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#biogenicCarbonWithdrawal + $ref: '#/components/schemas/NegativeEmissionsTrait' + dlucGhgEmissions: + description: 'Mandatory starting 2025: Direct land use change CO2e emissions in context of a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#dlucGhgEmissions + $ref: '#/components/schemas/PositiveEmissionsTrait' + extTFS_luGhgEmissions: + description: 'Mandatory starting 2025: Land use CO2 emissions in context of a product carbon footprint as specified by the TFS (Together For Sustainability) initiative. TFS specific extension.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#luGhgEmissions + $ref: '#/components/schemas/PositiveOrNegativeEmission' + aircraftGhgEmissions: + description: 'Mandatory starting 2025: GHG (Greenhouse Gas) emissions resulting from aircraft engine usage for the transport of the product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#aircraftGhgEmissions + $ref: '#/components/schemas/PositiveEmissionsTrait' + extWBCSD_packagingGhgEmissions: + description: 'Optional: Emissions resulting from the packaging of the product as specified in the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. WBCSD specific extension. In Catena-X not relevant to be reported separately.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#packagingGhgEmissions + $ref: '#/components/schemas/PositiveEmissionsTrait' + distributionStagePcfExcludingBiogenic: + description: 'Optional: Product carbon footprint for the distribution stage of a product excluding biogenic emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0).' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#distributionStagePcfExcludingBiogenic + $ref: '#/components/schemas/PositiveEmissionsTrait' + distributionStagePcfIncludingBiogenic: + description: 'Optional: Product carbon footprint for the distribution stage of a product including biogenic emissions as specified in the Catena-X PCF Rulebook (Version 3.0.0).' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#distributionStagePcfIncludingBiogenic + $ref: '#/components/schemas/PositiveOrNegativeEmission' + distributionStageFossilGhgEmissions: + description: 'Optional: Emissions from the combustion of fossil sources in the distribution stage as specified in the Catena-X PCF Rulebook (Version 3.0.0).' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#distributionStageFossilGhgEmissions + $ref: '#/components/schemas/PositiveEmissionsTrait' + distributionStageBiogenicCarbonEmissionsOtherThanCO2: + description: 'Optional: GWP (Global Warming Potential) of biogenic CO2e-emissions in distribution phase which contain only GHG (Greenhouse Gas) emissions other than CO2 ? excludes biogenic CO2. For specification see Catena-X PCF Rulebook (Version 3.0.0).' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#distributionStageBiogenicCarbonEmissionsOtherThanCO2 + $ref: '#/components/schemas/PositiveEmissionsTrait' + distributionStageBiogenicCarbonWithdrawal: + description: 'Optional: GWP (Global Warming Potential) of biogenic CO2-withdrawal in distribution stage (biogenic CO2 contained in the product) as specified in the Catena-X PCF Rulebook (Version 3.0.0).' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#distributionStageBiogenicCarbonWithdrawal + $ref: '#/components/schemas/NegativeEmissionsTrait' + extTFS_distributionStageDlucGhgEmissions: + description: 'Optional: Direct land use change CO2 emissions during distribution stage in context of a product carbon footprint as specified by the TFS (Together For Sustainability) initiative. TFS specific extension.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#distributionStageDlucGhgEmissions + $ref: '#/components/schemas/PositiveEmissionsTrait' + extTFS_distributionStageLuGhgEmissions: + description: 'Optional: Land use CO2 emissions in context of a product carbon footprint as specified by the TFS (Together For Sustainability) initiative. TFS specific extension.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#distributionStageLuGhgEmissions + $ref: '#/components/schemas/PositiveOrNegativeEmission' + carbonContentTotal: + description: 'Mandatory starting 2025: Total carbon content per declared unit in context of a product carbon footprint as specified in the Catena-X PCF Rulebook (Version 3.0.0).' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#carbonContentTotal + $ref: '#/components/schemas/PositiveEmissionsTrait' + extWBCSD_fossilCarbonContent: + description: 'Mandatory starting 2025: Fossil carbon amount embodied in a product as specified in the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Must be calculated with kgC (kilogram Carbon) / declaredUnit equal to or greater zero; WBCSD specific extension, in Catena-X specified by a calculated value.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#fossilCarbonContent + $ref: '#/components/schemas/PositiveEmissionsTrait' + carbonContentBiogenic: + description: 'Mandatory starting 2025: Biogenic carbon amount embodied in a product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.1.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. Must be calculated with kgC (kilogram Carbon) / declaredUnit equal to or greater zero.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#biogenicCarbonContent + $ref: '#/components/schemas/PositiveEmissionsTrait' + distributionStageAircraftGhgEmissions: + description: 'Optional: GHG (Greenhouse Gas) emissions for the distribution stage resulting from aircraft engine usage for the transport of the product as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative.' + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#distributionStageAircraftGhgEmissions + $ref: '#/components/schemas/PositiveEmissionsTrait' + required: + - declaredUnit + - unitaryProductAmount + - productMassPerDeclaredUnit + - exemptedEmissionsPercent + - geographyRegionOrSubregion + - referencePeriodStart + - referencePeriodEnd + - crossSectoralStandardsUsed + - productOrSectorSpecificRules + - extWBCSD_characterizationFactors + - extTFS_allocationWasteIncineration + - secondaryEmissionFactorSources + - extWBCSD_packagingEmissionsIncluded + - pcfExcludingBiogenic + CarbonFootprint: + description: Characteristic for defining a PCF (Product Carbon Footprint) as specified in the Catena-X PCF Rulebook (Version 3.0.0) in accordance with the technical specifications for PCF Data Exchange (Version 2.0.0) from the WBCSD (World Business Council for Sustainable Development)/ PACT initiative. + x-samm-aspect-model-urn: urn:samm:io.catenax.pcf:7.0.0#CarbonFootprint + type: object + allOf: + - $ref: '#/components/schemas/PcfEntity' \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/src/EDCDiscoveryAnddDTRAccess.puml b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/src/EDCDiscoveryAnddDTRAccess.puml similarity index 98% rename from docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/src/EDCDiscoveryAnddDTRAccess.puml rename to docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/src/EDCDiscoveryAnddDTRAccess.puml index 6a36e0c6255..2152c44565c 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/src/EDCDiscoveryAnddDTRAccess.puml +++ b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/src/EDCDiscoveryAnddDTRAccess.puml @@ -71,7 +71,7 @@ Showing submodel only to ease readability! "keys": [ { "type": "GlobalReference", - "value": "urn:samm:io.catenax.pcf:6.0.0#Pcf" + "value": "urn:samm:io.catenax.pcf:7.0.0#Pcf" } ] }, diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/src/PCFRequest.puml b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/src/PCFRequest.puml similarity index 68% rename from docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/src/PCFRequest.puml rename to docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/src/PCFRequest.puml index bd1d78c49cc..86ace6b323e 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/src/PCFRequest.puml +++ b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/src/PCFRequest.puml @@ -1,8 +1,4 @@ -<<<<<<< HEAD:docs-kits/kits/PCF Exchange Kit/resources/development-view/PCFRequestWithoutTwinOrSubmodel.puml -@startuml "PCF Request with missing Twin or Submodel" -======= @startuml "PCF Request through AAS" ->>>>>>> feature/PCF-Kit-Update_Rel-24-05:docs-kits/kits/PCF Exchange Kit/resources/development-view/src/PCFRequest.puml participant PCF_Client participant Client_API_Wapper @@ -73,11 +69,7 @@ end group Lookup Clients PCF Receive Asset Company_PCF_App -> Company_EDC: Lookup Client's Receive Asset\n(via Company's EDC URL) -<<<<<<< HEAD:docs-kits/kits/PCF Exchange Kit/resources/development-view/PCFRequestWithoutTwinOrSubmodel.puml -Company_EDC -> Client_EDC: Lookup Asset in Catalog\n(EDC asset type "data.pcf.exchangeEndpoint") -======= Company_EDC -> Client_EDC: Lookup Asset in Catalog\n(EDC asset type '{"@id":"cx-taxo:PcfExchange"}') ->>>>>>> feature/PCF-Kit-Update_Rel-24-05:docs-kits/kits/PCF Exchange Kit/resources/development-view/src/PCFRequest.puml note right There could be multiple EDC URLs, but only one with a PCF Exchange Asset @@ -87,29 +79,14 @@ Company_EDC -> Company_PCF_App: PCF Asset ID end group Push PCF to Client -<<<<<<< HEAD:docs-kits/kits/PCF Exchange Kit/resources/development-view/PCFRequestWithoutTwinOrSubmodel.puml -Company_PCF_App -> Company_API_Wapper: Invoke asset with reqID, BPN & comment -note right -PUT https://clientApiWrapperUrl/api/service/20ac18ab-5820-4065-9087-416d78e155cd/productIds/mat345?providerUrl=https://client.controlplane.url:8184&requestId=123&BPN=& -======= Company_PCF_App -> Company_API_Wapper: Invoke asset with reqID note right PUT https://clientApiWrapperUrl/api/service/20ac18ab-5820-4065-9087-416d78e155cd/productIds/mat345?providerUrl=https://client.controlplane.url:8184&requestId=123 ->>>>>>> feature/PCF-Kit-Update_Rel-24-05:docs-kits/kits/PCF Exchange Kit/resources/development-view/src/PCFRequest.puml end note Company_API_Wapper -> Company_EDC: Negotiate access to asset and enable proxy transfer Company_EDC -> Client_EDC: Negotiate access to asset and enable proxy transfer Client_EDC -> Company_EDC: Agreement & EndpointDataReference Company_EDC -> Company_API_Wapper: Agreement & EndpointDataReference -<<<<<<< HEAD:docs-kits/kits/PCF Exchange Kit/resources/development-view/PCFRequestWithoutTwinOrSubmodel.puml -Company_API_Wapper -> Company_EDC: PCF endpoint call incl. req.ID & BPN -Company_EDC -> Client_EDC: PCF endpoint call incl. req.ID & BPN -note right -Using PCF API through EDC via HTTP Proxy: -PUT https://{someURL}/productIds/mat345?requestId=123&BPN= -end note -Client_EDC -> PCF_Client: PCF endpoint call incl. req.ID, BPN & comment -======= Company_API_Wapper -> Company_EDC: PCF endpoint call incl. req.ID Company_EDC -> Client_EDC: PCF endpoint call incl. req.ID note right @@ -117,7 +94,6 @@ Using PCF API through EDC via HTTP Proxy: PUT https://{someURL}/productIds/mat345?requestId=123 end note Client_EDC -> PCF_Client: PCF endpoint call incl. req.ID & BPN (Header) ->>>>>>> feature/PCF-Kit-Update_Rel-24-05:docs-kits/kits/PCF Exchange Kit/resources/development-view/src/PCFRequest.puml PCF_Client -> Client_EDC: OK Client_EDC -> Company_EDC: OK Company_EDC -> Company_API_Wapper: OK diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/src/PCFRequestAlternatives.puml b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/src/PCFRequestAlternatives.puml similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/src/PCFRequestAlternatives.puml rename to docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/src/PCFRequestAlternatives.puml diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/src/PCFRequestWithoutTwinOrSubmodel.puml b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/src/PCFRequestWithoutTwinOrSubmodel.puml similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/src/PCFRequestWithoutTwinOrSubmodel.puml rename to docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/src/PCFRequestWithoutTwinOrSubmodel.puml diff --git a/docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/src/PCFUpdate.puml b/docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/src/PCFUpdate.puml similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/PCF Exchange Kit/resources/development-view/src/PCFUpdate.puml rename to docs-kits_versioned_docs/version-24.12/kits/PCF Exchange Kit/resources/development-view/src/PCFUpdate.puml diff --git a/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/page_software-development-view.md b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/page_software-development-view.md new file mode 100644 index 00000000000..fb626f8ffa7 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/page_software-development-view.md @@ -0,0 +1,932 @@ +--- +id: Software Development PURIS Kit +title: Software Development View +description: "PURIS Kit" +sidebar_position: 3 +--- + +![puris kit banner](/img/kit-icons/puris-kit-icon.svg) + +## Introduction + +The Development View provides information and resources for implementing the PURIS standards.. The architecture chapter +describes the interactions of all components in the PURIS context as well as the shared asset approach. The policies +chapter describes the access policies, usage policies, contract definitions and include information about the framework +agreement. The protocol chapter gives examples how the connector data asset is registered and how shell descriptors are +created. In the chapter sample data the PURIS aspect models are defined with a reference to the turtle file and an +example JSON payload. For the ready PURIS implementation and quick installation guides, please see Operation View. + +## Architecture + +This chapter shows the interactions of all necessary components required to fulfill the PURIS standards. + +Also the standards' transferred data objects are shown in the Catena-X context of registered assets. + +### Component Architecture (High-Level View) + +Figure 1 shows the high-level architecture of the Submodel exchange in the Catena-X dataspace and the services that are +involved. Both the data provider and the data consumer must be members of the Catena-X network in order to communicate +with each other. With the help of the Identity Access Management (IAM) each participant can authenticate itself, verify +the identity including associated claims (see Usage Purpose section) of the requesting party and decide whether to +authorize the request. For a local deployment of the portal including the IAM components, please refer to +the [umbrella helm chart](https://github.com/eclipse-tractusx/tractus-x-umbrella "https://github.com/eclipse-tractusx/tractus-x-umbrella"). +The data is provisioned in accordance with +the [Digital Twin KIT](https://eclipse-tractusx.github.io/docs-kits/next/kits/Digital%20Twin%20Kit/Software%20Development%20View/dt-kit-interaction-patterns) +in Catena-X. The architecture in this figure only applies to standards that are based on the Digital Twins in +Catena-X ([Digital Twin KIT](https://eclipse-tractusx.github.io/docs-kits/next/kits/Digital%20Twin%20Kit/Software%20Development%20View/dt-kit-interaction-patterns)). + +![PURIS Conceptual Levels](resources/PURIS-R2405-architecture-sketch.svg) +_Figure 1: High-level architecture of the submodel exchange in the Catena-X dataspace_ + +### Component Architecture (Conceptual Whitebox View) + +From conceptual point of view a PURIS system consists of different building blocks. These building blocks in the +following diagram show which participant deploys which components. Identification and Access Management is omitted for +simplicity reasons. + +![Whitebox View](resources/PURIS-KIT-24.08-Whitebox.svg) +_Figure 2: Whitebox view on a PURIS system_ + +The PURIS App is a software application that allows to exchange relevant data with partners. It's meant to + +- Provide data following the shared asset approach (see Digital Twin KIT). It manages the Digital Twin Registry (AAS + Registry and AAS Discovery API) and provides the data in the correct format via Submodel API. +- Manage the apis and assets in the Connector ( + see [Connector KIT](https://eclipse-tractusx.github.io/docs-kits/category/connector-kit)). + +The following components are needed for the communication based on the PURIS standard: + +- PURIS App: Component orchestrating the Data Exchange following this KIT (as explained above) while providing business + value. +- Connector: Component that manages data and API as assets to enable the sovereign data exchange (see Connector KIT) +- Digital Twin Registry: Component that provides AAS Registry and AAS Discovery API implementations (see Digital Twin + KIT) +- Data Provisioning & Transformation: Proprietary component allowing to use OWN data or to use PURIS data in internal + systems. +- Identity and Access Management (IAM): Identity Provider spanning authentication and authorization within Catena-X + and / or your company. Includes the Credential Service to proof e.g. that a participant signed the Framework + Agreement. + +Beside that a partner may use the Discovery Service in Catena-X to determine the EDC for a partner based on a Business +Partner Number Legal Entity. As there already exists a contractual basis, this information in the PURIS context can be +considered as known a-priori. + +### Distribution of aspects in shared asset approach + +Figure 2 shows how the shared asset approach is realized. The orange lines show which submodels belong to the respective +AAS. All specific submodels are bound to the specific Part Type's context e.g., meaning that each aspect is described +for the specific catalog item on supplier and customer side represented by the AASs. +See [Digital Twin KIT](https://eclipse-tractusx.github.io/docs-kits/category/digital-twin-kit) for more information on +the shared asset approach. + +The orange submodels are the submodels used within this standard's context. + +The grey submodels are used within +the [Industry Core KIT](https://eclipse-tractusx.github.io/docs-kits/next/category/industry-core-kit) ( +_PartTypeInformation, SingleLevelBomAsPlanned, SingleLevelUsageAsPlanned_). Besides PartTypeInformation on +supplier-side, no other models are mandatory. The Bill Of Material (BOM) and usage models can be used to build data +chains, if the partners align to ( +see [Industry Core KIT](https://eclipse-tractusx.github.io/docs-kits/next/category/industry-core-kit)). This KIT relies +on the "_Part Type_" life cycle of the Industry Core representing catalog items after sourcing. + +The blue dashed lines show the references between DTs based on Catena-X UUIDs and BPNL information that may be resolved +by the Item Relationship Service ( +see [Industry Core KIT](https://eclipse-tractusx.github.io/docs-kits/next/category/industry-core-kit), [Data Chain KIT](https://eclipse-tractusx.github.io/docs-kits/category/data-chain-kit) +and [Traceability KIT](https://eclipse-tractusx.github.io/docs-kits/category/traceability-kit)). + +The shared asset approach shown in figure 2 is one of the patterns described in the Digital Twin KIT. It preserves the +sovereignty by provisioning the aspect on on the owning partner's side creating a common view on the asset. A shared +asset approach is needed whenever the customer provides data for a part type digital twin. The following implications +apply: + +- The supplier generates the Catena-X ID and provides the aspect model _PartTypeInformation_ while the customer reuses + the generated Catena-X ID for his digital twin representation (see Industry Core KIT). +- If only the supplier would provide the Planned Production Output, no digital twin representation would be needed on + the customer-side. +- Also if only the customer provides information (e.g. Short-Term Material Demand), the supplier needs to create the + digital twin first so that the customer can create his representation. +- While one supplier side twin can be created to handle multiple customers, a customer must create the representation of + the specific twin per supplier - also if it's the same part type from customer point of view. + +Note: from business point of view a quid-pro-quo principle of exchanged information is recommended (stock for stock, +production for demand, delivery information as needed based inco term, days of supply for days of supply). + +![Conceptual Levels](resources/PURIS-Conceptual-levels-R2405.svg) +_Figure 3: Conceptual levels of provisioning digital twins in the shared asset approach_ + +## Policies + +This chapter describes the access & usage policies as well as the contract definitions. For more information on the +access & usage policies, please refer to +the [policies documentation in the tractusx-edc repository](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/docs/usage/management-api-walkthrough/02_policies.md) + +### Access Policies + +To enable data sovereignty, access and usage policies are important to protect the data assets of a data provider in the +connector, as described in +the [Connector KIT](https://eclipse-tractusx.github.io/docs-kits/next/category/connector-kit). + +To decide which company has access to the data assets, access policy should be used. Note that without protecting data +assets with access policies, they become publicly available in the Catena-X network which is not recommended. + +Therefore, every asset should be protected and only be made available through specified BPNL policy groups or specific +BPNL policies. For a detailed description, +see [Business Partner Validation Extension](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/edc-extensions/bpn-validation). + +#### BPNL Access Policy + +This policy allows limiting access to a data offer based on a list of specific BPNLs. This translates to the following +functionality: + +- The data offer creator will be able to create a policy listing all the BPN that can access the data offer. +- This means that only the connectors registered in the Catena-X network with the BPNL listed in the policy can see the + data offer and accept it (for the creation of data contracts and subsequent data exchange). + +#### Implementation Hint + +Examples including a JSON payload for a BPNL group access policy are described in +the [Business Partner Validation Extension](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/edc-extensions/bpn-validation). + +This reference implementation also provides an extension to add the BPNL of the requesting party to the header of a +proxied request. As a result, during implementation one can use this bpnl to design the internal submodel api design. + +### Usage Policies + +To decide which company can use the data asset under specific conditions, usage policies (also referred to as contract +policies) are used. Therefore, they are more specific than access policies and only used just after access is granted. +Currently, the usage policies aren't technically enforced but based on a legal framework agreements. Signing of +framework agreements can be enforced during negotiation depending on the connector implementation. + +Policies are defined based on the [W3C ODRL format](https://www.w3.org/TR/odrl-model/). This allows a standardized way +of formulating policy payloads. It further allows to stack different constraints with the `odrl:and` operator. +Therefore, every data provider can decide on his or her own under which conditions their data assets are shared in the +network. It is recommended to restrict the data usage for all exchanged data standards. An example of one usage policy +containing three different constraints is shown and described in the following: + +```json +{ + "@context": [ + "http://www.w3.org/ns/odrl.jsonld", + { + "edc": "https://w3id.org/edc/v0.0.1/ns/", + "cx-policy": "https://w3id.org/catenax/policy/" + } + ], + "@type": "PolicyDefinitionRequestDto", + "@id": "", // Important for the contract definition + "edc:policy": { + "@type": "Set", + "profile": "cx-policy:profile2405", + "permission": [ + { + "action": "use", + "constraint": { + "@type": "LogicalConstraint", + "and": [ + { + "@type": "LogicalConstraint", + "leftOperand": "cx-policy:FrameworkAgreement", + "operator": "eq", + "rightOperand": "Puris:1.0" + }, + { + "@type": "LogicalConstraint", + "leftOperand": "cx-policy:UsagePurpose", + "operator": "eq", + "rightOperand": "cx.puris.base:1" + }, + { + "@type": "LogicalConstraint", + "leftOperand": "cx-policy:ContractReference", + "operator": "eq", + "rightOperand": "x12345" + } + ] + } + } + ] + } +} +``` + +PURIS relies on the usage purpose [cx.puris.base:1](https://github.com/catenax-eV/cx-odrl-profile/blob/main/profile.md), +used in the example above. It's purpose is related to "_Optimizing processes, which includes, without limitation, +regular exchange of data to prevent and/or solve shortages in the supply chain, conducting plausibility checks against +other sources and/or collecting information to facilitate sound decision making, all of the above in the context of +predictive unit real-time information relating to production and/or logistics._" + +More information can be found in +the [Policies in Catena-X of the Connector KIT](https://eclipse-tractusx.github.io/docs-kits/kits/Connector%20Kit/Adoption%20View/connector_kit_adoption_view_policies_cx/). + +### Contract Definitions + +In the connector, every policy is associated with a contract. Thus, a contract definition is needed, detailing what +policies are required when contracting assets. + +When using an above mentioned Access Policy, their `ACCESS_POLICY_ID` needs to be included as a value of +the `accessPolicyId` key in the contract definition. + +When using an above mentioned Usage Policy, their `CONTRACT_POLICY_ID` needs to be included as a value of +the `contractPolicyId` key in the contract definition. + +```json +{ + "id": "{{CONTRACT_DEFINITION_ID}}", + "criteria": [ + { + "operandLeft": "asset:prop:id", + "operator": "=", + "operandRight": "{{ASSET_ID}}" + } + ], + "accessPolicyId": "{{ACCESS_POLICY_ID}}", + "contractPolicyId": "{{CONTRACT_POLICY_ID}}" +} +``` + +For a more detailed tutorial on creating contracts for assets, see +in [Chapter 3 of the End-to-End Adopter Journey](https://eclipse-tractusx.github.io/docs/tutorials/e2e/boost/provideData). + +## Protocol + +This chapter contains data structures that are designed for providing data in the PURIS standards. + +The PURIS KIT does not define its own protocol, as it is using the communication pattern described in +the [Digital Twin KIT](https://eclipse-tractusx.github.io/docs-kits/next/kits/Digital%20Twin%20Kit/Software%20Development%20View/dt-kit-interaction-patterns) +and relies on +the [Part Type Twin definitions of the Industry Core KIT](https://eclipse-tractusx.github.io/docs-kits/kits/Industry%20Core%20Kit/Software%20Development%20View/Digital%20Twins%20Development%20View%20Industry%20Core%20Kit). + +Examples of how the required data structures for that pattern may look like for PURIS are described in this chapter. + +### Connector Data Asset Structure + +To allow partners to find data regarding a specific Industry Core Part Type Twin, the provider has to register a +connector data asset (see [Connector KIT](https://eclipse-tractusx.github.io/docs-kits/next/category/connector-kit)) +specifying the address of the Digital Twin Registry of the provider ( +see [Digital Twin KIT](https://eclipse-tractusx.github.io/docs-kits/next/kits/Digital%20Twin%20Kit/Software%20Development%20View/dt-kit-interaction-patterns)). + +The structure is as follows: + +```json +{ + "@context": { + "@vocab": "https://w3id.org/edc/v0.0.1/ns/", + "cx-common": "https://w3id.org/catenax/ontology/common#", + "cx-taxo": "https://w3id.org/catenax/taxonomy#", + "dct": "http://purl.org/dc/terms/" + }, + "@id": "{{CONNECTOR_ASSET_ID}}", // defined by yourself + "properties": { + "dct:type": { "@id": "cx-taxo:DigitalTwinRegistry" }, + "cx-common:version": "3.0" + }, + "privateProperties": {}, + "dataAddress": { + "@type": "DataAddress", + "type": "HttpData", + "baseUrl": "{{ DIGITAL_TWIN_REGISTRY_ENDPOINT }}", + "proxyQueryParams": "true", + "proxyBody": "false", + "proxyPath": "true", + "proxyMethod": "false" + } +} +``` + +The property **_@id_** must uniquely identify the connector data asset. + +Other fields are predetermined by the used standard and protocol. + +### Connector Data Asset Structure for "Submodel" + +In order to allow partners to receive the actual aspect model data (e.g. Item Stock, +see [all PURIS semantic models](https://eclipse-tractusx.github.io/docs-kits/kits/PURIS%20Kit/Adoption%20View%20PURIS%20Kit#semantic-models)), +the provider has to register a connector data asset ( +see [Connector KIT](https://eclipse-tractusx.github.io/docs-kits/next/category/connector-kit)) specifying the address of +the submodel endpoint ( +see [Digital Twin KIT](https://eclipse-tractusx.github.io/docs-kits/next/category/digital-twin-kit)) providing the +actual data. + +```json +{ + "@context": { + "@vocab": "https://w3id.org/edc/v0.0.1/ns/", + "cx-common": "https://w3id.org/catenax/ontology/common#", + "cx-taxo": "https://w3id.org/catenax/taxonomy#", + "dct": "http://purl.org/dc/terms/", + "aas-semantics": "https://admin-shell.io/aas/3/0/HasSemantics/" + }, + "@id": "{{CONNECTOR_ASSET_ID}}", // defined by yourself + "properties": { + "dct:type": { "@id": "cx-taxo:Submodel" }, + "cx-common:version": "3.0", + "aas-semantics:semanticId": { + "@id": "urn:samm:io.catenax.item_stock:2.0.0#ItemStock" + } + }, + "privateProperties": {}, + "dataAddress": { + "@type": "DataAddress", + "type": "HttpData", + "baseUrl": "{{ SUBMODEL_ENDPOINT }}", + "proxyQueryParams": "false", + "proxyBody": "false", + "proxyPath": "true", + "proxyMethod": "false" + } +} +``` + +The property **_@id_** must uniquely identify the connector data asset. + +Other fields are predetermined by the used standard and protocol. + +Especially the semantic ID can be found in the Sample Data chapter and has to match the aspect model to be transferred. +Currently the PURIS standards restrict the user to not use the repository approach as the semantic id is mandatory for +the asset. + +### Shell Descriptors + +The Shell Descriptor defines the metadata of the Industry Core Part Type Twin. The following example Shell Descriptor +represents a the Shell Descriptor of a supplier who provides access to an "_Item Stock_" submodel ( +see [GitHub](https://github.com/eclipse-tractusx/sldt-semantic-models)) for two customers using the legacy access +control in the Digital Twin Registry reference implementation. For further information on the creation of Part Type +Twins, refer to +the [Digital Twin KIT](https://eclipse-tractusx.github.io/docs-kits/next/kits/Digital%20Twin%20Kit/Software%20Development%20View/dt-kit-software-development-view) +and the [Industry Core KIT](https://eclipse-tractusx.github.io/docs-kits/next/category/industry-core-kit). + +When searching the data assets catalog of a data provider, a data consumer uses the assetId determined via +subprotocolBody of the Submodel Descriptor's endpoint definition of subprotocol type "DSP" of the Submodel Descriptor of +interest. + +The relevant Submodel can be identified based on the semantic Id (see Sample Data chapter). + +```json +{ + "id": "{{TECHNIAL_TWIN_ID}}", + "globalAssetId": "{{MATERIAL_NUMBER_CX}}", + "idShort": "Semiconductor", + "specificAssetIds": [ + { + "name": "digitalTwinType", + "value": "PartType", + "externalSubjectId": { + "type": "ExternalReference", + "keys": [ + { + "type": "GlobalReference", + "value": "{{SUPPLIER_BPNL}}" + }, + { + "type": "GlobalReference", + "value": "{{CUSTOMER_BPNL}}" + }, + { + "type": "GlobalReference", + "value": "{{OTHER_CUSTOMER_BPNL}}" + } + ] + } + }, + { + "name": "manufacturerPartId", + "value": "{{MATERIAL_NUMBER_SUPPLIER}}", + "externalSubjectId": { + "type": "ExternalReference", + "keys": [ + { + "type": "GlobalReference", + "value": "{{SUPPLIER_BPNL}}" + }, + { + "type": "GlobalReference", + "value": "{{CUSTOMER_BPNL}}" + }, + { + "type": "GlobalReference", + "value": "{{OTHER_CUSTOMER_BPNL}}" + } + ] + } + }, + { + "name": "manufacturerId", + "value": "{{SUPPLIER_BPNL}}", + "externalSubjectId": { + "type": "ExternalReference", + "keys": [ + { + "type": "GlobalReference", + "value": "{{SUPPLIER_BPNL}}" + }, + { + "type": "GlobalReference", + "value": "{{CUSTOMER_BPNL}}" + }, + { + "type": "GlobalReference", + "value": "{{OTHER_CUSTOMER_BPNL}}" + } + ] + } + }, + { + "name": "customerPartId", + "value": "{{MATERIAL_NUMBER_CUSTOMER}}", + "externalSubjectId": { + "type": "ExternalReference", + "keys": [ + { + "type": "GlobalReference", + "value": "{{SUPPLIER_BPNL}}" + }, + { + "type": "GlobalReference", + "value": "{{CUSTOMER_BPNL}}" + } + ] + } + }, + { + "name": "customerPartId", + "value": "{{MATERIAL_NUMBER_OTHER_CUSTOMER}}", + "externalSubjectId": { + "type": "ExternalReference", + "keys": [ + { + "type": "GlobalReference", + "value": "{{SUPPLIER_BPNL}}" + }, + { + "type": "GlobalReference", + "value": "{{OTHER_CUSTOMER_BPNL}}" + } + ] + } + } + ], + "submodelDescriptors": [ + { + "id": "e5c96ab5-896a-482c-8761-efd74777ca97", + "semanticId": { + "type": "ExternalReference", + "keys": [ + { + "type": "GlobalReference", + "value": "urn:samm:io.catenax.item_stock:2.0.0#ItemStock" + } + ] + }, + "endpoints": [ + { + "interface": "SUBMODEL-3.0", + "protocolInformation": { + "href": "{{SUPPLIER_CONNECTOR_DATAPLANE_PUBLIC_API}}/{{PATH_IF_NEEDED}}", + "endpointProtocol": "HTTP", + "endpointProtocolVersion": ["1.1"], + "subprotocol": "DSP", + "subprotocolBody": "id={{CONNECTOR_ASSET_ID}};dspEndpoint={{SUPPLIER_CONNECTOR_DSP_ENDPOINT}}", + "subprotocolBodyEncoding": "plain", + "securityAttributes": [ + { + "type": "NONE", + "key": "NONE", + "value": "NONE" + } + ] + } + } + ] + }, + { + "id": "a6c96ab5-896a-482c-8761-efd74777ca99", + "semanticId": { + "type": "ExternalReference", + "keys": [ + { + "type": "GlobalReference", + "value": "urn:samm:io.catenax.item_stock:2.0.0#ItemStock" + } + ] + }, + "endpoints": [ + { + "interface": "SUBMODEL-3.0", + "protocolInformation": { + "href": "{{SUPPLIER_CONNECTOR_DATAPLANE_PUBLIC_API}}/{{PATH_IF_NEEDED}}", + "endpointProtocol": "HTTP", + "endpointProtocolVersion": ["1.1"], + "subprotocol": "DSP", + "subprotocolBody": "id={{CONNECTOR_ASSET_ID}};dspEndpoint={{SUPPLIER_CONNECTOR_DSP_ENDPOINT}}", + "subprotocolBodyEncoding": "plain", + "securityAttributes": [ + { + "type": "NONE", + "key": "NONE", + "value": "NONE" + } + ] + } + } + ] + } + ] +} +``` + +## Sample Data + +The semantic models in the business context are defined in the PURIS Adoption View. This chapter gives additional +information for each aspect model by providing the example data objects in JSON format, link to the RDF turtle file on +GitHub and unique semantic id of the aspect model. + +### 1. Item Stock v.2.0.0 + +GitHub link to semantic data model in RDF turtle +format: [https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.item_stock/2.0.0/ItemStock.ttl](https://github.com/eclipse-tractusx/sldt-semantic-models/blob/8e4b33858008c2bff56885904ce1e1f3cdef59da/io.catenax.item_stock/2.0.0/ItemStock.ttl) + +This aspect model has the following semantic id: + +```text +urn:samm:io.catenax.item_stock:2.0.0#ItemStock +``` + +**Example:** Item stock of 20 pieces for an order position of a given material with the Catena-X ID "urn:uuid: +48878d48-6f1d-47f5-8ded-a441d0d879df". This data object is created by the customer for its supplier, therefore with a +direction "INBOUND". + +```json +{ + "materialGlobalAssetId": "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df", + "positions": [ + { + "orderPositionReference": { + "supplierOrderId": "M-Nbr-4711", + "customerOrderId": "C-Nbr-4711", + "customerOrderPositionId": "PositionId-01" + }, + "allocatedStocks": [ + { + "isBlocked": false, + "stockLocationBPNA": "BPNA1234567890ZZ", + "lastUpdatedOnDateTime": "2023-04-28T14:23:00.123456+14:00", + "quantityOnAllocatedStock": { + "value": 20.0, + "unit": "unit:piece" + }, + "stockLocationBPNS": "BPNS1234567890ZZ" + } + ] + } + ], + "direction": "INBOUND" +} +``` + +### 2. Short-Term Material Demand v1.0.0 + +GitHub link to semantic data model in RDF turtle +format: [https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.short_term_material_demand/1.0.0/ShortTermMaterialDemand.ttl](https://github.com/eclipse-tractusx/sldt-semantic-models/blob/8e4b33858008c2bff56885904ce1e1f3cdef59da/io.catenax.short_term_material_demand/1.0.0/ShortTermMaterialDemand.ttl) + +This aspect model has the following semantic id: + +```json +urn:samm:io.catenax.short_term_material_demand:1.0.0#ShortTermMaterialDemand +``` + +**Example 1:** A demand quantity of 180 pieces with a demand category "series" and a demand quantity of 100 pieces with +demand category "after-sales" for a material with Catena-X ID "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df". The +customer location varies for the different demand series. This Short-Term Material Demand is the demand that a supplier +received from a customer. + +```json +{ + "materialGlobalAssetId": "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df", + "demandSeries": [ + { + "lastUpdatedOnDateTime": "2023-11-05T08:15:30.123-05:00", + "expectedSupplierLocation": "BPNS8888888888XX", + "demands": [ + { + "demand": { + "value": 180.0, + "unit": "unit:piece" + }, + "day": "2023-10-09" + } + ], + "customerLocation": "BPNS8888888888XX", + "demandCategory": { + "demandCategoryCode": "SR99" + } + }, + { + "expectedSupplierLocation": "BPNS8888888888XX", + "lastUpdatedOnDateTime": "2023-11-05T08:15:30.123-05:00", + "demands": [ + { + "demand": { + "value": 100.0, + "unit": "unit:piece" + }, + "day": "2023-10-09" + } + ], + "customerLocation": "BPNS5555555555XX", + "demandCategory": { + "demandCategoryCode": "A1S1" + } + } + ] +} +``` + +### 3. Delivery Information v2.0.0 + +GitHub link to semantic data model in RDF turtle +format: [https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.delivery_information/2.0.0/DeliveryInformation.ttl](https://github.com/eclipse-tractusx/sldt-semantic-models/blob/8e4b33858008c2bff56885904ce1e1f3cdef59da/io.catenax.delivery_information/2.0.0/DeliveryInformation.ttl) + +This aspect model has the following semantic id: + +```text +urn:samm:io.catenax.delivery_information:2.0.0#DeliveryInformation +``` + +The JSONs snippets below provide an example of the value-only serialization of the "_DeliveryInformation_" aspect model +for three different delivery situations: + +1. A not yet departed delivery - estimated departure and arrival dates +2. A delivery in transit - actual departure and estimated arrival dates +3. A delivery with actual arrival times - actual departure and arrival dates + +**Example 1:** The order has not yet departed from its origin, as is indicated by the estimated values for both +departure and arrival (see transitEvents property). This is an example of estimated delivery. + +```json +{ + "materialGlobalAssetId": "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df", + "positions": [ + { + "orderPositionReference": { + "supplierOrderId": "M-Nbr-4711", + "customerOrderId": "C-Nbr-4711", + "customerOrderPositionId": "PositionId-01" + }, + "deliveries": [ + { + "lastUpdatedOnDateTime": "2023-04-28T14:23:00.123456+14:00", + "deliveryQuantity": { + "value": 20.0, + "unit": "unit:piece" + }, + "transitEvents": [ + { + "dateTimeOfEvent": "2023-04-01T14:23:00+01:00", + "eventType": "estimated-departure" + }, + { + "dateTimeOfEvent": "2023-04-05T14:23:00+01:00", + "eventType": "estimated-arrival" + } + ], + "trackingNumber": "1Z9829WDE02128", + "incoterm": "EXW", + "transitLocations": { + "destination": { + "bpnsProperty": "BPNS0000000410ZZ", + "bpnaProperty": "BPNA0000002082ZZ" + }, + "origin": { + "bpnsProperty": "BPNS0000000185ZZ", + "bpnaProperty": "BPNA0000001982ZZ" + } + } + } + ] + } + ] +} +``` + +**Example 2:** The status of this delivery is currently in transit, denoted by the actual departure and estimated +arrival values (see transitEvents property). + +```json +{ + "materialGlobalAssetId": "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df", + "positions": [ + { + "orderPositionReference": { + "supplierOrderId": "M-Nbr-4711", + "customerOrderId": "C-Nbr-4711", + "customerOrderPositionId": "PositionId-01" + }, + "deliveries": [ + { + "lastUpdatedOnDateTime": "2023-04-28T14:23:00.123456+14:00", + "deliveryQuantity": { + "value": 20.0, + "unit": "unit:piece" + }, + "transitEvents": [ + { + "dateTimeOfEvent": "2023-04-01T14:23:00+01:00", + "eventType": "actual-departure" + }, + { + "dateTimeOfEvent": "2023-04-05T14:23:00+01:00", + "eventType": "estimated-arrival" + } + ], + "trackingNumber": "1Z9829WDE02128", + "incoterm": "EXW", + "transitLocations": { + "destination": { + "bpnsProperty": "BPNS0000000410ZZ", + "bpnaProperty": "BPNA0000002082ZZ" + }, + "origin": { + "bpnsProperty": "BPNS0000000185ZZ", + "bpnaProperty": "BPNA0000001982ZZ" + } + } + } + ] + } + ] +} +``` + +**Example 3:** As seen from the actual departure and actual arrival values (see transitEvents property), this is an +example of a completed delivery. + +```json +{ + "materialGlobalAssetId": "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df", + "positions": [ + { + "orderPositionReference": { + "supplierOrderId": "M-Nbr-4711", + "customerOrderId": "C-Nbr-4711", + "customerOrderPositionId": "PositionId-01" + }, + "deliveries": [ + { + "lastUpdatedOnDateTime": "2023-04-28T14:23:00.123456+14:00", + "deliveryQuantity": { + "value": 20.0, + "unit": "unit:piece" + }, + "transitEvents": [ + { + "dateTimeOfEvent": "2023-04-01T14:23:00+01:00", + "eventType": "actual-departure" + }, + { + "dateTimeOfEvent": "2023-04-05T14:23:00+01:00", + "eventType": "actual-arrival" + } + ], + "trackingNumber": "1Z9829WDE02128", + "incoterm": "EXW", + "transitLocations": { + "destination": { + "bpnsProperty": "BPNS0000000410ZZ", + "bpnaProperty": "BPNA0000002082ZZ" + }, + "origin": { + "bpnsProperty": "BPNS0000000185ZZ", + "bpnaProperty": "BPNA0000001982ZZ" + } + } + } + ] + } + ] +} +``` + +### 4. Planned Production Output Exchange v2.0.0 + +GitHub link to semantic data model in RDF turtle +format: [https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.planned_production_output/2.0.0/PlannedProductionOutput.ttl](https://github.com/eclipse-tractusx/sldt-semantic-models/blob/8e4b33858008c2bff56885904ce1e1f3cdef59da/io.catenax.planned_production_output/2.0.0/PlannedProductionOutput.ttl) + +This aspect model has the following semantic id: + +```text +urn:samm:io.catenax.planned_production_output:2.0.0#PlannedProductionOutput +``` + +**Example:** The _Planned Production Output_ quantities for three consecutive days in two different sites (BPNS) for a +material with Catena-X ID "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df". + +```json +{ + "materialGlobalAssetId": "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df", + "positions": [ + { + "lastUpdatedOnDateTime": "2023-04-01T14:23:00+01:00", + "orderPositionReference": { + "supplierOrderId": "M-Nbr-4711", + "customerOrderId": "C-Nbr-4711", + "customerOrderPositionId": "PositionId-01" + }, + "allocatedPlannedProductionOutputs": [ + { + "plannedProductionQuantity": { + "value": 10.0, + "unit": "unit:piece" + }, + "productionSiteBpns": "BPNS0123456789ZZ", + "estimatedTimeOfCompletion": "2023-04-01T14:23:00+01:00" + }, + { + "plannedProductionQuantity": { + "value": 20.0, + "unit": "unit:piece" + }, + "productionSiteBpns": "BPNS0123456789YZ", + "estimatedTimeOfCompletion": "2023-04-02T14:23:00+01:00" + }, + { + "plannedProductionQuantity": { + "value": 10.0, + "unit": "unit:piece" + }, + "productionSiteBpns": "BPNS0123456789ZZ", + "estimatedTimeOfCompletion": "2023-04-03T14:23:00+01:00" + } + ] + } + ] +} +``` + +### 5. Days of Supply v2.0.0 + +GitHub link to semantic data model in RDF turtle +format: + +This aspect model has the following semantic id: + +```text +urn:samm:io.catenax.days_of_supply:2.0.0#DaysOfSupply +``` + +**Example 1:** The _Days of Supply_ for a material with Catena-X ID "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df" for +one specific date. This data object is send from a customer to its supplier. The direction INBOUND (or incoming) +specifies that the value of days of supply refers to the amount of days in which the customer's _Item Stock_ (material +stock) is sufficient for the customer's _Short-Term Material Demand_. + +```json +{ + "materialGlobalAssetId": "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df", + "allocatedDaysOfSupply": [ + { + "stockLocationBPNA": "BPNA1234567890ZZ", + "lastUpdatedOnDateTime": "2023-04-28T14:23:00.123456+14:00", + "amountOfAllocatedDaysOfSupply": [ + { + "date": "2024-01-01T14:23:00+01:00", + "daysOfSupply": 3.51 + } + ], + "stockLocationBPNS": "BPNS1234567890ZZ" + } + ], + "direction": "INBOUND" +} +``` + +**Example 2**: The _Days of Supply_ for a product with Catena-X ID "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df" for +three specific dates. This data object is send from a supplier to its customer. The direction OUTBOUND (or outgoing) +specifies that the value of days of supply refers to the amount of days in which the supplier's _Item Stock_ (product +stock) is sufficient for the supplier's scheduled deliveries (see _Delivery Information_ standard). + +```json +{ + "materialGlobalAssetId": "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df", + "allocatedDaysOfSupply": [ + { + "stockLocationBPNA": "BPNA1234567890ZZ", + "lastUpdatedOnDateTime": "2023-04-28T14:23:00.123456+14:00", + "amountOfAllocatedDaysOfSupply": [ + { + "date": "2024-02-01T14:23:00+01:00", + "daysOfSupply": 3.51 + }, + { + "date": "2024-02-02T14:23:00+01:00", + "daysOfSupply": 4.25 + }, + { + "date": "2024-02-03T14:23:00+01:00", + "daysOfSupply": 2.78 + } + ], + "stockLocationBPNS": "BPNS1234567890ZZ" + } + ], + "direction": "OUTBOUND" +} +``` diff --git a/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-Conceptual-levels-R2405.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-Conceptual-levels-R2405.drawio.svg new file mode 100644 index 00000000000..a39dff78a0a --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-Conceptual-levels-R2405.drawio.svg @@ -0,0 +1,4 @@ + + + +
          represents same material
          equivalent specific asset IDs, global asset ID,
          different AAS ID
          represents same material...
          PartType for Material (e.g. "Semiconductor")
          PartType for Material...
          Supplier
          Supplier
          Customer
          Custom...
          Asset
          registered in dDTR as AAS
          Asset...
          Submodel
          Submodel
          PartType for Material "Control Unit"
          PartType for Materia...
          Item Stock
          (Direction = Outgoing)
          Item Stock...
          Item Stock
          (Direction = Incoming)
          Item Stock...
          PartTypeInformation
          PartTypeInformation
          SingleLevelUsageAs Planned
          SingleLevelUsageAs P...
          references twin
          references twin
          PartTypeInformation
          PartTypeInformation
          SingleLevel
          BomAsPlanned
          SingleLevel...
          references twin
          references twin
          submodel of
          submodel of
           Legend
           Legend
          Digital Twin in DTR
          Digital Twin in DTR
          Submodel (this KIT)
          Submodel (this KIT)
          Submodel (IC Part Type)
          Submodel (IC Part Type)
          submodel of
          submodel of
          references twin
          references twin
          PartType for Material "Semiconductor"
          PartType for Materia...
          Short-Term Material Demand
          Short-Term Material Dem...
          Delivery Information
          (Inco Term dependent)
          Delivery Information...
          Planned Production Output
          Planned Production Outp...
          Delivery Information
          (Inco Term dependent)
          Delivery Information...
          Days of Supply
          (Direction = Outgoing)
          Days of Supply...
          Days of Supply
          (Direction = Incoming)
          Days of Supply...
          submodel of
          submodel of
          submodel of
          submodel of          Text is not SVG - cannot display           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-Conceptual-levels-R2405.drawio.svg.license b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-Conceptual-levels-R2405.drawio.svg.license new file mode 100755 index 00000000000..dc254b0d581 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-Conceptual-levels-R2405.drawio.svg.license @@ -0,0 +1,9 @@ +This work is licensed under the CC-BY-4.0 + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST) +- SPDX-FileCopyrightText: 2024 TRUMPF Werkzeugmaschinen SE + Co. KG +- SPDX-FileCopyrightText: 2024 ISTOS GmbH (a member of the DMG Mori Group) +- SPDX-FileCopyrightText: 2024 Volkswagen AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs-kits/kits/PURIS%20Kit/Software%20Development%20View/resources/PURIS-Conceptual-levels-R2405.svg diff --git a/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-Conceptual-levels-R2405.svg b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-Conceptual-levels-R2405.svg new file mode 100644 index 00000000000..402af7add38 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-Conceptual-levels-R2405.svg @@ -0,0 +1,3 @@ + + +
          represents same material
          equivalent specific asset IDs, global asset ID,
          different AAS ID
          represents same material...
          PartType for Material (e.g. "Semiconductor")
          PartType for Material...
          Supplier
          Supplier
          Customer
          Custom...
          Asset
          registered in dDTR as AAS
          Asset...
          Submodel
          Submodel
          PartType for Material "Control Unit"
          PartType for Materia...
          Item Stock
          (Direction = Outgoing)
          Item Stock...
          Item Stock
          (Direction = Incoming)
          Item Stock...
          PartTypeInformation
          PartTypeInformation
          SingleLevelUsageAs Planned
          SingleLevelUsageAs P...
          references twin
          references twin
          PartTypeInformation
          PartTypeInformation
          SingleLevel
          BomAsPlanned
          SingleLevel...
          references twin
          references twin
          submodel of
          submodel of
           Legend
           Legend
          Digital Twin in DTR
          Digital Twin in DTR
          Submodel (this KIT)
          Submodel (this KIT)
          Submodel (IC Part Type)
          Submodel (IC Part Type)
          submodel of
          submodel of
          references twin
          references twin
          PartType for Material "Semiconductor"
          PartType for Materia...
          Short-Term Material Demand
          Short-Term Material Dem...
          Delivery Information
          (Inco Term dependent)
          Delivery Information...
          Planned Production Output
          Planned Production Outp...
          Delivery Information
          (Inco Term dependent)
          Delivery Information...
          Days of Supply
          (Direction = Outgoing)
          Days of Supply...
          Days of Supply
          (Direction = Incoming)
          Days of Supply...
          submodel of
          submodel of
          submodel of
          submodel of          Text is not SVG - cannot display           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-Conceptual-levels-R2405.svg.license b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-Conceptual-levels-R2405.svg.license new file mode 100644 index 00000000000..dc254b0d581 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-Conceptual-levels-R2405.svg.license @@ -0,0 +1,9 @@ +This work is licensed under the CC-BY-4.0 + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST) +- SPDX-FileCopyrightText: 2024 TRUMPF Werkzeugmaschinen SE + Co. KG +- SPDX-FileCopyrightText: 2024 ISTOS GmbH (a member of the DMG Mori Group) +- SPDX-FileCopyrightText: 2024 Volkswagen AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs-kits/kits/PURIS%20Kit/Software%20Development%20View/resources/PURIS-Conceptual-levels-R2405.svg diff --git a/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-KIT-24.08-Whitebox.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-KIT-24.08-Whitebox.drawio.svg new file mode 100644 index 00000000000..97177abc934 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-KIT-24.08-Whitebox.drawio.svg @@ -0,0 +1,4 @@ + + + +
          «data ecosystem»
          Catena-X
          «data ecosystem»...
          «system»
          PURIS (OTHER PARTNER)
          «system»...
          «system»
          PURIS
          «system»...
          «subsystem»
          Data Provisioning
          & Transformation
          «subsystem»...
          Submodel API
          Submodel API
          «subsystem»
          PURIS App
          «subsystem»...
          View Catalog (Data Offers),
          Negotiate Contracts,
          Initialize Data Transfer,
          Perform Data Transfer
          View Catalog (Data Offers),...
          Lookup Twin and
          Submodels via proxy
          Lookup Twin and...
          «subsystem»
          Connector
          «subsystem»...
          Receive OWN Data
          Receive OWN Data
          Register Digital Twin Registry
          Register Submodels as Assets
          Query Partner Data,
          Negotiate Contract,
          Initialize Data Transfer
          Register Digital Twin Registry...
          «Service»
          Discovery Service
          «Service»...
          Update OWN data
          Transform PARTNER data
          Update OWN data...
          Lookup Twin
          and Submodel
          Lookup Twin...
          «subsystem»
          Connector
          «subsystem»...
          «subsystem»
          PURIS App
          «subsystem»...
          Provide Data
          Provide Data
          Provide Data to Partner
          via Proxy
          Provide Data to Partner...
          Lookup partners' EDC address
          Lookup partners' EDC address
          Internal Systems
          I...
          Other interaces
          O...
          «subsystem»
          Digital Twin Registry
          «subsystem»...
          Retrieve OWN Data
          Retrieve OWN Data
          Reqister / Update Shell Descriptor with
           Submodel Descriptor
          Reqister / Update Shell Descri...
          AAS Discovery API
          AAS Discovery API
          AAS Discovery API
          AAS Registry API
          AAS Discovery API...
          «subsystem»
          Digital Twin Registry
          «subsystem»...
          Submodel API
          Submodel API
          AAS Discovery API
          AAS Discovery API          Text is not SVG - cannot display           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-KIT-24.08-Whitebox.drawio.svg.license b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-KIT-24.08-Whitebox.drawio.svg.license new file mode 100755 index 00000000000..79dea71f211 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-KIT-24.08-Whitebox.drawio.svg.license @@ -0,0 +1,9 @@ +This work is licensed under the CC-BY-4.0 + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST) +- SPDX-FileCopyrightText: 2024 TRUMPF Werkzeugmaschinen SE + Co. KG +- SPDX-FileCopyrightText: 2024 ISTOS GmbH (a member of the DMG Mori Group) +- SPDX-FileCopyrightText: 2024 Volkswagen AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs-kits/kits/PURIS%20Kit/Software%20Development%20View/resources/PURIS-KIT-24.08-Whitebox.svg diff --git a/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-KIT-24.08-Whitebox.svg b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-KIT-24.08-Whitebox.svg new file mode 100644 index 00000000000..d6bd1358e8f --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-KIT-24.08-Whitebox.svg @@ -0,0 +1,3 @@ + + +
          «data ecosystem»
          Catena-X
          «data ecosystem»...
          «system»
          PURIS (OTHER PARTNER)
          «system»...
          «system»
          PURIS
          «system»...
          «subsystem»
          Data Provisioning
          & Transformation
          «subsystem»...
          Submodel API
          Submodel API
          «subsystem»
          PURIS App
          «subsystem»...
          View Catalog (Data Offers),
          Negotiate Contracts,
          Initialize Data Transfer,
          Perform Data Transfer
          View Catalog (Data Offers),...
          Lookup Twin and
          Submodels via proxy
          Lookup Twin and...
          «subsystem»
          Connector
          «subsystem»...
          Receive OWN Data
          Receive OWN Data
          Register Digital Twin Registry
          Register Submodels as Assets
          Query Partner Data,
          Negotiate Contract,
          Initialize Data Transfer
          Register Digital Twin Registry...
          «Service»
          Discovery Service
          «Service»...
          Update OWN data
          Transform PARTNER data
          Update OWN data...
          Lookup Twin
          and Submodel
          Lookup Twin...
          «subsystem»
          Connector
          «subsystem»...
          «subsystem»
          PURIS App
          «subsystem»...
          Provide Data
          Provide Data
          Provide Data to Partner
          via Proxy
          Provide Data to Partner...
          Lookup partners' EDC address
          Lookup partners' EDC address
          Internal Systems
          I...
          Other interaces
          O...
          «subsystem»
          Digital Twin Registry
          «subsystem»...
          Retrieve OWN Data
          Retrieve OWN Data
          Reqister / Update Shell Descriptor with
           Submodel Descriptor
          Reqister / Update Shell Descri...
          AAS Discovery API
          AAS Discovery API
          AAS Discovery API
          AAS Registry API
          AAS Discovery API...
          «subsystem»
          Digital Twin Registry
          «subsystem»...
          Submodel API
          Submodel API
          AAS Discovery API
          AAS Discovery API          Text is not SVG - cannot display           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-KIT-24.08-Whitebox.svg.license b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-KIT-24.08-Whitebox.svg.license new file mode 100644 index 00000000000..79dea71f211 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-KIT-24.08-Whitebox.svg.license @@ -0,0 +1,9 @@ +This work is licensed under the CC-BY-4.0 + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST) +- SPDX-FileCopyrightText: 2024 TRUMPF Werkzeugmaschinen SE + Co. KG +- SPDX-FileCopyrightText: 2024 ISTOS GmbH (a member of the DMG Mori Group) +- SPDX-FileCopyrightText: 2024 Volkswagen AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs-kits/kits/PURIS%20Kit/Software%20Development%20View/resources/PURIS-KIT-24.08-Whitebox.svg diff --git a/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-R2405-architecture-sketch.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-R2405-architecture-sketch.drawio.svg new file mode 100644 index 00000000000..fcac834a754 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-R2405-architecture-sketch.drawio.svg @@ -0,0 +1,4 @@ + + + +
          Data Provider
          Data Provider
          Connector
          Connector
          Busines Application
          Busines App...
          Catena-X Core Service Provider
          Catena-X Core Service Provider
          IAM
          IAM
          Shared Identity Provider
          Shared Ident...
          Central Identity Provider
          Central Iden...
          Credential Service
          Credential S...
          BPN-DID Resolution Service
          BPN-DID Reso...
          Data Consumer
          Data Consumer
          Connector
          Connector
          Busines Application
          Busines Applicati...
            Authentication / Authorization  
            Authentication / Authorization  
            Authentication / Authorization  
            Authentication / Authorization  
          (8) Get Submodel
          (8) Get Su...
          (5) Query dDTR for Twin and submodel
          (5) Query dDTR for Twin and submodel
          (4) Connector Communication
            (Catalog / Contracting / Transfer)  
          (4) Connector Communication...
          dDTR
          dDTR
          Submodel Endpoint
          Submodel E...
          (10) Get Submodel
          (10) Get S...
          (3) Register Twin
          with Submodels
          (3) Register Twin...
          (2) Register Submodel Endpoint
           at Connector
          (2) Register Submodel Endpoint...
          (9)
          (9)
          Text
          Text
          (6) Get lookup/shells
          by specific asset ids
          (6) Get lookup/shells...
          (1) Register dDTR at Connector
          (1) Register dDTR at Connector
          (7) Get shell-descriptors
          by AAS ID
          (7) Get shell-descriptors...          Text is not SVG - cannot display           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-R2405-architecture-sketch.drawio.svg.license b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-R2405-architecture-sketch.drawio.svg.license new file mode 100755 index 00000000000..f089cee51e3 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-R2405-architecture-sketch.drawio.svg.license @@ -0,0 +1,9 @@ +This work is licensed under the CC-BY-4.0 + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST) +- SPDX-FileCopyrightText: 2024 TRUMPF Werkzeugmaschinen SE + Co. KG +- SPDX-FileCopyrightText: 2024 ISTOS GmbH (a member of the DMG Mori Group) +- SPDX-FileCopyrightText: 2024 Volkswagen AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs-kits/kits/PURIS%20Kit/Software%20Development%20View/resources/PURIS-R2405-architecture-sketch.svg diff --git a/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-R2405-architecture-sketch.svg b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-R2405-architecture-sketch.svg new file mode 100644 index 00000000000..534f4d4f49f --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-R2405-architecture-sketch.svg @@ -0,0 +1,3 @@ + + +
          Data Provider
          Connector
          Busines Application
          Catena-X Core Service Provider
          IAM
          Shared Identity Provider
          Central Identity Provider
          Credential Service
          BPN-DID Resolution Service
          Data Consumer
          Connector
          Busines Application
            Authentication / Authorization  
            Authentication / Authorization  
          (8) Get Submodel
          (5) Query dDTR for Twin and submodel
          (4) Connector Communication
            (Catalog / Contracting / Transfer)  
          dDTR
          Submodel Endpoint
          (10) Get Submodel
          (3) Register Twin
          with Submodels
          (2) Register Submodel Endpoint
           at Connector
          (9)
          Text
          (6) Get lookup/shells
          by specific asset ids
          (1) Register dDTR at Connector
          (7) Get shell-descriptors
          by AAS ID
           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-R2405-architecture-sketch.svg.license b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-R2405-architecture-sketch.svg.license new file mode 100644 index 00000000000..f089cee51e3 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/Software Development View/resources/PURIS-R2405-architecture-sketch.svg.license @@ -0,0 +1,9 @@ +This work is licensed under the CC-BY-4.0 + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST) +- SPDX-FileCopyrightText: 2024 TRUMPF Werkzeugmaschinen SE + Co. KG +- SPDX-FileCopyrightText: 2024 ISTOS GmbH (a member of the DMG Mori Group) +- SPDX-FileCopyrightText: 2024 Volkswagen AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs-kits/kits/PURIS%20Kit/Software%20Development%20View/resources/PURIS-R2405-architecture-sketch.svg diff --git a/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/assets/PURIS_KIT_overview.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/assets/PURIS_KIT_overview.drawio.svg new file mode 100755 index 00000000000..66868ea017e --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/assets/PURIS_KIT_overview.drawio.svg @@ -0,0 +1,4 @@ + + + +
          Short Term Material Demand
          Short Term Mater...
          Item Stock
          Item Stock
          Delivery Information
          Delivery Informa...
          Days of Supply
          Days of Supply
          SC Disruption Notification
          SC Disruption No...
          Planned Production Output
          Planned Producti...
          Item Stock
          Item Stock
          Delivery Information
          Delivery Informa...
          Days of Supply
          Days of Supply
          SC Disruption Notification
          SC Disruption No...
          Data Exchange
          Data Exchange
          Data Exchange
          Data Exchange
          Supplier
          Supplier
          Customer
          Customer
          Tier-n
          Tier-n
          Tier-2
          Tier-2
          OEM
          OEM
          Tier-1
          Tier-1          Text is not SVG - cannot display           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/assets/PURIS_KIT_overview.drawio.svg.license b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/assets/PURIS_KIT_overview.drawio.svg.license new file mode 100755 index 00000000000..c403e99de11 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/assets/PURIS_KIT_overview.drawio.svg.license @@ -0,0 +1,9 @@ +This work is licensed under the CC-BY-4.0 + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST) +- SPDX-FileCopyrightText: 2024 TRUMPF Werkzeugmaschinen SE + Co. KG +- SPDX-FileCopyrightText: 2024 ISTOS GmbH (a member of the DMG Mori Group) +- SPDX-FileCopyrightText: 2024 Volkswagen AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs-kits/kits/PURIS%20Kit/assets/PURIS_KIT_overview.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/assets/PURIS_KIT_overview.svg b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/assets/PURIS_KIT_overview.svg new file mode 100755 index 00000000000..017776e8d07 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/assets/PURIS_KIT_overview.svg @@ -0,0 +1,3 @@ + + +
          Short Term Material Demand
          Short Term Mater...
          Item Stock
          Item Stock
          Delivery Information
          Delivery Informa...
          Days of Supply
          Days of Supply
          SC Disruption Notification
          SC Disruption No...
          Planned Production Output
          Planned Producti...
          Item Stock
          Item Stock
          Delivery Information
          Delivery Informa...
          Days of Supply
          Days of Supply
          SC Disruption Notification
          SC Disruption No...
          Data Exchange
          Data Exchange
          Data Exchange
          Data Exchange
          Supplier
          Supplier
          Customer
          Customer
          Tier-n
          Tier-n
          Tier-2
          Tier-2
          OEM
          OEM
          Tier-1
          Tier-1          Text is not SVG - cannot display           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/assets/PURIS_KIT_overview.svg.license b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/assets/PURIS_KIT_overview.svg.license new file mode 100644 index 00000000000..29155d66dcf --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/assets/PURIS_KIT_overview.svg.license @@ -0,0 +1,9 @@ +This work is licensed under the CC-BY-4.0 + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST) +- SPDX-FileCopyrightText: 2024 TRUMPF Werkzeugmaschinen SE + Co. KG +- SPDX-FileCopyrightText: 2024 ISTOS GmbH (a member of the DMG Mori Group) +- SPDX-FileCopyrightText: 2024 Volkswagen AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs-kits/kits/PURIS%20Kit/assets/PURIS_KIT_overview.svg diff --git a/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/assets/example-use-case.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/assets/example-use-case.drawio.svg new file mode 100644 index 00000000000..0c1d1ae6492 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/assets/example-use-case.drawio.svg @@ -0,0 +1,4 @@ + + + +
          • Production Plan
          • Stocks
          • Demand
          • ...
          PURIS & ecosystem, showing the novelty and value-added process
          In addition to improving the traditional management of shortage cases, PURIS enables continuous monitoring of critical parts to proactively prevent supply chain bottlenecks.
          Supplier
          Shortage Management
          .xls
          Customer
          Shortage Management
          Supplier
          Shortage Management
          Customer
          Shortage Management
          Monitoring
          Monitoring
          • Production plan
          • Stocks
          • Demands
          • …
           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/assets/example-use-case.drawio.svg.license b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/assets/example-use-case.drawio.svg.license new file mode 100755 index 00000000000..769aeab3475 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/assets/example-use-case.drawio.svg.license @@ -0,0 +1,9 @@ +This work is licensed under the CC-BY-4.0 + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST) +- SPDX-FileCopyrightText: 2024 TRUMPF Werkzeugmaschinen SE + Co. KG +- SPDX-FileCopyrightText: 2024 ISTOS GmbH (a member of the DMG Mori Group) +- SPDX-FileCopyrightText: 2024 Volkswagen AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs-kits/kits/PURIS%20Kit/assets/example-use-case.svg diff --git a/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/assets/example-use-case.svg b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/assets/example-use-case.svg new file mode 100644 index 00000000000..6a61fc8e283 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/assets/example-use-case.svg @@ -0,0 +1,3 @@ + + +
          • Production Plan
          • Stocks
          • Demand
          • ...
          PURIS & ecosystem, showing the novelty and value-added process
          In addition to improving the traditional management of shortage cases, PURIS enables continuous monitoring of critical parts to proactively prevent supply chain bottlenecks.
          Supplier
          Shortage Management
          .xls
          Customer
          Shortage Management
          Supplier
          Shortage Management
          Customer
          Shortage Management
          Monitoring
          Monitoring
          • Production plan
          • Stocks
          • Demands
          • …
           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/assets/example-use-case.svg.license b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/assets/example-use-case.svg.license new file mode 100644 index 00000000000..769aeab3475 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/assets/example-use-case.svg.license @@ -0,0 +1,9 @@ +This work is licensed under the CC-BY-4.0 + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST) +- SPDX-FileCopyrightText: 2024 TRUMPF Werkzeugmaschinen SE + Co. KG +- SPDX-FileCopyrightText: 2024 ISTOS GmbH (a member of the DMG Mori Group) +- SPDX-FileCopyrightText: 2024 Volkswagen AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/blob/main/docs-kits/kits/PURIS%20Kit/assets/example-use-case.svg diff --git a/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/page_adoption-view.md new file mode 100644 index 00000000000..484cb6eaee5 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/page_adoption-view.md @@ -0,0 +1,188 @@ +--- +id: Adoption View PURIS Kit +title: Adoption View +description: "PURIS Kit" +sidebar_position: 2 +--- + +![PURIS kit banner](/img/kit-icons/puris-kit-icon.svg) + +### PURIS Kit + +## Vision & Mission + +### Vision + +**_Revolutionizing the Global Supply Chain Ecosystem with Integrated, Proactive Data Sharing and Collaboration_** + +The introduction of the **P**redictive **U**nit **R**eal-Time **I**nformation **S**ervice (PURIS) enriches a company's resilience strategy through standardized data sharing, giving stakeholders heightened transparency and comprehensive information. This clarity allows PURIS users to detect supply chain issues earlier, initiate solution-finding more swiftly, and access a wider array of options, leading to more effective, cost-efficient, and environmentally friendly outcomes. By facilitating proactive anticipation, concurrent management, and reactive recovery, PURIS supports the supply chain across pre-, during-, and post-disruption phases, thereby improving operational efficiency and resilience within the Catena-X network. + + + +## Mission + +**_Empowering Stakeholders with Real-time, Predictive Insights for Proactive Supply Chain Management_** + +The PURIS KIT provides the necessary standards, aspect models, interfaces, logics, and processes to implement a comprehensive and compliant exchange of short term supply chain key information between business partners. It intends to enhance the foundation of supply chain interactions, encouraging a proactive management approach over a reactive one. + +The core is the exchange of supply chain key information between partners within a horizon of up to four weeks, including: + +1. **Item Stock:** Visibility of current inventory levels on both sides +2. **Short-term Material Demand**: Forecast of materials needed for production +3. **Planned Production Output:** Anticipated production output quantities +4. **Delivery Information:** Scheduled and actual deliveries and their details +5. **Days of Supply:** Information on how long the inventory on hand will last + +With PURIS, supply chain partners can anticipate, adapt, and align their operations to both current and future events, optimizing inventory levels, production and planning capabilities. The result is improved operational efficiency, enabling businesses to respond adequate and quickly to changes and disruptions in the supply chain. + +The PURIS service enriches companies' resilience strategy by improving data sharing and providing key information between supply chain partners on demand. This enables users to identify and manage supply chain issues with enlarged foresight. The result is that \(from a process perspective\) downstream services, systems or applications can detect critical bottlenecks at an earlier stage. + +![Overview](assets/PURIS_KIT_overview.svg) + +_Figure 1: PURIS information exchange between partners_. + +Key aspects of PURIS are: + +- **Standardized information exchange**: Base for a fast and effective handling of shortages and enhances early detection capabilities for optimized supply chain decision-making. +- **Short-term focus:** PURIS targets a period of 0-4 weeks, although longer periods are not technically restricted. +- **Collaborative approach**: Equal and fair data exchange \(quid-pro-quo\) between partners \(1-up / 1-down\), leading to a more transparent, predictable, and resilient supply chain ecosystem. +- **Data usage control and compliance**: PURIS employs the Catena-X data space to ensure the required level of data security and sovereignty for all participants. +- **Accessibility**: PURIS provides a FOSS \(Free and Open-Source Software\) reference implementation that aims to keep the entry threshold for participating in PURIS as low as possible, making it easier for smaller businesses to participate and take advantage of the benefits. + +By considering these principles, PURIS is not just enhancing current supply chain management practices but is also paving the way for a more agile, informed, and responsive automotive industry + +## Today's Challenge + +Supply chain complexity and the frequency of crises and exceptional situations pose a growing threat of significant disruptions, supply shortages and even temporary production halts for both small and medium enterprises \(SMEs\) and large enterprises \(LEs\). Rapid response and replanning are critical, which can involve considerable expenses. Costly, drawn-out decision-making among partners who might be reluctant to share information can lead to expensive special arrangements and workarounds. The longer the problem persists, the fewer viable alternatives for ensuring a continuous supply. There is an urgent need for a better information base for decision-making. + +Status-quo: + +1. **Supply Chain Transparency:** The lack of up-to-date data and transparency in the supply chain makes it difficult to anticipate disruptions and actual demand, manage production and inventory efficiently, and ensure timely deliveries. Complex and Volatile Supplier Network: The supply chain, with its widespread and diverse suppliers, faces visibility and control challenges. Demand volatility, influenced by key companies, impacts forecasting and immediate needs. +2. **Inefficient communication:** Manual and non-standardized information exchange, e.g. via Excel or phone, between partners is slow and can lead to misunderstandings, errors and unnecessary effort, which in turn negatively impacts the supply situation and increases costs. +3. **Lack of Trust:** Reluctance to share sensitive information, such as inventory levels, demand forecasts, and production capacities hinders the flow of critical information and prevent the formation of a cohesive, collaborative supply chain network. This can lead to a siloed and inefficient supply chain, where the best and most sustainable solutions are not realized. Consequences are missed opportunities, increased costs, and decreased competitiveness. + +Moreover, currently only proprietary systems are available, which are insufficiently scalable and also involve a vendor lock-in. This highlights the need for an open standard and a FOSS \(Free and Open Source Software\) reference implementation. Moreover, these systems often have a long-term focus on demand and capacity management. + +## Business Value + +The traditional approach to managing supply chains is often inflexible and involves a high degree of manual work, leading to delays and limited opportunities for proactive measures. This is particularly challenging when dealing with potential shortages that can affect the entire supply chain. + +PURIS transforms this by creating a collaborative network within the Catena-X data space, where partners, including suppliers and customers, share and use daily data. This approach allows for a dynamic and interconnected supply chain management, enhancing the ability to monitor supply and demand, identify potential issues early, and make informed decisions. + +The benefits of adopting the PURIS KIT for suppliers and customers include: + +**Improved Efficiency and Data Quality**: + +- Less manual information gathering through automated exchange of required supply chain information. +- Higher data quality and reliability through the use of standardized plan and actual data. +- Efficient planning by having a broader information and decision base. + +**Better Visibility and Collaboration**: + +- Shared view of the supply and demand situation between partners; especially in tight supply situations. +- Data sovereignty through the usage of Catena-X standards and principles as a base for trustful cooperation. + +**Cost Reduction and Sustainability**: + +- Reduced costs through avoidance of downtime, production holds and overstocks. +- Contribute to waste reduction, lower emissions, and compliance with environmental regulations and sustainability goals by avoiding unnecessary logistics measures, such as underutilized transportation of small quantities. + +Overall, adapting PURIS helps businesses achieve operational excellence, strategic resilience, data-driven decision making, collaborative innovation, and sustainability, all while reducing costs and improving market responsiveness. + +**Benefits for Large Enterprises, Small and Medium-sized Enterprises, and Solution Provider**: + +- **For OEMs and large suppliers:** + - **Increased overall supply chain efficiency:** When a critical mass of participants is reached, the PURIS standard can increase efficiency of the entire supply chain, ultimately benefiting OEMs and large Tier-1s at the end of the chain. + - **Lower operating and maintenance costs:** Consolidating and standardizing data flow through the PUris standard can reduce operating and maintenance costs for proprietary systems. + - **Avoid vendor lock-in:** With the PURIS standard, there is no need to depend on a dominant solutions provider that can result in vendor lock-in. +- **For Small and Medium-sized Enterprises \(SMEs\):** + - **Single integration point:** With PURIS there is just a single integration point, reducing the complexity and costs of managing and serving multiple customer interfaces, systems and platforms. + - **Bi-directional data exchange:** One of the significant benefits of PURIS is that it enables small and medium companies to receive information in addition to providing it. This bi-directional data exchange on equal footing reduces blind decision-making and guesswork, allowing for more informed decision-making and collaboration + - **Competitive advantage:** Using the PURIS standard can give a competitive advantage when bidding for contracts, as compliance with the PURIS standard can be favored in some procurement processes. By adopting the PURIS standard, it can be demonstrated to potential partners that a SME ist committed to data exchange best practices, making it a more attractive partner for collaboration and contract opportunities. +- **For Solution Providers:** + - **Scaling solutions:** Solution providers can scale their PURIS solutions in the market and thereby access new customer groups. + - **Versatile business models:** Offerings in the areas of consulting, integration, and operation allow for various business models, providing solution providers with the flexibility to tailor their services to specific customer needs. + +## Example Use Case + +In the following example, a Supply Chain Manager uses a tool similar to the PURIS reference application to monitor goods and parts. If problems arise, I can immediately check the status of my parts and respond appropriately. + +**The results in detail:** + +- I have a perfect view of my material pipeline towards my customer at any time. +- I can rely on updates immediately if necessary. +- This gives me confidence in my supply situation as result of my work. + +**Decisions about replenishment, additional transportation or other measures can be made immediately if necessary:** + +- I always have a clear perspective on the most economical booking methods, such as with agents. +- I receive immediate updates if necessary. This provides my organization with cost savings, even in critical situations, as a result of these practices. + +**Stressful phone calls & meetings with my customer can be reduced to exceptional situations.** + +- I no longer need to circulate Excel spreadsheets and fill them in manually. +- This means for me less stress and work load. + +![Example Use Case](assets/example-use-case.svg) +_Figure 2: Use case for standardized information exchange via PURIS_ + +## Semantic Models + +The information about the provided PURIS standardization objects is detailed in this section. It's used in ongoing business relationships and build-to-order \(BTO\) contexts, not for build-to-stock \(BTS\) situations without existing business ties. + +| Semantic Model | Semantic Model Version | Standard name | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------: | :-----------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [Item Stock](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.item_stock/2.0.0) | v.2.0.0 | CX-0122 | Item Stock includes materials in the outbound warehouse or inbound at the customer's site. Standardizing its definition and using digital twins for data sharing allows quick inventory updates across the supply chain, improving coordination and addressing supply shortages. | +| [Short-Term Material Demand](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.short_term_material_demand/1.0.0) | v.1.0.0 | CX-0120 | This exchange specifies the material a customer's production line needs from a supplier in the next four weeks. It adds context to regular orders, highlighting essential demands and extra requests for safety stocks. This detail helps suppliers plan and address potential shortages proactively. | +| [Planned Production Output](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.planned_production_output/2.0.0) | v.2.0.0 | CX-0121 | This exchange shows the agreed but unmanufactured material quantity a supplier plans to produce for a customer. Standardizing this via digital platforms ensures clear communication of future production volumes, aligning supply chain expectations and improving responsiveness to market needs. | +| [Delivery Information](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.delivery_information/2.0.0) | v.2.0.0 | CX-0118 | Delivery Information includes logistics details and metrics. It specifies shipment timing, location, quantity, and compares planned vs. actual departure and arrival times. This data, including tracking numbers and essential logistics info, helps coordinate and streamline deliveries. | +| [Days of Supply](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.days_of_supply/2.0.0) | v2.0.0 | CX-0145 | The Days of Supply \(DoS\) standard measures how long inventory can sustain operations without replenishment. This metric helps manage inventory efficiently. The standard supports proactive decisions and ensures data accuracy across the supply chain. | + +## Business Process + +PURIS orchestrates a set of business processes within the Catena-X network, enhancing supply chain visibility and operational coordination. These processes, characterized by their adaptability to multi-sourcing strategies, are described as follows: + +### Actors and Roles + +- **Data Consumer:** Act as data consumers needing information on customers' production output and material demand. +- **Data Provider:** Act as data providers, offering detailed information about their material demand and production plans to suppliers. + +### Key Processes + +- **Single Sourcing:** Direct allocation of orders and material demand in a one-to-one relationship between customer and supplier. +- **Multi-Sourcing:** One item is supplied from more than one supplier. The exchanged data must be allocated to each supplier. +- **Multi-Customer:** One item is provided to more than one customer. The exchanged data must be allocated to each customer. +- **Demand Categories:** Differentiation between regular and extraordinary demand to assist suppliers in prioritization and planning. +- **Production Planning:** Daily versus non-daily planning, with a recommendation for daily planning to enhance accuracy and responsiveness. +- **Inventory Management:** Balances inventory to prevent excess and shortages, optimizing costs and enhancing supply chain responsiveness. +- **Shortage Management:** Early detection and rapid response to supply disruptions via standardized data exchange. + +The business process facilitated by PURIS enables partners in the Catena-X network to swiftly act on up-to-date information, adapt to the fluidity of market conditions, and develop a well-rounded view of supply chain operations. This comprehensive approach not only encourages collaborative partnerships but also advances risk mitigation strategies and bolsters the overall resilience of the supply chain ecosystem. + +## Standards + +The relevant standards can be found in the [Catena-X Association Standard Library](https://catenax-ev.github.io/docs/next/standards/overview)\: + +- [CX-0118 Delivery Information Exchange 2.0.0](https://catenax-ev.github.io/docs/next/standards/CX-0118-ActualDeliveryInformationExchange) +- [CX-0120 Short-Term Material Demand Exchange 2.0.0](https://catenax-ev.github.io/docs/next/standards/CX-0120-ShortTermMaterialDemandExchange) +- [CX-0121 Planned Production Output Exchange](https://catenax-ev.github.io/docs/next/standards/CX-0121-PlannedProductionOutputExchange) +- [CX-0122 Item Stock Exchange 2.0.0](https://catenax-ev.github.io/docs/next/standards/CX-0122-ItemStockExchange) +- [CX-0145 Days of Supply Exchange 1.0.0](https://catenax-ev.github.io/docs/next/standards/CX-0145-DaysofsupplyExchange) + +## Notice + +This work is licensed under the CC-BY-4.0 + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST) +- SPDX-FileCopyrightText: 2024 TRUMPF Werkzeugmaschinen SE + Co. KG +- SPDX-FileCopyrightText: 2024 ISTOS GmbH (a member of the DMG Mori Group) +- SPDX-FileCopyrightText: 2024 Volkswagen AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/page_changelog.md b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/page_changelog.md new file mode 100644 index 00000000000..554a0d76b2d --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/page_changelog.md @@ -0,0 +1,69 @@ +--- +id: PURIS Kit Changelog +title: Changelog +description: 'PURIS Kit' +sidebar_position: 1 +--- + +### PURIS Kit + +All notable changes to this Kit will be documented in this file. + +## [0.3.1] - 2024-08-08 + +### Changed + +- Adoption View + - Made "Customer" white font in overview graphic + - Corrected confusion of Data Consumer and Data Provider in section "Actors and Roles" + +## [0.3.0] - 2024-08-01 + +### Added + +- Development View + - Added page logo on the top + - Added "Sample Data > 5. Days of Supply v2.0.0" chapter + - Added section "Component Architecture (Conceptual Whitebox View)" with figure 2: Whitebox View on a PURIS System. + +- Operation View + - Added initial Operation View + - Moved reference implementation from the Development View to Operation View + +### Changed + +- Development View + - Updated architecture chapter: added link to the umbrella helm chart + - Updated figure 1: replaced Keycloak with SIP, CIP and BPN-DID + - Updated figure 3 (previously 2): extended with Days of Supply model + - Updated policies chapter: removed membership policy example, moved framework agreement example into the JSON example in the usage policies, add PURIS purpose explanation. + - Updated reference implementation chapter: extended the PURIS FOSS description to include all other PURIS models + +## [0.2.0] - 2024-05-29 + +### Added​ + +- documentation of the adoption view +- documentation of the software development view + +### Changed​ + +- ./. + +### Removed​ + +- ./. + +## [0.1.0] - 2023-11-29 + +### Added + +- Initial version of the Kit including the adoption view + +### Changed + +- ./. + +### Removed + +- ./. diff --git a/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/page_operations-view.md b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/page_operations-view.md new file mode 100644 index 00000000000..59e8e3362b1 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/PURIS Kit/page_operations-view.md @@ -0,0 +1,24 @@ +--- +id: Operations View PURIS Kit +title: Operations View +description: 'PURIS Kit Operations View' +sidebar_position: 4 +--- + +![PURIS kit banner](/img/kit-icons/puris-kit-icon.svg) + +## Reference Implementation + +The [PURIS FOSS reference implementation](https://github.com/eclipse-tractusx/puris/tree/main/docs) serves as an application allowing to request and provide all information mentioned in sample data chapter. + +It also allows exchanging the Demand and Capacity Notifications which are described in the Supply Chain Disruption Notifications KIT. + +Arc42 of the implementation is found [here](https://github.com/eclipse-tractusx/puris/blob/main/docs/architecture/Index.md). + +## Setup + +The PURIS FOSS reference implementation can be deployed by following the [project Installation](https://github.com/eclipse-tractusx/puris/blob/29a20f9ea38e1eb54a9d9c938b94b57dfc898c32/INSTALL.md) guide. + +To run a test scenario locally, follow the [local testing and development guide](https://github.com/eclipse-tractusx/puris/blob/29a20f9ea38e1eb54a9d9c938b94b57dfc898c32/local/INSTALL.md). + +A guide to run the integration tests is found [here](https://github.com/eclipse-tractusx/puris/blob/29a20f9ea38e1eb54a9d9c938b94b57dfc898c32/local/postman/README.md). diff --git a/docs-kits_versioned_docs/version-24.05/kits/Quality-Kit/Software Development View/page_software-development-view.md b/docs-kits_versioned_docs/version-24.12/kits/Quality-Kit/Software Development View/page_software-development-view.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Quality-Kit/Software Development View/page_software-development-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Quality-Kit/Software Development View/page_software-development-view.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Quality-Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-24.12/kits/Quality-Kit/page_adoption-view.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Quality-Kit/page_adoption-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Quality-Kit/page_adoption-view.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Quality-Kit/page_changelog.md b/docs-kits_versioned_docs/version-24.12/kits/Quality-Kit/page_changelog.md similarity index 98% rename from docs-kits_versioned_docs/version-24.05/kits/Quality-Kit/page_changelog.md rename to docs-kits_versioned_docs/version-24.12/kits/Quality-Kit/page_changelog.md index 52780da54f4..f95b4c97d80 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Quality-Kit/page_changelog.md +++ b/docs-kits_versioned_docs/version-24.12/kits/Quality-Kit/page_changelog.md @@ -11,7 +11,7 @@ sidebar_position: 1 All notable changes to this Kit will be documented in this file. -## [2.0.0] - unreleased +## [1.2.1] - unreleased ### Added diff --git a/docs-kits_versioned_docs/version-24.05/kits/Quality-Kit/page_software-operation-view.md b/docs-kits_versioned_docs/version-24.12/kits/Quality-Kit/page_software-operation-view.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Quality-Kit/page_software-operation-view.md rename to docs-kits_versioned_docs/version-24.12/kits/Quality-Kit/page_software-operation-view.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Resiliency/MP_Kit.md b/docs-kits_versioned_docs/version-24.12/kits/Resiliency/MP_Kit.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Resiliency/MP_Kit.md rename to docs-kits_versioned_docs/version-24.12/kits/Resiliency/MP_Kit.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Resiliency/MaaS.md b/docs-kits_versioned_docs/version-24.12/kits/Resiliency/MaaS.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Resiliency/MaaS.md rename to docs-kits_versioned_docs/version-24.12/kits/Resiliency/MaaS.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Resiliency/PURIS_Kit.md b/docs-kits_versioned_docs/version-24.12/kits/Resiliency/PURIS_Kit.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Resiliency/PURIS_Kit.md rename to docs-kits_versioned_docs/version-24.12/kits/Resiliency/PURIS_Kit.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/Resiliency/resiliency.mdx b/docs-kits_versioned_docs/version-24.12/kits/Resiliency/resiliency.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Resiliency/resiliency.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Resiliency/resiliency.mdx diff --git a/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/page_adoption-view.md b/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/page_adoption-view.md new file mode 100644 index 00000000000..afac4ae97da --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/page_adoption-view.md @@ -0,0 +1,240 @@ +--- +id: Adoption View PURIS-DCM Supply Chain Disruption Notifications +title: Adoption View +description: "PURIS-DCM Supply Chain Disruption Notifications" +sidebar_position: 2 +--- + +![Supply Chain Disruption Notifications kit banner](@site/static/img/kits/supply-chain-disruption-notification/supply-chain-disruption-notification-kit-icon.drawio.svg) + +## Vision + +**_Elevating Robustness and Flexibility in the Supply Chains through Disruption Notifications_** + +The Supply Chain Disruption Notifications within the Catena-X framework embodies a transformative approach to fortify supply chains. This notification holds significant relevance beyond the automotive supply chain and can be effectively applied to other industries characterized by an n-tier supplier structure. By establishing a standardized, rapid communication for supply chain disruption notifications, this notification empowers stakeholders across the value chain to act swiftly and effectively in the face of challenges. Enhanced transparency and timely information exchange enable members to anticipate disruptions, streamline decision-making processes, and mitigate potential impacts. This proactive and collaborative framework not only elevates operational resilience but also drives cost efficiencies, reduces production downtime, and promotes a more sustainable and responsive supply chain ecosystem. By fostering rapid information flow, the Supply Chain Disruption Notifications is a significant step toward a more interconnected and resilient automotive industry. + +## Mission + +**_Enhancing Proactive Resilience in Supply Chains through Effective Disruption Notifications_** + +The Supply Chain Disruption Notification marks an important step in advancing industries' capability to preemptively manage supply chain risks. By instituting a standardized, efficient communication for disruption notifications, this standard is transforming how stakeholders anticipate, communicate, and respond to supply chain disruptions. It's not merely about relaying information; it's about redefining the essence of collaborative supply chain management to be anticipatory and strategic rather than merely responsive. + +Central to this mission is equipping stakeholders with a mechanism that delivers timely, actionable information, enabling them to make strategic decisions swiftly and effectively. Through the seamless integration of quick disruption notifications and information exchange, stakeholders gain a dynamic view of the supply chain, facilitating rapid adaptation to both imminent and potential disruptions. + +**Key facets of this mission include:** + +- Establishing a standardized framework for Supply Chain Disruption Notifications, ensuring consistency, accuracy, and speed in communication. +- Enhancing the industry's collective ability to respond to disruptions, thereby minimizing operational impact and maintaining continuity. +- Ensuring that all supply chain participants, no matter their size or role, have access to essential information, thereby promoting fairness across the industry. +- Promoting a culture of transparency and collaboration, enabling stakeholders to work together more effectively in the face of disruptions, thereby enhancing the overall resilience and agility of the automotive supply chain. + +Through these principles, the Supply Chain Disruption Notifications is not only addressing the immediate needs for better disruption management but also laying the groundwork for a more resilient, adaptive, and interconnected supply chain ecosystems. + +### Example Use Case + +#### Streamlining Disruption Management in Automotive Manufacturing + +The automotive industry, particularly in the context of increasing complexity and interconnectivity in supply chains, faces significant challenges in managing disruptions. + +Consider a scenario where an unexpected disruption occurs in the supply of aluminum, a critical material for vehicle manufacturing. This disruption could arise from various factors such as natural disasters, geopolitical tensions, or logistical challenges, impacting multiple manufacturers and their production lines. The aluminum producer (sender) must evaluate the impact and identify which products and stakeholders are affected. If the impact is significant, the sender will communicate the current situation upstream in a notification, potentially informing its supplier as well. Another scenario would be that an OEM notifies their suppliers about a significant demand increase which then potentially goes down the supply chain. + +For both scenarios, the recipient of this notification reviews the content and assesses the impact on their operations. Based on this assessment, the recipient determines whether further stakeholders need to be informed (either one level up or down the supply chain). If additional notifications are necessary, the recipient, now acting as the sender, drafts a new message (including a UID for the original message) to inform subsequent recipients. These recipients then evaluate the impact on their own operations and decide if further notifications are required. + +In this context, the "Supply Chain Disruption Notifications" plays a significant role in addressing these challenges by facilitating swift and standardized communication of supply chain disruptions. + +![Process](res/Process2SCDN.jpg) +_Figure 1: Visualisation of example use case_ + +#### Implementation Example + +1. **Disruption Notification Initiation:** When a primary supplier of aluminum faces a disruption, it utilizes the "Supply Chain Disruption Notification" to send out an alert. This notification includes detailed information about the nature of the disruption, expected impact, and the estimated duration of the disruption. +1. **Proactive Response Activation:** Based on the received notification, automotive manufacturers can quickly assess the impact on their production schedules. They can determine whether the disruption affects specific models or production lines and initiate contingency plans, such as activating alternative suppliers or adjusting production schedules to minimize the impact. The mentioned consequences and measures are not part of the "Supply Chain Disruption Notification" feature, but can be initiated significantly faster than without the feature. +1. **Collaborative Problem-Solving:** The standardized notification format allows for quick understanding and response from all impacted stakeholders (i.e. notification recipients). For instance, if a particular model is heavily affected, manufacturers can collaborate with suppliers to explore rapid procurement alternatives or adjust orders based on the real-time data provided in the notification. +1. **Feedback Loop:** As the situation evolves, the supplier continues to provide updates through the notification system, ensuring all impacted stakeholders have the latest information to make informed decisions. This ongoing communication fosters a collaborative environment where manufacturers and suppliers work together to mitigate the disruption's effects. +1. **Resolution**: As soon as the situation is finalized (e.g. solution found, crisis over, measures effective), the sender updates all impacted stakeholders through the notification system. This ensures, that all stakeholders have the latest status and can take corresponding decisions. + +#### Impact & Benefits + +This use case demonstrates the vital role of the "Supply Chain Disruption Notifications" standard in enhancing the agility and resilience of the automotive supply chain. By providing a structured and efficient way to communicate disruptions, the notification enables all involved stakeholders of the supply chain (both 1-up and 1-down) to: + +- Quickly adapt to supply chain disruptions, reducing production downtime and maintaining production continuity. +- Enhance collaboration between customers and suppliers, fostering a more responsive and flexible supply chain network. +- Make informed decisions rapidly, minimizing the financial and operational impacts of disruptions. +- Maintain transparency with stakeholders, including customers, about potential delays or changes in production. + +Ultimately, the adoption of this standard contributes to a more robust and adaptable automotive industry, capable of navigating the complexities of modern supply chains with enhanced efficiency and resilience. + +## Business Value + +Traditional supply chain management often struggles with rigidity and manual interventions, leading to inefficiencies and a reactive stance towards disruptions. The "Supply Chain Disruption Notifications" standard improves this by facilitating an integrated, real-time communication network within the Catena-X ecosystem, enabling stakeholders to swiftly respond to and manage supply chain disruptions. + +The adoption of this standard brings several advantages to all stakeholders within the supply chain: + +- **Enhanced Proactive Management:** The standard provides a mechanism for immediate notification and detailed insights into disruptions, allowing stakeholders to transition from a reactive to a proactive management approach. This enables faster decision-making and implementation of contingency plans, minimizing downtime and operational disruptions. +- **Improved Supply Chain Visibility:** By standardizing the disruption notification process, all parties gain a clearer understanding of the supply chain's current state. This visibility helps in identifying potential bottlenecks and vulnerabilities, facilitating a more robust supply chain design and operational strategy. +- **Increased Collaboration and Trust:** The standardized communication fosters a culture of transparency and collaboration among supply chain partners. Enhanced trust leads to more effective joint problem-solving and innovation, driving collective resilience against future disruptions. +- **Strategic Decision Support:** Access to real-time, actionable data allows organizations to make informed strategic decisions. This capability supports better resource allocation, investment in mitigation strategies, and overall supply chain optimization. +- **Market Competitiveness:** Organizations that rapidly adapt to disruptions can maintain or even improve their market position. The ability to sustain operations during adverse events translates to reliable service delivery, maintaining customer satisfaction and loyalty. +- **Sustainability:** Effective disruption management contributes to sustainability by reducing waste associated with overproduction or expedited shipping to compensate for delays. + +In sum, integrating the "Supply Chain Disruption Notifications" standard into the Catena-X data space equips stakeholders with advanced tools to navigate the complexities of modern supply chains. This adoption underscores a commitment to operational excellence, resilience, and strategic foresight, paving the way for a more interconnected and resilient automotive industry. + +## Use Case / Domain explanation + +In the context of the automotive industry's evolving needs, particularly with the integration of the "Supply Chain Disruption Notifications" within the Catena-X network, we explore a pertinent domain: Enhancing Disruption Management in Automotive Supply Chains. This domain aims to tackle the challenges posed by disruptions in the automotive supply chain, focusing on improving resilience and response strategies. + +### Today's Challenge + +The automotive supply chain is characterized by a high degree of complexity and interdependence, where disruptions can ripple through the network, impacting production, lead times, and market competitiveness. Key challenges include: + +- **Disruption Readiness:** The ability to rapidly identify, communicate, and respond to disruptions is often hampered by a lack of current data and standardized communication. +- **Interconnectedness:** The intricate web of suppliers, manufacturers, and logistic partners in the automotive industry necessitates a cohesive approach to manage and mitigate disruptions effectively. +- **Response Agility:** The speed at which an organization can adapt to and recover from supply chain disruptions directly affects its operational continuity and market position. + +**Opportunities**: + +1. **Enhanced Communication:** Establishing a standardized communication for disruption notifications enables swift and accurate information sharing, fostering a proactive response mechanism. +1. **Operational Resilience:** Empowering stakeholders with real-time data and insights into supply chain disruptions strengthens the industry's ability to maintain continuity amidst volatility. +1. **Strategic Collaboration:** Facilitating a collaborative environment where stakeholders can coordinate responses to disruptions enhances the supply chain's overall robustness. + +### Benefits for involved n-tier suppliers and OEMs + +Within the n-tier value chain there are customer-supplier relationships. As a participant in the value chain, a company commonly acts as a customer and a supplier: + +- **Customers (incl. OEM):** Immediate access to Disruption Notifications allows for quicker adjustment of production plans, inventory management, and customer communications, reducing the impact on operations. +- **Supplier:** Enhanced visibility into potential disruptions enables suppliers to adjust their production and delivery schedules proactively, maintaining service levels and customer relationships. + +### Use case conclusion + +Addressing the challenges of disruption management in the automotive supply chain through the "Supply Chain Disruption Notifications" within the Catena-X network offers significant advantages. By enhancing the flow of critical information and fostering a collaborative response to disruptions, stakeholders can achieve greater operational resilience, maintain supply chain continuity, and uphold competitive advantage. This collaborative framework not only mitigates the immediate effects of disruptions but also paves the way for a more agile and responsive automotive industry. + +## Semantic Models + +Currently the standard _Supply Chain Disruption Notifications_ provides one semantic model _Demand and Capacity Notification._ + +| Semantic Model | Version | Link to GitHub Repository | +| ------------------------------------------------ | ------- | ---------------------------------------------------------------------------------------------------------------- | +| Demand and Capacity Notification (Release 24.05) | v2.0.0 | | + +## Business Process + +The Supply Chain Disruption Notifications standard orchestrates significant business processes within the Catena-X network, aiming to enhance the industries' resilience to supply chain disruptions. These processes facilitate timely and efficient communication among stakeholders, ensuring a coordinated response to disruptions. Here's an overview of the roles and processes involved: + +**Actors and Roles:** + +- **Notification Senders:** Entities that detect and report disruptions within the supply chain, acting as the primary source of real-time disruption information. +- **Notification Recipient:** Stakeholders who receive the disruption notifications, needing to adjust their operations or decision-making in response to the reported disruptions. + +**Potential Triggers:** + +Supply Chain Disruption Notifications are recommended for exceptional circumstances and are not intended for routine communication regarding changes in demands or capacities. For the latter the usage of the DCM and the PURIS KIT/Apps is recommended. As outlined, these notifications are specifically deployed in response to extraordinary events that significantly impact the supply chain. The determination of what constitutes an "extraordinary" event is at the discretion of the sender. Below is a list of potential triggers for issuing a Supply Chain Disruption Notification: + +- **Affected Period:** An assessment indicating that the issue or situation will have a long-term impact that cannot be resolved within a defined period of weeks or persists over an extended duration. +- **Duration:** Duration of capacity reduction or change in demand, such as whether capacity is diminished over a specified period. +- **Degree of Deviation:** The degree of capacity loss or demand change is typically addressed in the normal failure batch by setting user capacity to zero. However, if significant changes occur, an alert may be triggered. +- **Affected number of business partners:** Assessment indicates that the problem or situation will impact additional business partners beyond the direct 1:1 business relationship and cannot be resolved solely within that relationship. + +**Data Exchange and Notification Transmission:** + +- **Disruption Information:** Detailed notifications about the nature, scope, and expected impact of the disruption, including estimated duration and affected materials or components if already known/identified. +- **Impact Assessment:** Recipients evaluate the potential impact of the disruption on their operations, considering factors like inventory levels, production schedules, and delivery commitments. Further, they evaluate if they need to inform their partners via a new notification. +- **Response Coordination:** Facilitates a collaborative approach among impacted stakeholders to develop and implement mitigation strategies, ensuring a unified response to the disruption. + +**Key Processes:** + +- **Direct Notification:** Immediate dissemination of disruption information from the sender to all relevant recipients (limited to 1-up/1-down) within the network. +- **Collaborative Resolution:** Stakeholders work together to address the disruption, sharing insights and potential solutions to mitigate the impact across the supply chain. +- **Update and Feedback Loop:** Continuous updates on the evolving status of the disruption and its resolution, enabling stakeholders to adapt their strategies in real-time. + +**Operational Adaptation:** + +- **Proactive Adjustment:** Stakeholders use the received information to proactively adjust production plans, inventory management, and logistical arrangements. +- **Strategic Planning:** Incorporation of disruption data into strategic planning, enhancing the supply chain's agility and preparedness for future disruptions. + +**Notification Identifiers:** + +To differentiate messages and maintain chronological and dependance tracking, distinct IDs are included in the notifications sent: + +- **Notification ID:** Unique ID identifying the notification. +- **Related Notification ID:** Unique ID identifying a previously received notification triggering the exchange of the current notification. +- **Source Notification ID:** Unique ID identifying a source notification related to the current one. + +The business process underpinned by the "Supply Chain Disruption Notifications" standard empowers partners within the Catena-X network to respond effectively to unexpected disruptions. This system enhances the industry's ability to maintain operational continuity, mitigate risks, and uphold service levels, contributing to a more resilient and responsive automotive supply chain. + +## Business Architecture + +### Introduction + +The "Supply Chain Disruption Notifications" standard within the Catena-X framework facilitates a structured and efficient communication process for disruption notifications across the automotive supply chain. This system is integral for enabling rapid dissemination and reception of critical disruption information among stakeholders. The architecture of this system is designed to: + +- Provide operative capabilities for stakeholders to exchange supply chain disruption notifications with immediate upstream and downstream partners, ensuring a direct and efficient communication pathway. +- Define data models that are essential for the interoperable and standardized exchange of supply chain disruption information. +- Offer guidance on how stakeholders should disseminate and react to supply chain disruption notifications, supporting scenarios that involve complex supply chain structures such as multi-sourcing or multi-customer frameworks. +- Propose methodologies for leveraging supply chain disruption data to enhance decision-making and supply chain resilience (referencing the provided use case example). + +### Components + +The "Supply Chain Disruption Notifications" framework consists of several components that work in unison to ensure a robust and responsive system: + +- **Notification Exchange Application:** A software component that enables stakeholders to send and receive supply chain disruption notifications. It integrates with existing systems to extract and input relevant data, ensuring the timeliness and accuracy of the information exchanged. +- **Connector:** This component manages the secure and compliant exchange of data, acting as a bridge between business partners within the Catena-X network. It ensures that data flow adheres to standardized communication and security measures. +- **Data Provisioning & Transformation:** This aspect involves transforming internal data into the standardized format required for the notification system and vice versa, allowing seamless integration with internal systems and processes. +- **Identity and Access Management (IAM):** Ensures secure access to the system, managing authentication and authorization across the Catena-X network. It includes mechanisms to verify the identity and credentials of participating entities, ensuring that data exchange occurs within a trusted environment. + +By adopting this business architecture, stakeholders in the automotive supply chain can significantly enhance their ability to manage and mitigate the impacts of disruptions, fostering a more resilient and agile supply chain ecosystem within the Catena-X framework. + +## Logic & Schema + +To send and receive Supply Chain Disruption Notifications, an internal process for evaluating incoming notifications as well as sending new notifications needs to be implemented. The following figure visualises the process in the supply chain, in which a tier 2 company sends a notification to its customers and a supplier. + +![Logic & Schema](res/image-2024-3-5_15-22-27-1.png) +_Figure 2: Visualisation of the notifications process_ + +## Standards + +The relevant standards can be found in the [Catena-X Association Standard Library](https://catenax-ev.github.io/docs/next/standards/overview): + +- [CX-0146 Supply Chain Disruption Notifications 1.0.0](https://catenax-ev.github.io/docs/next/standards/CX-0146-SupplyChainDisruptionNotifications) + +### Normative References + +| Standard | Standard Name | +| -------- | ----------------------------------- | +| CX-0001 | EDC Discovery API | +| CX-0003 | SAMM Aspect Meta Model | +| CX-0006 | Registration and initial onboarding | +| CX-0010 | Business Partner Number (BPN) | +| CX-0015 | IAM & Access Control Paradigm | +| CX-0018 | Dataspace Connectivity | +| CX-0126 | Industry Core: Part Type | +| CX-0149 | Verified Company Identity | + +### Non-Normative References + +| Context | Link | +| --------- | -------------------------------------------- | +| CX - 0118 | Delivery Information | +| CX - 0120 | Short-Term Material Demand | +| CX - 0121 | Planned Production Output | +| CX - 0122 | Item Stock | +| CX - 0128 | Demand and Capacity Management Data Exchange | +| CX - 0145 | Days of Supply | + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode) + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 SAP SE +- SPDX-FileCopyrightText: 2024 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2024 BASF SE +- SPDX-FileCopyrightText: 2024 SupplyOn AG +- SPDX-FileCopyrightText: 2024 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2024 Contributors of the Eclipse Foundation +- SPDX-FileCopyrightText: 2024 ISTOS GmbH (a member of the DMG Mori Group) +- SPDX-FileCopyrightText: 2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST) +- SPDX-FileCopyrightText: 2024 TRUMPF Werkzeugmaschinen SE + Co. KG +- SPDX-FileCopyrightText: 2024 Volkswagen AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/page_changelog.md b/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/page_changelog.md new file mode 100644 index 00000000000..1b18ba49c04 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/page_changelog.md @@ -0,0 +1,59 @@ +--- +id: Supply Chain Disruption Notifications Changelog +title: Changelog +description: 'Supply Chain Disruption Notifications' +sidebar_position: 1 +--- + +![Supply Chain Disruption Notifications kit banner](@site/static/img/kits/supply-chain-disruption-notification/supply-chain-disruption-notification-kit-icon.drawio.svg) + +### Supply Chain Disruption Notifications + +All notable changes to this Kit will be documented in this file. + +## [1.0.1] - 2024-11-18 + +### Added + +- ./. + +### Changed + +- New kit-icon and gallery banner + +### Removed + +- ./. + +## [1.0.0] - 2024-08-01 + +### Added + +- Initial version of the Kit including adoption, development and operations view + +### Changed + +- ./. + +### Removed + +- ./. + +## Notice + +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 SAP SE +- SPDX-FileCopyrightText: 2024 Mercedes Benz Group AG +- SPDX-FileCopyrightText: 2024 BASF SE +- SPDX-FileCopyrightText: 2024 SupplyOn AG +- SPDX-FileCopyrightText: 2024 Henkel AG & Co.KGaA +- SPDX-FileCopyrightText: 2024 Contributors of the Eclipse Foundation +- SPDX-FileCopyrightText: 2024 ISTOS GmbH (a member of the DMG Mori Group) +- SPDX-FileCopyrightText: 2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST) +- SPDX-FileCopyrightText: 2024 TRUMPF Werkzeugmaschinen SE + Co. KG +- SPDX-FileCopyrightText: 2024 Volkswagen AG +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation diff --git a/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/page_operations_view.md b/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/page_operations_view.md new file mode 100644 index 00000000000..6beb44b1390 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/page_operations_view.md @@ -0,0 +1,22 @@ +--- +id: Operations View PURIS-DCM Supply Chain Disruption Notifications +title: Operations View +description: 'PURIS-DCM Supply Chain Disruption Notifications' +sidebar_position: 4 +--- + +![Supply Chain Disruption Notifications kit banner](@site/static/img/kits/supply-chain-disruption-notification/supply-chain-disruption-notification-kit-icon.drawio.svg) + +## Reference Implementation + +The [PURIS FOSS reference implementation](https://github.com/eclipse-tractusx/puris/tree/main/docs) serves as an application allowing to send and receive [Demand and Capacity Notifications](https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.demand_and_capacity_notification/2.0.0/DemandAndCapacityNotification.ttl) among other data objects that are described in the [PURIS KIT](https://eclipse-tractusx.github.io/docs-kits/kits/PURIS%20Kit/Software%20Development%20View/Software%20Development%20PURIS%20Kit). + +Arc42 of the implementation is found [here](https://github.com/eclipse-tractusx/puris/blob/main/docs/architecture/Index.md). + +## Setup + +The PURIS FOSS reference implementation can be deployed by following the [project Installation](https://github.com/eclipse-tractusx/puris/blob/29a20f9ea38e1eb54a9d9c938b94b57dfc898c32/INSTALL.md) guide. + +To run a test scenario locally, follow the [local testing and development guide](https://github.com/eclipse-tractusx/puris/blob/29a20f9ea38e1eb54a9d9c938b94b57dfc898c32/local/INSTALL.md). + +A guide to run the integration tests is found [here](https://github.com/eclipse-tractusx/puris/blob/29a20f9ea38e1eb54a9d9c938b94b57dfc898c32/local/postman/README.md). diff --git a/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/page_software-development-view.md b/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/page_software-development-view.md new file mode 100644 index 00000000000..b98455109f5 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/page_software-development-view.md @@ -0,0 +1,277 @@ +--- +id: Software Development View PURIS-DCM Supply Chain Disruption Notifications +title: Software Development View +description: "PURIS-DCM Supply Chain Disruption Notifications" +sidebar_position: 3 +--- + +![Supply Chain Disruption Notifications kit banner](@site/static/img/kits/supply-chain-disruption-notification/supply-chain-disruption-notification-kit-icon.drawio.svg) + +## Introduction + +The Development View provides information and resources for implementing Supply Chain Disruption Notifications (further: notifications) standards. The architecture chapter describes the interactions of all components in the notifications context. The policies chapter describes the access policies, usage policies and contract definitions. The protocol chapter gives examples how the data asset is registered in the connector. In the chapter sample data the semantic data model of the Supply Chain Disruption Notifications are defined with a reference to the turtle file and an example JSON payload. For quick installation guides and reference to a ready implementation of notifications, please see Operation View. + +## Architecture + +Figure 1 shows the high-level architecture of the notification exchange in the Catena-X dataspace and the services that +are involved. Both the notification sender and the notification recipient must be members of the Catena-X network in +order to communicate with each other. With the help of the Identity Access Management (IAM) each participant can +authenticate itself, verify the identity of the requesting party and decide whether to authorize the request. + +![Architecture Sketch](res/PURIS-R2408-architecture-sketch.png) +_Figure 1: High-level architecture of the notification exchange in the Catena-X dataspace_ + +From conceptual point of view the system consists of different building blocks. These building blocks in the following +diagram show which participant deploys which components. Identification and Access Management is omitted for simplicity +reasons. + +![System Architecture](res/PURIS-R2408-system-architecture%20sketch.png) +_Figure 2: Whitebox view on a PURIS system_ + +## Policies + +This chapter describes the access & usage policies as well as the contract definitions. For more information on the +access & usage policies, please refer to +the [policies documentation in the tractusx-edc repository](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/docs/usage/management-api-walkthrough/02_policies.md).[​](https://github.com/eclipse-tractusx/tractusx-edc/tree/main "Direct link to heading") + +### Access Policies[​](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Software%20Development%20View/Data%20Provider%20Development%20View%20Traceability%20Kit/#access-policies "Direct link to heading") + +To enable data sovereignty, access and usage policies are important to protect the data assets of a data provider in the +connector, as described in +the [Connector KIT](https://eclipse-tractusx.github.io/docs-kits/next/category/connector-kit). + +To decide which company has access to the data assets, access policy should be used. Note that without protecting data +assets with access policies, they become publicly available in the Catena-X network which is not recommended. + +Therefore, every asset should be protected and only be made available through specified BPNL policy groups or specific +BPNL policies. For a detailed description, +see [Business Partner Validation Extension](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/edc-extensions/bpn-validation). + +#### BPNL Access Policy[​](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Software%20Development%20View/Data%20Provider%20Development%20View%20Traceability%20Kit/#bpn-access-policy "Direct link to heading") + +This policy allows limiting access to a data offer based on a list of specific BPNLs. This translates to the following +functionality: + +- The data offer creator will be able to create a policy listing all the BPN that can access the data offer. +- This means that only the connectors registered in the Catena-X network with the BPNL listed in the policy can see the + data offer and accept it (for the creation of data contracts and subsequent data exchange). + +#### Implementation Hint + +Examples including a JSON payload for a BPNL group access policy are described in +the [Business Partner Validation Extension](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/edc-extensions/bpn-validation). + +The reference implementation (see Operation View) also provides an extension to add the BPNL of the requesting party to +the header of a proxied request. As a result, during implementation one can use this BPNL to design the internal +submodel API. + +### Usage Policies[​](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Software%20Development%20View/Data%20Provider%20Development%20View%20Traceability%20Kit/#usage-policies "Direct link to heading") + +To decide which company can use the data asset under specific conditions, usage policies (also referred to as contract +policies) are used. Therefore, they are more specific than access policies and only used just after access is granted. +Currently, the usage policies aren't technically enforced but based on a legal framework agreements. Signing of +framework agreements can be enforced during negotiation depending on the connector implementation. + +Policies are defined based on the [W3C ODRL format](https://www.w3.org/TR/odrl-model/). This allows a standardized way +of formulating policy payloads. It further allows to stack different constraints with the `odrl:and` operator. +Therefore, every data provider can decide on his or her own under which conditions their data assets are shared in the +network. It is recommended to restrict the data usage for all exchanged data standards. An example of one usage policy +containing three different constraints is shown and described in the following: + +```json +{ + "@context": [ + "http://www.w3.org/ns/odrl.jsonld", + { + "edc": "https://w3id.org/edc/v0.0.1/ns/", + "cx-policy": "https://w3id.org/catenax/policy/" + } + ], + "@type": "PolicyDefinitionRequestDto", + "@id": "", + // Important for the contract definition + "edc:policy": { + "@type": "Set", + "profile": "cx-policy:profile2405", + "permission": [ + { + "action": "use", + "constraint": { + "@type": "LogicalConstraint", + "and": [ + { + "@type": "LogicalConstraint", + "leftOperand": "cx-policy:FrameworkAgreement", + "operator": "eq", + "rightOperand": "" + }, + { + "@type": "LogicalConstraint", + "leftOperand": "cx-policy:UsagePurpose", + "operator": "eq", + "rightOperand": "" + }, + { + "@type": "LogicalConstraint", + "leftOperand": "cx-policy:ContractReference", + "operator": "eq", + "rightOperand": "x12345" + } + ] + } + } + ] + } +} +``` + +It is recommended to use the following values for rightOperand of FrameworkAgreement and UsagePurpose depending on the +use case: + +| Use case | cx-policy:FrameworkAgreement | cx-policy:UsagePurpose | +| -------- | ---------------------------- | ---------------------- | +| DCM | `DemandCapacity:1.0` | `cx.dcm.base:1` | +| PURIS | `Puris:1.0` | `cx.puris.base:1` | + +More information can be found in +the [Policies in Catena-X of the Connector KIT](https://eclipse-tractusx.github.io/docs-kits/kits/Connector%20Kit/Adoption%20View/connector_kit_adoption_view_policies_cx/). + +### Contract Definitions[​](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Software%20Development%20View/Data%20Provider%20Development%20View%20Traceability%20Kit/#contract-definitions "Direct link to heading") + +In the connector, every policy is associated with a contract. Thus, a contract definition is needed, detailing what +policies are required when contracting assets. + +When using an above mentioned Access Policy, their `ACCESS_POLICY_ID` needs to be included as a value of +the `accessPolicyId` key in the contract definition. + +When using an above mentioned Usage Policy, their `CONTRACT_POLICY_ID` needs to be included as a value of +the `contractPolicyId` key in the contract definition. + +```json +{ + "id": "{{CONTRACT_DEFINITION_ID}}", + "criteria": [ + { + "operandLeft": "asset:prop:id", + "operator": "=", + "operandRight": "{{ASSET_ID}}" + } + ], + "accessPolicyId": "{{ACCESS_POLICY_ID}}", + "contractPolicyId": "{{CONTRACT_POLICY_ID}}" +} +``` + +For a more detailed tutorial on creating contracts for assets, see +in [Chapter 3 of the End-to-End Adopter Journey](https://eclipse-tractusx.github.io/docs/tutorials/e2e/boost/provideData). + +## Protocol + +This chapter contains data structures that are designed for providing data for notifications. + +### Connector Data Asset Structure for "Notification API" + +To enable notifications, the recipient has to register its notification API as a data asset as follows: + +```json +{ + "@context": { + "@vocab": "https://w3id.org/edc/v0.0.1/ns/", + "cx-taxo": "https://w3id.org/catenax/taxonomy#", + "cx-common": "https://w3id.org/catenax/ontology/common#", + "dct": "http://purl.org/dc/terms/" + }, + "@id": "{{DEMAND_AND_CAPACITY_NOTIFICATIONS_REQUEST_API_ASSET_ID}}", + "properties": { + "dct:type": { + "@id": "cx-taxo:DemandAndCapacityNotificationApi" + }, + "cx-common:version": "1.0", + "description": "Demand and Capacity Notification API Endpoint" + }, + "dataAddress": { + "@type": "DataAddress", + "type": "HttpData", + "proxyBody": "true", + "proxyMethod": "true", + "baseUrl": "{{DEMAND_AND_CAPACITY_NOTIFICATION_API_ENDPOINT}}", + "contentType": "application/json" + } +} +``` + +This asset can then be contracted by senders of notifications. + +## Sample Data + +The semantic models in the business context are defined in the Adoption View of this KIT. This chapter gives additional +information for each aspect model by providing the example data objects in JSON format, link to the RDF turtle file on +GitHub and unique semantic id of the aspect model. Currently the standard _Supply Chain Disruption Notifications_ +provides one semantic model _Demand and Capacity Notification_. + +### 1. Demand and Capacity Notification + +GitHub link to semantic data model in RDF turtle +format: + +This aspect model has the following semantic id: + +`urn:samm:io.catenax.demand_and_capacity_notification:2.0.0#DemandAndCapacityNotification` + +The following JSON provides an example of the value-only serialization of the _Supply Chain Disruption Notification_ +aspect model for a sample notification. The notification informs the supplier about a strike at the customer's site +resulting in a demand reduction between 12.12.2023 and 17.12.2023. + +```json +{ + "affectedSitesSender": ["BPNS7588787849VQ"], + "affectedSitesRecipient": ["BPNS6666787765VQ"], + "materialNumberSupplier": ["MNR-8101-ID146955.001"], + "contentChangedAt": "2023-12-13T15:00:00+01:00", + "startDateOfEffect": "2023-12-13T15:00:00+01:00", + "materialNumberCustomer": ["MNR-7307-AU340474.002"], + "leadingRootCause": "strike", + "effect": "demand-reduction", + "notificationId": "urn:uuid:d8b6b4ca-ca9c-42d9-8a34-f62591a1c68a", + "relatedNotificationId": "urn:uuid:d8b6b4ca-ca9c-42d9-8a34-f62591a1c68a", + "sourceNotificationId": "urn:uuid:d8b6b4ca-ca9c-42d9-8a34-f62591a1c68a", + "text": "Capacity reduction due to ongoing strike.", + "expectedEndDateOfEffect": "2023-12-17T08:00:00+01:00", + "status": "open" +} +``` + +The following JSON provides an example with the same payload and additionally with a message header. For more +information on the message header, see +the [RDF turtle file of the message header](https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.shared.message_header/3.0.0/MessageHeaderAspect.ttl). + +```json +{ + "header": { + "senderBpn": "BPNL7588787849VQ", + "context": "CX-DemandAndCapacityNotification:1.0", + "messageId": "3b4edc05-e214-47a1-b0c2-1d831cdd9ba9", + "receiverBpn": "BPNL6666787765VQ", + "sentDateTime": "2023-12-01T21:24:00+07:00", + "version": "3.0.0" + }, + "content": { + "demandAndCapacityNotification": { + "affectedSitesSender": ["BPNS7588787849VQ"], + "affectedSitesRecipient": ["BPNS6666787765VQ"], + "materialNumberSupplier": ["MNR-8101-ID146955.001"], + "contentChangedAt": "2023-12-13T15:00:00+01:00", + "startDateOfEffect": "2023-12-13T15:00:00+01:00", + "materialNumberCustomer": ["MNR-7307-AU340474.002"], + "leadingRootCause": "strike", + "effect": "demand-reduction", + "notificationId": "urn:uuid:d8b6b4ca-ca9c-42d9-8a34-f62591a1c68a", + "relatedNotificationId": "urn:uuid:d8b6b4ca-ca9c-42d9-8a34-f62591a1c68a", + "sourceNotificationId": "urn:uuid:d8b6b4ca-ca9c-42d9-8a34-f62591a1c68a", + "text": "Capacity reduction due to ongoing strike.", + "expectedEndDateOfEffect": "2023-12-17T08:00:00+01:00", + "status": "open" + } + } +} +``` diff --git a/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/res/2024-07-23_Messaging process_EN_short.pptx b/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/res/2024-07-23_Messaging process_EN_short.pptx new file mode 100644 index 00000000000..9badcfefcbf Binary files /dev/null and b/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/res/2024-07-23_Messaging process_EN_short.pptx differ diff --git a/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/res/PURIS-R2408-architecture-sketch.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/res/PURIS-R2408-architecture-sketch.drawio.svg new file mode 100644 index 00000000000..29a46958d32 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/res/PURIS-R2408-architecture-sketch.drawio.svg @@ -0,0 +1,4 @@ + + + +
          Notification Recipient
          Notification Recipient
          (4) Receive Notitification
          (4) Receive Notitification
          Connector
          Connector
          Business Application
          Business Ap...
          Notification Endpoint
          Notificatio...
          (1) Register Notification Endpoint
          (1) Register Notification Endpoint
          Notification Sender
          Notification Sender
          Connector
          Connector
          Business Application
          Business Ap...
          (3) POST Notification
          (3) POST Notification
          (2) Connector Communication
            (Catalog/Contracting/Transfer)  
          (2) Connector Communication...
          Catena-X Core Service Provider
          Catena-X Core Service Provider
          IAM
          IAM
          Shared Identity Provider
          Shared Ident...
          Central Identity Provider
          Central Iden...
          Credential Service
          Credential S...
          BPN-DID Resolution Service
          BPN-DID Reso...
            Authentication / Authorization  
            Authentication / Authorization  
            Authentication / Authorization  
            Authentication / Authorization            Text is not SVG - cannot display           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/res/PURIS-R2408-architecture-sketch.png b/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/res/PURIS-R2408-architecture-sketch.png new file mode 100644 index 00000000000..63127e10a42 Binary files /dev/null and b/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/res/PURIS-R2408-architecture-sketch.png differ diff --git a/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/res/PURIS-R2408-system-architecture sketch.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/res/PURIS-R2408-system-architecture sketch.drawio.svg new file mode 100644 index 00000000000..a869a090cde --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/res/PURIS-R2408-system-architecture sketch.drawio.svg @@ -0,0 +1,4 @@ + + + +
          «data ecosystem»
          Catena-X
          «data ecosystem»...
          «system»
          Notification Recipient
          «system»...
          «system»
          Notification Sender
          «system»...
          Update OWN data
          Update OWN data
          «subsystem»
          Data Provisioning
          & Transformation
          «subsystem»...
          Notification API
          Notification API
          Register Notification API
          Query Partner Data,
          Negotiate Contract,
          Initialize Data Transfer
          Register Notification API...
          Lookup partners' EDC address
          Lookup partners' EDC address
          «subsystem»
          Notification Source

          «subsystem»...
          View Catalog (Data Offers),
          Negotiate Contracts,
          Provide Notification API,
          Receive Notification
          View Catalog (Data Offers),...
          «subsystem»
          Connector
          «subsystem»...
          Receive OWN Data
          Receive OWN Data
          «Service»
          Discovery Service
          «Service»...
          «subsystem»
          Connector
          «subsystem»...
          «subsystem»
          Notification Sink
          «subsystem»...
          Internal Systems
          I...
          Other interfaces
          O...
          Notification API
          Notification API          Text is not SVG - cannot display           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/res/PURIS-R2408-system-architecture sketch.png b/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/res/PURIS-R2408-system-architecture sketch.png new file mode 100644 index 00000000000..eb73363ca8d Binary files /dev/null and b/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/res/PURIS-R2408-system-architecture sketch.png differ diff --git a/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/res/Process2SCDN.jpg b/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/res/Process2SCDN.jpg new file mode 100644 index 00000000000..80f5b5cfa44 Binary files /dev/null and b/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/res/Process2SCDN.jpg differ diff --git a/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/res/Schaubild Notifications.pptx b/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/res/Schaubild Notifications.pptx new file mode 100644 index 00000000000..9fcc38c4dc8 Binary files /dev/null and b/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/res/Schaubild Notifications.pptx differ diff --git a/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/res/image-2024-3-5_15-22-27-1.png b/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/res/image-2024-3-5_15-22-27-1.png new file mode 100644 index 00000000000..9365d9450d5 Binary files /dev/null and b/docs-kits_versioned_docs/version-24.12/kits/Supply Chain Disruption Notifications KIT/res/image-2024-3-5_15-22-27-1.png differ diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/Software Development View/_category_.json b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/Software Development View/_category_.json similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/Software Development View/_category_.json rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/Software Development View/_category_.json diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/Software Development View/page_app-provider_software-development-view.mdx b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/Software Development View/page_app-provider_software-development-view.mdx similarity index 68% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/Software Development View/page_app-provider_software-development-view.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/Software Development View/page_app-provider_software-development-view.mdx index 366dfd2ddef..91be16ba70c 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/Software Development View/page_app-provider_software-development-view.mdx +++ b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/Software Development View/page_app-provider_software-development-view.mdx @@ -35,7 +35,8 @@ The traceability app providers are supposed to implement the capabilities to ena This feature will enable the whole industry to exchange and act upon quality issues in a more standardized, integrated, accelerated and precise manner in order to streamline claim management, avoid general and inaccurate recalls as well as reduce cost and safeguard brand reputation. In order to uniquely reference the affected parts across the network in the context of a quality incident, the exchange of quality notifications uses Catena-X Unique ID, which are the network-wide unique identifiers for a serialized part or batch, for which a digital twin has been created. Therefore, an app provider should also deliver capabilities for standardized creation of digital twins of vehicles, parts and materials as described in the [Industry Core KIT](../../../category/industry-core-kit) and [Digital Twin KIT](../../../category/digital-twin-kit). -![Quality Notifications](../assets/quality_notifications.png) + +![Quality Notifications](../assets/quality_notifications.svg) ### Quality Notification Process The notification process takes place between traceability applications or application stacks, and the focus is on minimal interaction, which must be supported by all applications participating in a quality notification or quality investigation scenario. This minimal interaction includes sending and receiving of quality notification as well as updating of the notification state. Application internals like user journeys, process steps or workflows for notification creation and management in an application are not standardized within Catena-X, and therefore omitted. @@ -46,7 +47,32 @@ The notification states and their cycle are described in the following figure. ### Quality Notification API A standardized set of APIs and payloads are specified to enable partners to send quality notifications in a standardized way while already knowing which parts (i.e., serialized parts or batches) and which direct customers or suppliers are affected. Notifications are - in contrast to classical data offers in Catena-X which is created for consumption by external stakeholders - a way to push notification related data from a sender to a receiver. For now, this notification API is limited to the sending and receiving of quality notifications as well as the update of the notification status following a state model. It is important to mention that the notification API shall be implemented into each participant's traceability solution or solution stack in order to be able to receive information related to quality issues. The implemented endpoints shall be able to process the defined request body and respond with the HTTP status codes and - if required - reply with the defined response body. -Meanwhile, this notification API shall only be accessible after successful contract negotiation via Connector based on [Dataspace Protocol (DSP)](https://docs.internationaldataspaces.org/dataspace-protocol/), since the API is made available as part of an EDC data asset with usage policy attached. Please refer to the Notification API ([v1.2.1](../openapi/notifications_1-2-1.yaml), [v2.0.0](../openapi/notifications_2-0-0.yaml)) for more details. +Meanwhile, this notification API shall only be accessible after successful contract negotiation via Connector based on [Dataspace Protocol (DSP)](https://docs.internationaldataspaces.org/dataspace-protocol/), since the API is made available as part of an EDC data asset with usage policy attached. Please refer to the corresponding Notification API specifications for more details: +- [Notification API (v1.2.1)](../openapi/notifications_1-2-1.yaml) +- [Notification API (v2.0.0)](../openapi/notifications_2-0-0.yaml) + +> :raised_hand: For the current release, **version 1.2.1 is mandatory** and must be supported by every App provider. The newer version 2.0.0 can be supported optionally. + +## Block Notifications +While quality notifications are primarily aimed at (first) contact between business partners, block notifications represent an extended form of data exchange in order to actively initiate an immediate measure to block or sort out the produced parts at the customer's production or logistics. As the quality notifications, block notifications take place between traceability applications or other application stacks, so that this functionality must be implemented by both business partners application. + +In this case, block notifications include a **notification status similar to quality notifications** to track communication, but **also include a new status model** for each individual part of the block notification to provide additional information. For example, whether the part was blocked or whether the process to block a part was canceled. + +> :raised_hand: Since the Catena-x unique ID is used for the individually listed (damaged) parts in the block notification, the app provider should also provide functions for the standardized creation of digital twins of vehicles, parts and materials, as already mentioned in the quality notifications section. + +### Block Status Model +In order to track the blocking process in the Catena X network, a defined status model is used for each part of the block notification: +![Block Status Model](../assets/block-notification-state-model.svg) + +- ACTIVE means that the part has been identified as a damaged and safety-critical part and must therefore be blocked on the customer side. +- PART_BLOCKED is used when the recipient has received the block notification and actually blocks / sorts out the damaged parts as a measure. +- CANCELED serves as the update status of the component originally identified to be blocked if the supplier subsequently determines that the original part does meet safety requirements, is not damaged or that the information was sent by mistake. This status can also be set by the manufacturer if, after an (initial) analysis, the part does not require a block. + +### Block Notification API +A standardized API and corresponding payloads are specified for block notification to enable and ensure the exchange of information that is critical to the blocking process in a standardized way. At this point, the notification API is focused on sending and receiving notifications with a full stack of block information and on updating a previously sent notification by changing the block status. The implemented endpoints shall be able to process the defined request body and respond with the HTTP status codes and - if required - reply with the defined response body. Meanwhile, the Block Notification API shall only be accessible after successful contract negotiation via Connector based on [Dataspace Protocol (DSP)](https://docs.internationaldataspaces.org/dataspace-protocol/), since the API is made available as part of an EDC data asset with usage policy attached. Please refer to the corresponding Block Notification API specification for more details: +- [Block Notification API (v1.0.0)](../openapi/block-notifications-1-0-0.yaml) + +> :raised_hand: For the current release, **version 1.0.0 is optional** and MUST be supported by every App provider from the next (major) release. The block notifications are not standardized yet, but will be released as a new optional functionality in the CX-0125 Traceability Use Case Standard as of the next release 25.03. ## Asset Registration via Connector Since the notification APIs are published towards the network using a data asset/contract definition in terms of the dataspace protocol (DSP), there are general guidelines defined for registering a notification receiving endpoint within a data asset. The traceability solutions are supposed to implement a similar data asset with the same structure and provisioning towards Catena-X. @@ -57,9 +83,11 @@ The notification endpoint providers must set properties `dct:type` and `cx-commo In general, during EDC asset creation, the notification API version needs to provided for `cx-common:version` as specified in OpenAPI documentation. For `dct:type` the following asset typizations should be used during implementation: - ReceiveQualityInvestigationNotification -- ReceiveQualityAlertNotification -- ReceiveQualityAlertNotification - UpdateQualityInvestigationNotification +- ReceiveQualityAlertNotification +- UpdateQualityAlertNotification +- ReceiveBlockNotification +- UpdateBlockNotification Please refer to the [Digital Twin KIT](../../../category/digital-twin-kit) for more details. @@ -99,8 +127,10 @@ Please refer to the [Digital Twin KIT](../../../category/digital-twin-kit) for m For general guidelines for policy creation, please refer to [Industry Core KIT](../../../category/industry-core-kit) and [Connector KIT](../../../category/connector-kit). It is possible to restrict visibility of data offer for notification API with access policy either for members of Catena-X (“Membership”) and one or several Data Consumers identified by a specific business partner number ("BusinessPartnerNumber"). As for usage policy, participants and related services must restrict the data usage for notification endpoints by using the following policy rules: -- Use Case Framework (“FrameworkAgreement”) – The official agreement is published on [Catena-X website](https://catena-x.net/en/catena-x-introduce-implement/governance-framework-for-data-space-operations) -- at least one use case purpose (“UsagePurpose”) from the [ODRL policy repository](https://github.com/catenax-eV/cx-odrl-profile). +- Data Exchange Governance (leftOperand: “FrameworkAgreement”) – The official "Data Exchange Governance" is published on [Catena-X website](https://catena-x.net/en/catena-x-introduce-implement/governance-framework-for-data-space-operations) +- at least one use case purpose (“UsagePurpose”) from the [ODRL policy repository](https://github.com/catenax-eV/cx-odrl-profile) + - for quality notifications, the corresponding usage policy MUST be used (leftOperand: “qualityNotifications”) + - for block notifications, the same usage policy as quality notifications MUST be used (leftOperand: “qualityNotifications”) Additionally, respective usage policies MAY include the following policy rule: - Reference Contract (“ContractReference”). @@ -129,7 +159,7 @@ Additionally, respective usage policies MAY include the following policy rule: { "leftOperand": "cx-policy:FrameworkAgreement", "operator": "eq", - "rightOperand": "Traceability:1.0" + "rightOperand": "DataExchangeGovernance:1.0" }, { "leftOperand": "cx-policy:UsagePurpose", diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/Software Development View/page_data-provider_software-development-view.mdx b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/Software Development View/page_data-provider_software-development-view.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/Software Development View/page_data-provider_software-development-view.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/Software Development View/page_data-provider_software-development-view.mdx diff --git a/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/Software Development View/part_aspect-models.mdx b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/Software Development View/part_aspect-models.mdx new file mode 100644 index 00000000000..cd60fc7f943 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/Software Development View/part_aspect-models.mdx @@ -0,0 +1,254 @@ +--- +sidebar_class_name: hidden +--- + + + +import AspectModelOverview from './../../Industry Core Kit/Software Development View/part_aspect-model-overview.mdx' + +Aspect models are mostly easy to create by transforming a company's internal data into the target aspect model. Transformations are mostly straightforward in these cases. If necessary, special steps in creating aspect models are mentioned in the corresponding sections. + + + + +The following section shows an overview of all aspect models of the Traceability Use Case that can be attached to part instance twins. + +| Digital Twin Type | Aspect Model | Mandatory Version | Optional Versions | KIT | Standard | +| :-- | :-- | :-- | :-- | :-- | :-- | +| PartInstance | TractionBatteryCode | 2.0.0 | | Traceability | CX-0125 Traceability Use Case v2.0.0 | +| | SoftwareInformation | 1.0.0 | | Traceability | N/A | +| | CertificateSigningRequests | 1.0.0 | | Traceability | N/A | +| | SpecialCharacteristics | 1.0.0 | | Traceability | N/A | + +### TractionBatteryCode + +The aspect provides the information of the Traction battery code of a battery cell, a battery module or a battery pack according to the chinese standard GB/T 34014-2017. Furthermore, it provides the traction battery codes for the assembled sub parts of the component, e.g. Traction battery code of a battery module plus all the traction battery codes of the assembled battery cells of this battery module. + +Aspect model in GitHub: +- Version 1.0.0: https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.traction_battery_code/1.0.0 + +##### Example: Submodel `TractionBatteryCode` for a Battery Cell + +```json +{ + "productType": "cell", + "tractionBatteryCode": "X12CCPM27KLPCLE662382320" +} +``` + +##### Example: Submodel `TractionBatteryCode` for a Battery Module + +```json +{ + "productType": "module", + "tractionBatteryCode": "B54MCPM27KLPCLE6A7519857", + "subcomponents": [ + { + "productType": "cell", + "tractionBatteryCode": "X12CCPM27KLPCLE662382320" + }, + { + "productType": "cell", + "tractionBatteryCode": "X12CCPM27KLPCLE662382321" + } + ] +} +``` + +##### Example: Submodel `TractionBatteryCode` for a Battery Pack + +```json +{ + "productType": "pack", + "tractionBatteryCode": "4A6PCPM27KLPCLE742946319", + "subcomponents": [ + { + "productType": "module", + "tractionBatteryCode": "B54MCPM27KLPCLE6A7519857", + "subcomponents": [ + { + "productType": "cell", + "tractionBatteryCode": "X12CCPM27KLPCLE662382320" + }, + { + "productType": "cell", + "tractionBatteryCode": "X12CCPM27KLPCLE662382321" + } + ] + }, + { + "productType": "module", + "tractionBatteryCode": "B54MCPM27KLPCLE6A7519858", + "subcomponents": [ + { + "productType": "cell", + "tractionBatteryCode": "X12CCPM27KLPCLE662382322" + }, + { + "productType": "cell", + "tractionBatteryCode": "X12CCPM27KLPCLE662382323" + } + ] + } + ] +} +``` + +### SoftwareInformation +The software information aspect model contains the essential information of all software components that have been implemented or flashed in an instantiated part (e.g. serialized part). + +Aspect model in GitHub: +- Version 1.0.0: https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.software_information/1.0.0 + +##### Example: Submodel `SoftwareInformation` +```json +{ + "catenaXId": "urn:uuid:454ffa8e-f88d-4ad1-be45-06981756aeb1", + "softwareInformation": [ + { + "name": "ECU Software XY12345", + "softwareId": "SW123456789", + "version": "1.2.0", + "lastModifiedOn": "2023-03-21T08:17:29.187+01:00" + }, + { + "name": "Controller-SW", +   "softwareId": "SW987654321", + "version": "3.0.0", + "lastModifiedOn": "2024-04-30T08:17:29.187+01:00" + } + ] +} +``` + +### CertificateSigningRequests +The Certificate Signing Requests aspect model contains the essential information needed to request specific certificates for a unique ECU component via a Certificate Signing Request (CSR) and to validate and certificate the ECU against this data. + +A CSR (Certificate Signing Request) is a 64-based PEM formatted and encrypted message to request a (digital) certificate. The CSR validates the information required by a specific certification authority (CA) to issue the associated certificate. + +Aspect model in GitHub: +- Version 1.0.0: https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.certificate_signing_requests/1.0.0 + +##### Example: Submodel `CertificateSigningRequests` +```json +{ + "certificateSigningRequestList": [ + { + "certificateSigningRequest": "MIIC2TCCAToCAQAwgZwxEzARBgNVBAgTClByb2R1Y3Rpb24xDDAKBgNVBAcMA0FUTTESMBAGA1UEChMJQk1XIEdyb3VwMRcwFQYDVQQLEw5WZWhpY2xlUEtJLUVDVTEXMBUGA1UEAxMOSVBzZWMtaW50ZXJuYWwxMTAvBgNVBAUTKEVDVS1VSUQ6QzAwMDgyNDI3MUREQTYwMDAwMDAwMDAwMjdBQTg0MjQwdjAQBgcqhkjOPQIBBgUrgQQAIgNiAAShNm4y5Mdzu4b9xDW3TfBZr", + "subjectLocality": "ATM--02", + "subjectCommonName": "ID", + "subjectSerialNumber": "SN12345678" + }, + { + "certificateSigningRequest": "MII3tbCCAToCAQAwgZwxEzARBgNVBAgTClByb2R1Y3Rpb24xDDAKBgNVBAcMA0FUTTESMBAGA1UEChMJQk1XIEdyb3VwMRcwFQYDVQQLEw5WZWhpY2xlUEtJLUVDVTEXMBUGA1UEAxMOSVBzZWMtaW50ZXJuYWwxMTAvBgNVBAUTKEVDVS1VSUQ6QzAwMDgyNDI3MUREQTYwMDAwMDAwMDAwMjdBQTg0MjQwdjAQBgcqhkjOPQIBBgUrgQQAIgNiAAShNm4y5Mdzu4b9xDW3TfBZr", + "subjectLocality": "ATM--02", + "subjectCommonName": "IPsec-Internal", + "subjectSerialNumber": "SN12345678" + } + ] +} +``` + +### SpecialCharacteristicMeasurement +Special Characteristics are measureable and these measurements are of interest for a consumer who defined these characteristics. The proposal is a data model "result" which represents a measurement related to a specific measurement and product. A measurement result is identified by the identification of a characteristic and the product. + +Aspect model in GitHub: +- Version 1.0.0: https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.special_characteristics.measurement/1.0.0 + +#### Example: Submodel `SpecialCharacteristicMeasurement` + +```json +{ + "localIdentifiers": [ + { + "value": "SN12345678", + "key": "partInstanceId" + }, + { + "value": "SN12345678", + "key": "manufactuererId" + } + ], + "customerPartId": "PRT-12345", + "revisionIndex": "01", + "measurementType": "simple", + "characteristicId": "S1", + "results": [ ] +} +``` +#### Recommended Pattern (Key Value Pair) +Due to the amount of different characteristics we opted not to require a specific format for the measurement objects contained in the **"results": [ ]** object list. We rather provide a set of format we recommend to use. These recommendations depend on the most common characteristics and their requirements for the results. + +##### Simple Measurements +We consider for characteristics a simple measurement if it just requires to measure a single value. For example the thickness of a rolled steel plate. We designed the measurement object to be able to represent any measurement where it is required to measure a value with a unit. + +**Data model** +| Attribute | Plausability | Type | Example | +| :-- | :-- | :-- | :-- | +| value | mandatory | string | -2.9426523E38 | +| unit | mandatory | string | -eOMtThyhVNLWUZNRcBaQKxI | +| measurementTimeStamp | mandatory | timestamp | 2024-10-01 | + +**Example: Submodel Simple Measurements** +```json +{ + "measurement" : { + "value" : -2.9426523E38, + "unit" : "eOMtThyhVNLWUZNRcBaQKxI" + }, + "measurementTimestamp" : "2024-10-01" +} +``` + +##### Qualitative Measurements +We consider a qualitative measurement a measurement where a value has to be extracted and a read Qualitity has to be determined. An example would be the serial number which has to be etched onto the product. The result of the etching has to be of a certain quality where this quality is measured by some metric. + +**Data model** +| Attribute | Plausability | Type | Example | +| :-- | :-- | :-- | :-- | +| extractedValue | mandatory | string | eOMtThyhVNLWUZNRcBaQKxI | +| readQuality | mandatory | string | 5 | +| measurementTimeStamp | mandatory | timestamp | 2024-10-01 | + +**Example: Submodel Qualitative Measurements** +```json +{ + "extractedValue" : "eOMtThyhVNLWUZNRcBaQKxI", + "readQuality" : 5, + "measurementTimestamp" : "2024-10-01" +} +``` + +##### Functional Measurements +Functional Measurements are for characteristics where the result just confirms that the function is at it is expected. + +**Data model** +| Attribute | Plausability | Type | Example | +| :-- | :-- | :-- | :-- | +| value | mandatory | boolean | true | +| measurementTimeStamp | mandatory | timestamp | 2024-10-01 | + +**Example** +```json +{ + "value" : true, + "measurementTimestamp" : "2024-10-01" +} +``` + diff --git a/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/architecture_level_1.svg b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/architecture_level_1.svg new file mode 100644 index 00000000000..da4412718ef --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/architecture_level_1.svg @@ -0,0 +1,4 @@ + + + +

          Catena-X Core Services
          «Catena-X Partner»
          Traceability at Another Catena-X Partner
          «Catena-X Partner»
          Traceability at Catena-X Partner
          Register Digital Twins 
          Lookup EDC adress
           
          for Catena-X partners
          «Component»
          Data Provisioning
          Fetch Data from Digital Twins 
          Optionally: Lookup Digital Twins
          «Component»
          Traceability App
          «Service»
          Eclipse Dataspace
          Connector
          (EDC)
          Internal Systems
          «Service»
          Eclipse Dataspace
          Connector
          (EDC)
          Optional: 

          «Service»
          Item Relationship Service
          (IRS)
          Internal Systems
          «Service»
          EDC Discovery
          «Service»
          Digital Twin Registry
          «Service»
          Digital Twin Registry
          DTR via EDC:
          Lookup Digital Twins for Catena-X Partners

          Register Quality Investigation & Alert Topics
          as EDC Assets

          Register Block Information as EDC Assets

          Receive and send
           Quality Investigation & Alert notifications

          Receive and send Block notifications

          Optionally: Fetch Data from Digital Twins 
          Lookup EDC adress
           
          for Catena-X partners
          DTR via EDC:
          Lookup Digital Twins for Catena-X Partners

          Register Submodels as EDC Assets

          Process requests for EDC Assets

          Register Unique ID Push Topics as EDC Assets

          Receive and send Unique ID Push notifications
           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/quality_notifications.png.license b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/architecture_level_1.svg.license similarity index 98% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/quality_notifications.png.license rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/architecture_level_1.svg.license index 725b4f88d99..7208212b02c 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/quality_notifications.png.license +++ b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/architecture_level_1.svg.license @@ -12,4 +12,4 @@ This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses - SPDX-FileCopyrightText: 2023 T-Systems International GmbH - SPDX-FileCopyrightText: 2023 ZF Friedrichshafen AG - SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation -- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Traceability%20Kit (latest version) \ No newline at end of file +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Traceability%20Kit (latest version) diff --git a/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/block-notification-state-model-interaction.svg b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/block-notification-state-model-interaction.svg new file mode 100644 index 00000000000..682dd0a849b --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/block-notification-state-model-interaction.svg @@ -0,0 +1,4 @@ + + + +
          Scenario 2 (Update)
          Block information of one or more parts 
          was sent by mistake. Therefore, the 
          block status of the previously sent parts 
          must be updated.

          Note: The CANCELED status can also 
          be updated by the recipient if it has 
          been determined that the part is faultless 
          and therefore does not need to be 
          sorted out. 
          Update Block Notification
          Scenario 1 (Default)
          Block information was sent for faulty 
          parts that needs to be sorted out.
          Scenario 1 (Update)
          Parts were blocked and therefore the 
          status was updated.
          Receiver


          Block Notifcation
          Data
          Data: all block information
          Status: VALID
          ID: 884267902
          VALID
          Data: all block information
          Status: VALID
          VALID
          ID: 864267903
          ID: 864287306


          Block Notifcation
          Data
          Data: all block information
          Status: VALID
          ID: 884267902
          VALID
          Data: all block information
          Status: VALID
          VALID
          ID: 864267903
          Data: all block information
          Status: VALID
          ID: 884267902
          VALID
          Data: all block information
          Status: VALID
          VALID
          ID: 864267903


          . . .
          Block Notifcation
          Data
          ID: 884267902
          ID: 864267903
          Block Notifcation
          Data
          Block Notifcation
          Data
          Block Notification
          Data
          Receive Block
          Notification
          Update Block 
          Notification
          ONLY status update
          BlockStatus: 
          PART_BLOCKED
          BlockStatus: 
          PART_BLOCKED
          Sender


          . . .
          Block Notifcation
          Data
          Data: all block information
          Status: VALID
          ID: 884267902
          VALID
          Data: all block information
          Status: VALID
          VALID
          ID: 864267903
          Data: all block information
          Status: VALID
          VALID
          ID: 864287306


          . . .
          Block Notifcation
          Data
          Data: all block information
          Status: VALID
          ID: 884267902
          VALID
          Data: all block information
          Status: VALID
          VALID
          ID: 864267903
          Data: all block information
          Status: VALID
          VALID
          ID: 864287306


          . . .
          Block Notifcation
          Data
          Data: all block information
          Status: VALID
          ID: 884267902
          VALID
          Data: all block information
          Status: VALID
          VALID
          ID: 864267903
          Data: all block information
          Status: VALID
          VALID
          ID: 864287306


          . . .
          Block Notifcation
          Data
          Data: block information
          BlockStatus: 
          ID: 884267902
          Data: block information
          ID: 864267903
          Data: block information
          ID: 864287306
          Block Notifcation
          Data
          Block Notifcation
          Data
          Block Notification
          Status Update
          ACTIVE
          BlockStatus: 
          ACTIVE
          BlockStatus: 
          ACTIVE
          Block Notifcation
          Data


          Block Notifcation
          Data


          Block Notifcation
          Data


          . . .
          Block Notification
          Status Update
          ID: 864287306
          ONLY status update
          BlockStatus: 
          CANCELED
           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/block-notification-state-model-interaction.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/block-notification-state-model-interaction.svg.license new file mode 100644 index 00000000000..ae4bfbd15fb --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/block-notification-state-model-interaction.svg.license @@ -0,0 +1,6 @@ +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Traceability%20Kit (latest version) diff --git a/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/block-notification-state-model.svg b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/block-notification-state-model.svg new file mode 100644 index 00000000000..a9b1bcc4e99 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/block-notification-state-model.svg @@ -0,0 +1,4 @@ + + + +
          ACTIVE
          CANCELED
          ONLY by 
          the Sender
          by the Sender OR
          the Receiver
          Legend
          Sender
          Receiver
          PART_BLOCKED
          ONLY by
          the Receiver
          X
          X
           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/block-notification-state-model.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/block-notification-state-model.svg.license new file mode 100644 index 00000000000..ae4bfbd15fb --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/block-notification-state-model.svg.license @@ -0,0 +1,6 @@ +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Traceability%20Kit (latest version) diff --git a/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/block_notifications.svg b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/block_notifications.svg new file mode 100644 index 00000000000..4c375ece037 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/block_notifications.svg @@ -0,0 +1,4 @@ + + + +
          B
          BLOCK INFORMATION - BOTTOM UP
          Tier-n
          Tier-2
          Tier-1
          OEM
          Field
          Localization and sorting out the affected parts in the production or logitics process based on stuctured data
          Identification of affected components, which should be blocked based on the current analysis
          NO action needed, if the defective parts were sorted out before installation
          X
          Z
          W
          c
          2
          a
          Identification of potential issues
          Identification of affected components with customer
          Identification of affected components with customer
          Analysis and containment of affected vehicles
          Countermeasures for affected vehicles
          PREVENTIVE QUALITY ALERTS - BOTTOM UP
          Tier-n
          Tier-2
          Tier-1
          OEM
          Field
          B
          x
          y
          z
          w
          b
          c
          A
          1
          2
          a
          b
          Y
          potential immediate measure 
           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/block_notifications.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/block_notifications.svg.license new file mode 100644 index 00000000000..ae4bfbd15fb --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/block_notifications.svg.license @@ -0,0 +1,6 @@ +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Traceability%20Kit (latest version) diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/data_provisioning_data_flow.png b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/data_provisioning_data_flow.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/data_provisioning_data_flow.png rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/data_provisioning_data_flow.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/data_provisioning_data_flow.png.license b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/data_provisioning_data_flow.png.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/data_provisioning_data_flow.png.license rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/data_provisioning_data_flow.png.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/notification-state-model.png b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/notification-state-model.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/notification-state-model.png rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/notification-state-model.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/notification-state-model.png.license b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/notification-state-model.png.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/notification-state-model.png.license rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/notification-state-model.png.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/notification-state-model.svg b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/notification-state-model.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/notification-state-model.svg rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/notification-state-model.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/notification-state-model.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/notification-state-model.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/notification-state-model.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/notification-state-model.svg.license diff --git a/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/quality_notifications.svg b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/quality_notifications.svg new file mode 100644 index 00000000000..c0d23cd0390 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/quality_notifications.svg @@ -0,0 +1,4 @@ + + + +
          Identification of potential issues
          Identification of affected components with customer
          Identification of affected components with customer
          Analysis and containment of affected vehicles
          Countermeasures for affected vehicles
          PREVENTIVE QUALITY ALERTS - BOTTOM UP
          Tier-n
          Tier-2
          Tier-1
          OEM
          Field
          B
          x
          y
          z
          w
          b
          c
          A
          1
          2
          a
          PREVENTIVE QUALITY INVESTIGATION - TOP DOWN
          Frequent error
          Analysis & containment of relevant components
          Identification & data exchange with supplier
          Cause analysis & countermeasures
          Tier-n
          Tier-2
          Tier-1
          OEM
          Field
          B
          X
          Y
          Z
          W
          b
          c
          A
          1
          2
          a
           \ No newline at end of file diff --git a/docs-kits/kits/Traceability Kit/assets/quality_notifications.png.license b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/quality_notifications.svg.license similarity index 100% rename from docs-kits/kits/Traceability Kit/assets/quality_notifications.png.license rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/quality_notifications.svg.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/traceability_customer-journey.png b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/traceability_customer-journey.png similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/traceability_customer-journey.png rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/traceability_customer-journey.png diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/traceability_customer-journey.png.license b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/traceability_customer-journey.png.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/traceability_customer-journey.png.license rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/traceability_customer-journey.png.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/traceability_sources.pptx b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/traceability_sources.pptx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/traceability_sources.pptx rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/traceability_sources.pptx diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/traceability_sources.pptx.license b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/traceability_sources.pptx.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/assets/traceability_sources.pptx.license rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/assets/traceability_sources.pptx.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/_category_.json b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/_category_.json similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/_category_.json rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/_category_.json diff --git a/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/block-notification-send-receive.svg b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/block-notification-send-receive.svg new file mode 100644 index 00000000000..6609f40dfb7 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/block-notification-send-receive.svg @@ -0,0 +1,4 @@ + + + +
          RECEIVER
          SENDER
          EDC
          Some (Traceability) App
          Identify affected Part(s) /
          Batch(es) who needs to be 
          blocked / sorted out
          Identify BPN for affected
          Part(s) / Batch(es)
          Create Notification
          Status:= CREATED
          [05]
          Create Block Status for each 
          affected Part(s) / Batch(es).
          Block Status:= ACTIVE
          Update Notification
          Status:= SENT
          Update Notification
          Status:= RECEIVED
          Notification 
          EDC Adapter
          Find and Select
          Contract
          EDC
          Some (Traceability) App
          Resolve EDC Endpoint
          OK
          Send Notification Update
          Fetch 
          Catalog
          Initiate Contract 
          Negotiation
          Contract 
          Negotiation
          Establish 
          Channel
          POST /public/...
          POST /public/...
          POST /notifications/
          blocknotification/receive
          BPN of supply chain partner (as given in existing notification)
          Find the correct contract offer with:

          "asset:Prop:notificationtype" : "blocknotification",
          "asset:prop:notificationmethod" : "receive"
          The http path depends on the DataAddress in the EDC Data Asset. Thus, it depends on the (Trace) app.
          201 OK
          Discovery
          Service
          Fetch 
          Catalog
          201 OK
          201 OK
          201 OK
          Some 
          (Traceability) App
          Notification 
          EDC Adapter
          EDC
          Discovery
          Service
          EDC
          Some 
          (Traceability) App
          OK
          [01]
          Create EDC Asset for 
          "ReceiveBlockNotification" 
          with DataAddress as HTTP 
          POST endpoint
          [02]
          [03]
          [04]
          [06]
          Not mandatory as the interaction with the EDC can be implemented also in an (traceabililty) app.

          However, a similar functionality (e.g. fetch catalog) - as shown below - must be provided.
          [07]
          [08]
          [09]
          Payload as described in the Block Notification API specification
          [10]
          [11]
          [12]
          [13]
          [13]
          [14]
          Initiate Data 
          Transfer
          [15]
          [16]
          [17]
          Payload as described in the Block Notification API specification
          [18]
          [19]
          Payload as described in the Block Notification API specification
          [20]
          [21]
          [22]
          [23]
          [24]
           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/block-notification-send-receive.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/block-notification-send-receive.svg.license new file mode 100644 index 00000000000..ae4bfbd15fb --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/block-notification-send-receive.svg.license @@ -0,0 +1,6 @@ +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Traceability%20Kit (latest version) diff --git a/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/block-notification-update-status.svg b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/block-notification-update-status.svg new file mode 100644 index 00000000000..1defb8e02ba --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/block-notification-update-status.svg @@ -0,0 +1,4 @@ + + + +
          RECEIVER
          SENDER
          EDC
          Some (Traceability) App
          Identify affected Part(s) /
          Batch(es) whose block status
          needs to be updated
          Identify BPN for affected
          Part(s) / Batch(es)
          Create Notification
          Status:= CREATED
          [05]
          Change Block Status of the 
          affected Part(s) / Batch(es) 
          that needs to be updated
          (according to the status model)
          Update Notification
          Status:= SENT
          Update Notification
          Status:= RECEIVED
          Notification 
          EDC Adapter
          Find and Select
          Contract
          EDC
          Some (Traceability) App
          Resolve EDC Endpoint
          OK
          Send Notification Update
          Fetch 
          Catalog
          Initiate Contract 
          Negotiation
          Contract 
          Negotiation
          Establish 
          Channel
          POST /public/...
          POST /public/...
          POST /notifications/
          blocknotification/update
          BPN of supply chain partner (as given in existing notification)
          Find the correct contract offer with:

          "asset:Prop:notificationtype" : "blocknotification",
          "asset:prop:notificationmethod" : "update"
          The http path depends on the DataAddress in the EDC Data Asset. Thus, it depends on the (Trace) app.
          201 OK
          Discovery
          Service
          Fetch 
          Catalog
          201 OK
          201 OK
          201 OK
          Some 
          (Traceability) App
          Notification 
          EDC Adapter
          EDC
          Discovery
          Service
          EDC
          Some 
          (Traceability) App
          Depending on whether the process for block parts was canceled or parts were actually blocked and sorted out, a different status is sent during an update.
          OK
          [01]
          Create EDC Asset for 
          "UpdateBlockNotification" 
          with DataAddress as HTTP 
          POST endpoint
          [02]
          [03]
          [04]
          [06]
          Not mandatory as the interaction with the EDC can be implemented also in an (traceabililty) app.

          However, a similar functionality (e.g. fetch catalog) - as shown below - must be provided.
          [07]
          [08]
          [09]
          Payload as described in the Block Notification API specification
          [10]
          [11]
          [12]
          [13]
          [13]
          [14]
          Initiate Data 
          Transfer
          [15]
          [16]
          [17]
          Payload as described in the Block Notification API specification
          [18]
          [19]
          Payload as described in the Block Notification API specification
          [20]
          [21]
          [22]
          [23]
          [24]
           \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/block-notification-update-status.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/block-notification-update-status.svg.license new file mode 100644 index 00000000000..ae4bfbd15fb --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/block-notification-update-status.svg.license @@ -0,0 +1,6 @@ +This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). + +- SPDX-License-Identifier: CC-BY-4.0 +- SPDX-FileCopyrightText: 2024 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/docs-kits/kits/Traceability%20Kit (latest version) diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/notifcation_send-receive.puml b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/notifcation_send-receive.puml similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/notifcation_send-receive.puml rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/notifcation_send-receive.puml diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/notification_send-receive-alert.puml b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/notification_send-receive-alert.puml similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/notification_send-receive-alert.puml rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/notification_send-receive-alert.puml diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/notification_send-receive-alert.svg b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/notification_send-receive-alert.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/notification_send-receive-alert.svg rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/notification_send-receive-alert.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/notification_send-receive-alert.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/notification_send-receive-alert.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/notification_send-receive-alert.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/notification_send-receive-alert.svg.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/notification_send-receive.svg b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/notification_send-receive.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/notification_send-receive.svg rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/notification_send-receive.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/notification_send-receive.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/notification_send-receive.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/notification_send-receive.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/notification_send-receive.svg.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/notification_update-alert.puml b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/notification_update-alert.puml similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/notification_update-alert.puml rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/notification_update-alert.puml diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/notification_update-alert.svg b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/notification_update-alert.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/notification_update-alert.svg rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/notification_update-alert.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/notification_update-alert.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/notification_update-alert.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/notification_update-alert.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/notification_update-alert.svg.license diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/notification_update-investigation.puml b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/notification_update-investigation.puml similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/notification_update-investigation.puml rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/notification_update-investigation.puml diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/notification_update-investigation.svg b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/notification_update-investigation.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/notification_update-investigation.svg rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/notification_update-investigation.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/notification_update-investigation.svg.license b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/notification_update-investigation.svg.license similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/diagrams/notification_update-investigation.svg.license rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/diagrams/notification_update-investigation.svg.license diff --git a/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/openapi/block-notifications-1-0-0.yaml b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/openapi/block-notifications-1-0-0.yaml new file mode 100644 index 00000000000..2690c3b7daa --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/openapi/block-notifications-1-0-0.yaml @@ -0,0 +1,602 @@ +openapi: '3.0.3' +info: + title: Block Notification API + version: '1.0.0' + description: "The blocking process is a process in the automotive industry to segregate or quarantine nonconforming parts in the supply chain to prevent using them in the production process. Therefore, the supplier must send all relevant information to the customer, so that he is able to identify the affected parts for example at the assembly line or in logistics. \n\n This API is to be used to transfer this information in a standardized manner and to trace the individual parts back to see whether they have been blocked and sorted out on the customer side in order to prevent subsequent damage or major product recalls. In addition, the notification is intended to improve the quality and speed of the block information provided." + license: + name: Apache License v2.0 + url: https://www.apache.org/licenses/LICENSE-2.0 + +servers: +- url: https://example.com/api/v1 + variables: + api-version: + default: '1.0.0' + +paths: + + # Path to send and receive block notifications + /block-notification/receive: + post: + tags: + - Block Notification + requestBody: + $ref: '#/components/requestBodies/BlockNotificationReceive' + responses: + "201": + $ref: '#/components/responses/Successful' + "400": + $ref: '#/components/responses/Malformed' + "401": + $ref: '#/components/responses/Unauthorized' + "403": + $ref: '#/components/responses/Forbidden' + "404": + $ref: '#/components/responses/NotFoundError' + "405": + $ref: '#/components/responses/Duplication' + "422": + $ref: '#/components/responses/SemanticError' + + # Path to send and receive a status update of a existing block notifications + /block-notification/update: + post: + tags: + - Block Notification + requestBody: + $ref: '#/components/requestBodies/BlockNotificationUpdate' + responses: + "201": + $ref: '#/components/responses/Successful' + "400": + $ref: '#/components/responses/Malformed' + "401": + $ref: '#/components/responses/Unauthorized' + "403": + $ref: '#/components/responses/Forbidden' + "404": + $ref: '#/components/responses/NotFoundError' + "405": + $ref: '#/components/responses/Duplication' + "422": + $ref: '#/components/responses/SemanticError' + +components: + + # Schemas to build up the request body and the reponses + schemas: + BlockNotificationReceive: + type: object + description: "Request schema to send block notifications." + properties: + header: + $ref: '#/components/schemas/urn_samm_io.catenax.shared.message_header_3.0.0_HeaderCharacteristic' + content: + $ref: '#/components/schemas/NotificationContentReceive' + required: + - header + - content + + BlockNotificationUpdate: + type: object + description: "Request body schema to send a status update for an existing block notification." + properties: + header: + $ref: '#/components/schemas/urn_samm_io.catenax.shared.message_header_3.0.0_HeaderCharacteristic' + content: + $ref: '#/components/schemas/NotificationContentUpdate' + required: + - header + - content + + # Schemas to build up the header + 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: + $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 + + urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait: + type: string + description: "The fully anonymous Catena-X ID of the serialized part or\ + \ batch, valid for the Catena-X dataspace. \n\nThe 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: |- + 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. + example: 'Traceability-BlockNotification:1.0.0' + + 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. + example: '2024-10-07T10:15+00:00' + + 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-]+)*)?$" + example: '3.0.0' + + # Schemas to build up the content (default notification) + urn_samm_io.catenax.block_notification_receive_1.0.0_PartBlockingInformationSet: + description: The characteristic of the part blocking information defined as + an Array Set. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_PartBlockingInformationEntity' + uniqueItems: true + + urn_samm_io.catenax.block_notification_data_1.0.0_PartBlockingInformationEntity: + description: The entitiy of the part blocking information Array Set. + type: object + properties: + catenaXId: + description: "The fully anonymous Catena-X ID of the serialized part or\ + \ batch, valid for the Catena-X dataspace." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait' + blockStatus: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_1.0.0_BlockStatus' + componentLevelContainment: + description: Section with blocking information at component level. + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_ComponentLevelContainmentCharacteristic' + periodAndVolumeLevelContainment: + description: Section with blocking information at period and volume level. + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_PeriodAndVolumeLevelContainmentCharacteristic' + locationInTheContainer: + description: 'Object which contain information regarding the locality of + the part within a small load carrier. ' + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_LocationInTheContainerCharacteristic' + required: + - catenaXId + - blockStatus + - componentLevelContainment + - periodAndVolumeLevelContainment + + urn_samm_io.catenax.block_notification_1.0.0_BlockStatus: + type: string + description: "Child-element of the partBlockingInformation array.\n\nProvides\ + \ information about the status of the individual part within a blocking\ + \ notification that must be blocked for security reasons. \n\nACTIVE means\ + \ that the part has been identified as a damaged and safety-critical part\ + \ and must therefore be blocked on the customer side.\n\nPART_BLOCKED\ + \ Status when the receiver has accepted the block and has actually blocked\ + \ the part (Note: sender must be informed!).\n\nCANCELED serves as the\ + \ update status of the component originally identified to be blocked if\ + \ the manufacturer subsequently determines that the original part does\ + \ meet safety requirements, is not damaged or that the information was\ + \ sent by mistake. " + enum: + - ACTIVE + - PART_BLOCKED + - CANCELED + + urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaCharacteristic: + type: string + description: "Identifies the respective address of the supplier's location + from which the corresponding components are delivered. \n\n The provided regular expression ensures that the BPNA is composed\ + \ of prefix 'BPNA', 10 digits and two alphanumeric letters." + pattern: "^BPNA[a-zA-Z0-9]{12}$" + + urn_samm_io.catenax.block_notification_data_1.0.0_IntegrationLevelCharacteristic: + type: string + description: "(E/E component generation (hardware and software) with defined\ + \ functional content and coordinated system communication) [Vehicle electrics/electronics]\t" + example: 'S18A-19-03-400' + + urn_samm_io.catenax.serial_part_3.0.0_PartIdCharacteristic: + type: string + description: |- + An ID that consists of two different pieces of information but at least always contains a part number: + + Part Number + identifier of a particular part design (or material used) which unambiguously identifies a part design within a single corporation, sometimes across several corporations + + Change Index (optional) + The change index corresponds to the identification of a version of a technical object (also in the technical drawing). + This provides easy-to-understand version management, which allows older variants to be clearly addressed. The first version usually has an index of 0. When changes are made, this is usually increased by 1. The current edition therefore has the highest change index. Alternatively, it is possible to represent the index in ascending order with letters, i.e. A, B, C,... Z, AA, AB, etc. + example: '884267902' + + urn_samm_io.catenax.serial_part_3.0.0_KeyTrait: + type: string + description: Constraint that ensures that the standard keys and custom key prefixes + can be used. + pattern: ^(manufacturerId|partInstanceId|batchId|van|customKey:\w+)$ + + urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic: + type: string + description: The value of an identifier. + + urn_samm_io.catenax.serial_part_3.0.0_KeyValueList: + description: "A list of key value pairs for local identifiers, which are composed\ + \ of a key and a corresponding value." + type: object + properties: + key: + description: 'The key of a local identifier. ' + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyTrait' + value: + description: The value of an identifier. + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_ValueCharacteristic' + required: + - key + - value + + urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic: + description: "A local identifier enables identification of a part in a specific\ + \ dataspace, but is not unique in Catena-X dataspace. Multiple local identifiers\ + \ may exist. \n\n A single serialized part may have multiple attributes, that uniquely\ + \ identify a that part in a specific dataspace (e.g. the manufacturer`s dataspace)" + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_KeyValueList' + uniqueItems: true + example: + - key: 'manufacturerId' + value: 'BPNL0123456789ZZ' + - key: 'partInstanceId' + value: 'SN12345678' + - key: 'customKey:ecuSerialNumber' + value: '220115001384267902201978150063581180' + + urn_samm_io.catenax.block_notification_data_1.0.0_ComponentLevelContainmentCharacteristic: + description: 'The characteristic of the component level containment defined + as a Object. ' + type: object + properties: + manufacturingLocationId: + $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_2.0.0_BpnaCharacteristic' + integrationLevel: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_IntegrationLevelCharacteristic' + customerPartId: + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_PartIdCharacteristic' + localIdentifiers: + $ref: '#/components/schemas/urn_samm_io.catenax.serial_part_3.0.0_LocalIdentifierCharacteristic' + required: + - manufacturingLocationId + - customerPartId + - localIdentifiers + + 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.shared.quantity_2.0.0_QuantityValueCharacteristic: + type: number + description: The quantity value associated with the unit expressed as float. + example: 20.0 + + urn_samm_io.catenax.block_notification_data_1.0.0_QuantityCharacteristic: + description: 'The characteristic to define the quantity an value of a property. ' + type: object + properties: + itemUnit: + description: "The unit of an item. Common units may be related to mass,\ + \ count, linear, area, volume or misc." + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_ItemUnitEnumeration' + quantityValue: + description: The quantity value associated with the unit. + $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_2.0.0_QuantityValueCharacteristic' + required: + - itemUnit + - quantityValue + + urn_samm_io.catenax.block_notification_data_1.0.0_DeliveryPlaceCharacteristic: + type: string + description: "The identification number of the unloading point. An unloading\ + \ point is an important part of logistics, as it describes the location\ + \ where goods can be loaded or unloaded using a means of transport. In\ + \ addition to the address itself, the spatial conditions at the unloading\ + \ point are also important. Each warehouse has its own type of unloading\ + \ point, such as a ramp that is specifically designed for loading and\ + \ unloading goods. These specific conditions are crucial for the efficient\ + \ and secure processing of deliveries.\t" + example: '22610' + + urn_samm_io.catenax.block_notification_data_1.0.0_DeliveryNoteNumberCharacteristic: + type: string + description: "The number of the delivery note that accompanies the delivery\ + \ and shows the description, unit and quantity of goods included in the\ + \ delivery, etc..\t" + example: '68988545' + + urn_samm_io.catenax.block_notification_data_1.0.0_PackageNumberCharacteristic: + type: string + description: "Identififcation number of the package, the unit of goods and\ + \ packaging material. These can be boxes, pallets, mesh boxes, roll containers\ + \ and other loading equipment." + example: '12295140916130' + + urn_samm_io.catenax.block_notification_data_1.0.0_OrderNumberCharacteristic: + type: string + description: The order number (only for production synchronization requests + (JIS)) + example: '7334663' + + urn_samm_io.catenax.block_notification_data_1.0.0_PeriodAndVolumeLevelContainmentCharacteristic: + description: 'The characteristic of the period and volume level containment + defined as Object. ' + type: object + properties: + sizeOfProductionLot: + description: "A production lot is the combined number of products or manufactured\ + \ parts that are produced in a work process without interruption. There\ + \ is no need to convert production facilities. \t" + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_QuantityCharacteristic' + deliveryNoteNumber: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_DeliveryNoteNumberCharacteristic' + packageNumber: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_PackageNumberCharacteristic' + deliveryPlace: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_DeliveryPlaceCharacteristic' + deliveryDate: + description: "The date, on which the supplier handed over the shipment \ + \ to the carrier. Shiiping date of the manufacturer." + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + numberOfPartsPerDeliveryNote: + description: The quanity of delivered parts per delivery note. + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_QuantityCharacteristic' + productionDate: + $ref: '#/components/schemas/urn_samm_org.eclipse.esmf.samm_characteristic_2.1.0_Timestamp' + numberOfPartsPerPackage: + description: Number of parts, which are stored in a package. + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_QuantityCharacteristic' + orderNumber: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_OrderNumberCharacteristic' + required: + - sizeOfProductionLot + - deliveryNoteNumber + - packageNumber + - deliveryPlace + - deliveryDate + - numberOfPartsPerDeliveryNote + - productionDate + - numberOfPartsPerPackage + + urn_samm_io.catenax.block_notification_data_1.0.0_XPositionCharacteristic: + type: string + description: "Position along the X coordinate where the faulty component\ + \ (cell) is located within the small charge carrier.\t" + example: 'F' + + urn_samm_io.catenax.block_notification_data_1.0.0_YPositionCharacteristic: + type: string + description: Position along the Y coordinate where the faulty component + (cell) is located within the small charge carrier. + example: '10' + + urn_samm_io.catenax.block_notification_data_1.0.0_SmallLoadCarrierLayerCharacteristic: + type: string + description: |- + The layer within the small load carrier in which the faulty part is located. + (Ideally if available: UCID = Unique Container ID - ID of the small load carrier in which the faulty part is located) + Packaging specific for high-voltage battery cells. Other components (e.g. penthouse are not packaged in small load carriers). + example: '53BUN6555599345283155+000000008' + + urn_samm_io.catenax.block_notification_data_1.0.0_LocationInTheContainerCharacteristic: + description: The characteristic to define the location in the container defined + as entity. + type: object + properties: + xPosition: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_XPositionCharacteristic' + yPosition: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_YPositionCharacteristic' + smallLoadCarrierLayer: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_data_1.0.0_SmallLoadCarrierLayerCharacteristic' + + # Schemas to build up the content (status udpate notification) + urn_samm_io.catenax.block_notification_status_update_1.0.0_PartBlockingInformationSet: + description: The characteristic of the part blocking information defined as + an Array Set. + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_status_update_1.0.0_PartBlockingInformationEntity' + uniqueItems: true + example: + - catenaXId: '580d3adf-1981-44a0-a214-13d6ceed9379' + blockStatus: 'PART_BLOCKED' + - catenaXId: '6a3cA7E1-1682-5F25-FE1d-cF112433C2f4' + blockStatus: 'PART_BLOCKED' + - catenaXId: '550d3swf-1845-55sw-a2s8-13d6ceed4265' + blockStatus: 'PART_BLOCKED' + + urn_samm_io.catenax.block_notification_status_update_1.0.0_PartBlockingInformationEntity: + description: The entitiy of the part blocking information Array Set. + type: object + properties: + catenaXId: + $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_2.0.0_UuidV4Trait' + blockStatus: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_1.0.0_BlockStatus' + required: + - catenaXId + - blockStatus + + NotificationContentReceive: + type: object + properties: + notificationStatus: + $ref: '#/components/schemas/NotificationStatus' + problemDescription: + type: string + maxLength: 1000 + example: "Gear boxes lose oil while driving." + description: A free text field which provides information why the parts from the provided list must be blocked or sorted out. + blockInformations: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_receive_1.0.0_PartBlockingInformationSet' + required: + - notificationStatus + - blockInformations + + NotificationContentUpdate: + type: object + properties: + notificationStatus: + $ref: '#/components/schemas/NotificationStatus' + updateReason: + type: string + maxLength: 1000 + example: "Defect gear boxes were sorted out to prevent major damage." + description: A free text field that informs why a previously provided list of damaged parts needs to be updated. For example, because the order to block the parts must be canceled due to a user error or because the damaged parts were sorted out by the customer and thus blocked. + blockInformations: + $ref: '#/components/schemas/urn_samm_io.catenax.block_notification_status_update_1.0.0_PartBlockingInformationSet' + required: + - notificationStatus + - blockInformations + + NotificationStatus: + type: string + enum: + - CREATED + - SENT + - RECEIVED + - ACKNOWLEDGED + - CLOSED + example: 'SENT' + description: The status of the block notification. The following entries are supported and allowed + + - CREATED + This status is an internal status and is used after the initial creation of a notification. It is not communicated to an other CX/business partner. + + - SENT + This status means that the notification has been sent out. This status is shown on the sender side (and not on the receiver side). + + - RECEIVED + This status means that the notification has been received by the receiver. The status is shown on sender and receiver side. It is not communicated to another CX/business partner. + + - ACKNOWLEDGED + Defines that a user has confirmed that the notification has been received. + + - CLOSED + This status is set by the initiator of the notification either to regularly close the notification (i.e., after the receiver has set the status to ACKNOWLEDGED). + + # Response Content + responses: + Successful: + description: Block notification was sent successfully. + Malformed: + description: Request body was malformed. + Unauthorized: + description: The requesting user or client is not authenticated. + Forbidden: + description: The requesting user or client is not authorized to access.resources. + NotFoundError: + description: Method not allowed. + Duplication: + description: Could not accept the sent block notification, because a block notification with that same notification ID already exists. + SemanticError: + description: Could not accept the sent block notification even though it is syntactically correct. The block notification is not accepted, because of semantic reasons (e.g., an affected item is not known by the receiver). + + # Request Body Content + requestBodies: + BlockNotificationReceive: + content: + application/json: + schema: + $ref: '#/components/schemas/BlockNotificationReceive' + BlockNotificationUpdate: + content: + application/json: + schema: + $ref: '#/components/schemas/BlockNotificationUpdate' diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/openapi/notifications_1-2-1.yaml b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/openapi/notifications_1-2-1.yaml similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/openapi/notifications_1-2-1.yaml rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/openapi/notifications_1-2-1.yaml diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/openapi/notifications_2-0-0.yaml b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/openapi/notifications_2-0-0.yaml similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/openapi/notifications_2-0-0.yaml rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/openapi/notifications_2-0-0.yaml diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/page_architecture-view.mdx b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/page_architecture-view.mdx similarity index 70% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/page_architecture-view.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/page_architecture-view.mdx index dac73dac88e..87e63bb698f 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/page_architecture-view.mdx +++ b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/page_architecture-view.mdx @@ -51,14 +51,14 @@ This KIT describes two core capabilties of Traceability: This overview shows the two core capabilities of Traceabilty and the Catena-X Core Services onto which Traceability is built and which are required by the Traceability architecture. -![Architecture - Level 1](./assets/architecture_level_1.png) +![Architecture - Level 1](./assets/architecture_level_1.svg) ### Traceability Components | Subsystem | Description | |:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Data Provisioning | This component extracts data from a company's internal systems, transforms it into digital twins, and publishes these digital twins in the DTR and their data in the EDC (as submodels, based on aspect models). The published data is used by Traceability apps as well as other use cases that require Traceabiilty data. | -| Traceability App | A Traceability app has two core functionalities:
          • providing an UI to show the parts manufactured by a company and published as digital twins
          • create and process quality alerts and quality investigations for quality actions
          | +| Traceability App | A Traceability app has three core functionalities:
          • providing an UI to show the parts manufactured by a company and published as digital twins
          • create and process quality alerts and quality investigations for quality actions
          • create and transfer block information in real time to separate or quarantine faulty parts in the supply chain to prevent them from being used in the production process (currently optional app feature)
          | | Internal Systems | These are existing internal systems of a Catena-X partner which provides data to Traceability components, e.g.,
          • for data provisioning: The data provided to Catena-X is fetched from a partner's internal PLM and parts master data systems.
          • for Traceability apps: A Traceability app may show more data to a user than just the data that is provided to Catena-X. Generally, the business scope of COTS software is bigger than just Traceability and they have existing interfaces to fetch all data they need for their business functionality (and not only Traceability data).
          Both components can also send data back to internal systems. That's at the discretion of the Catena-X partner and neither required nor prohibited by the Traceability use case. | ### Catena-X Core Services @@ -85,13 +85,16 @@ The following diagram shows a basic data processing flow how a company's interna Data provisioning of Traceabilty is built on the data provisioning of the [Industry Core KIT](../Industry%20Core%20Kit/Architecture%20View%20Industry%20Core%20Kit), i.e., Traceability extends the digital twins PartType and PartInstance with additional aspect models: - Digital Twin "PartType" - + - N/A - Digital Twin "PartInstance" - - Aspect model ["TractionBatteryCode"](../Traceability%20Kit/Software%20Development%20View/Data%20Provider%20Development%20View%20Traceability%20Kit#tractionbatterycode) - + - Aspect model ["TractionBatteryCode"](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Software%20Development%20View/Data%20Provider%20Development%20View%20Traceability%20Kit#tractionbatterycode) + - Aspect model ["SoftwareInformation"](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Software%20Development%20View/Data%20Provider%20Development%20View%20Traceability%20Kit#softwareinformation) + - Aspect model ["CertificateSigningRequests"](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Software%20Development%20View/Data%20Provider%20Development%20View%20Traceability%20Kit#certificatesigningrequests) Details about these aspect models, i.e., the SAMM data model as well as example data, can be found in the [Developer View](../Traceability%20Kit/Software%20Development%20View/Data%20Provider%20Development%20View%20Traceability%20Kit). +> :raised_hand: Beware that the aspect models **_SoftwareInformation_** and **_CertificateSigningRequests_** are not standardized yet, but MAY be released as standardized aspect models in future releases of the CX-0125 Traceability Use Case Standard. + ### Policies To enable data sovereignty, access and usage policies are important to protect the data assets of a data provider in the EDC, described in the following. Further details are described in the [CX - 0018 Sovereign Data Exchange](#standards) standard. @@ -119,7 +122,8 @@ This capability defines what mandatory features a Traceability app must provide | Data Sharing via [CX-0018](#standards) compliant connector | Yes | The data sharing with other Catena-X partners (for Traceability partners, these are their customers and suppliers mostly) must be done via via a [CX-0018](#standards) compliant connector (e.g. EDC). | | Data Sovereignty | Yes | The usage of data in the Traceability app is compliant with the Access and Usage Policies as defined in this KIT. | Quality Alerts | Yes | In the event of an incident the partner's value chain, the partner would like to be informed promptly and in a structured manner by the triggering partners (e.g., manufacturing problem, field problems) so that the partner can respond as quickly as possible (Supplier/Customer). In the same way, the partner wants to inform their value chain partners easily and specifically in the event of relevant incidents. The traceability apps are able to exchange the alerts in the same interoperable way. | -| Quality Investigations | Yes | For a given incident in a partner's supply chain, the partner would like to be able to narrow down the affected products as sharply as possible in order to carry out suitable actions in a targeted manner. The partners in the value chain use interoperable Traceability apps for this purpose.| +| Quality Investigations | Yes | For a given incident in a partner's supply chain, the partner would like to be able to narrow down the affected products as sharply as possible in order to carry out suitable actions in a targeted manner. The partners in the value chain use interoperable Traceability apps for this purpose.| +| Block Information | No | The blocking process is a event where faulty parts in the supply chain are separated or quarantined to prevent them from being used in the production process. Due to the criticality, this part-specific information must be forwarded to the affected manufacturers as quickly as possible so that they can react immediately to sorting out the corresponding components. To overcome this challenge, this information is provided and transmitted via a standardized API.| ### Non-Functional Requirements @@ -137,29 +141,59 @@ The notification itself has various states. The states and their cycle are descr ![Notification State Model](./assets/notification-state-model.svg) -## Runtime View +### Block Information + +The blocking process is a process in the automotive industry to segregate or quarantine nonconforming parts in the supply chain to prevent using them in the production process. Therefore, the supplier must send all relevant information to the customer, so that he is able to identify the affected parts for example at the assembly line or in logistics. + +Catena-X is to be used to transfer this information in a standardized manner and to trace the individual parts back to see whether they have been blocked and sorted out on the customer side in order to prevent subsequent damage or major product recalls. In addition, the notification is intended to improve the quality and speed of the block information provided. + +#### Block Notification Interaction + +The interaction of block notifications is based on events that can be triggered by both the sender and the recipient. These events are represented by a status model and are used to track the progress of the parts that need to be blocked or respectively sorted out by the customer. Details about these status model and the Open API specification for Block Notifications are available in the [Developer View](../Traceability%20Kit/Software%20Development%20View/Data%20Provider%20Development%20View%20Traceability%20Kit). + +**Scenario 1:** In this case, it is assumed that the sender sends a list of parts with the associated block information to the recipient. The block status of each part is set to ACTIVE by default. + +When all block information has been received by the recipient, checked internally, further processed and finally all affected parts were blocked or sorted out, this information is sent back to the sender through a status update (PART_BLOCKED). + +> :raised_hand: Note that the update notification whether one or more parts have been blocked and therefore sorted out by the customer is **not mandatory**. The decision to provide suppliers with this information through a feedback notification **MUST** have been negotiated and accepted by both business partners before implemented. + +**Scenario 2:** +In this case, the sender identified that the block information sent from Scenario 1 was sent incorrectly or unintentionally. + +In order to inform the recipient of this error, the block status of the affected parts is set to CANCELED via an update notification, so that these parts cannot be sorted out and used to be installed by the recipient. -### Processes for Sending, Updating and Resolving Notifications +> :raised_hand: The CANCELED status can also be updated by the recipient if it has been determined that the part(s) are faultless and therefore does not need to be sorted out. -Below the sequence for sending, updating and resolving of notifications between (traceability) applications is shown with UML sequence diagrams. In all cases, Http POST requests are used. Those Http endpoints are described in the section (TRS) Quality Notification Endpoints and EDC Contract Offerings. +![Block State Model Interaction](./assets/block-notification-state-model-interaction.svg) + +## Runtime View + +In the sub-sections below the sequence for sending, updating and resolving of notifications between (traceability) applications is shown with UML sequence diagrams. In all cases, Http POST requests are used. Those Http endpoints are described in the corresponding sections: +- [(TRS) Quality Notification Endpoints](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Software%20Development%20View/App%20Provider%20Development%20View%20Traceability%20Kit#quality-notifications) +- [Block Notification Endpoints](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Software%20Development%20View/App%20Provider%20Development%20View%20Traceability%20Kit#block-notifications) +- [EDC Contract Offerings](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Software%20Development%20View/App%20Provider%20Development%20View%20Traceability%20Kit#asset-registration-via-connector). To read the UML sequence diagrams correctly, some remarks: - The shown Notification EDC Adapter is not mandatory. It is just one option to send a notification via the EDC control and data plane. Important is that a similar functionality must be provided/implemented by the (traceability) application vendor. The Notification EDC Adapter or a similar component / functionality will not be provided as a central service from Catena-X. - To know where a notification must be send to, the (traceability) application must resolve the BPN of the receiver. This can either be happen because the (traceability) application has this information in its data model or it could - alternatively - also be resolved e.g. via a lookup of the digital twin in the central asset administration shell (AAS) registry. - :raised_hand: The (traceability) applications that fully rely on the AAS registry and the corresponding AAS submodels can only support quality investigations. With the release of the AAS submodel SingleLevelUsageAsBuilt or a similar AAS submodel that contains the information, which supply chain partner purchased/assembled a part / batch, it is possible to also support quality alerts for those (traceability) applications. (Warnung) - The resolution of the EDC URL for a given BPN is done via the Discovery Service API. The entry for each EDC into this Discovery Service is done via the CX Portal. - In each UML sequence diagram the step [01] describes the publishing of the notification endpoints as described in the above sections - Similarly, the Http POST request and response bodies are described in the above sections +### Processes for Sending, Updating and Resolving Quality Notifications + #### Sending and Receiving of a Quality Investigation Below, the UML sequence diagram to send and receive a quality investigation is depicted. In addition to the above mentioned general remarks, the following remark: +- The status transition from SENT to RECEIVED has to be done by the sender once it received the Http status code 201 from the receiver + ![NotificationSendReceive](./diagrams/notification_send-receive.svg) #### Sending and Receiving of a Quality Alert +> :raised_hand: The (traceability) applications that fully rely on the AAS registry and the corresponding AAS submodels can only support quality investigations. With the release of the AAS submodel SingleLevelUsageAsBuilt or a similar AAS submodel that contains the information, which supply chain partner purchased/assembled a part / batch, it is possible to also support quality alerts for those (traceability) applications. Below, the UML sequence diagram to send and receive a quality alert is depicted. In addition to the above mentioned general remarks, the following remark: @@ -167,7 +201,6 @@ Below, the UML sequence diagram to send and receive a quality alert is depicted. ![NotificationSendReceiveAlert](./diagrams/notification_send-receive-alert.svg) - #### Update of a Quality Investigation Below, the UML sequence diagram to update a quality investigation is depicted. @@ -175,19 +208,33 @@ Below, the UML sequence diagram to update a quality investigation is depicted. ![NotificationUpdateInvestigation](./diagrams/notification_update-investigation.svg) #### Update of a Quality Alert +> :raised_hand: The (traceability) applications that fully rely on the AAS registry and the corresponding AAS submodels can only support quality investigations. With the release of the AAS submodel SingleLevelUsageAsBuilt or a similar AAS submodel that contains the information, which supply chain partner purchased/assembled a part / batch, it is possible to also support quality alerts for those (traceability) applications. Below, the UML sequence diagram to update a quality alert is depicted. ![NotificationUpdateAlert](./diagrams/notification_update-alert.svg) +### Processes for Sending, Updating and Resolving Block Notifications + +#### Sending and Receiving of Block Information +Below, the UML sequence diagram to send and receive a block information is depicted. + +![BlockNotificationSendReceive](./diagrams/block-notification-send-receive.svg) + +#### Update of Block Information +Below, the UML sequence diagram to update a block information is depicted. +> :raised_hand: The process for sending update notifications regarding an ongoing blocking process must be carried out in the same way as sending block information for the first time. The differences are limited to the following changes: +> - Another data asset “BlockNotificationStatusUpdate” is used for the update +> - The data model of the notification is limited to the ID and block status of a part and therefore does not include full block informations +> - Both 'CANCELED' and 'PART_BLOCKED' can be set for the status depending on which case applies to the notification + +![BlockNotificationUpdateStatus](./diagrams/block-notification-update-status.svg) + ## Standards Our relevant standards can be downloaded from the official [Catena-X Standard Library](https://catena-x.net/de/standard-library): - Traceability is built on the Industry Core. Please check the relevant [standards of the Industry Core](../Industry%20Core%20Kit/Architecture%20View%20Industry%20Core%20Kit#standards). -- [CX - 0022 Notification Process 1.1.1](https://catena-x.net/de/standard-library) -- [CX - 0023 Notification API 1.2.2](https://catena-x.net/de/standard-library) -- [CX - 0062 Traceability Notification Triangle 1.0.0](https://catena-x.net/de/standard-library) -- [CX - 0093 Aspect Model Traction Battery Code 1.0.0](https://catena-x.net/de/standard-library) +- [CX - 0125 Traceability Use Case v2.0.0](https://catenax-ev.github.io/docs/next/standards/CX-0125-TraceabilityUseCase) diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/page_business_view.mdx b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/page_business_view.mdx similarity index 65% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/page_business_view.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/page_business_view.mdx index dc109e519b8..43e8a5b370d 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/page_business_view.mdx +++ b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/page_business_view.mdx @@ -79,7 +79,54 @@ In the worst case, the quality alert can result in a recall of the affected seri The following figure illustrates, how quality investigations and alerts throughout the supply chain enable quality problems to be contained quickly and precisely. -![Quality Notifications](assets/quality_notifications.png) +![Quality Notifications](assets/quality_notifications.svg) + +### Block Notifications + +Equal to quality notifications, block notifications are a form of data exchange to transfer information about defective parts in a standardized way. Quality notifications in general and quality alerts in particular can be used for the (first) mainly **unstructured** contact between business partners to initiate e.g. a supplier self-disclosure. Block notifications, in contrast, are **structured** messages. They are used to report parts with critical defects, enriched with specific information, directly to business partners, as an immediate measure potentially following a preceding quality alert. + +> :raised_hand: Detailed information of the specific data being exchanged are available in the [Development View](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Software%20Development%20View/Data%20Provider%20Development%20View%20Traceability%20Kit#aspect-models). + +In this way, the customer can react quickly and precisely locate the parts based on the block information and sort them out at an early stage to prevent subsequent damage or major recalls and thus save costs and ensure a high quality of the vehicles, delivered to the customer. Block notifications should therefore significantly simplify the data exchange of block information in a standardized way and improve speed and quality. + +The following figure gives an overview of how block notifications are exchanged between business partners: + +![Block Notifications](assets/block_notifications.svg) + +### Special Characteristics +Special characteristics are product or process characteristics that may have an impact on safety or regulatory compliance, fit, function, performance or further processing of the product. + +Special Characteristics are: + +- suitable for communicating, product quality and securing in the supply chain. +- Characteristics that require increased care in order to avoid production issues and ensure the quality of the products. +- defined and recorded with the supplier during development. + +Special Characteristics are divided into three categories: + +- Legal / relevant to legislation / homologation, +- Safety +- Function + +> :raised_hand: All products with safety or legal relevant properties, markings or functions are traceability and compliance relevant. Special Characteristics are also mentioned on VDA organization. More details can be found on [VDA home page](https://www.vda.de/de). + +Data on the Special Characteristics are collected within the supply chain, but not systematically forwarded to the OEM. The aim is to improve data exchange and consistency for special characteristics. + +- Data collection and provision for critical components +- Data collection for a limited period of time, when required, in the event of quality problems or as part of industrialization. + +The exchange between supplier and OEM is currently done on single data exchange with special data format accepted by the partners. That means every data exchange has its single implementation. The more interfaces there are, the more difficult it becomes to manage and operate. + +Catena-X is to be used for data exchange within the supply chain. Since traceability must be ensured for special characteristics, it is advisable to supplement the Catena-X Use Cases Industry Core and Traceability with an additional functionality (additional aspect model) for the special characteristics. The special characteristics will be directly linked to the digital twin. + +#### Processual Approach +The target vision aims to enable an end-to-end (E2E) data exchange of special characteristics via Catena-X in three main steps: + +- **Requesting Special Characteristics:** The customer should have the capability to request special characteristics from the supplier. +- **Exchanging Specification Data:** The exchange of specification data for special characteristics should be possible at the part type level. +- **Consuming Measured Data:** The customer should be able to consume the measured data (special characteristics) provided by the manufacturer. + +In this development phase, both the consumer and the provider are responsible for defining a format for requesting and exchanging information on the specifications of the special characteristics. The consumption of the measurement results is based on the expansion of the digital twin to include the aspect of special characteristics as defined in the [Development View](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Software%20Development%20View/Data%20Provider%20Development%20View%20Traceability%20Kit#specialcharacteristics). ### Benefits for OEM, SME and Solution Provider #### OEM @@ -103,7 +150,6 @@ With the Traceability KIT, we support the Catena-X customer journey for our adop ![Customer Journey](assets/traceability_customer-journey.png) - ## Further Explanations ### Example - Industry Problem diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/page_changelog.mdx b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/page_changelog.mdx similarity index 61% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/page_changelog.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/page_changelog.mdx index e91052d232a..a8a189cdd1f 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/page_changelog.mdx +++ b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/page_changelog.mdx @@ -30,6 +30,88 @@ import Notice from './part_notice.mdx' All notable changes to this Kit will be documented in this file. +## [6.0.0] - 2024-12-01 + +Compatible for **release 24.12**. + +### Added + +-**Business View:** + - **Block Notifications:** + - Added new sub-section 'Block Notifications' to introduce the new feature including a picture for further explanation + - **Special Characteristics:** + - Added new section to introduce the special characteristics in general +- **Architecture View:** + - **Traceability Components:** + - Enhanced the existing table 'Traceability Components' by adding a new line for the block notification feature + - **Functional Requirements:** + - Enhanced the existing table 'Functional Requirements' by adding a new row for the block notification feature + - **Digital Twins and Aspect Models:** + - Added references of two new aspect models (SoftwareInformation 1.0.0, CertificateSigningRequests 1.0.0) + - **Traceability Apps:** + - Added new sub-section 'Block Information' to describe the Notification State Model inclusive the corresponding state model picture + - **Runtime View:** + - Added references to the coressponding sections of the HTTP Endpoints for the notifications + - Added new sub-sections to describe the processes for sending, updating and resolving block notifications including its UML sequence diagrams + - **Standards:** + - Added reference to latest Traceability Use Case Standard v.2.0.0 +- **Development View:** + - **App Provider:** + - **Block Notifications:** + - Added new sub-sections to describe the Block Notifications state model and the new Block Notification API specification + - **Asset Creation:** + - Added two lines for the typizations 'ReceiveBlockNotification' and 'UpdateBlockNotification' of the new block notifications + - **Policy Creation:** + - Added two lines to specify the needed (usage) policies for quality- and block notifications + - **Data Provider:** + - **Aspect Models:** + - Added the new SpecialCharacteristics model to the aspect model overview + - **Special Characteristics:** + - Added a new section to describe and reference the aspect model for special characteristics including JSON examples + +### Changed +- **Architecture View:** + - **Build Block View:** + - Updated the Traceability architecture picture with new description regarding Block Notifications + - **Runtime View:** + - Adapted / restructured the remarks text block to be applicable for quality- and the new block notifications +- **Development View:** + - **App Provider:** + - **Quality Notification API:** + - The last sentence, which mentions the Notification APIs, has been restructured to make the references to the Notification API specifications more visible + - **Asset Creation:** + - Fixed / changed asset typization from 'ReceiveQualityAlertNotification' to 'UpdateQualityAlertNotification' + +### Removed +- **Architecture View:** + - **Standards:** + - Removed references to deprecated Traceability standards + +## [5.1.1] - 2024-08-18 + +### Changed + +- **Operation View:** + - Correct link to INSTALL.md + +## [5.1.0] - 2024-07-24 + +Compatible for **release 24.08**. + +### Added + +- **Development View:** + - **Data Provider:** + - Added new section for the aspect model [SoftwareInformation](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Software%20Development%20View/Data%20Provider%20Development%20View%20Traceability%20Kit/#softwareinformation) + - Added new section for the aspect model [CertificateSigningRequests](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Software%20Development%20View/Data%20Provider%20Development%20View%20Traceability%20Kit/#certificatesigningrequests) + - Added aspect models SoftwareInformation and CertificateSigningRequests into the aspect model overview + +### Changed + +- **Development View:** + - **App Provider:** + - Replace use case specific FrameworkAgreement rightOperand with the new, consolidated DataExchangeGovernance released with 2408 + ## [5.0.1] - 2024-05-22 ### Changed diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/page_software-operation-view.mdx b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/page_software-operation-view.mdx similarity index 97% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/page_software-operation-view.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/page_software-operation-view.mdx index 0ade8e3de42..5fbc7cc7767 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/page_software-operation-view.mdx +++ b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/page_software-operation-view.mdx @@ -34,6 +34,6 @@ Traceability app. One open-source example is the **Trace-X app**. For further in their usage, configuration and deployment, follow these resources: - [Trace-X GitHub Repository](https://github.com/eclipse-tractusx/traceability-foss) -- [Trace-X Installation Guide](https://github.com/eclipse-tractusx/traceability-foss/blob/main/frontend/INSTALL.md) +- [Trace-X Installation Guide](https://github.com/eclipse-tractusx/traceability-foss/blob/main/INSTALL.md) diff --git a/docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/part_notice.mdx b/docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/part_notice.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/Traceability Kit/part_notice.mdx rename to docs-kits_versioned_docs/version-24.12/kits/Traceability Kit/part_notice.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/_category_.json b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/_category_.json similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/_category_.json rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/_category_.json diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/architecture.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/architecture.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/architecture.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/architecture.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/basic-service.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/basic-service.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/basic-service.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/basic-service.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/business-process.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/business-process.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/business-process.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/business-process.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/combination-all-roles-coincide.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/combination-all-roles-coincide.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/combination-all-roles-coincide.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/combination-all-roles-coincide.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/combination-consumer-is-skill-and-data-provider.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/combination-consumer-is-skill-and-data-provider.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/combination-consumer-is-skill-and-data-provider.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/combination-consumer-is-skill-and-data-provider.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/combination-consumer-is-skill-and-service-provider.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/combination-consumer-is-skill-and-service-provider.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/combination-consumer-is-skill-and-service-provider.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/combination-consumer-is-skill-and-service-provider.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/combination-consumer-is-skill-provider-and-data-provider-is-service-provider.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/combination-consumer-is-skill-provider-and-data-provider-is-service-provider.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/combination-consumer-is-skill-provider-and-data-provider-is-service-provider.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/combination-consumer-is-skill-provider-and-data-provider-is-service-provider.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/combination-consumer-is-skill-provider.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/combination-consumer-is-skill-provider.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/combination-consumer-is-skill-provider.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/combination-consumer-is-skill-provider.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/combination-data-provider-is-service-provider.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/combination-data-provider-is-service-provider.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/combination-data-provider-is-service-provider.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/combination-data-provider-is-service-provider.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/combination-data-provider-is-skill-provider.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/combination-data-provider-is-skill-provider.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/combination-data-provider-is-skill-provider.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/combination-data-provider-is-skill-provider.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/combination-service-provider-is-skill-provider.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/combination-service-provider-is-skill-provider.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/combination-service-provider-is-skill-provider.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/combination-service-provider-is-skill-provider.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/combination-skill-provider-is-neutral-entity.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/combination-skill-provider-is-neutral-entity.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/combination-skill-provider-is-neutral-entity.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/combination-skill-provider-is-neutral-entity.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/complex-dataspace.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/complex-dataspace.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/complex-dataspace.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/complex-dataspace.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/cx-releases-timeline-condensed.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/cx-releases-timeline-condensed.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/cx-releases-timeline-condensed.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/cx-releases-timeline-condensed.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/cx-releases-timeline.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/cx-releases-timeline.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/cx-releases-timeline.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/cx-releases-timeline.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/dataspace-complex.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/dataspace-complex.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/dataspace-complex.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/dataspace-complex.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/dataspace-knowledge-agent.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/dataspace-knowledge-agent.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/dataspace-knowledge-agent.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/dataspace-knowledge-agent.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/dataspace.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/dataspace.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/dataspace.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/dataspace.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/logic.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/logic.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/logic.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/logic.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/supply-chain-visibility.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/supply-chain-visibility.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/supply-chain-visibility.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/supply-chain-visibility.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/triplet-example-hasargument.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/triplet-example-hasargument.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/triplet-example-hasargument.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/triplet-example-hasargument.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/triplet-example-partof.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/triplet-example-partof.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/triplet-example-partof.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/triplet-example-partof.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/triplet.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/triplet.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/assets/triplet.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/assets/triplet.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/introduction.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/introduction.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/introduction.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/introduction.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/knowledge-agent.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/knowledge-agent.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/knowledge-agent.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/knowledge-agent.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/new-use-cases.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/new-use-cases.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/new-use-cases.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/new-use-cases.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/overview.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/overview.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/overview.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/overview.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/terminology.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/terminology.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/terminology.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/terminology.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/to-be-considered.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/to-be-considered.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/to-be-considered.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/to-be-considered.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/versioning.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/versioning.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/adoption-view/versioning.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/adoption-view/versioning.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/assets/caution.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/assets/caution.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/assets/caution.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/assets/caution.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/assets/external-link.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/assets/external-link.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/assets/external-link.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/assets/external-link.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/changelog.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/changelog.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/changelog.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/changelog.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/development-view/_category_.json b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/development-view/_category_.json similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/development-view/_category_.json rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/development-view/_category_.json diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/development-view/contracts-and-policies.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/development-view/contracts-and-policies.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/development-view/contracts-and-policies.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/development-view/contracts-and-policies.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/development-view/data-bindings.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/development-view/data-bindings.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/development-view/data-bindings.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/development-view/data-bindings.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/development-view/guidance-and-resources.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/development-view/guidance-and-resources.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/development-view/guidance-and-resources.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/development-view/guidance-and-resources.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/development-view/overview.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/development-view/overview.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/development-view/overview.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/development-view/overview.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/development-view/service-bindings.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/development-view/service-bindings.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/development-view/service-bindings.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/development-view/service-bindings.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/development-view/skill.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/development-view/skill.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/development-view/skill.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/development-view/skill.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/overview.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/overview.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/overview.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/overview.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/_category_.json b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/_category_.json similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/_category_.json rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/_category_.json diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/_category_.json b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/_category_.json similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/_category_.json rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/_category_.json diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/adoption-view/_category_.json b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/adoption-view/_category_.json similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/adoption-view/_category_.json rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/adoption-view/_category_.json diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/adoption-view/architecture.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/adoption-view/architecture.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/adoption-view/architecture.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/adoption-view/architecture.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/adoption-view/assets/business-process.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/adoption-view/assets/business-process.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/adoption-view/assets/business-process.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/adoption-view/assets/business-process.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/adoption-view/introduction.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/adoption-view/introduction.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/adoption-view/introduction.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/adoption-view/introduction.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/adoption-view/overview.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/adoption-view/overview.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/adoption-view/overview.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/adoption-view/overview.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/adoption-view/terminology.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/adoption-view/terminology.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/adoption-view/terminology.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/adoption-view/terminology.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/development-view/_category_.json b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/development-view/_category_.json similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/development-view/_category_.json rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/development-view/_category_.json diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/development-view/data-bindings.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/development-view/data-bindings.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/development-view/data-bindings.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/development-view/data-bindings.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/development-view/overview.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/development-view/overview.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/development-view/overview.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/development-view/overview.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/development-view/service-bindings.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/development-view/service-bindings.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/development-view/service-bindings.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/development-view/service-bindings.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/development-view/skill.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/development-view/skill.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/development-view/skill.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/development-view/skill.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/overview.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/overview.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/hi/overview.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/hi/overview.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/overview.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/overview.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/overview.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/overview.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/_category_.json b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/_category_.json similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/_category_.json rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/_category_.json diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/adoption-view/_category_.json b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/adoption-view/_category_.json similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/adoption-view/_category_.json rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/adoption-view/_category_.json diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/adoption-view/architecture.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/adoption-view/architecture.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/adoption-view/architecture.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/adoption-view/architecture.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/adoption-view/assets/business-process.drawio.svg b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/adoption-view/assets/business-process.drawio.svg similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/adoption-view/assets/business-process.drawio.svg rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/adoption-view/assets/business-process.drawio.svg diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/adoption-view/introduction.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/adoption-view/introduction.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/adoption-view/introduction.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/adoption-view/introduction.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/adoption-view/overview.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/adoption-view/overview.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/adoption-view/overview.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/adoption-view/overview.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/adoption-view/terminology.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/adoption-view/terminology.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/adoption-view/terminology.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/adoption-view/terminology.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/development-view/_category_.json b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/development-view/_category_.json similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/development-view/_category_.json rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/development-view/_category_.json diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/development-view/data-bindings.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/development-view/data-bindings.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/development-view/data-bindings.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/development-view/data-bindings.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/development-view/overview.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/development-view/overview.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/development-view/overview.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/development-view/overview.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/development-view/service-bindings.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/development-view/service-bindings.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/development-view/service-bindings.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/development-view/service-bindings.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/development-view/skill.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/development-view/skill.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/development-view/skill.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/development-view/skill.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/overview.md b/docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/overview.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/behaviour-twin-kit/use-cases/rul/overview.md rename to docs-kits_versioned_docs/version-24.12/kits/behaviour-twin-kit/use-cases/rul/overview.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/adoption-view/intro.md b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/adoption-view/intro.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/adoption-view/intro.md rename to docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/adoption-view/intro.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/Arc42.md b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/Arc42.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/Arc42.md rename to docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/Arc42.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/api.md b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/api.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/api.md rename to docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/api.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/api/agent/get.mdx b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/api/agent/get.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/api/agent/get.mdx rename to docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/api/agent/get.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/api/agent/post.mdx b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/api/agent/post.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/api/agent/post.mdx rename to docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/api/agent/post.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/api/agent/skill/get.mdx b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/api/agent/skill/get.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/api/agent/skill/get.mdx rename to docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/api/agent/skill/get.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/api/agent/skill/post.mdx b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/api/agent/skill/post.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/api/agent/skill/post.mdx rename to docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/api/agent/skill/post.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/api/graph/delete.mdx b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/api/graph/delete.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/api/graph/delete.mdx rename to docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/api/graph/delete.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/api/graph/post.mdx b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/api/graph/post.mdx similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/api/graph/post.mdx rename to docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/api/graph/post.mdx diff --git a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/architecture.md b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/architecture.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/architecture.md rename to docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/architecture.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/modelling.md b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/modelling.md similarity index 100% rename from docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/modelling.md rename to docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/modelling.md diff --git a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/modules.md b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/modules.md similarity index 97% rename from docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/modules.md rename to docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/modules.md index 0cfe1af1d3c..c4bc887bc92 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/modules.md +++ b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/modules.md @@ -245,7 +245,7 @@ standard. Actually, this KIT is caring about two bridges, one which bridges AAS information that is described in Catena-X aspect schemas into the Catena-X domain ontologies (the AAS-KA Bridge). And one bridge which is able to emulate -shells and submodels out of a given (federated) virtual graph. +shells and submodels out of a given (federated) virtual graph (the SPARQL-AAS Bridge). [![AAS Bridge(s)](/img/knowledge-agents/aas_bridge_small.png)](/img/knowledge-agents/aas_bridge.png) @@ -268,20 +268,20 @@ There are two main components whose interplay implements the AAS-KA bridge: * A flexible SQL/JSON engine, such as Dremio or in parts also Postgresql which is able to mount raw data in various formats from remote filesystems and APIs. This engine is used to build flat relational views onto a hierarchical json structure that may originate in the value-only-serialization of the AAS. Typically there will be one table/view -per json-schema/submodel template. As an example, see these [scripts](https://github.com/catenax-ng/product-knowledge/tree/main/infrastructure/resources/dremio) -* A graph engine (such as [ontop](https://ontop-vkg.org/guide/) ) that is able to bind/translate SPARQL queries into SQL. As an example, see these [bindings](https://github.com/catenax-ng/product-knowledge/tree/main/infrastructure/oem/resources/trace.obda) +per json-schema/submodel template. As an example, see these [scripts](https://github.com/big-data-spaces/knowledge-agent-deployment/tree/main/infrastructure/resources/dremio) +* A graph engine (such as [ontop](https://ontop-vkg.org/guide/) ) that is able to bind/translate SPARQL queries into SQL. As an example, see these [bindings](https://github.com/big-data-spaces/knowledge-agent-deployment/tree/main/infrastructure/oem/resources/trace.obda) Of course, if the data is available in a native SQL-schema, the SQL/JSON-engine can be omitted. Likewise, even the graph engine can be left out if a sparql-capable database holds its data in conformance to the CX-ontologies. -#### KA->AAS Bridge +#### SPARQL->AAS Bridge In order to form a twin-based, highly-standarized access to any graphTo allow for a more strict In order to form a graph-based, flexible access to AAS backend components, we employ a bridge virtualization module which denormalizes/caches the information inside Shells and Submodels. -Exposing substructures of the distributed knowledge graph via the AAS APIs is possible by deploying the [KA-AAS-Bridge](https://github.com/eclipse-tractusx/knowledge-agents-aas-bridge). This generic tool can be used to expose the graphs structures as AAS by configuring a set of mappings. Each consists of two components +Exposing substructures of the distributed knowledge graph via the AAS APIs is possible by deploying the [KA-AAS-Bridge](https://github.com/eclipse-tractusx/knowledge-agents-aas-bridge) and its [KA-AAS Deployment](../operation-view/bridge). This generic tool can be used to expose the graphs structures as AAS by configuring a set of mappings. Each consists of two components * a SPARQL query extracting "flat" information out of the virtual graph * a mapping configuration providing the basic structure of the target AAS diff --git a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/reference.md b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/reference.md similarity index 90% rename from docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/reference.md rename to docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/reference.md index 17c80d5cfb9..8791a07d99b 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/development-view/reference.md +++ b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/development-view/reference.md @@ -43,14 +43,11 @@ For more information see * Provider-Side Programming Language: Java > 12 * Eclipse Dataspace Connector - * Provider Agent: OnTop - * Inference Agent: Fuseki - * Function Agent: RDF4J + * Provider Agent: OnTop VKP + * Matchmaking Agent: Apache Fuseki + * Remoting Agent: RDF4J + * Conforming Agent: JAX-RS (Jersey) & Glassfish * SPARQL-AAS Bridge: FAAAST -* Consumer-Side Programming Language: Typescript - * Skill Framework: React/Redux - * Knowledge Explorer: React/Redux & Catena-X Portal - * Skill Development Environment: React/Redux & Catena-X Portal ## Sources And Artifacts diff --git a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/operation-view/agent_edc.md b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/operation-view/agent_edc.md similarity index 99% rename from docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/operation-view/agent_edc.md rename to docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/operation-view/agent_edc.md index f2e61aef3b0..496754cc12a 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/operation-view/agent_edc.md +++ b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/operation-view/agent_edc.md @@ -45,11 +45,11 @@ Add a helm dependency to your umbrella/infrastructure Chart.yaml (this example u - name: tractusx-connector alias: my-connector repository: https://eclipse-tractusx.github.io/charts/dev - version: 0.7.0 + version: 0.7.3 - name: agent-plane alias: my-agent-plane repository: https://eclipse-tractusx.github.io/charts/dev - version: 1.12.19 + version: 1.13.22 ``` Then configure the connector in the values.yaml diff --git a/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/operation-view/bridge.md b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/operation-view/bridge.md new file mode 100644 index 00000000000..2923b3f2d78 --- /dev/null +++ b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/operation-view/bridge.md @@ -0,0 +1,1142 @@ +--- +sidebar_position: 1 +title: Bridging +--- + + +For Bridging between Knowledge Agents API and AAS, this KIT recommends deploying the [Tractus-X Knowledge Agents AAS Bridge (KA-AAS)](https://github.com/eclipse-tractusx/knowledge-agents-aas-api) + +## Quick Setup Guide for AAS Bridge + +### 1. Add Helm Dependency to the AAS Bridge + +Add a helm dependency to your umbrella/infrastructure Chart.yaml (this example uses a Traveability graph, see [here](https://github.com/eclipse-tractusx/knowledge-agents-aas-bridge/blob/main/sparql-aas/README.md) for more options and full details). + +```yaml + - name: aas-bridge + repository: https://eclipse-tractusx.github.io/charts/dev + version: 1.13.7 + alias: my-aas-bridge +``` + +### 2. Configure the AAS Bridge with Mappings + +Then configure the aas bridge in the values.yaml - especially you introduce so-called mapping domains ("traceability") which are pairs of XSLT stylesheets and SPARQL commands. +Using these mappings, the aas bridge know how to describe digital twins and submodels out of a background graph. + +Each domain will have a mandatory mapping `aas` which describes the digital twins and the existance of submodels. And it will have a dynamic set of submodel mappings for the individual submodels. +Domains will also be representeded as a component of the resulting keys (asset and submodel id's). + +In the following example, we map digital twins with one submodel (`PartAsPlanned`) out of an existing graph following to the [Bill-Of-Material Ontology](https://w3id.org/catenax/ontology/bill-of-material), the [Vehicle Ontology](https://w3id.org/catenax/ontology/vehicle), the [Common (Dataspace) Ontology](https://w3id.org/catenax/ontology/common) and the [Core (Meta) Ontology](https://w3id.org/catenax/ontology/core) - all being part of the [Complete (Merged) Ontology](https://w3id.org/catenax/ontology). + +Since the AAS Bridge internally speaks https, you need to enable your ingress to relay the ssl-layer (see the `annotations` section). + +```yaml +my-aas-bridge: + nameOverride: my-aas-bridge + fullnameOverride: my-aas-bridge + aas: + persistence: + # -- The default sparql server is embedded + sparql: http://sparql.local + endpoints: + default: + path: "/" + ingresses: + - enabled: true + hostname: "aas-bridge.domain" + annotations: + nginx.ingress.kubernetes.io/backend-protocol: "HTTPS" + endpoints: + - default + tls: + enabled: true +domains: + traceability: + aas: + mapping.xslt: |- + + + + + + + / + + + + + + + + + + Instance + + + + + en + + + + + + + ExternalReference + + + Submodel + // + + + + + + + + + + + + select-all.rq: |- + PREFIX cx-common: + PREFIX cx-core: + PREFIX cx-vehicle: + PREFIX cx-bom: + PREFIX rdf: + PREFIX rdfs: + + # + # A request for obtaining all asset administration shells for serialized parts + # + + SELECT DISTINCT ?id ?name ?pasp ?psasp ?hasRecycling ?slbomap ?slusap ?mfr WHERE { + + # all parts are twins + ?id rdf:type cx-vehicle:Part; + cx-core:name ?name. + + # Part + OPTIONAL{ + ?id cx-core:id ?manufacturerPartId. + BIND( as ?pasp). + } + } + ORDER BY DESC(?id) + select-some.rq: |- + PREFIX cx-common: + PREFIX cx-core: + PREFIX cx-vehicle: + PREFIX cx-bom: + PREFIX rdf: + PREFIX rdfs: + + # + # A request for obtaining specific asset administration shells for serialized parts + # + + SELECT DISTINCT ?id ?name ?pasp ?psasp ?hasRecycling ?slbomap ?slusap ?mfr WHERE { + + VALUES(?id) { + (%s) + } + + # all parts are twins + ?id rdf:type cx-vehicle:Part; + cx-core:name ?name. + + # Part + OPTIONAL{ + ?id cx-core:id ?manufacturerPartId. + BIND( as ?pasp). + } + } + ORDER BY DESC(?id) + partAsPlanned: + mapping.xslt: |- + + + + + + + / + + + // + + + + + + + + + + + Instance + + + + + + ExternalReference + + + Submodel + + + + + + + + + + + + + Instance + + ModelReference + + + ConceptDescription + + + + + + PartAsPlanned + + + en + A Part AsPlanned represents an item in the Catena-X Bill of Material (BOM) in As-Planned lifecycle status. + + + + + Key + catenaXId + + + en + The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace. + + + + + en + Catena-X Identifier + + + + ModelReference + + + ConceptDescription + urn:bamm:io.catenax.part_as_planned:1.0.1#catenaXId + + + + xs:string + + + + partTypeInformation + + + en + Encapsulation for data related to the part type + + + + + en + Part Type Information Entity + + + + + Key + manufacturerPartId + + + en + Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number. + + + + + en + Manufacturer Part ID + + + + ModelReference + + + ConceptDescription + urn:bamm:io.catenax.part_as_planned:1.0.1#manufacturerPartId + + + + xs:string + + + + Value + nameAtManufacturer + + + en + Name of the part as assigned by the manufacturer. + + + + + en + Name at Manufacturer + + + + ModelReference + + + ConceptDescription + urn:bamm:io.catenax.part_as_planned:1.0.1#nameAtManufacturer + + + + xs:string + + + + Enum + classification + + + en + Classification of the part as assigned by the manufacturer. + + + + + en + Product Classification + + + + ModelReference + + + ConceptDescription + urn:bamm:io.catenax.part_as_planned:1.0.1#classification + + + + xs:string + + + + + + validityPeriod + + + en + Temporal validity period of the part. + + + + + en + validityPeriod + + + + + Time + validFrom + + + en + Start date of validity period. + + + + + en + Valid From + + + + ModelReference + + + ConceptDescription + urn:bamm:io.catenax.part_as_planned:1.0.1#validFrom + + + + xs:dateTime + + + + Time + validFrom + + + en + End date of validity period. + + + + + en + Valid To + + + + ModelReference + + + ConceptDescription + urn:bamm:io.catenax.part_as_planned:1.0.1#validTo + + + + xs:dateTime + + + + + + + + + + + + + + select-all.rq: |- + PREFIX cx-common: + PREFIX cx-core: + PREFIX cx-vehicle: + PREFIX rdf: + PREFIX rdfs: + + # Select all part information + + SELECT ?catenaXId ?validFrom ?validTo ?classification ?manufacturerPartId ?nameAtManufacturer + WHERE { + ?catenaXId rdf:type cx-vehicle:Part; + cx-core:id ?manufacturerPartId; + cx-core:name ?nameAtManufacturer; + cx-vehicle:productionPeriodStart ?validFrom; + cx-vehicle:productionPeriodEnd ?validTo. + BIND('product' AS ?classification). + } + ORDER BY DESC(?catenaXId) + select-some.rq: |- + PREFIX cx-common: + PREFIX cx-core: + PREFIX cx-vehicle: + PREFIX rdf: + PREFIX rdfs: + + # Select some part information + + SELECT ?catenaXId ?validFrom ?validTo ?classification ?manufacturerPartId ?nameAtManufacturer + WHERE { + + VALUES(?catenaXId) { + (%s) + } + + ?catenaXId rdf:type cx-vehicle:Part; + cx-core:id ?manufacturerPartId; + cx-core:name ?nameAtManufacturer; + cx-vehicle:productionPeriodStart ?validFrom; + cx-vehicle:productionPeriodEnd ?validTo. + + BIND('product' AS ?classification). + } + ORDER BY DESC(?catenaXId) +``` + +### 3. Testdrive the AAS Bridge + +After the aas bridge has been setup, you may invoke AAS Api calls against it + +```console +curl --location 'https://aas-bridge.domain/api/v3.0/description' +``` + +and you should receive an answer, such as + +```json +{ + "profiles": [ + "https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRepositoryServiceSpecification/SSP-001", + "https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-001", + "https://admin-shell.io/aas/API/3/0/ConceptDescriptionServiceSpecification/SSP-001", + "https://admin-shell.io/aas/API/3/0/DiscoveryServiceSpecification/SSP-001" + ] +} +``` + +To get the list of shells, you may invoke + +```console +curl --location 'http://aas-bridge.domain/api/v3.0/shells' +``` + +and you should receive an answer, such as + +```json +{ + "result": [ + { + "modelType": "AssetAdministrationShell", + "assetInformation": { + "assetKind": "Instance", + "globalAssetId": "traceability/urn:uuid:f5efbf45-7d84-4442-b3b8-05cf1c5c5a0b" + }, + "submodels": [ + { + "keys": [ + { + "type": "Submodel", + "value": "traceability/urn:bamm:io.catenax.part_as_planned:1.0.1#PartAsPlanned/urn:uuid:f5efbf45-7d84-4442-b3b8-05cf1c5c5a0b" + } + ], + "type": "ExternalReference" + } + ], + "id": "traceability/urn:uuid:f5efbf45-7d84-4442-b3b8-05cf1c5c5a0b", + "description": [ + { + "language": "en", + "text": "Tier C Piston Rod" + } + ], + "idShort": "traceability/urn:uuid:f5efbf45-7d84-4442-b3b8-05cf1c5c5a0b" + }, + ... + { + "modelType": "AssetAdministrationShell", + "assetInformation": { + "assetKind": "Instance", + "globalAssetId": "traceability/urn:uuid:0733946c-59c6-41ae-9570-cb43a6e4c79e" + }, + "submodels": [ + { + "keys": [ + { + "type": "Submodel", + "value": "traceability/urn:bamm:io.catenax.part_as_planned:1.0.1#PartAsPlanned/urn:uuid:0733946c-59c6-41ae-9570-cb43a6e4c79e" + } + ], + "type": "ExternalReference" + } + ], + "id": "traceability/urn:uuid:0733946c-59c6-41ae-9570-cb43a6e4c79e", + "description": [ + { + "language": "en", + "text": "Vehicle Model A" + } + ], + "idShort": "traceability/urn:uuid:0733946c-59c6-41ae-9570-cb43a6e4c79e" + } + ], + "paging_metadata": { + "cursor": null + } +} +``` + +To get the list of shells, you may invoke + +```console +curl --location 'http://oem-aas-bridge.knowledge.int.catena-x.net/api/v3.0/submodels?content=value&level=deep' +``` + +and you should receive an answer, such as + +```json +{ + "result": [ + { + "modelType": "Submodel", + "kind": "Instance", + "semanticId": { + "keys": [ + { + "type": "ConceptDescription", + "value": "urn:bamm:io.catenax.part_as_planned:1.0.1#PartAsPlanned" + } + ], + "type": "ModelReference" + }, + "id": "traceability/urn:bamm:io.catenax.part_as_planned:1.0.1#PartAsPlanned/urn:uuid:f5efbf45-7d84-4442-b3b8-05cf1c5c5a0b", + "description": [ + { + "language": "en", + "text": "A Part AsPlanned represents an item in the Catena-X Bill of Material (BOM) in As-Planned lifecycle status. " + } + ], + "idShort": "PartAsPlanned", + "submodelElements": [ + { + "modelType": "Property", + "semanticId": { + "keys": [ + { + "type": "ConceptDescription", + "value": "urn:bamm:io.catenax.part_as_planned:1.0.1#catenaXId" + } + ], + "type": "ModelReference" + }, + "value": "urn:uuid:f5efbf45-7d84-4442-b3b8-05cf1c5c5a0b", + "valueType": "xs:string", + "category": "Key", + "description": [ + { + "language": "en", + "text": "The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace." + } + ], + "displayName": [ + { + "language": "en", + "text": "Catena-X Identifier" + } + ], + "idShort": "catenaXId" + }, + { + "modelType": "SubmodelElementCollection", + "description": [ + { + "language": "en", + "text": "Encapsulation for data related to the part type" + } + ], + "displayName": [ + { + "language": "en", + "text": "Part Type Information Entity" + } + ], + "idShort": "partTypeInformation", + "value": [ + { + "modelType": "Property", + "semanticId": { + "keys": [ + { + "type": "ConceptDescription", + "value": "urn:bamm:io.catenax.part_as_planned:1.0.1#manufacturerPartId" + } + ], + "type": "ModelReference" + }, + "value": "5760234-23", + "valueType": "xs:string", + "category": "Key", + "description": [ + { + "language": "en", + "text": "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number." + } + ], + "displayName": [ + { + "language": "en", + "text": "Manufacturer Part ID" + } + ], + "idShort": "manufacturerPartId" + }, + { + "modelType": "Property", + "semanticId": { + "keys": [ + { + "type": "ConceptDescription", + "value": "urn:bamm:io.catenax.part_as_planned:1.0.1#nameAtManufacturer" + } + ], + "type": "ModelReference" + }, + "value": "Tier C Piston Rod", + "valueType": "xs:string", + "category": "Value", + "description": [ + { + "language": "en", + "text": "Name of the part as assigned by the manufacturer." + } + ], + "displayName": [ + { + "language": "en", + "text": "Name at Manufacturer" + } + ], + "idShort": "nameAtManufacturer" + }, + { + "modelType": "Property", + "semanticId": { + "keys": [ + { + "type": "ConceptDescription", + "value": "urn:bamm:io.catenax.part_as_planned:1.0.1#classification" + } + ], + "type": "ModelReference" + }, + "value": "product", + "valueType": "xs:string", + "category": "Enum", + "description": [ + { + "language": "en", + "text": "Classification of the part as assigned by the manufacturer." + } + ], + "displayName": [ + { + "language": "en", + "text": "Product Classification" + } + ], + "idShort": "classification" + } + ] + }, + { + "modelType": "SubmodelElementCollection", + "description": [ + { + "language": "en", + "text": "Temporal validity period of the part." + } + ], + "displayName": [ + { + "language": "en", + "text": "validityPeriod" + } + ], + "idShort": "validityPeriod", + "value": [ + { + "modelType": "Property", + "semanticId": { + "keys": [ + { + "type": "ConceptDescription", + "value": "urn:bamm:io.catenax.part_as_planned:1.0.1#validFrom" + } + ], + "type": "ModelReference" + }, + "value": "2014-02-24", + "valueType": "xs:dateTime", + "category": "Time", + "description": [ + { + "language": "en", + "text": "Start date of validity period." + } + ], + "displayName": [ + { + "language": "en", + "text": "Valid From" + } + ], + "idShort": "validFrom" + }, + { + "modelType": "Property", + "semanticId": { + "keys": [ + { + "type": "ConceptDescription", + "value": "urn:bamm:io.catenax.part_as_planned:1.0.1#validTo" + } + ], + "type": "ModelReference" + }, + "value": "2027-11-04", + "valueType": "xs:dateTime", + "category": "Time", + "description": [ + { + "language": "en", + "text": "End date of validity period." + } + ], + "displayName": [ + { + "language": "en", + "text": "Valid To" + } + ], + "idShort": "validFrom" + } + ] + } + ] + }, + --- + { + "modelType": "Submodel", + "kind": "Instance", + "semanticId": { + "keys": [ + { + "type": "ConceptDescription", + "value": "urn:bamm:io.catenax.part_as_planned:1.0.1#PartAsPlanned" + } + ], + "type": "ModelReference" + }, + "id": "traceability/urn:bamm:io.catenax.part_as_planned:1.0.1#PartAsPlanned/urn:uuid:0733946c-59c6-41ae-9570-cb43a6e4c79e", + "description": [ + { + "language": "en", + "text": "A Part AsPlanned represents an item in the Catena-X Bill of Material (BOM) in As-Planned lifecycle status. " + } + ], + "idShort": "PartAsPlanned", + "submodelElements": [ + { + "modelType": "Property", + "semanticId": { + "keys": [ + { + "type": "ConceptDescription", + "value": "urn:bamm:io.catenax.part_as_planned:1.0.1#catenaXId" + } + ], + "type": "ModelReference" + }, + "value": "urn:uuid:0733946c-59c6-41ae-9570-cb43a6e4c79e", + "valueType": "xs:string", + "category": "Key", + "description": [ + { + "language": "en", + "text": "The fully anonymous Catena-X ID of the serialized part, valid for the Catena-X dataspace." + } + ], + "displayName": [ + { + "language": "en", + "text": "Catena-X Identifier" + } + ], + "idShort": "catenaXId" + }, + { + "modelType": "SubmodelElementCollection", + "description": [ + { + "language": "en", + "text": "Encapsulation for data related to the part type" + } + ], + "displayName": [ + { + "language": "en", + "text": "Part Type Information Entity" + } + ], + "idShort": "partTypeInformation", + "value": [ + { + "modelType": "Property", + "semanticId": { + "keys": [ + { + "type": "ConceptDescription", + "value": "urn:bamm:io.catenax.part_as_planned:1.0.1#manufacturerPartId" + } + ], + "type": "ModelReference" + }, + "value": "ZX-55", + "valueType": "xs:string", + "category": "Key", + "description": [ + { + "language": "en", + "text": "Part ID as assigned by the manufacturer of the part. The Part ID identifies the part (as designed) in the manufacturer`s dataspace. The Part ID does not reference a specific instance of a part and thus should not be confused with the serial number." + } + ], + "displayName": [ + { + "language": "en", + "text": "Manufacturer Part ID" + } + ], + "idShort": "manufacturerPartId" + }, + { + "modelType": "Property", + "semanticId": { + "keys": [ + { + "type": "ConceptDescription", + "value": "urn:bamm:io.catenax.part_as_planned:1.0.1#nameAtManufacturer" + } + ], + "type": "ModelReference" + }, + "value": "Vehicle Model A", + "valueType": "xs:string", + "category": "Value", + "description": [ + { + "language": "en", + "text": "Name of the part as assigned by the manufacturer." + } + ], + "displayName": [ + { + "language": "en", + "text": "Name at Manufacturer" + } + ], + "idShort": "nameAtManufacturer" + }, + { + "modelType": "Property", + "semanticId": { + "keys": [ + { + "type": "ConceptDescription", + "value": "urn:bamm:io.catenax.part_as_planned:1.0.1#classification" + } + ], + "type": "ModelReference" + }, + "value": "product", + "valueType": "xs:string", + "category": "Enum", + "description": [ + { + "language": "en", + "text": "Classification of the part as assigned by the manufacturer." + } + ], + "displayName": [ + { + "language": "en", + "text": "Product Classification" + } + ], + "idShort": "classification" + } + ] + }, + { + "modelType": "SubmodelElementCollection", + "description": [ + { + "language": "en", + "text": "Temporal validity period of the part." + } + ], + "displayName": [ + { + "language": "en", + "text": "validityPeriod" + } + ], + "idShort": "validityPeriod", + "value": [ + { + "modelType": "Property", + "semanticId": { + "keys": [ + { + "type": "ConceptDescription", + "value": "urn:bamm:io.catenax.part_as_planned:1.0.1#validFrom" + } + ], + "type": "ModelReference" + }, + "value": "2017-01-03", + "valueType": "xs:dateTime", + "category": "Time", + "description": [ + { + "language": "en", + "text": "Start date of validity period." + } + ], + "displayName": [ + { + "language": "en", + "text": "Valid From" + } + ], + "idShort": "validFrom" + }, + { + "modelType": "Property", + "semanticId": { + "keys": [ + { + "type": "ConceptDescription", + "value": "urn:bamm:io.catenax.part_as_planned:1.0.1#validTo" + } + ], + "type": "ModelReference" + }, + "value": "2029-11-15", + "valueType": "xs:dateTime", + "category": "Time", + "description": [ + { + "language": "en", + "text": "End date of validity period." + } + ], + "displayName": [ + { + "language": "en", + "text": "Valid To" + } + ], + "idShort": "validFrom" + } + ] + } + ] + } + ], + "paging_metadata": { + "cursor": null + } +} +``` + +To access a particular shell, you may + +```console +curl --location 'http://oem-aas-bridge.knowledge.int.catena-x.net/api/v3.0/shells/dHJhY2VhYmlsaXR5L3Vybjp1dWlkOmY1ZWZiZjQ1LTdkODQtNDQ0Mi1iM2I4LTA1Y2YxYzVjNWEwYg==' +``` + +which would return + +```json +{ + "modelType": "AssetAdministrationShell", + "assetInformation": { + "assetKind": "Instance", + "globalAssetId": "traceability/urn:uuid:f5efbf45-7d84-4442-b3b8-05cf1c5c5a0b" + }, + "submodels": [ + { + "keys": [ + { + "type": "Submodel", + "value": "traceability/urn:bamm:io.catenax.part_as_planned:1.0.1#PartAsPlanned/urn:uuid:f5efbf45-7d84-4442-b3b8-05cf1c5c5a0b" + } + ], + "type": "ExternalReference" + } + ], + "id": "traceability/urn:uuid:f5efbf45-7d84-4442-b3b8-05cf1c5c5a0b", + "description": [ + { + "language": "en", + "text": "Tier C Piston Rod" + } + ], + "idShort": "traceability/urn:uuid:f5efbf45-7d84-4442-b3b8-05cf1c5c5a0b" +} +``` + +A particular submodel can be selected as follows + +```console +curl --location 'http://oem-aas-bridge.knowledge.int.catena-x.net/api/v3.0/shells/dHJhY2VhYmlsaXR5L3Vybjp1dWlkOmY1ZWZiZjQ1LTdkODQtNDQ0Mi1iM2I4LTA1Y2YxYzVjNWEwYg==' +``` + +which would produce a result like + +```json +{ + "modelType": "AssetAdministrationShell", + "assetInformation": { + "assetKind": "Instance", + "globalAssetId": "traceability/urn:uuid:f5efbf45-7d84-4442-b3b8-05cf1c5c5a0b" + }, + "submodels": [ + { + "keys": [ + { + "type": "Submodel", + "value": "traceability/urn:bamm:io.catenax.part_as_planned:1.0.1#PartAsPlanned/urn:uuid:f5efbf45-7d84-4442-b3b8-05cf1c5c5a0b" + } + ], + "type": "ExternalReference" + } + ], + "id": "traceability/urn:uuid:f5efbf45-7d84-4442-b3b8-05cf1c5c5a0b", + "description": [ + { + "language": "en", + "text": "Tier C Piston Rod" + } + ], + "idShort": "traceability/urn:uuid:f5efbf45-7d84-4442-b3b8-05cf1c5c5a0b" +} +``` + +(C) 2021,2024 Contributors to the Eclipse Foundation. SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/operation-view/deployment.md b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/operation-view/deployment.md similarity index 70% rename from docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/operation-view/deployment.md rename to docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/operation-view/deployment.md index 83b01cf7326..9920eee0eaa 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/operation-view/deployment.md +++ b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/operation-view/deployment.md @@ -54,7 +54,8 @@ role that the business partner takes. The roles are described in more detail in As a consumer, you just need to: * enable your [dataspace connector](agent_edc) to initiate/delegate the required Agent protocols (here: SparQL-over-Http). -* (optionally) mount your connector/matchmaking agent as a remote repository into your enterprise graph infrastructure. +* (optionally) use a separate matchmaking agent to securely host your own business and meta data in the graph storage behind the connector layer +* (optionally) mount your matchmaking agent as a remote repository into your enterprise graph infrastructure. ## Role: As A Skill Provider @@ -69,6 +70,7 @@ and which require computational resources at the provider side) instead of distr As a provider, you need to * enable your [dataspace connector](agent_edc) to receive/internalize the required Agent protocols. +* (optionally) use a separate matchmaking agent to securely publish your own business and meta data from the graph storage behind the connector layer Depending on the kind of provisioning, you will setup additional internal "agents" (endpoints). @@ -98,13 +100,15 @@ The Stable Environment is a minimal example environment exhibiting all roles and Knowledge Agents on Stable is deployed on the following two tenants * App Provider 1 (BPNL000000000001) - * Dataspace Connector (Postgresl, Hashicorp-Vault) - * Agent-Plane (Postgresql, Hashicorp-Vault) - * Provisioning Agent incl. Local Database - * Remoting Agent (against a Public WebService) + * Dataspace Connector (Postgresl, Hashicorp-Vault) "provider-connector" see [manifest](#app-provider-1-dataspace-connector-manifest) + * Agent-Plane (Postgresql, Hashicorp-Vault) "provider-agent-plane" see [manifest](#app-provider-1-agent-plane-manifest) + * Provisioning Agent incl. Local Database "sql-agent" see [manifest](#4-deploy-app-provider-1-provisioning-agent) + * Remoting Agent (against a Public WebService) "api-agent" see [manifest](#5-deploy-app-provider-1-remoting-agent) + * AAS Bridge (against a prerecorded )"aas-bridge" see [manifest](#6-deploy-app-provider-1-aas-bridge) * App Consumer 4 (BPNL0000000005VV) - * Dataspace Connector (Postgresl, Hashicorp-Vault) - * Agent-Plane (Postgresql, Hashicorp-Vault) + * Dataspace Connector (Postgresl, Hashicorp-Vault) "consumer-connector" see [manifest](#app-consumer-4-datspace-connector-manifest) + * Agent-Plane (Postgresql, Hashicorp-Vault) "consumer-agent-plane" see [manifest](#app-consumer-4-agent-plane-manifest) + * Matchmaking-Agent "consumer-agent" see [manifest](#app-consumer-4-matchmaking-agent-manifest) ### 1. Prepare the Two Tenants @@ -137,11 +141,13 @@ We give the complete manifests but hide the secrets. #### App Provider 1 Dataspace Connector Manifest +Deployed as "provider-connector" + ```yaml project: project-knowledge source: repoURL: 'https://eclipse-tractusx.github.io/charts/dev' - targetRevision: 0.7.0 + targetRevision: 0.7.3 plugin: env: - name: HELM_VALUES @@ -190,7 +196,16 @@ source: pullPolicy: Always endpoints: management: - authKey: **** + control: + port: 8083 + path: "/control" + protocol: + port: 8084 + path: "/api/v1/dsp" + management: + port: 8081 + path: "/management" + authKey: *** bdrs: server: url: https://bpn-did-resolution-service.int.demo.catena-x.net/api/directory @@ -206,21 +221,12 @@ source: # -- Enables TLS on the ingress resource tls: enabled: true - env: - EDC_DATAPLANE_SELECTOR_AGENTPLANE_URL: http://agent-plane-provider:8087/api/signaling/v1/dataflows - EDC_DATAPLANE_SELECTOR_AGENTPLANE_SOURCETYPES: cx-common:Protocol?w3c:http:SPARQL,cx-common:Protocol?w3c:http:SKILL - EDC_DATAPLANE_SELECTOR_AGENTPLANE_TRANSFERTYPES: HttpData-PULL - EDC_DATAPLANE_SELECTOR_AGENTPLANE_DESTINATIONTYPES: HttpProxy - EDC_DATAPLANE_SELECTOR_AGENTPLANE_PROPERTIES: '{ "publicApiUrl": "https://provider-agent.stable.demo.catena-x.net/api/public/" }' - EDC_IAM_TRUSTED-ISSUER_0-ISSUER_ID: did:web:dim-static-prod.dis-cloud-prod.cfapps.eu10-004.hana.ondemand.com:dim-hosted:2f45795c-d6cc-4038-96c9-63cedc0cd266:holder-iatp dataplane: token: signer: privatekey_alias: consumer-key verifier: publickey_alias: consumer-cert - env: - EDC_IAM_TRUSTED-ISSUER_0-ISSUER_ID: did:web:dim-static-prod.dis-cloud-prod.cfapps.eu10-004.hana.ondemand.com:dim-hosted:2f45795c-d6cc-4038-96c9-63cedc0cd266:holder-iatp chart: tractusx-connector destination: server: 'https://kubernetes.default.svc' @@ -229,11 +235,13 @@ destination: #### App Provider 1 Agent Plane Manifest +Deployed as "provider-agent-plane" + ```yaml project: project-knowledge source: repoURL: 'https://eclipse-tractusx.github.io/charts/dev' - targetRevision: 1.12.19 + targetRevision: 1.13.22 plugin: env: - name: HELM_VALUES @@ -261,13 +269,13 @@ source: trustedIssuers: - did:web:dim-static-prod.dis-cloud-prod.cfapps.eu10-004.hana.ondemand.com:dim-hosted:2f45795c-d6cc-4038-96c9-63cedc0cd266:holder-iatp sts: - dim: - url: https://dis-integration-service-prod.eu10.dim.cloud.sap/api/v2.0.0/iatp/catena-x-portal - oauth: - token_url: https://bpnl000000000001-authentication.eu10.hana.ondemand.com/oauth/token - client: - id: sa4 - secret_alias: stable-provider-dim + dim: + url: https://dis-integration-service-prod.eu10.dim.cloud.sap/api/v2.0.0/iatp/catena-x-portal + oauth: + token_url: https://bpnl000000000001-authentication.eu10.hana.ondemand.com/oauth/token + client: + id: sa4 + secret_alias: stable-provider-dim postgresql: name: agent-postgresql jdbcUrl: jdbc:postgresql://agent-postgresql:5432/provider @@ -275,10 +283,19 @@ source: database: provider username: provider_user password: **** + connector: provider-connector controlplane: endpoints: + control: + port: 8083 + path: "/control" + protocol: + port: 8084 + path: "/api/v1/dsp" management: - authKey: **** + port: 8081 + path: "/management" + authKey: *** bdrs: server: url: https://bpn-did-resolution-service.int.demo.catena-x.net/api/directory @@ -310,24 +327,26 @@ source: enabled: true configs: dataspace.ttl: |- - ################################################ - # Catena-X Agent Bootstrap - ################################################ + ################################################################# + # Catena-X Agent Bootstrap Graph in TTL/RDF/OWL FORMAT + ################################################################# @prefix : . - @prefix cx: . @prefix cx-common: . + @prefix owl: . @prefix rdf: . + @prefix xml: . + @prefix json: . @prefix xsd: . + @prefix rdfs: . @prefix bpnl: . + @prefix bpns: . @base . + + bpnl:BPNL000000000001 cx-common:id "BPNL000000000001"^^xsd:string; + cx-common:hasConnector . - bpnl:BPNL000000000001 cx:hasBusinessPartnerNumber "BPNL000000000001"^^xsd:string; - cx:hasConnector ; - cx-common:hasConnector . - - bpnl:BPNL0000000005VV cx:hasBusinessPartnerNumber "BPNL0000000005VV"^^xsd:string; - cx:hasConnector ; - cx-common:hasConnector . + bpnl:BPNL0000000005VV cx-common:id "BPNL0000000005VV"^^xsd:string; + cx-common:hasConnector . agent: synchronization: 360000 connectors: @@ -340,11 +359,13 @@ destination: #### App Consumer 4 Datspace Connector Manifest +Deployed as "consumer-connector" + ```yaml project: project-knowledge source: repoURL: 'https://eclipse-tractusx.github.io/charts/dev' - targetRevision: 0.7.0 + targetRevision: 0.7.3 plugin: env: - name: HELM_VALUES @@ -392,8 +413,16 @@ source: image: pullPolicy: Always endpoints: + control: + port: 8083 + path: "/control" + protocol: + port: 8084 + path: "/api/v1/dsp" management: - authKey: **** + port: 8081 + path: "/management" + authKey: *** bdrs: server: url: https://bpn-did-resolution-service.int.demo.catena-x.net/api/directory @@ -409,21 +438,12 @@ source: # -- Enables TLS on the ingress resource tls: enabled: true - env: - EDC_DATAPLANE_SELECTOR_AGENTPLANE_URL: http://agent-plane-consumer:8087/api/signaling/v1/dataflows - EDC_DATAPLANE_SELECTOR_AGENTPLANE_SOURCETYPES: cx-common:Protocol?w3c:http:SPARQL,cx-common:Protocol?w3c:http:SKILL - EDC_DATAPLANE_SELECTOR_AGENTPLANE_TRANSFERTYPES: HttpData-PULL - EDC_DATAPLANE_SELECTOR_AGENTPLANE_DESTINATIONTYPES: HttpProxy - EDC_DATAPLANE_SELECTOR_AGENTPLANE_PROPERTIES: '{ "publicApiUrl": "https://consumer-agent.stable.demo.catena-x.net/api/public/" }' - EDC_IAM_TRUSTED-ISSUER_0-ISSUER_ID: did:web:dim-static-prod.dis-cloud-prod.cfapps.eu10-004.hana.ondemand.com:dim-hosted:2f45795c-d6cc-4038-96c9-63cedc0cd266:holder-iatp dataplane: token: signer: privatekey_alias: consumer-key verifier: publickey_alias: consumer-cert - env: - EDC_IAM_TRUSTED-ISSUER_0-ISSUER_ID: did:web:dim-static-prod.dis-cloud-prod.cfapps.eu10-004.hana.ondemand.com:dim-hosted:2f45795c-d6cc-4038-96c9-63cedc0cd266:holder-iatp chart: tractusx-connector destination: server: 'https://kubernetes.default.svc' @@ -432,11 +452,13 @@ destination: #### App Consumer 4 Agent Plane Manifest +Deployed as "consumer-agent-plane" + ```yaml project: project-knowledge source: repoURL: 'https://eclipse-tractusx.github.io/charts/dev' - targetRevision: 1.12.19 + targetRevision: 1.13.22 plugin: env: - name: HELM_VALUES @@ -478,10 +500,20 @@ source: database: consumer username: consumer_user password: **** + connector: consumer-connector controlplane: endpoints: management: - authKey: **** + control: + port: 8083 + path: "/control" + protocol: + port: 8084 + path: "/api/v1/dsp" + management: + port: 8081 + path: "/management" + authKey: *** bdrs: server: url: https://bpn-did-resolution-service.int.demo.catena-x.net/api/directory @@ -505,7 +537,7 @@ source: auth: {} ingresses: - enabled: true - hostname: "consumer-agent.stable.demo.catena-x.net" + hostname: "agent-consumer-dp.stable.demo.catena-x.net" endpoints: - public - default @@ -513,36 +545,130 @@ source: enabled: true configs: dataspace.ttl: |- - ################################################ - # Catena-X Agent Bootstrap - ################################################ + ################################################################# + # Catena-X Agent Bootstrap Graph in TTL/RDF/OWL FORMAT + ################################################################# @prefix : . - @prefix cx: . @prefix cx-common: . + @prefix owl: . @prefix rdf: . + @prefix xml: . + @prefix json: . @prefix xsd: . + @prefix rdfs: . @prefix bpnl: . + @prefix bpns: . @base . + + bpnl:BPNL000000000001 cx-common:id "BPNL000000000001"^^xsd:string; + cx-common:hasConnector . - bpnl:BPNL000000000001 cx:hasBusinessPartnerNumber "BPNL000000000001"^^xsd:string; - cx:hasConnector ; - cx-common:hasConnector . - - bpnl:BPNL0000000005VV cx:hasBusinessPartnerNumber "BPNL0000000005VV"^^xsd:string; - cx:hasConnector ; - cx-common:hasConnector . + bpnl:BPNL0000000005VV cx-common:id "BPNL0000000005VV"^^xsd:string; + cx-common:hasConnector . agent: synchronization: 360000 connectors: BPNL000000000001: https://agent-provider-cp.stable.demo-catena-x.net BPNL0000000005VV: https://agent-consumer-cp.stable.demo-catena-x.net + matchmaking: https://consumer-agent.stable.demo-catena-x.net chart: agent-plane destination: server: 'https://kubernetes.default.svc' namespace: product-knowledge ``` -### 3. Deploy App Provider 1 Provisioning Agent +### 3. Deploy Matchmaking Agent + +#### App Consumer 4 Matchmaking Agent Manifest + +Deployed as "consumer-agent" + +```yaml +project: project-knowledge +source: + repoURL: 'https://eclipse-tractusx.github.io/charts/dev' + targetRevision: 1.13.22 + plugin: + env: + - name: HELM_VALUES + value: | + participant: + id: BPNL0000000005VV + nameOverride: agent-plane-consumer + fullnameOverride: agent-plane-consumer + connector: consumer-connector + controlplane: + endpoints: + management: + control: + port: 8083 + path: "/control" + protocol: + port: 8084 + path: "/api/v1/dsp" + management: + port: 8081 + path: "/management" + authKey: *** + bdrs: + server: + url: https://bpn-did-resolution-service.int.demo.catena-x.net/api/directory + ingresses: + - enabled: true + # -- The hostname to be used to precisely map incoming traffic onto the underlying network service + hostname: "agent-consumer-cp.stable.demo.catena-x.net" + # -- EDC endpoints exposed by this ingress resource + endpoints: + - protocol + - management + - api + # -- Enables TLS on the ingress resource + tls: + enabled: true + ingresses: + - enabled: true + hostname: "consumer-agent.stable.demo.catena-x.net" + endpoints: + - default + tls: + enabled: true + certManager: + clusterIssuer: *clusterIssuer + configs: + # -- An example of an empty graph in ttl syntax + dataspace.ttl: | + ################################################################# + # Catena-X Agent Bootstrap Graph in TTL/RDF/OWL FORMAT + ################################################################# + @prefix : . + @prefix cx-common: . + @prefix owl: . + @prefix rdf: . + @prefix xml: . + @prefix json: . + @prefix xsd: . + @prefix rdfs: . + @prefix bpnl: . + @prefix bpns: . + @base . + + bpnl:BPNL000000000001 cx-common:id "BPNL000000000001"^^xsd:string; + cx-common:hasConnector . + + bpnl:BPNL0000000005VV cx-common:id "BPNL0000000005VV"^^xsd:string; + cx-common:hasConnector . + agent: + synchronization: 360000 + connectors: + BPNL000000000001: https://agent-provider-cp.stable.demo-catena-x.net + BPNL0000000005VV: https://agent-consumer-cp.stable.demo-catena-x.net + chart: matchmaking-agent +destination: + server: 'https://kubernetes.default.svc' + namespace: product-knowledge +``` + +### 4. Deploy App Provider 1 Provisioning Agent Using the following application has been installed. @@ -553,7 +679,7 @@ Therefore, some of the following settings are specific to stable and will not be project: project-knowledge source: repoURL: 'https://eclipse-tractusx.github.io/charts/dev' - targetRevision: 1.12.19 + targetRevision: 1.13.22 plugin: env: - name: HELM_VALUES @@ -618,7 +744,7 @@ destination: namespace: product-knowledge ``` -### 4. Deploy App Provider 1 Remoting Agent +### 5. Deploy App Provider 1 Remoting Agent Using the following application has been installed. @@ -628,7 +754,7 @@ For simplicity, the remoting agent exposes a simply public API as a graph. project: project-knowledge source: repoURL: 'https://eclipse-tractusx.github.io/charts/dev' - targetRevision: 1.12.19 + targetRevision: 1.13.22 plugin: env: - name: HELM_VALUES @@ -699,9 +825,48 @@ destination: namespace: product-knowledge ``` +### 6. Deploy App Provider 1 AAS Bridge + +Using the following application has been installed. + +For simplicity, the aas bridge uses builtin-persistence. + +```yaml +project: project-knowledge +source: + repoURL: 'https://eclipse-tractusx.github.io/charts/dev' + targetRevision: 1.13.7 + plugin: + env: + - name: HELM_VALUES + value: | + image: + pullPolicy: Always + aas: + persistence: + # -- The default sparql server is embedded + sparql: http://sparql.local + endpoints: + default: + path: "/" + ingresses: + - enabled: true + hostname: "aas-bridge.stable.demo.catena-x.net" + annotations: + nginx.ingress.kubernetes.io/backend-protocol: "HTTPS" + endpoints: + - default + tls: + enabled: true + chart: aas-bridge +destination: + server: 'https://kubernetes.default.svc' + namespace: product-knowledge +``` + ### 5. Perform Smoke Tests -This KIT provides a [Postman collection](https://www.postman.com/catena-x/workspace/catena-x-knowledge-agents/folder/2757771-04658655-9019-4f1c-9de0-eeaf6245b9b6?action=share&source=copy-link&creator=2757771&ctx=documentation) and a corresponding [environment](https://www.postman.com/catena-x/workspace/catena-x-knowledge-agents/environment/2757771-31115ff3-61d7-4ad6-8310-1e50290a1c3a?action=share&creator=2757771&active-environment=2757771-3a7489c5-7540-470b-8e44-04610511d9a9) +This KIT provides a [Postman collection/folder](https://www.postman.com/catena-x/workspace/catena-x-knowledge-agents/folder/2757771-3534e62a-e7c3-4f0b-9aad-75afc650d92e?action=share&source=copy-link&creator=2757771&ctx=documentation) and a corresponding [environment](https://www.postman.com/catena-x/workspace/catena-x-knowledge-agents/environment/2757771-31115ff3-61d7-4ad6-8310-1e50290a1c3a?action=share&creator=2757771&active-environment=2757771-3a7489c5-7540-470b-8e44-04610511d9a9) It consists of the following steps: @@ -714,6 +879,7 @@ It consists of the following steps: * Create Data Graph Asset (Provider) * Create Function Graph Asset (Provider) * Show Own Catalogue (Provider) +* Query AAS Bridge (Provider) * Show Remote Catalogue (Consumer) * Query Data Graph Asset (Consumer) * Query Function Graph Asset (Consumer) diff --git a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/operation-view/ka_conformity_scripts.postman_collection.json b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/operation-view/ka_conformity_scripts.postman_collection.json similarity index 92% rename from docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/operation-view/ka_conformity_scripts.postman_collection.json rename to docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/operation-view/ka_conformity_scripts.postman_collection.json index f0767796987..4b7210b2f36 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/operation-view/ka_conformity_scripts.postman_collection.json +++ b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/operation-view/ka_conformity_scripts.postman_collection.json @@ -1,7 +1,7 @@ { "info": { "_postman_id": "0ad1b7a6-734c-4289-9221-667fc56a21da", - "name": "KA Conformity Assessment Scripts (R24.05)", + "name": "KA Conformity Assessment Scripts (R24.08)", "description": "(C) 2021,2023 Contributors to the Eclipse Foundation\n\nSPDX-LICENSE-IDENTIFIER: CC-BY-4.0", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "2757771", @@ -232,7 +232,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"@context\": {\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\",\n \"rdf\": \"http://www.w3.org/1999/02/22-rdf-syntax-ns#\",\n \"rdfs\": \"http://www.w3.org/2000/01/rdf-schema#\",\n \"cx-common\": \"https://w3id.org/catenax/ontology/common#\",\n \"xsd\": \"http://www.w3.org/2001/XMLSchema#\",\n \"sh\": \"http://www.w3.org/ns/shacl#\",\n \"cs-taxo\": \"https://w3id.org/catenax/taxonomy#\",\n \"dct\": \"https://purl.org/dc/terms/\"\n },\n \"@id\": \"GraphAsset?cab=Conforming&mode=open\",\n \"properties\": {\n \"cx-common:name\": \"Open Conforming Asset.\",\n \"cx-common:description\": \"A graph asset/offering hosting a conforming agent for testing and conformity checking.\",\n \"cx-common:version\": \"1.12.19\",\n \"cx-common:contenttype\": \"application/json, application/xml\",\n \"cx-common:publishedUnderContract\": \"Contract?cab=Asset&mode=open\",\n \"dct:type\": \"cx-taxo:GraphAsset\",\n \"rdfs:isDefinedBy\": \"\",\n \"cx-common:implementsProtocol\": \"cx-common:Protocol?w3c:http:SPARQL\",\n \"sh:shapesGraph\": \"@prefix : .\\n\",\n \"cx-common:isFederated\": \"true^^xsd:boolean\"\n },\n \"privateProperties\": {},\n \"dataAddress\": {\n \"id\": \"GraphAsset?cab=Conforming&mode=open\",\n \"@type\": \"DataAddress\",\n \"baseUrl\": \"{{cabConformingAgent}}/bind\",\n \"type\": \"cx-common:Protocol?w3c:http:SPARQL\",\n \"proxyPath\": \"false\",\n \"proxyMethod\": \"true\",\n \"proxyQueryParams\": \"true\",\n \"proxyBody\": \"true\"\n }\n}", + "raw": "{\n \"@context\": {\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\",\n \"rdf\": \"http://www.w3.org/1999/02/22-rdf-syntax-ns#\",\n \"rdfs\": \"http://www.w3.org/2000/01/rdf-schema#\",\n \"cx-common\": \"https://w3id.org/catenax/ontology/common#\",\n \"xsd\": \"http://www.w3.org/2001/XMLSchema#\",\n \"sh\": \"http://www.w3.org/ns/shacl#\",\n \"cs-taxo\": \"https://w3id.org/catenax/taxonomy#\",\n \"dct\": \"https://purl.org/dc/terms/\"\n },\n \"@id\": \"GraphAsset?cab=Conforming&mode=open\",\n \"properties\": {\n \"cx-common:name\": \"Open Conforming Asset.\",\n \"cx-common:description\": \"A graph asset/offering hosting a conforming agent for testing and conformity checking.\",\n \"cx-common:version\": \"1.13.22\",\n \"cx-common:contenttype\": \"application/json, application/xml\",\n \"cx-common:publishedUnderContract\": \"Contract?cab=Asset&mode=open\",\n \"dct:type\": \"cx-taxo:GraphAsset\",\n \"rdfs:isDefinedBy\": \"\",\n \"cx-common:implementsProtocol\": \"cx-common:Protocol?w3c:http:SPARQL\",\n \"sh:shapesGraph\": \"@prefix : .\\n\",\n \"cx-common:isFederated\": \"true^^xsd:boolean\"\n },\n \"privateProperties\": {},\n \"dataAddress\": {\n \"id\": \"GraphAsset?cab=Conforming&mode=open\",\n \"@type\": \"DataAddress\",\n \"baseUrl\": \"{{cabConformingAgent}}/bind\",\n \"type\": \"cx-common:Protocol?w3c:http:SPARQL\",\n \"proxyPath\": \"false\",\n \"proxyMethod\": \"true\",\n \"proxyQueryParams\": \"true\",\n \"proxyBody\": \"true\"\n }\n}", "options": { "raw": { "language": "json" @@ -281,7 +281,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"@context\": {\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\",\n \"rdf\": \"http://www.w3.org/1999/02/22-rdf-syntax-ns#\",\n \"rdfs\": \"http://www.w3.org/2000/01/rdf-schema#\",\n \"cx-common\": \"https://w3id.org/catenax/ontology/common#\",\n \"xsd\": \"http://www.w3.org/2001/XMLSchema#\",\n \"sh\": \"http://www.w3.org/ns/shacl#\",\n \"cs-taxo\": \"https://w3id.org/catenax/taxonomy#\",\n \"dct\": \"https://purl.org/dc/terms/\"\n },\n \"@id\": \"GraphAsset?cab=Conforming&mode=closed\",\n \"properties\": {\n \"cx-common:name\": \"Closed Conforming Asset.\",\n \"cx-common:description\": \"A graph asset/offering hosting a conforming agent for testing and conformity checking.\",\n \"cx-common:version\": \"1.12.19\",\n \"cx-common:contenttype\": \"application/json, application/xml\",\n \"cx-common:publishedUnderContract\": \"Contract?cab=Asset&mode=closed\",\n \"dct:type\": \"cx-taxo:GraphAsset\",\n \"rdfs:isDefinedBy\": \"\",\n \"cx-common:implementsProtocol\": \"cx-common:Protocol?w3c:http:SPARQL\",\n \"sh:shapesGraph\": \"@prefix : .\\n\",\n \"cx-common:isFederated\": \"true^^xsd:boolean\"\n },\n \"privateProperties\": {},\n \"dataAddress\": {\n \"id\": \"GraphAsset?cab=Conforming&mode=closed\",\n \"@type\": \"DataAddress\",\n \"baseUrl\": \"{{cabConformingAgent}}/bind\",\n \"type\": \"cx-common:Protocol?w3c:http:SPARQL\",\n \"proxyPath\": \"false\",\n \"proxyMethod\": \"true\",\n \"proxyQueryParams\": \"true\",\n \"proxyBody\": \"true\"\n }\n}", + "raw": "{\n \"@context\": {\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\",\n \"rdf\": \"http://www.w3.org/1999/02/22-rdf-syntax-ns#\",\n \"rdfs\": \"http://www.w3.org/2000/01/rdf-schema#\",\n \"cx-common\": \"https://w3id.org/catenax/ontology/common#\",\n \"xsd\": \"http://www.w3.org/2001/XMLSchema#\",\n \"sh\": \"http://www.w3.org/ns/shacl#\",\n \"cs-taxo\": \"https://w3id.org/catenax/taxonomy#\",\n \"dct\": \"https://purl.org/dc/terms/\"\n },\n \"@id\": \"GraphAsset?cab=Conforming&mode=closed\",\n \"properties\": {\n \"cx-common:name\": \"Closed Conforming Asset.\",\n \"cx-common:description\": \"A graph asset/offering hosting a conforming agent for testing and conformity checking.\",\n \"cx-common:version\": \"1.13.22\",\n \"cx-common:contenttype\": \"application/json, application/xml\",\n \"cx-common:publishedUnderContract\": \"Contract?cab=Asset&mode=closed\",\n \"dct:type\": \"cx-taxo:GraphAsset\",\n \"rdfs:isDefinedBy\": \"\",\n \"cx-common:implementsProtocol\": \"cx-common:Protocol?w3c:http:SPARQL\",\n \"sh:shapesGraph\": \"@prefix : .\\n\",\n \"cx-common:isFederated\": \"true^^xsd:boolean\"\n },\n \"privateProperties\": {},\n \"dataAddress\": {\n \"id\": \"GraphAsset?cab=Conforming&mode=closed\",\n \"@type\": \"DataAddress\",\n \"baseUrl\": \"{{cabConformingAgent}}/bind\",\n \"type\": \"cx-common:Protocol?w3c:http:SPARQL\",\n \"proxyPath\": \"false\",\n \"proxyMethod\": \"true\",\n \"proxyQueryParams\": \"true\",\n \"proxyBody\": \"true\"\n }\n}", "options": { "raw": { "language": "json" @@ -330,7 +330,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"@context\": {\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\",\n \"rdf\": \"http://www.w3.org/1999/02/22-rdf-syntax-ns#\",\n \"rdfs\": \"http://www.w3.org/2000/01/rdf-schema#\",\n \"cx-common\": \"https://w3id.org/catenax/ontology/common#\",\n \"xsd\": \"http://www.w3.org/2001/XMLSchema#\",\n \"sh\": \"http://www.w3.org/ns/shacl#\",\n \"cs-taxo\": \"https://w3id.org/catenax/taxonomy#\",\n \"dct\": \"https://purl.org/dc/terms/\"\n },\n \"@id\": \"GraphAsset?cab=Conforming&mode=unfederated\",\n \"properties\": {\n \"cx-common:name\": \"Unfederated Conforming Asset.\",\n \"cx-common:description\": \"A graph asset/offering hosting a conforming agent for testing and conformity checking.\",\n \"cx-common:version\": \"1.12.19\",\n \"cx-common:contenttype\": \"application/json, application/xml\",\n \"cx-common:publishedUnderContract\": \"Contract?cab=Graph&mode=open\",\n \"dct:type\": \"cx-taxo:GraphAsset\",\n \"rdfs:isDefinedBy\": \"\",\n \"cx-common:implementsProtocol\": \"cx-common:Protocol?w3c:http:SPARQL\",\n \"sh:shapesGraph\": \"@prefix : .\\n\",\n \"cx-common:isFederated\": \"false^^xsd:boolean\"\n },\n \"privateProperties\": {},\n \"dataAddress\": {\n \"id\": \"GraphAsset?cab=Conforming&mode=unfederated\",\n \"@type\": \"DataAddress\",\n \"baseUrl\": \"{{cabConformingAgent}}/bind\",\n \"type\": \"cx-common:Protocol?w3c:http:SPARQL\",\n \"proxyPath\": \"false\",\n \"proxyMethod\": \"true\",\n \"proxyQueryParams\": \"true\",\n \"proxyBody\": \"true\"\n }\n}", + "raw": "{\n \"@context\": {\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\",\n \"rdf\": \"http://www.w3.org/1999/02/22-rdf-syntax-ns#\",\n \"rdfs\": \"http://www.w3.org/2000/01/rdf-schema#\",\n \"cx-common\": \"https://w3id.org/catenax/ontology/common#\",\n \"xsd\": \"http://www.w3.org/2001/XMLSchema#\",\n \"sh\": \"http://www.w3.org/ns/shacl#\",\n \"cs-taxo\": \"https://w3id.org/catenax/taxonomy#\",\n \"dct\": \"https://purl.org/dc/terms/\"\n },\n \"@id\": \"GraphAsset?cab=Conforming&mode=unfederated\",\n \"properties\": {\n \"cx-common:name\": \"Unfederated Conforming Asset.\",\n \"cx-common:description\": \"A graph asset/offering hosting a conforming agent for testing and conformity checking.\",\n \"cx-common:version\": \"1.13.22\",\n \"cx-common:contenttype\": \"application/json, application/xml\",\n \"cx-common:publishedUnderContract\": \"Contract?cab=Graph&mode=open\",\n \"dct:type\": \"cx-taxo:GraphAsset\",\n \"rdfs:isDefinedBy\": \"\",\n \"cx-common:implementsProtocol\": \"cx-common:Protocol?w3c:http:SPARQL\",\n \"sh:shapesGraph\": \"@prefix : .\\n\",\n \"cx-common:isFederated\": \"false^^xsd:boolean\"\n },\n \"privateProperties\": {},\n \"dataAddress\": {\n \"id\": \"GraphAsset?cab=Conforming&mode=unfederated\",\n \"@type\": \"DataAddress\",\n \"baseUrl\": \"{{cabConformingAgent}}/bind\",\n \"type\": \"cx-common:Protocol?w3c:http:SPARQL\",\n \"proxyPath\": \"false\",\n \"proxyMethod\": \"true\",\n \"proxyQueryParams\": \"true\",\n \"proxyBody\": \"true\"\n }\n}", "options": { "raw": { "language": "json" @@ -453,7 +453,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"@context\": {\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\",\n \"rdf\": \"http://www.w3.org/1999/02/22-rdf-syntax-ns#\",\n \"rdfs\": \"http://www.w3.org/2000/01/rdf-schema#\",\n \"cx-common\": \"https://w3id.org/catenax/ontology/common#\",\n \"xsd\": \"http://www.w3.org/2001/XMLSchema#\",\n \"sh\": \"http://www.w3.org/ns/shacl#\",\n \"cs-taxo\": \"https://w3id.org/catenax/taxonomy#\",\n \"dct\": \"https://purl.org/dc/terms/\"\n },\n \"@id\": \"SkillAsset?cab=Conforming&mode=open\",\n \"properties\": {\n \"cx-common:name\": \"Open Skill\",\n \"cx-common:description\": \"A conformity assessment skill.\",\n \"cx-common:version\": \"1.12.19\",\n \"cx-common:contenttype\": \"application/json, application/xml\",\n \"cx-common:publishedUnderContract\": \"Contract?cab=Asset&mode=open\",\n \"dct:type\": \"cx-taxo:SkillAsset\",\n \"rdfs:isDefinedBy\": \"\",\n \"cx-common:implementsProtocol\": \"cx-common:Protocol?w3c:http:SKILL\",\n \"cx-common:distributionMode\": \"cx-common:SkillDistribution?run=all\",\n \"cx-common:isFederated\": \"true^^xsd:boolean\"\n },\n \"privateProperties\": {\n \"cx-common:query\": \"# Sample Skill accessing a graph\\n\\nSELECT ?subject ?predicate ?object WHERE { \\n SERVICE {\\n GRAPH { \\n ?subject ?predicate ?object. \\n }\\n } \\n}\"\n },\n \"dataAddress\": {\n \"id\": \"SkillAsset?cab=Conforming&mode=open\",\n \"@type\": \"DataAddress\",\n \"type\": \"cx-common:Protocol?w3c:http:SKILL\",\n \"proxyPath\": \"false\",\n \"proxyMethod\": \"true\",\n \"proxyQueryParams\": \"true\",\n \"proxyBody\": \"true\"\n }\n}", + "raw": "{\n \"@context\": {\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\",\n \"rdf\": \"http://www.w3.org/1999/02/22-rdf-syntax-ns#\",\n \"rdfs\": \"http://www.w3.org/2000/01/rdf-schema#\",\n \"cx-common\": \"https://w3id.org/catenax/ontology/common#\",\n \"xsd\": \"http://www.w3.org/2001/XMLSchema#\",\n \"sh\": \"http://www.w3.org/ns/shacl#\",\n \"cs-taxo\": \"https://w3id.org/catenax/taxonomy#\",\n \"dct\": \"https://purl.org/dc/terms/\"\n },\n \"@id\": \"SkillAsset?cab=Conforming&mode=open\",\n \"properties\": {\n \"cx-common:name\": \"Open Skill\",\n \"cx-common:description\": \"A conformity assessment skill.\",\n \"cx-common:version\": \"1.13.22\",\n \"cx-common:contenttype\": \"application/json, application/xml\",\n \"cx-common:publishedUnderContract\": \"Contract?cab=Asset&mode=open\",\n \"dct:type\": \"cx-taxo:SkillAsset\",\n \"rdfs:isDefinedBy\": \"\",\n \"cx-common:implementsProtocol\": \"cx-common:Protocol?w3c:http:SKILL\",\n \"cx-common:distributionMode\": \"cx-common:SkillDistribution?run=all\",\n \"cx-common:isFederated\": \"true^^xsd:boolean\"\n },\n \"privateProperties\": {\n \"cx-common:query\": \"# Sample Skill accessing a graph\\n\\nSELECT ?subject ?predicate ?object WHERE { \\n SERVICE {\\n GRAPH { \\n ?subject ?predicate ?object. \\n }\\n } \\n}\"\n },\n \"dataAddress\": {\n \"id\": \"SkillAsset?cab=Conforming&mode=open\",\n \"@type\": \"DataAddress\",\n \"type\": \"cx-common:Protocol?w3c:http:SKILL\",\n \"proxyPath\": \"false\",\n \"proxyMethod\": \"true\",\n \"proxyQueryParams\": \"true\",\n \"proxyBody\": \"true\"\n }\n}", "options": { "raw": { "language": "json" @@ -577,7 +577,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"@context\": {\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\",\n \"rdf\": \"http://www.w3.org/1999/02/22-rdf-syntax-ns#\",\n \"rdfs\": \"http://www.w3.org/2000/01/rdf-schema#\",\n \"cx-common\": \"https://w3id.org/catenax/ontology/common#\",\n \"xsd\": \"http://www.w3.org/2001/XMLSchema#\",\n \"sh\": \"http://www.w3.org/ns/shacl#\",\n \"cs-taxo\": \"https://w3id.org/catenax/taxonomy#\",\n \"dct\": \"https://purl.org/dc/terms/\"\n },\n \"@id\": \"SkillAsset?cab=Conforming&mode=closed\",\n \"properties\": {\n \"cx-common:name\": \"Closed Skill\",\n \"cx-common:description\": \"A conformity assessment skill.\",\n \"cx-common:version\": \"1.12.19\",\n \"cx-common:contenttype\": \"application/json, application/xml\",\n \"cx-common:publishedUnderContract\": \"Contract?cab=Asset&mode=closed\",\n \"dct:type\": \"cx-taxo:SkillAsset\",\n \"rdfs:isDefinedBy\": \"\",\n \"cx-common:implementsProtocol\": \"cx-common:Protocol?w3c:http:SKILL\",\n \"cx-common:distributionMode\": \"cx-common:SkillDistribution?run=all\",\n \"cx-common:isFederated\": \"false^^xsd:boolean\"\n },\n \"privateProperties\": {\n \"cx-common:query\": \"# Sample Skill accessing a graph\\n\\nSELECT ?subject ?predicate ?object WHERE { \\n SERVICE {\\n GRAPH { \\n ?subject ?predicate ?object. \\n }\\n } \\n}\"\n },\n \"dataAddress\": {\n \"id\": \"SkillAsset?cab=Conforming&mode=closed\",\n \"@type\": \"DataAddress\",\n \"type\": \"cx-common:Protocol?w3c:http:SKILL\",\n \"proxyPath\": \"false\",\n \"proxyMethod\": \"true\",\n \"proxyQueryParams\": \"true\",\n \"proxyBody\": \"true\"\n }\n}", + "raw": "{\n \"@context\": {\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\",\n \"rdf\": \"http://www.w3.org/1999/02/22-rdf-syntax-ns#\",\n \"rdfs\": \"http://www.w3.org/2000/01/rdf-schema#\",\n \"cx-common\": \"https://w3id.org/catenax/ontology/common#\",\n \"xsd\": \"http://www.w3.org/2001/XMLSchema#\",\n \"sh\": \"http://www.w3.org/ns/shacl#\",\n \"cs-taxo\": \"https://w3id.org/catenax/taxonomy#\",\n \"dct\": \"https://purl.org/dc/terms/\"\n },\n \"@id\": \"SkillAsset?cab=Conforming&mode=closed\",\n \"properties\": {\n \"cx-common:name\": \"Closed Skill\",\n \"cx-common:description\": \"A conformity assessment skill.\",\n \"cx-common:version\": \"1.13.22\",\n \"cx-common:contenttype\": \"application/json, application/xml\",\n \"cx-common:publishedUnderContract\": \"Contract?cab=Asset&mode=closed\",\n \"dct:type\": \"cx-taxo:SkillAsset\",\n \"rdfs:isDefinedBy\": \"\",\n \"cx-common:implementsProtocol\": \"cx-common:Protocol?w3c:http:SKILL\",\n \"cx-common:distributionMode\": \"cx-common:SkillDistribution?run=all\",\n \"cx-common:isFederated\": \"false^^xsd:boolean\"\n },\n \"privateProperties\": {\n \"cx-common:query\": \"# Sample Skill accessing a graph\\n\\nSELECT ?subject ?predicate ?object WHERE { \\n SERVICE {\\n GRAPH { \\n ?subject ?predicate ?object. \\n }\\n } \\n}\"\n },\n \"dataAddress\": {\n \"id\": \"SkillAsset?cab=Conforming&mode=closed\",\n \"@type\": \"DataAddress\",\n \"type\": \"cx-common:Protocol?w3c:http:SKILL\",\n \"proxyPath\": \"false\",\n \"proxyMethod\": \"true\",\n \"proxyQueryParams\": \"true\",\n \"proxyBody\": \"true\"\n }\n}", "options": { "raw": { "language": "json" @@ -701,7 +701,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"@context\": {\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\",\n \"rdf\": \"http://www.w3.org/1999/02/22-rdf-syntax-ns#\",\n \"rdfs\": \"http://www.w3.org/2000/01/rdf-schema#\",\n \"cx-common\": \"https://w3id.org/catenax/ontology/common#\",\n \"xsd\": \"http://www.w3.org/2001/XMLSchema#\",\n \"sh\": \"http://www.w3.org/ns/shacl#\",\n \"cs-taxo\": \"https://w3id.org/catenax/taxonomy#\",\n \"dct\": \"https://purl.org/dc/terms/\"\n },\n \"@id\": \"SkillAsset?cab=Conforming&mode=provider\",\n \"properties\": {\n \"cx-common:name\": \"Provider-Forced Skill\",\n \"cx-common:description\": \"A conformity assessment skill.\",\n \"cx-common:version\": \"1.12.19\",\n \"cx-common:contenttype\": \"application/json, application/xml\",\n \"cx-common:publishedUnderContract\": \"Contract?cab=Asset&mode=open\",\n \"dct:type\": \"cx-taxo:SkillAsset\",\n \"rdfs:isDefinedBy\": \"\",\n \"cx-common:implementsProtocol\": \"cx-common:Protocol?w3c:http:SKILL\",\n \"cx-common:distributionMode\": \"cx-common:SkillDistribution?run=provider\",\n \"cx-common:isFederated\": \"true^^xsd:boolean\"\n },\n \"privateProperties\": {\n \"cx-common:query\": \"# Sample Skill accessing a graph\\n\\nSELECT ?subject ?predicate ?object WHERE { \\n SERVICE {\\n GRAPH { \\n ?subject ?predicate ?object. \\n }\\n } \\n}\"\n },\n \"dataAddress\": {\n \"id\": \"SkillAsset?cab=Conforming&mode=provider\",\n \"@type\": \"DataAddress\",\n \"type\": \"cx-common:Protocol?w3c:http:SKILL\",\n \"proxyPath\": \"false\",\n \"proxyMethod\": \"true\",\n \"proxyQueryParams\": \"true\",\n \"proxyBody\": \"true\"\n }\n}", + "raw": "{\n \"@context\": {\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\",\n \"rdf\": \"http://www.w3.org/1999/02/22-rdf-syntax-ns#\",\n \"rdfs\": \"http://www.w3.org/2000/01/rdf-schema#\",\n \"cx-common\": \"https://w3id.org/catenax/ontology/common#\",\n \"xsd\": \"http://www.w3.org/2001/XMLSchema#\",\n \"sh\": \"http://www.w3.org/ns/shacl#\",\n \"cs-taxo\": \"https://w3id.org/catenax/taxonomy#\",\n \"dct\": \"https://purl.org/dc/terms/\"\n },\n \"@id\": \"SkillAsset?cab=Conforming&mode=provider\",\n \"properties\": {\n \"cx-common:name\": \"Provider-Forced Skill\",\n \"cx-common:description\": \"A conformity assessment skill.\",\n \"cx-common:version\": \"1.13.22\",\n \"cx-common:contenttype\": \"application/json, application/xml\",\n \"cx-common:publishedUnderContract\": \"Contract?cab=Asset&mode=open\",\n \"dct:type\": \"cx-taxo:SkillAsset\",\n \"rdfs:isDefinedBy\": \"\",\n \"cx-common:implementsProtocol\": \"cx-common:Protocol?w3c:http:SKILL\",\n \"cx-common:distributionMode\": \"cx-common:SkillDistribution?run=provider\",\n \"cx-common:isFederated\": \"true^^xsd:boolean\"\n },\n \"privateProperties\": {\n \"cx-common:query\": \"# Sample Skill accessing a graph\\n\\nSELECT ?subject ?predicate ?object WHERE { \\n SERVICE {\\n GRAPH { \\n ?subject ?predicate ?object. \\n }\\n } \\n}\"\n },\n \"dataAddress\": {\n \"id\": \"SkillAsset?cab=Conforming&mode=provider\",\n \"@type\": \"DataAddress\",\n \"type\": \"cx-common:Protocol?w3c:http:SKILL\",\n \"proxyPath\": \"false\",\n \"proxyMethod\": \"true\",\n \"proxyQueryParams\": \"true\",\n \"proxyBody\": \"true\"\n }\n}", "options": { "raw": { "language": "json" @@ -825,7 +825,7 @@ ], "body": { "mode": "raw", - "raw": "{\n \"@context\": {\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\",\n \"rdf\": \"http://www.w3.org/1999/02/22-rdf-syntax-ns#\",\n \"rdfs\": \"http://www.w3.org/2000/01/rdf-schema#\",\n \"cx-common\": \"https://w3id.org/catenax/ontology/common#\",\n \"xsd\": \"http://www.w3.org/2001/XMLSchema#\",\n \"sh\": \"http://www.w3.org/ns/shacl#\",\n \"cs-taxo\": \"https://w3id.org/catenax/taxonomy#\",\n \"dct\": \"https://purl.org/dc/terms/\"\n },\n \"@id\": \"SkillAsset?cab=Conforming&mode=consumer\",\n \"properties\": {\n \"cx-common:name\": \"Consumer-Forced Skill\",\n \"cx-common:description\": \"A conformity assessment skill.\",\n \"cx-common:version\": \"1.12.19\",\n \"cx-common:contenttype\": \"application/json, application/xml\",\n \"cx-common:publishedUnderContract\": \"Contract?cab=Asset&mode=open\",\n \"dct:type\": \"cx-taxo:SkillAsset\",\n \"rdfs:isDefinedBy\": \"\",\n \"cx-common:implementsProtocol\": \"cx-common:Protocol?w3c:http:SKILL\",\n \"cx-common:distributionMode\": \"cx-common:SkillDistribution?run=consumer\",\n \"cx-common:isFederated\": \"true^^xsd:boolean\"\n },\n \"privateProperties\": {\n \"cx-common:query\": \"# Sample Skill accessing a graph\\n\\nSELECT ?subject ?predicate ?object WHERE { \\n SERVICE {\\n GRAPH { \\n ?subject ?predicate ?object. \\n }\\n } \\n}\"\n },\n \"dataAddress\": {\n \"id\": \"SkillAsset?cab=Conforming&mode=consumer\",\n \"@type\": \"DataAddress\",\n \"type\": \"cx-common:Protocol?w3c:http:SKILL\",\n \"proxyPath\": \"false\",\n \"proxyMethod\": \"true\",\n \"proxyQueryParams\": \"true\",\n \"proxyBody\": \"true\"\n }\n}", + "raw": "{\n \"@context\": {\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\",\n \"rdf\": \"http://www.w3.org/1999/02/22-rdf-syntax-ns#\",\n \"rdfs\": \"http://www.w3.org/2000/01/rdf-schema#\",\n \"cx-common\": \"https://w3id.org/catenax/ontology/common#\",\n \"xsd\": \"http://www.w3.org/2001/XMLSchema#\",\n \"sh\": \"http://www.w3.org/ns/shacl#\",\n \"cs-taxo\": \"https://w3id.org/catenax/taxonomy#\",\n \"dct\": \"https://purl.org/dc/terms/\"\n },\n \"@id\": \"SkillAsset?cab=Conforming&mode=consumer\",\n \"properties\": {\n \"cx-common:name\": \"Consumer-Forced Skill\",\n \"cx-common:description\": \"A conformity assessment skill.\",\n \"cx-common:version\": \"1.13.22\",\n \"cx-common:contenttype\": \"application/json, application/xml\",\n \"cx-common:publishedUnderContract\": \"Contract?cab=Asset&mode=open\",\n \"dct:type\": \"cx-taxo:SkillAsset\",\n \"rdfs:isDefinedBy\": \"\",\n \"cx-common:implementsProtocol\": \"cx-common:Protocol?w3c:http:SKILL\",\n \"cx-common:distributionMode\": \"cx-common:SkillDistribution?run=consumer\",\n \"cx-common:isFederated\": \"true^^xsd:boolean\"\n },\n \"privateProperties\": {\n \"cx-common:query\": \"# Sample Skill accessing a graph\\n\\nSELECT ?subject ?predicate ?object WHERE { \\n SERVICE {\\n GRAPH { \\n ?subject ?predicate ?object. \\n }\\n } \\n}\"\n },\n \"dataAddress\": {\n \"id\": \"SkillAsset?cab=Conforming&mode=consumer\",\n \"@type\": \"DataAddress\",\n \"type\": \"cx-common:Protocol?w3c:http:SKILL\",\n \"proxyPath\": \"false\",\n \"proxyMethod\": \"true\",\n \"proxyQueryParams\": \"true\",\n \"proxyBody\": \"true\"\n }\n}", "options": { "raw": { "language": "json" @@ -3304,6 +3304,402 @@ ] } ] + }, + { + "name": "0303_PROVIDER_AAS", + "item": [ + { + "name": "030301_PROVIDER_AAS_BRIDGE", + "item": [ + { + "name": "030301_AAS_DESCRIPTION", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "pm.test(\"AAS 3.0 description was successful\", function () {", + " pm.expect(pm.response.code).oneOf([200]);", + " res = pm.response.json();", + "\t\tpm.expect(res).to.have.property('profiles');", + "\t\tpm.expect(res.profiles).to.have.length.gte(1);", + "\t\taasProfiles=res.profiles.filter(function(profile) {", + "\t\t\treturn profile.includes(\"AssetAdministrationShellRepository\");", + "\t\t});", + "\t\tpm.expect(aasProfiles.length).to.be.eq(1);", + "\t\tsubmodelProfiles=res.profiles.filter(function(profile) {", + "\t\t\treturn profile.includes(\"SubmodelRepository\");", + "\t\t});", + " pm.expect(submodelProfiles.length).to.be.eq(1);", + "});", + "" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "protocolProfileBehavior": { + "disabledSystemHeaders": { + "accept": true, + "user-agent": true, + "accept-encoding": true, + "connection": true + } + }, + "request": { + "auth": { + "type": "noauth" + }, + "method": "GET", + "header": [], + "url": { + "raw": "{{providerAasBridge}}/api/v3.0/description", + "host": [ + "{{providerAasBridge}}" + ], + "path": [ + "api", + "v3.0", + "description" + ] + } + }, + "response": [] + }, + { + "name": "030302_AAS_ALL_SHELLS", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "pm.test(\"AAS 3.0 shells was successful\", function () {", + " pm.expect(pm.response.code).oneOf([200]);", + " res = pm.response.json();", + "\tpm.expect(res).to.have.property('result');", + "\tpm.expect(res.result).to.have.length.gte(1);", + "\tres.result.forEach(function(shell) {", + " pm.expect(shell).to.have.property(\"id\");", + " pm.expect(shell).to.have.property(\"idShort\");", + " pm.expect(shell).to.have.property(\"assetInformation\");", + " pm.expect(shell.assetInformation).to.have.property(\"globalAssetId\");", + " pm.expect(shell).to.have.property(\"submodels\");", + " pm.expect(shell.submodels).to.have.length.gte(1);", + " shell.submodels.forEach(function(submodel) {", + " pm.expect(submodel).to.have.property(\"keys\");", + " pm.expect(submodel.keys).to.have.length.gte(1);", + " });", + " });", + "});" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{providerAasBridge}}/api/v3.0/shells", + "host": [ + "{{providerAasBridge}}" + ], + "path": [ + "api", + "v3.0", + "shells" + ] + } + }, + "response": [] + }, + { + "name": "030303_AAS_ALL_SUBMODELS", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "pm.test(\"AAS 3.0 submodels was successful\", function () {", + " pm.expect(pm.response.code).oneOf([200]);", + " res = pm.response.json();", + "\tpm.expect(res).to.have.property('result');", + "\tpm.expect(res.result).to.have.length.gte(1);", + "\tres.result.forEach(function(submodel) {", + " pm.expect(submodel).to.have.property(\"id\");", + " pm.expect(submodel).to.have.property(\"idShort\");", + " pm.expect(submodel).to.have.property(\"semanticId\");", + " pm.expect(submodel.semanticId).to.have.property(\"keys\");", + " pm.expect(submodel.semanticId.keys).to.have.length.gte(1);", + " pm.expect(submodel).to.have.property(\"submodelElements\");", + " pm.expect(submodel.submodelElements).to.have.length.gte(1);", + " submodel.submodelElements.forEach(function(submodelElement) {", + " pm.expect(submodelElement).to.have.property(\"idShort\");", + " pm.expect(submodelElement).to.have.property(\"value\");", + " });", + " });", + "});" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{providerAasBridge}}/api/v3.0/submodels?content=value&level=deep", + "host": [ + "{{providerAasBridge}}" + ], + "path": [ + "api", + "v3.0", + "submodels" + ], + "query": [ + { + "key": "content", + "value": "value" + }, + { + "key": "level", + "value": "deep" + } + ] + } + }, + "response": [] + }, + { + "name": "030304_ONE_SHELL", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "pm.test(\"AAS 3.0 specific shell was successful\", function () {", + " pm.expect(pm.response.code).oneOf([200]);", + " shell = pm.response.json();", + " pm.expect(shell).to.have.property(\"id\");", + " pm.expect(shell).to.have.property(\"idShort\");", + " pm.expect(shell).to.have.property(\"assetInformation\");", + " pm.expect(shell.assetInformation).to.have.property(\"globalAssetId\");", + " pm.expect(shell).to.have.property(\"submodels\");", + " pm.expect(shell.submodels).to.have.length.gte(1);", + " shell.submodels.forEach(function(submodel) {", + " pm.expect(submodel).to.have.property(\"keys\");", + " pm.expect(submodel.keys).to.have.length.gte(1);", + " });", + "});" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{providerAasBridge}}/api/v3.0/shells/:shellid", + "host": [ + "{{providerAasBridge}}" + ], + "path": [ + "api", + "v3.0", + "shells", + ":shellid" + ], + "variable": [ + { + "key": "shellid", + "value": "dHJhY2VhYmlsaXR5L3Vybjp1dWlkOmY1ZWZiZjQ1LTdkODQtNDQ0Mi1iM2I4LTA1Y2YxYzVjNWEwYg==" + } + ] + } + }, + "response": [] + }, + { + "name": "030305_NOTEXISTS_SHELL", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "pm.test(\"AAS 3.0 not existant shell wasfailure\", function () {", + " pm.expect(pm.response.code).oneOf([400,500]);", + " message = pm.response.json();", + "\tpm.expect(message).to.have.property(\"messages\");", + "\tpm.expect(message.messages).to.have.length.gte(1);", + "\tmessage.messages.forEach(function(message) {", + "\t\t\tpm.expect(message).to.have.property(\"messageType\");", + "\t\t\tpm.expect(message).to.have.property(\"text\");", + "\t\t\tpm.expect(message).to.have.property(\"code\");", + "\t\t\tpm.expect(message).to.have.property(\"timestamp\");", + "\t});", + "});" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{providerAasBridge}}/api/v3.0/shells/:shellid", + "host": [ + "{{providerAasBridge}}" + ], + "path": [ + "api", + "v3.0", + "shells", + ":shellid" + ], + "variable": [ + { + "key": "shellid", + "value": "dHJhY2VhYmlsaXR5L3Vybjp1dWlkOmY1ZWZiZjQ1LTdkODQtNDQ0Mi1iM2I4LTA1Y2YxYzVjNWEwYw==" + } + ] + } + }, + "response": [] + }, + { + "name": "030306_ONE_SUBMODEL", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "pm.test(\"AAS 3.0 specific submodel was successful\", function () {", + " pm.expect(pm.response.code).oneOf([200]);", + " submodel = pm.response.json();", + "\tpm.expect(submodel).to.have.property(\"id\");", + "\tpm.expect(submodel).to.have.property(\"idShort\");", + "\tpm.expect(submodel).to.have.property(\"semanticId\");", + "\tpm.expect(submodel.semanticId).to.have.property(\"keys\");", + "\tpm.expect(submodel.semanticId.keys).to.have.length.gte(1);", + "\tpm.expect(submodel).to.have.property(\"submodelElements\");", + "\tpm.expect(submodel.submodelElements).to.have.length.gte(1);", + "\tsubmodel.submodelElements.forEach(function(submodelElement) {", + "\t\t\tpm.expect(submodelElement).to.have.property(\"idShort\");", + "\t\t\tpm.expect(submodelElement).to.have.property(\"value\");", + "\t});", + "});" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{providerAasBridge}}/api/v3.0/submodels/:submodelIdentifier?level=deep", + "host": [ + "{{providerAasBridge}}" + ], + "path": [ + "api", + "v3.0", + "submodels", + ":submodelIdentifier" + ], + "query": [ + { + "key": "level", + "value": "deep" + }, + { + "key": "content", + "value": "value", + "disabled": true + } + ], + "variable": [ + { + "key": "submodelIdentifier", + "value": "dHJhY2VhYmlsaXR5L3VybjpiYW1tOmlvLmNhdGVuYXgucGFydF9hc19wbGFubmVkOjEuMC4xI1BhcnRBc1BsYW5uZWQvdXJuOnV1aWQ6ZjVlZmJmNDUtN2Q4NC00NDQyLWIzYjgtMDVjZjFjNWM1YTBi" + } + ] + } + }, + "response": [] + }, + { + "name": "030307_NOTEXISTS_SUBMODEL", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "pm.test(\"AAS 3.0 not existant submodel wasfailure\", function () {", + " pm.expect(pm.response.code).oneOf([400,500]);", + " message = pm.response.json();", + "\tpm.expect(message).to.have.property(\"messages\");", + "\tpm.expect(message.messages).to.have.length.gte(1);", + "\tmessage.messages.forEach(function(message) {", + "\t\t\tpm.expect(message).to.have.property(\"messageType\");", + "\t\t\tpm.expect(message).to.have.property(\"text\");", + "\t\t\tpm.expect(message).to.have.property(\"code\");", + "\t\t\tpm.expect(message).to.have.property(\"timestamp\");", + "\t});", + "});" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{providerAasBridge}}/api/v3.0/submodels/:submodelIdentifier?level=deep", + "host": [ + "{{providerAasBridge}}" + ], + "path": [ + "api", + "v3.0", + "submodels", + ":submodelIdentifier" + ], + "query": [ + { + "key": "level", + "value": "deep" + }, + { + "key": "content", + "value": "value", + "disabled": true + } + ], + "variable": [ + { + "key": "submodelIdentifier", + "value": "dHJhY2VhYmlsaXR5L3VybjpiYW1tOmlvLmNhdGVuYXgucGFydF9zaXRlX2luZm9ybWF0aW9uX2FzX3BsYW5uZWQ6MS4wLjAjUGFydFNpdGVJbmZvcm1hdGlvbkFzUGxhbm5lZC91cm46dXVpZDplNWM5NmFiNS04OTZhLTQ4MmMtODc2MS1lZmQ3NDc3N2NhOTc=" + } + ] + } + }, + "response": [] + } + ] + } + ] } ] }, diff --git a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/operation-view/policy.md b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/operation-view/policy.md similarity index 99% rename from docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/operation-view/policy.md rename to docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/operation-view/policy.md index 8ed4e9a827f..b6ae6e3c0c1 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/operation-view/policy.md +++ b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/operation-view/policy.md @@ -117,7 +117,7 @@ A result from would look like this }, "version": { "type": "literal", - "value": "1.12.19" + "value": "1.13.22" } }, { diff --git a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/operation-view/provider.md b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/operation-view/provider.md similarity index 99% rename from docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/operation-view/provider.md rename to docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/operation-view/provider.md index 426e37fd9f9..e7d76772920 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/operation-view/provider.md +++ b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/operation-view/provider.md @@ -50,7 +50,7 @@ Add a helm dependency to your umbrella/infrastructure Chart.yaml (this example u ```yaml - name: provisioning-agent repository: https://eclipse-tractusx.github.io/charts/dev - version: 1.12.19 + version: 1.13.22 alias: my-provider-agent ``` @@ -317,7 +317,7 @@ Add a helm dependency to your umbrella/infrastructure Chart.yaml (this example u ```yaml - name: remoting-agent repository: https://eclipse-tractusx.github.io/charts/dev - version: 1.12.19 + version: 1.13.22 alias: my-remoting-agent ``` @@ -1112,7 +1112,7 @@ curl --location --globoff 'https://my-connector-control.domain/management/v3/ass "cx-common:name": "Lifetime Prognosis Service for Gearboxes", "cx-common:description": "A sample graph asset/offering referring to a specific prognosis resource.", "cx-common:description@de": "Ein Beispielasset für eine Prognosefunktion.", - "cx-common:version": "1.12.19", + "cx-common:version": "1.13.22", "cx-common:contenttype": "application/json, application/xml", "cx-common:publishedUnderContract": "Contract?supplier=Graph", "dc:type": "cx-taxo:GraphAsset", @@ -1158,7 +1158,7 @@ curl --location --globoff 'https://my-connector-control.domain/management/v3/ass "cx-common:name": "Health Prognosis Service for Gearboxes", "cx-common:description": "A second sample graph asset/offering referring to a specific prognosis resource.", "cx-common:description@de": "Ein weiteres Beispielasset für eine Prognosefunktion.", - "cx-common:version": "1.12.19", + "cx-common:version": "1.13.22", "cx-common:contenttype": "application/json, application/xml", "cx-common:publishedUnderContract": "Contract?supplier=Graph", "dc:type": "cx-taxo:GraphAsset", diff --git a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/operation-view/testbed.md b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/operation-view/testbed.md similarity index 98% rename from docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/operation-view/testbed.md rename to docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/operation-view/testbed.md index e42b179cd09..8c9030bd313 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/operation-view/testbed.md +++ b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/operation-view/testbed.md @@ -57,6 +57,8 @@ The scripts are organised as follows: * 030101_PROVIDER_DATA_SPARQL - scripts to be run against Data Provider Agents * 0302_PROVIDER_FUNCTION - scripts to be run at Function Provider CAPs * 030201_PROVIDER_FUNCTION_SPARQL - scripts to be run against Function Provider Agents + * 0303_PROVIDER_AAS - scripts to be run at AAS Provider CAPs + * 030301_PROVIDER_AAS_API - scripts to be run against AAS Provider Bridge * 04_CONSUMER - scripts to be run against Consumer CAPs * 0401_CONSUMER_APPLICATION - scripts to be run against a KA-enabled Application * 040101_CONSUMER_APPLICATION_SPARQL - scripts to be run against a SPARQL-speaking Application @@ -184,7 +186,7 @@ The CAB may use the following Graph Asset Descriptions (referring to the contrac "properties": { "cx-common:name": "Open Conforming Asset.", "cx-common:description": "A graph asset/offering hosting a conforming agent for testing and conformity checking.", - "cx-common:version": "1.12.19", + "cx-common:version": "1.13.22", "cx-common:contenttype": "application/json, application/xml", "cx-common:publishedUnderContract": "Contract?cab=Asset&mode=open", "dct:type": "cx-taxo:GraphAsset", @@ -225,7 +227,7 @@ The CAB may use the following Graph Asset Descriptions (referring to the contrac "properties": { "cx-common:name": "Closed Conforming Asset.", "cx-common:description": "A graph asset/offering hosting a conforming agent for testing and conformity checking.", - "cx-common:version": "1.12.19", + "cx-common:version": "1.13.22", "cx-common:contenttype": "application/json, application/xml", "cx-common:publishedUnderContract": "Contract?cab=Asset&mode=closed", "dct:type": "cx-taxo:GraphAsset", @@ -266,7 +268,7 @@ The CAB may use the following Graph Asset Descriptions (referring to the contrac "properties": { "cx-common:name": "Unfederated Conforming Asset.", "cx-common:description": "A graph asset/offering hosting a conforming agent for testing and conformity checking.", - "cx-common:version": "1.12.19", + "cx-common:version": "1.13.22", "cx-common:contenttype": "application/json, application/xml", "cx-common:publishedUnderContract": "Contract?cab=Graph&mode=open", "dct:type": "cx-taxo:GraphAsset", @@ -311,7 +313,7 @@ The CAB may use the following Skill Asset Descriptions (referring to the contrac "properties": { "cx-common:name": "Open Skill", "cx-common:description": "A conformity assessment skill.", - "cx-common:version": "1.12.19", + "cx-common:version": "1.13.22", "cx-common:contenttype": "application/json, application/xml", "cx-common:publishedUnderContract": "Contract?cab=Asset&mode=open", "dct:type": "cx-taxo:SkillAsset", @@ -353,7 +355,7 @@ The CAB may use the following Skill Asset Descriptions (referring to the contrac "properties": { "cx-common:name": "Closed Skill", "cx-common:description": "A conformity assessment skill.", - "cx-common:version": "1.12.19", + "cx-common:version": "1.13.22", "cx-common:contenttype": "application/json, application/xml", "cx-common:publishedUnderContract": "Contract?cab=Asset&mode=closed", "dct:type": "cx-taxo:SkillAsset", @@ -395,7 +397,7 @@ The CAB may use the following Skill Asset Descriptions (referring to the contrac "properties": { "cx-common:name": "Provider-Forced Skill", "cx-common:description": "A conformity assessment skill.", - "cx-common:version": "1.12.19", + "cx-common:version": "1.13.22", "cx-common:contenttype": "application/json, application/xml", "cx-common:publishedUnderContract": "Contract?cab=Asset&mode=open", "dct:type": "cx-taxo:SkillAsset", @@ -437,7 +439,7 @@ The CAB may use the following Skill Asset Descriptions (referring to the contrac "properties": { "cx-common:name": "Consumer-Forced Skill", "cx-common:description": "A conformity assessment skill.", - "cx-common:version": "1.12.19", + "cx-common:version": "1.13.22", "cx-common:contenttype": "application/json, application/xml", "cx-common:publishedUnderContract": "Contract?cab=Asset&mode=open", "dct:type": "cx-taxo:SkillAsset", diff --git a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/page_changelog.md b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/page_changelog.md similarity index 97% rename from docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/page_changelog.md rename to docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/page_changelog.md index af23894514e..da556efa0ea 100644 --- a/docs-kits_versioned_docs/version-24.05/kits/knowledge-agents/page_changelog.md +++ b/docs-kits_versioned_docs/version-24.12/kits/knowledge-agents/page_changelog.md @@ -32,6 +32,16 @@ sidebar_position: 1 All notable changes to the (Knowledge) Agents KIT will be documented in this file. +## [1.2.0] - 2024-07-29 + +### Added + +- AAS Bridge Released + +### Changed + +- References to 24.08 (1.31.22/1.13.7) + ## [1.1.0] - 2024-05-13 ### Added diff --git a/docs-kits_versioned_sidebars/version-24.03-sidebars.json b/docs-kits_versioned_sidebars/version-24.03-sidebars.json deleted file mode 100644 index a0760d8c56a..00000000000 --- a/docs-kits_versioned_sidebars/version-24.03-sidebars.json +++ /dev/null @@ -1,1167 +0,0 @@ -{ - "kits": [ - { - "type": "category", - "label": "Agents Kit", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - "kits/knowledge-agents/Knowledge Agent Changelog", - "kits/knowledge-agents/adoption-view/intro", - { - "type": "category", - "label": "Development View", - "link": { - "type": "doc", - "id": "kits/knowledge-agents/development-view/architecture" - }, - "collapsed": true, - "items": [ - "kits/knowledge-agents/development-view/architecture", - "kits/knowledge-agents/development-view/Arc42", - "kits/knowledge-agents/development-view/modules", - "kits/knowledge-agents/development-view/reference", - { - "type": "category", - "label": "API", - "link": { - "type": "doc", - "id": "kits/knowledge-agents/development-view/api" - }, - "collapsed": true, - "items": [ - "kits/knowledge-agents/development-view/api/agent/getAgent", - "kits/knowledge-agents/development-view/api/agent/postAgent", - "kits/knowledge-agents/development-view/api/agent/skill/postSkill" - ] - } - ] - }, - { - "type": "category", - "label": "Operation View", - "link": { - "type": "doc", - "id": "kits/knowledge-agents/operation-view/deployment" - }, - "collapsed": true, - "items": [ - "kits/knowledge-agents/operation-view/deployment", - "kits/knowledge-agents/operation-view/agent_edc", - "kits/knowledge-agents/operation-view/provider", - "kits/knowledge-agents/operation-view/bridge", - "kits/knowledge-agents/operation-view/policy", - "kits/knowledge-agents/operation-view/testbed" - ] - } - ] - }, - { - "type": "category", - "label": "Business Partner KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - "kits/Business Partner Kit/Changelog", - "kits/Business Partner Kit/Adoption View", - { - "type": "category", - "label": "Development View", - "link": { - "type": "generated-index" - }, - "items": [ - "kits/Business Partner Kit/Software Development View/Specification", - { - "type": "category", - "label": "Gate API", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate" - }, - { - "type": "category", - "label": "sharing-state-controller", - "link": { - "type": "generated-index", - "title": "sharing-state-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Gate Api/sharing-state-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-sharing-states", - "label": "Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/upsert-sharing-state", - "label": "Creates or updates a sharing state of a business partner", - "className": "menu__list-item--deprecated api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/post-sharing-state-ready", - "label": "Sets the given business partners into ready to be shared state", - "className": "api-method post" - } - ] - }, - { - "type": "category", - "label": "site-controller", - "link": { - "type": "generated-index", - "title": "site-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Gate Api/site-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/upsert-sites-output", - "label": "Creates or updates an existing site in the output stage", - "className": "menu__list-item--deprecated api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-sites", - "label": "Returns sites from the input stage", - "className": "menu__list-item--deprecated api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/upsert-sites", - "label": "Creates or updates an existing site in the input stage", - "className": "menu__list-item--deprecated api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-sites-output", - "label": "Returns sites by an array of external IDs from the output stage", - "className": "menu__list-item--deprecated api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-sites-by-external-ids", - "label": "Returns sites by an array of external IDs from the input stage", - "className": "menu__list-item--deprecated api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-site-by-external-id", - "label": "Returns site by external ID from the input stage", - "className": "menu__list-item--deprecated api-method get" - } - ] - }, - { - "type": "category", - "label": "legal-entity-controller", - "link": { - "type": "generated-index", - "title": "legal-entity-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Gate Api/legal-entity-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/upsert-legal-entities-output", - "label": "Creates or updates an existing legal entity in the output stage", - "className": "menu__list-item--deprecated api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities", - "label": "Returns legal entities from the input stage", - "className": "menu__list-item--deprecated api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/upsert-legal-entities", - "label": "Creates or updates an existing legal entity in the input stage", - "className": "menu__list-item--deprecated api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities-output", - "label": "Returns legal entities by an array of external IDs from the output stage", - "className": "menu__list-item--deprecated api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entities-by-external-ids", - "label": "Returns legal entities by an array of external IDs from the input stage", - "className": "menu__list-item--deprecated api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-legal-entity-by-external-id", - "label": "Returns legal entity by external ID from the input stage", - "className": "menu__list-item--deprecated api-method get" - } - ] - }, - { - "type": "category", - "label": "address-controller", - "link": { - "type": "generated-index", - "title": "address-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Gate Api/address-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/upsert-addresses-output", - "label": "Creates or updates an existing address in the output stage", - "className": "menu__list-item--deprecated api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-addresses", - "label": "Returns addresses from the input stage", - "className": "menu__list-item--deprecated api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/upsert-addresses", - "label": "Creates or updates an existing address in the input stage", - "className": "menu__list-item--deprecated api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-addresses-output", - "label": "Returns addresses by an array of external IDs from the output stage", - "className": "menu__list-item--deprecated api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-addresses-by-external-ids", - "label": "Returns addresses by an array of external IDs from the input stage", - "className": "menu__list-item--deprecated api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-address-by-external-id", - "label": "Returns address by external ID from the input stage", - "className": "menu__list-item--deprecated api-method get" - } - ] - }, - { - "type": "category", - "label": "business-partner-controller", - "link": { - "type": "generated-index", - "title": "business-partner-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/upsert-business-partners-input", - "label": "Create or update business partner with given external ID", - "className": "api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-business-partners-output", - "label": "Search business partners by an array of external IDs from the output stage", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-business-partners-input", - "label": "Search business partner by external ID. An empty external ID list returns a paginated list of all business partners.", - "className": "api-method post" - } - ] - }, - { - "type": "category", - "label": "changelog-controller", - "link": { - "type": "generated-index", - "title": "changelog-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Gate Api/changelog-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-output-changelog", - "label": "Returns changelog entries for changes to the business partner output stage", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-input-changelog", - "label": "Returns changelog entries for changes to the business partner input stage", - "className": "api-method post" - } - ] - }, - { - "type": "category", - "label": "stats-controller", - "link": { - "type": "generated-index", - "title": "stats-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Gate Api/stats-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/count-address-types", - "label": "countAddressTypes", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/count-partners-per-stage", - "label": "countPartnersPerStage", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/count-partners-by-sharing-state", - "label": "countPartnersBySharingState", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-confidence-criteria-stats", - "label": "getConfidenceCriteriaStats", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "gate-documentation-controller", - "link": { - "type": "generated-index", - "title": "gate-documentation-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Gate Api/gate-documentation-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-mermaid-gate-persistence", - "label": "Get mermaid class diagramm for the gate JPA model", - "className": "api-method get" - } - ] - } - ] - }, - { - "type": "category", - "label": "Pool API", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool" - }, - { - "type": "category", - "label": "site-controller", - "link": { - "type": "generated-index", - "title": "site-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/site-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-sites-paginated", - "label": "Get page of sites matching the pagination search criteria", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/update-site", - "label": "Updates an existing site", - "className": "api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/create-site", - "label": "Creates a new site", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/search-sites", - "label": "Returns sites by an array of BPNS and/or an array of corresponding BPNL", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/search-main-addresses", - "label": "Search for sites' main addresses", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-site", - "label": "Returns a site by its BPNS", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "legal-entity-controller", - "link": { - "type": "generated-index", - "title": "legal-entity-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/legal-entity-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entities", - "label": "Returns legal entities by different search parameters", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/update-business-partners", - "label": "Updates an existing legal entity", - "className": "api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/create-business-partners", - "label": "Creates a new legal entity", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/set-legal-entity-currentness", - "label": "Confirms that the data of a legal entity business partner is still up to date.", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/search-legal-entitys", - "label": "Returns legal entities by an array of BPNL", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/search-legal-addresses", - "label": "Search Legal Addresses", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity", - "label": "Returns a legal entity by identifier, like BPN, DUNS or EU VAT ID, specified by the identifier type", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-sites", - "label": "Returns all sites of a legal entity with a specific BPNL", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-addresses", - "label": "Returns all addresses of a legal entity with a specific BPNL", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "address-controller", - "link": { - "type": "generated-index", - "title": "address-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/address-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-addresses-1", - "label": "Returns addresses by different search parameters", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/update-addresses", - "label": "Updates an existing address", - "className": "api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/create-addresses", - "label": "Creates a new address", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/search-addresses", - "label": "Returns addresses by an array of BPNA and/or an array of corresponding BPNS and/or an array of corresponding BPNL.", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-address", - "label": "Returns an address by its BPNA", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "metadata-controller", - "link": { - "type": "generated-index", - "title": "metadata-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/metadata-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-regions", - "label": "Get page of regions", - "className": "menu__list-item--deprecated api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/create-region", - "label": "Create new Region", - "className": "menu__list-item--deprecated api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-legal-forms", - "label": "Returns all legal forms", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/create-legal-form", - "label": "Creates a new legal form", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-types", - "label": "Returns all identifier types filtered by business partner type and country.", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-type", - "label": "Creates a new identifier type", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-field-quality-rules", - "label": "Get all field quality rules filtered by country (specified by its ISO 3166-1 alpha-2 country code)", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-admin-areas-level-1", - "label": "Get page of country subdivisions suitable for the administrativeAreaLevel1 address property", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "changelog-controller", - "link": { - "type": "generated-index", - "title": "changelog-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/changelog-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-changelog-entries", - "label": "Returns changelog entries as of a specified timestamp, optionally filtered by a list of BPNL/S/A, or business partner types", - "className": "api-method post" - } - ] - }, - { - "type": "category", - "label": "bpn-controller", - "link": { - "type": "generated-index", - "title": "bpn-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/bpn-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/find-bpns-by-identifiers", - "label": "Returns a list of identifier mappings of an identifier to a BPNL/A/S, specified by a business partner type, identifier type and identifier values", - "className": "api-method post" - } - ] - }, - { - "type": "category", - "label": "pool-documentation-controller", - "link": { - "type": "generated-index", - "title": "pool-documentation-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/pool-documentation-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-mermaid-pool-persistence", - "label": "Get mermaid class diagramm for the pool JPA model", - "className": "api-method get" - } - ] - } - ] - }, - { - "type": "category", - "label": "Bridge Dummy API", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Bridge Dummy Api/business-partner-data-management-bridge-dummy" - }, - { - "type": "category", - "label": "bridge-controller", - "link": { - "type": "generated-index", - "title": "bridge-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/bridge-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Bridge Dummy Api/trigger-sync", - "label": "Start sync between Gate and Pool", - "className": "api-method post" - } - ] - } - ] - }, - { - "type": "category", - "label": "Cleaning Dummy API", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Cleaning Dummy Api/business-partner-data-management-cleaning-service-dummy" - } - ] - }, - { - "type": "category", - "label": "Orchestrator API", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Orchestrator Api/business-partner-data-management-orchestrator" - }, - { - "type": "category", - "label": "Task Client", - "link": { - "type": "generated-index", - "title": "Task Client", - "slug": "/category/kits/Business Partner Kit/Software Development View/Orchestrator Api/task-client" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Orchestrator Api/create-tasks", - "label": "Create new golden record tasks for given business partner data", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Orchestrator Api/search-task-states", - "label": "Search for the state of golden record tasks by task identifiers", - "className": "api-method post" - } - ] - }, - { - "type": "category", - "label": "Task Worker", - "link": { - "type": "generated-index", - "title": "Task Worker", - "slug": "/category/kits/Business Partner Kit/Software Development View/Orchestrator Api/task-worker" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Orchestrator Api/resolve-step-results", - "label": "Post step results for reserved golden record tasks in the given step queue", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Orchestrator Api/reserve-tasks-for-step", - "label": "Reserve the next golden record tasks waiting in the given step queue", - "className": "api-method post" - } - ] - } - ] - }, - "kits/Business Partner Kit/Software Development View/Use Cases" - ] - }, - "kits/Business Partner Kit/Operation View", - { - "type": "category", - "label": "Success Stories", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Business Partner Kit/Success Stories" - } - ] - }, - { - "type": "category", - "label": "Architecture View", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Business Partner Kit/Documentation BPDM" - } - ] - } - ] - }, - { - "type": "category", - "label": "Certificate Management KIT", - "link": { - "type": "generated-index" - }, - "items": [ - "kits/Certificate Management Kit/Changelog", - "kits/Certificate Management Kit/Adoption View", - "kits/Certificate Management Kit/Operation View", - { - "type": "category", - "label": "Development View", - "link": { - "type": "generated-index" - }, - "items": [ - "kits/Certificate Management Kit/Software Development View/Specification", - { - "type": "link", - "label": "API", - "href": "https://app.swaggerhub.com/apis/eclipse-tractusx-bot/bpdm-certificate-management" - } - ] - }, - { - "type": "category", - "label": "Documentation", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Certificate Management Kit/Documentation Certificate Management" - } - ] - } - ] - }, - { - "type": "category", - "label": "Circularity KIT", - "link": { - "type": "doc", - "id": "kits/Circularity_KIT/page-adoption-view" - }, - "items": [ - "kits/Circularity_KIT/Changelog Circularity KIT", - "kits/Circularity_KIT/page-adoption-view" - ] - }, - { - "type": "category", - "label": "Connector KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - "kits/Connector Kit/page_changelog", - "kits/Connector Kit/Adoption View/connector_kit_adoption_view", - { - "type": "category", - "label": "Development View", - "link": { - "type": "doc", - "id": "kits/Connector Kit/Development View/connector_kit_development_view_specifications" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Connector Kit/Development View" - } - ] - }, - "kits/Connector Kit/Operation View/connector_kit_operation_view" - ] - }, - { - "type": "category", - "label": "Data Chain KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - "kits/Data Chain Kit/data chain kit changelog", - "kits/Data Chain Kit/Adoption View Data Chain Kit", - "kits/Data Chain Kit/Operation View", - { - "type": "category", - "label": "Development View", - "link": { - "type": "doc", - "id": "kits/Data Chain Kit/Software Development View/Specification" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Data Chain Kit/Software Development View/Job Api" - } - ] - }, - { - "type": "category", - "label": "Documentation", - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Data Chain Kit/Documentation" - } - ] - } - ] - }, - { - "type": "category", - "label": "DCM KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Demand and Capacity Management Kit" - } - ] - }, - { - "type": "category", - "label": "Data Governance Kit", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - "kits/Data Governance Kit/Data Governance Kit Changelog", - "kits/Data Governance Kit/Data Governance Kit Adoption View", - { - "type": "category", - "label": "Development View", - "link": { - "type": "doc", - "id": "kits/Data Governance Kit/Software Development View/Data Governance Kit Development View" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Data Governance Kit/resources/MDX Files" - } - ] - } - ] - }, - { - "type": "category", - "label": "Digital Twin KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Digital Twin Kit" - } - ] - }, - { - "type": "category", - "label": "Eco Pass KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Eco_Pass_KIT" - } - ] - }, - { - "type": "category", - "label": "ESS KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/ESS-Kit" - } - ] - }, - { - "type": "category", - "label": "Health Indicator (HI) KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Behaviour Twin HI Kit" - } - ] - }, - { - "type": "category", - "label": "Industry Core KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Industry Core Kit" - } - ] - }, - { - "type": "category", - "label": "Model Based Development and Data Processing (MDP) KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Behaviour Twin MDP Kit" - } - ] - }, - { - "type": "category", - "label": "Modular Production Kit", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Modular Production Kit" - } - ] - }, - { - "type": "category", - "label": "Manufacturing as a Service KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Manufacturing as a Service Kit" - } - ] - }, - { - "type": "category", - "label": "OSim Kit", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/OSim Kit" - } - ] - }, - { - "type": "category", - "label": "PCF Exchange KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - "kits/PCF Exchange Kit/PCF Exchange Kit Changelog", - "kits/PCF Exchange Kit/Adoption View", - "kits/PCF Exchange Kit/Operation View", - { - "type": "category", - "label": "Development View", - "link": { - "type": "generated-index" - }, - "items": [ - "kits/PCF Exchange Kit/Software Development View/Specification", - { - "type": "category", - "label": "PCF Exchange API", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "doc", - "id": "kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/catena-x-pcf-request-endpoint" - }, - { - "type": "category", - "label": "PCF Exchange API", - "items": [ - { - "type": "doc", - "id": "kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/get-pcf", - "label": "get_pcf", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/set-pcf", - "label": "set_pcf", - "className": "api-method put" - } - ] - } - ] - } - ] - } - ] - }, - { - "type": "category", - "label": "Quality KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Quality-Kit" - } - ] - }, - { - "type": "category", - "label": "Remaining Useful Life (RuL) KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Behaviour Twin RuL Kit" - } - ] - }, - { - "type": "category", - "label": "Traceability KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Traceability Kit" - } - ] - }, - { - "type": "category", - "label": "Upcoming KITs", - "link": { - "type": "doc", - "id": "kits/Resiliency/resiliency" - }, - "items": [ - "kits/Resiliency/maas", - "kits/Resiliency/PURIS" - ] - } - ] -} diff --git a/docs-kits_versioned_sidebars/version-24.05-sidebars.json b/docs-kits_versioned_sidebars/version-24.05-sidebars.json deleted file mode 100644 index 16d2d1aa6d1..00000000000 --- a/docs-kits_versioned_sidebars/version-24.05-sidebars.json +++ /dev/null @@ -1,1056 +0,0 @@ -{ - "kits": [ - { - "type": "category", - "label": "Agents Kit", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - "kits/knowledge-agents/Knowledge Agent Changelog", - "kits/knowledge-agents/adoption-view/intro", - { - "type": "category", - "label": "Development View", - "link": { - "type": "doc", - "id": "kits/knowledge-agents/development-view/architecture" - }, - "collapsed": true, - "items": [ - "kits/knowledge-agents/development-view/Arc42", - "kits/knowledge-agents/development-view/modelling", - "kits/knowledge-agents/development-view/modules", - "kits/knowledge-agents/development-view/reference", - { - "type": "category", - "label": "API", - "link": { - "type": "doc", - "id": "kits/knowledge-agents/development-view/api" - }, - "collapsed": true, - "items": [ - "kits/knowledge-agents/development-view/api/agent/getAgent", - "kits/knowledge-agents/development-view/api/agent/postAgent", - "kits/knowledge-agents/development-view/api/agent/skill/postSkill", - "kits/knowledge-agents/development-view/api/agent/skill/getSkill", - "kits/knowledge-agents/development-view/api/graph/postGraph", - "kits/knowledge-agents/development-view/api/graph/deleteGraph" - ] - } - ] - }, - { - "type": "category", - "label": "Operation View", - "link": { - "type": "doc", - "id": "kits/knowledge-agents/operation-view/deployment" - }, - "collapsed": true, - "items": [ - "kits/knowledge-agents/operation-view/agent_edc", - "kits/knowledge-agents/operation-view/provider", - "kits/knowledge-agents/operation-view/bridge", - "kits/knowledge-agents/operation-view/policy", - "kits/knowledge-agents/operation-view/testbed" - ] - } - ] - }, - { - "type": "category", - "label": "Behaviour Twin KIT", - "link": { - "type": "doc", - "id": "kits/behaviour-twin-kit/overview" - }, - "collapsed": true, - "items": [ - "kits/behaviour-twin-kit/changelog", - { - "type": "category", - "label": "Adoption View", - "link": { - "type": "doc", - "id": "kits/behaviour-twin-kit/adoption-view/overview" - }, - "items": [ - "kits/behaviour-twin-kit/adoption-view/introduction", - "kits/behaviour-twin-kit/adoption-view/architecture", - "kits/behaviour-twin-kit/adoption-view/knowledge-agent", - "kits/behaviour-twin-kit/adoption-view/versioning", - "kits/behaviour-twin-kit/adoption-view/to-be-considered", - "kits/behaviour-twin-kit/adoption-view/new-use-cases", - "kits/behaviour-twin-kit/adoption-view/terminology" - ] - }, - { - "type": "category", - "label": "Development View", - "link": { - "type": "doc", - "id": "kits/behaviour-twin-kit/development-view/overview" - }, - "items": [ - "kits/behaviour-twin-kit/development-view/contracts-and-policies", - "kits/behaviour-twin-kit/development-view/data-bindings", - "kits/behaviour-twin-kit/development-view/service-bindings", - "kits/behaviour-twin-kit/development-view/skill", - "kits/behaviour-twin-kit/development-view/guidance-and-resources" - ] - }, - { - "type": "category", - "label": "Use Cases", - "link": { - "type": "doc", - "id": "kits/behaviour-twin-kit/use-cases/overview" - }, - "items": [ - { - "type": "category", - "label": "Remaining useful Life", - "link": { - "type": "doc", - "id": "kits/behaviour-twin-kit/use-cases/rul/overview" - }, - "items": [ - { - "type": "category", - "label": "Adoption View", - "link": { - "type": "doc", - "id": "kits/behaviour-twin-kit/use-cases/rul/adoption-view/overview" - }, - "items": [ - "kits/behaviour-twin-kit/use-cases/rul/adoption-view/introduction", - "kits/behaviour-twin-kit/use-cases/rul/adoption-view/architecture", - "kits/behaviour-twin-kit/use-cases/rul/adoption-view/terminology" - ] - }, - { - "type": "category", - "label": "Development View", - "link": { - "type": "doc", - "id": "kits/behaviour-twin-kit/use-cases/rul/development-view/overview" - }, - "items": [ - "kits/behaviour-twin-kit/use-cases/rul/development-view/data-bindings", - "kits/behaviour-twin-kit/use-cases/rul/development-view/service-bindings", - "kits/behaviour-twin-kit/use-cases/rul/development-view/skill" - ] - } - ] - }, - { - "type": "category", - "label": "Health Indicator", - "link": { - "type": "doc", - "id": "kits/behaviour-twin-kit/use-cases/hi/overview" - }, - "items": [ - { - "type": "category", - "label": "Adoption View", - "link": { - "type": "doc", - "id": "kits/behaviour-twin-kit/use-cases/hi/adoption-view/overview" - }, - "items": [ - "kits/behaviour-twin-kit/use-cases/hi/adoption-view/introduction", - "kits/behaviour-twin-kit/use-cases/hi/adoption-view/architecture", - "kits/behaviour-twin-kit/use-cases/hi/adoption-view/terminology" - ] - }, - { - "type": "category", - "label": "Development View", - "link": { - "type": "doc", - "id": "kits/behaviour-twin-kit/use-cases/hi/development-view/overview" - }, - "items": [ - "kits/behaviour-twin-kit/use-cases/hi/development-view/data-bindings", - "kits/behaviour-twin-kit/use-cases/hi/development-view/service-bindings", - "kits/behaviour-twin-kit/use-cases/hi/development-view/skill" - ] - } - ] - } - ] - } - ] - }, - { - "type": "category", - "label": "Business Partner KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - "kits/Business Partner Kit/Changelog", - "kits/Business Partner Kit/Adoption View", - { - "type": "category", - "label": "Development View", - "link": { - "type": "generated-index" - }, - "items": [ - "kits/Business Partner Kit/Software Development View/Specification", - { - "type": "category", - "label": "Gate API", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate" - }, - { - "type": "category", - "label": "business-partner-controller", - "link": { - "type": "generated-index", - "title": "business-partner-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/upsert-business-partners-input", - "label": "Create or update business partner with given external ID", - "className": "api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-business-partners-output", - "label": "Search business partners by an array of external IDs from the output stage", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-business-partners-input", - "label": "Search business partner by external ID. An empty external ID list returns a paginated list of all business partners.", - "className": "api-method post" - } - ] - }, - { - "type": "category", - "label": "sharing-state-controller", - "link": { - "type": "generated-index", - "title": "sharing-state-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Gate Api/sharing-state-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/post-sharing-state-ready", - "label": "Sets the given business partners into ready to be shared state", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-sharing-states", - "label": "Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "changelog-controller", - "link": { - "type": "generated-index", - "title": "changelog-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Gate Api/changelog-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-output-changelog", - "label": "Returns changelog entries for changes to the business partner output stage", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-input-changelog", - "label": "Returns changelog entries for changes to the business partner input stage", - "className": "api-method post" - } - ] - }, - { - "type": "category", - "label": "stats-controller", - "link": { - "type": "generated-index", - "title": "stats-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Gate Api/stats-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/count-address-types", - "label": "countAddressTypes", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/count-partners-per-stage", - "label": "countPartnersPerStage", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/count-partners-by-sharing-state", - "label": "countPartnersBySharingState", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Gate Api/get-confidence-criteria-stats", - "label": "getConfidenceCriteriaStats", - "className": "api-method get" - } - ] - } - ] - }, - { - "type": "category", - "label": "Pool API", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/business-partner-data-management-pool" - }, - { - "type": "category", - "label": "Changelog Controller", - "link": { - "type": "generated-index", - "title": "Changelog Controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/changelog-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/search-changelog-entries", - "label": "searchChangelogEntries", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-changelog-entries", - "label": "Returns changelog entries as of a specified timestamp, optionally filtered by a list of BPNL/S/A, or business partner types", - "className": "api-method post" - } - ] - }, - { - "type": "category", - "label": "Legal Entity Controller", - "link": { - "type": "generated-index", - "title": "Legal Entity Controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/legal-entity-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entities", - "label": "Returns legal entities by different search parameters", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/update-business-partners", - "label": "Updates an existing legal entity", - "className": "api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/create-business-partners", - "label": "Creates a new legal entity", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/search-legal-entities", - "label": "searchLegalEntities", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/post-legal-entity-search", - "label": "Returns legal entities by different search parameters", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-legal-entity", - "label": "Returns a legal entity by identifier, like BPN, DUNS or EU VAT ID, specified by the identifier type", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-sites-1", - "label": "Returns all sites of a legal entity with a specific BPNL", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-addresses", - "label": "Returns all addresses of a legal entity with a specific BPNL", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "Metadata Controller", - "link": { - "type": "generated-index", - "title": "Metadata Controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/metadata-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-legal-forms", - "label": "Returns all legal forms", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/create-legal-form", - "label": "Creates a new legal form", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-identifier-types", - "label": "Returns all identifier types filtered by business partner type and country.", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/create-identifier-type", - "label": "Creates a new identifier type", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-field-quality-rules", - "label": "Get all field quality rules filtered by country (specified by its ISO 3166-1 alpha-2 country code)", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-admin-areas-level-1", - "label": "Get page of country subdivisions suitable for the administrativeAreaLevel1 address property", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "Site Controller", - "link": { - "type": "generated-index", - "title": "Site Controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/site-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-sites", - "label": "Get page of sites matching the pagination search criteria", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/update-site", - "label": "Updates an existing site", - "className": "api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/create-site", - "label": "Creates a new site", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/post-site-search", - "label": "Returns sites by an array of BPNS and/or an array of corresponding BPNL", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/post-site-search-1", - "label": "postSiteSearch_1", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-site", - "label": "Returns a site by its BPNS", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "Bpn Controller", - "link": { - "type": "generated-index", - "title": "Bpn Controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/bpn-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/find-bpns-by-identifiers", - "label": "Returns a list of identifier mappings of an identifier to a BPNL/A/S, specified by a business partner type, identifier type and identifier values", - "className": "api-method post" - } - ] - }, - { - "type": "category", - "label": "Address Controller", - "link": { - "type": "generated-index", - "title": "Address Controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Pool Api/address-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-addresses-1", - "label": "Returns addresses by different search parameters", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/update-addresses", - "label": "Updates an existing address", - "className": "api-method put" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/create-addresses", - "label": "Creates a new address", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/search-addresses", - "label": "searchAddresses", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/search-addresses-1", - "label": "Returns addresses by an array of BPNA and/or an array of corresponding BPNS and/or an array of corresponding BPNL.", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Pool Api/get-address", - "label": "Returns an address by its BPNA", - "className": "api-method get" - } - ] - } - ] - }, - { - "type": "category", - "label": "Bridge Dummy API", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Bridge Dummy Api/business-partner-data-management-bridge-dummy" - }, - { - "type": "category", - "label": "bridge-controller", - "link": { - "type": "generated-index", - "title": "bridge-controller", - "slug": "/category/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/bridge-controller" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Bridge Dummy Api/trigger-sync", - "label": "Start sync between Gate and Pool", - "className": "api-method post" - } - ] - } - ] - }, - { - "type": "category", - "label": "Cleaning Dummy API", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Cleaning Dummy Api/business-partner-data-management-cleaning-service-dummy" - } - ] - }, - { - "type": "category", - "label": "Orchestrator API", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Orchestrator Api/business-partner-data-management-orchestrator" - }, - { - "type": "category", - "label": "Task Client", - "link": { - "type": "generated-index", - "title": "Task Client", - "slug": "/category/kits/Business Partner Kit/Software Development View/Orchestrator Api/task-client" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Orchestrator Api/create-tasks", - "label": "Create new golden record tasks for given business partner data", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Orchestrator Api/search-task-states", - "label": "Search for the state of golden record tasks by task identifiers", - "className": "api-method post" - } - ] - }, - { - "type": "category", - "label": "Task Worker", - "link": { - "type": "generated-index", - "title": "Task Worker", - "slug": "/category/kits/Business Partner Kit/Software Development View/Orchestrator Api/task-worker" - }, - "items": [ - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Orchestrator Api/resolve-step-results", - "label": "Post step results for reserved golden record tasks in the given step queue", - "className": "api-method post" - }, - { - "type": "doc", - "id": "kits/Business Partner Kit/Software Development View/Orchestrator Api/reserve-tasks-for-step", - "label": "Reserve the next golden record tasks waiting in the given step queue", - "className": "api-method post" - } - ] - } - ] - }, - "kits/Business Partner Kit/Software Development View/Use Cases" - ] - }, - "kits/Business Partner Kit/Operation View", - { - "type": "category", - "label": "Success Stories", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Business Partner Kit/Success Stories" - } - ] - }, - { - "type": "category", - "label": "Architecture View", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Business Partner Kit/Documentation BPDM" - } - ] - } - ] - }, - { - "type": "category", - "label": "Circularity KIT", - "link": { - "type": "doc", - "id": "kits/Circularity_KIT/page-adoption-view" - }, - "items": [ - "kits/Circularity_KIT/Changelog Circularity KIT", - "kits/Circularity_KIT/page-adoption-view", - "kits/Circularity_KIT/page-glossary" - ] - }, - { - "type": "category", - "label": "Connector KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - "kits/Connector Kit/page_changelog", - { - "type": "category", - "label": "Adoption View", - "link": { - "type": "doc", - "id": "kits/Connector Kit/Adoption View/connector_kit_adoption_view" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Connector Kit/Adoption View" - } - ] - }, - { - "type": "category", - "label": "Development View", - "link": { - "type": "doc", - "id": "kits/Connector Kit/Development View/connector_kit_development_view_specifications" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Connector Kit/Development View" - } - ] - }, - "kits/Connector Kit/Operation View/connector_kit_operation_view" - ] - }, - { - "type": "category", - "label": "Data Chain KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - "kits/Data Chain Kit/data chain kit changelog", - "kits/Data Chain Kit/Adoption View Data Chain Kit", - "kits/Data Chain Kit/Operation View", - { - "type": "category", - "label": "Development View", - "link": { - "type": "doc", - "id": "kits/Data Chain Kit/Software Development View/Specification" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Data Chain Kit/Software Development View/Job Api" - } - ] - }, - { - "type": "category", - "label": "Documentation", - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Data Chain Kit/Documentation" - } - ] - } - ] - }, - { - "type": "category", - "label": "Demand and Capacity Management Kit", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Demand and Capacity Management Kit" - } - ] - }, - { - "type": "category", - "label": "Data Governance Kit", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - "kits/Data Governance Kit/Data Governance Kit Changelog", - "kits/Data Governance Kit/Data Governance Kit Adoption View", - { - "type": "category", - "label": "Development View", - "link": { - "type": "doc", - "id": "kits/Data Governance Kit/Software Development View/Data Governance Kit Development View" - }, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Data Governance Kit/resources/MDX Files" - } - ] - } - ] - }, - { - "type": "category", - "label": "Digital Twin KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Digital Twin Kit" - } - ] - }, - { - "type": "category", - "label": "Eco Pass KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Eco_Pass_KIT" - } - ] - }, - { - "type": "category", - "label": "ESS KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/ESS-Kit" - } - ] - }, - { - "type": "category", - "label": "Industry Core KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Industry Core Kit" - } - ] - }, - { - "type": "category", - "label": "Model Based Development and Data Processing (MDP) KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Behaviour Twin MDP Kit" - } - ] - }, - { - "type": "category", - "label": "Modular Production Kit", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Modular Production Kit" - } - ] - }, - { - "type": "category", - "label": "Manufacturing as a Service KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Manufacturing as a Service Kit" - } - ] - }, - { - "type": "category", - "label": "OSim Kit", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/OSim Kit" - } - ] - }, - { - "type": "category", - "label": "PURIS Kit", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/PURIS Kit" - } - ] - }, - { - "type": "category", - "label": "PCF Exchange KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - "kits/PCF Exchange Kit/PCF Exchange Kit Changelog", - "kits/PCF Exchange Kit/Adoption View", - "kits/PCF Exchange Kit/Operation View", - { - "type": "category", - "label": "Development View", - "link": { - "type": "generated-index" - }, - "items": [ - "kits/PCF Exchange Kit/Software Development View/Specification", - { - "type": "category", - "label": "PCF Exchange API", - "link": { - "type": "generated-index" - }, - "items": [ - { - "type": "doc", - "id": "kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/catena-x-pcf-request-endpoint" - }, - { - "type": "category", - "label": "PCF Exchange API", - "items": [ - { - "type": "doc", - "id": "kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/get-pcf", - "label": "get_pcf", - "className": "api-method get" - }, - { - "type": "doc", - "id": "kits/PCF Exchange Kit/Software Development View/pcf-exchange-api/set-pcf", - "label": "set_pcf", - "className": "api-method put" - } - ] - } - ] - } - ] - } - ] - }, - { - "type": "category", - "label": "Quality KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Quality-Kit" - } - ] - }, - { - "type": "category", - "label": "Traceability KIT", - "link": { - "type": "generated-index" - }, - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "kits/Traceability Kit" - } - ] - } - ] -} diff --git a/docs-kits_versioned_sidebars/version-24.12-sidebars.json b/docs-kits_versioned_sidebars/version-24.12-sidebars.json new file mode 100644 index 00000000000..6906c5dec53 --- /dev/null +++ b/docs-kits_versioned_sidebars/version-24.12-sidebars.json @@ -0,0 +1,763 @@ +{ + "kits": [ + { + "type": "category", + "label": "Agents Kit", + "link": { + "type": "generated-index" + }, + "collapsed": true, + "items": [ + "kits/knowledge-agents/Knowledge Agent Changelog", + "kits/knowledge-agents/adoption-view/intro", + { + "type": "category", + "label": "Development View", + "link": { + "type": "doc", + "id": "kits/knowledge-agents/development-view/architecture" + }, + "collapsed": true, + "items": [ + "kits/knowledge-agents/development-view/Arc42", + "kits/knowledge-agents/development-view/modelling", + "kits/knowledge-agents/development-view/modules", + "kits/knowledge-agents/development-view/reference", + { + "type": "category", + "label": "API", + "link": { + "type": "doc", + "id": "kits/knowledge-agents/development-view/api" + }, + "collapsed": true, + "items": [ + "kits/knowledge-agents/development-view/api/agent/getAgent", + "kits/knowledge-agents/development-view/api/agent/postAgent", + "kits/knowledge-agents/development-view/api/agent/skill/postSkill", + "kits/knowledge-agents/development-view/api/agent/skill/getSkill", + "kits/knowledge-agents/development-view/api/graph/postGraph", + "kits/knowledge-agents/development-view/api/graph/deleteGraph" + ] + } + ] + }, + { + "type": "category", + "label": "Operation View", + "link": { + "type": "doc", + "id": "kits/knowledge-agents/operation-view/deployment" + }, + "collapsed": true, + "items": [ + "kits/knowledge-agents/operation-view/agent_edc", + "kits/knowledge-agents/operation-view/provider", + "kits/knowledge-agents/operation-view/bridge", + "kits/knowledge-agents/operation-view/policy", + "kits/knowledge-agents/operation-view/testbed" + ] + } + ] + }, + { + "type": "category", + "label": "Behaviour Twin KIT", + "link": { + "type": "doc", + "id": "kits/behaviour-twin-kit/overview" + }, + "collapsed": true, + "items": [ + "kits/behaviour-twin-kit/changelog", + { + "type": "category", + "label": "Adoption View", + "link": { + "type": "doc", + "id": "kits/behaviour-twin-kit/adoption-view/overview" + }, + "items": [ + "kits/behaviour-twin-kit/adoption-view/introduction", + "kits/behaviour-twin-kit/adoption-view/architecture", + "kits/behaviour-twin-kit/adoption-view/knowledge-agent", + "kits/behaviour-twin-kit/adoption-view/versioning", + "kits/behaviour-twin-kit/adoption-view/to-be-considered", + "kits/behaviour-twin-kit/adoption-view/new-use-cases", + "kits/behaviour-twin-kit/adoption-view/terminology" + ] + }, + { + "type": "category", + "label": "Development View", + "link": { + "type": "doc", + "id": "kits/behaviour-twin-kit/development-view/overview" + }, + "items": [ + "kits/behaviour-twin-kit/development-view/contracts-and-policies", + "kits/behaviour-twin-kit/development-view/data-bindings", + "kits/behaviour-twin-kit/development-view/service-bindings", + "kits/behaviour-twin-kit/development-view/skill", + "kits/behaviour-twin-kit/development-view/guidance-and-resources" + ] + }, + { + "type": "category", + "label": "Use Cases", + "link": { + "type": "doc", + "id": "kits/behaviour-twin-kit/use-cases/overview" + }, + "items": [ + { + "type": "category", + "label": "Remaining useful Life", + "link": { + "type": "doc", + "id": "kits/behaviour-twin-kit/use-cases/rul/overview" + }, + "items": [ + { + "type": "category", + "label": "Adoption View", + "link": { + "type": "doc", + "id": "kits/behaviour-twin-kit/use-cases/rul/adoption-view/overview" + }, + "items": [ + "kits/behaviour-twin-kit/use-cases/rul/adoption-view/introduction", + "kits/behaviour-twin-kit/use-cases/rul/adoption-view/architecture", + "kits/behaviour-twin-kit/use-cases/rul/adoption-view/terminology" + ] + }, + { + "type": "category", + "label": "Development View", + "link": { + "type": "doc", + "id": "kits/behaviour-twin-kit/use-cases/rul/development-view/overview" + }, + "items": [ + "kits/behaviour-twin-kit/use-cases/rul/development-view/data-bindings", + "kits/behaviour-twin-kit/use-cases/rul/development-view/service-bindings", + "kits/behaviour-twin-kit/use-cases/rul/development-view/skill" + ] + } + ] + }, + { + "type": "category", + "label": "Health Indicator", + "link": { + "type": "doc", + "id": "kits/behaviour-twin-kit/use-cases/hi/overview" + }, + "items": [ + { + "type": "category", + "label": "Adoption View", + "link": { + "type": "doc", + "id": "kits/behaviour-twin-kit/use-cases/hi/adoption-view/overview" + }, + "items": [ + "kits/behaviour-twin-kit/use-cases/hi/adoption-view/introduction", + "kits/behaviour-twin-kit/use-cases/hi/adoption-view/architecture", + "kits/behaviour-twin-kit/use-cases/hi/adoption-view/terminology" + ] + }, + { + "type": "category", + "label": "Development View", + "link": { + "type": "doc", + "id": "kits/behaviour-twin-kit/use-cases/hi/development-view/overview" + }, + "items": [ + "kits/behaviour-twin-kit/use-cases/hi/development-view/data-bindings", + "kits/behaviour-twin-kit/use-cases/hi/development-view/service-bindings", + "kits/behaviour-twin-kit/use-cases/hi/development-view/skill" + ] + } + ] + } + ] + } + ] + }, + { + "type": "category", + "label": "Business Partner KIT", + "link": { + "type": "generated-index" + }, + "collapsed": true, + "items": [ + "kits/Business Partner Kit/Changelog", + "kits/Business Partner Kit/Adoption View", + { + "type": "category", + "label": "Development View", + "link": { + "type": "generated-index" + }, + "items": [ + "kits/Business Partner Kit/Software Development View/Specification", + { + "type": "link", + "label": "Gate API", + "href": "https://eclipse-tractusx.github.io/api-hub/bpdm/6.2.0/gate/swagger-ui/" + }, + { + "type": "link", + "label": "Pool API", + "href": "https://eclipse-tractusx.github.io/api-hub/bpdm/6.2.0/pool/swagger-ui/" + }, + { + "type": "link", + "label": "Orchestrator API", + "href": "https://eclipse-tractusx.github.io/api-hub/bpdm/6.2.0/orchestrator/swagger-ui/" + }, + "kits/Business Partner Kit/Software Development View/Use Cases" + ] + }, + "kits/Business Partner Kit/Operation View", + { + "type": "category", + "label": "Success Stories", + "link": { + "type": "generated-index" + }, + "items": [ + { + "type": "autogenerated", + "dirName": "kits/Business Partner Kit/Success Stories" + } + ] + }, + { + "type": "category", + "label": "Architecture View", + "link": { + "type": "generated-index" + }, + "items": [ + { + "type": "autogenerated", + "dirName": "kits/Business Partner Kit/Documentation BPDM" + } + ] + } + ] + }, + { + "type": "category", + "label": "Circularity KIT", + "link": { + "type": "doc", + "id": "kits/Circularity_KIT/page-adoption-view" + }, + "items": [ + "kits/Circularity_KIT/Changelog Circularity KIT", + "kits/Circularity_KIT/page-adoption-view", + "kits/Circularity_KIT/page-glossary" + ] + }, + { + "type": "category", + "label": "Connector KIT", + "link": { + "type": "generated-index" + }, + "collapsed": true, + "items": [ + "kits/Connector Kit/page_changelog", + { + "type": "category", + "label": "Adoption View", + "link": { + "type": "doc", + "id": "kits/Connector Kit/Adoption View/connector_kit_adoption_view" + }, + "items": [ + { + "type": "autogenerated", + "dirName": "kits/Connector Kit/Adoption View" + } + ] + }, + { + "type": "category", + "label": "Development View", + "link": { + "type": "doc", + "id": "kits/Connector Kit/Development View/connector_kit_development_view_specifications" + }, + "items": [ + { + "type": "autogenerated", + "dirName": "kits/Connector Kit/Development View" + } + ] + }, + "kits/Connector Kit/Operation View/connector_kit_operation_view" + ] + }, + { + "type": "category", + "label": "Data Chain KIT", + "link": { + "type": "generated-index" + }, + "collapsed": true, + "items": [ + "kits/Data Chain Kit/data chain kit changelog", + "kits/Data Chain Kit/Adoption View Data Chain Kit", + "kits/Data Chain Kit/Operation View", + { + "type": "category", + "label": "Development View", + "link": { + "type": "doc", + "id": "kits/Data Chain Kit/Software Development View/Specification" + }, + "items": [ + { + "type": "autogenerated", + "dirName": "kits/Data Chain Kit/Software Development View/Job Api" + } + ] + }, + { + "type": "category", + "label": "Documentation", + "items": [ + { + "type": "autogenerated", + "dirName": "kits/Data Chain Kit/Documentation" + } + ] + } + ] + }, + { + "type": "category", + "label": "Demand and Capacity Management KIT", + "link": { + "type": "doc", + "id": "kits/Demand and Capacity Management Kit/adoption-view/overview" + }, + "collapsed": true, + "items": [ + "kits/Demand and Capacity Management Kit/changelog", + { + "type": "category", + "label": "Adoption View", + "link": { + "type": "doc", + "id": "kits/Demand and Capacity Management Kit/adoption-view/overview" + }, + "items": [ + "kits/Demand and Capacity Management Kit/adoption-view/glossary", + { + "type": "category", + "label": "Use Case", + "link": { + "type": "generated-index" + }, + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "kits/Demand and Capacity Management Kit/adoption-view/use-case" + } + ] + }, + "kits/Demand and Capacity Management Kit/adoption-view/onboarding", + "kits/Demand and Capacity Management Kit/adoption-view/qna", + "kits/Demand and Capacity Management Kit/adoption-view/foss-app" + ] + }, + { + "type": "category", + "label": "Development View", + "link": { + "type": "doc", + "id": "kits/Demand and Capacity Management Kit/development-view/overview" + }, + "items": [ + "kits/Demand and Capacity Management Kit/development-view/model-WeekBasedMaterialDemand", + "kits/Demand and Capacity Management Kit/development-view/model-WeekBasedCapacityGroup", + "kits/Demand and Capacity Management Kit/development-view/model-IdBasedRequestForUpdate", + "kits/Demand and Capacity Management Kit/development-view/model-IdBasedComment", + "kits/Demand and Capacity Management Kit/development-view/api-WeekBasedMaterialDemand", + { + "type": "category", + "label": "API Specification", + "link": { + "type": "generated-index" + }, + "items": [ + { + "type": "doc", + "id": "kits/Demand and Capacity Management Kit/development-view/plugin-generated-material-demand-api/catena-x-dcm-week-based-material-demand" + }, + { + "type": "category", + "label": "WeekBasedMaterialDemand", + "link": { + "type": "generated-index", + "title": "WeekBasedMaterialDemand", + "slug": "/category/kits/Demand and Capacity Management Kit/development-view/plugin-generated-material-demand-api/week-based-material-demand" + }, + "items": [ + { + "type": "doc", + "id": "kits/Demand and Capacity Management Kit/development-view/plugin-generated-material-demand-api/post-week-based-material-demand", + "label": "postWeekBasedMaterialDemand", + "className": "api-method post" + } + ] + } + ] + }, + "kits/Demand and Capacity Management Kit/development-view/api-WeekBasedCapacityGroup", + { + "type": "category", + "label": "API Specification", + "link": { + "type": "generated-index" + }, + "items": [ + { + "type": "doc", + "id": "kits/Demand and Capacity Management Kit/development-view/plugin-generated-capacity-group-api/catena-x-dcm-week-based-capacity-group" + }, + { + "type": "category", + "label": "WeekBasedCapacityGroup", + "link": { + "type": "generated-index", + "title": "WeekBasedCapacityGroup", + "slug": "/category/kits/Demand and Capacity Management Kit/development-view/plugin-generated-capacity-group-api/week-based-capacity-group" + }, + "items": [ + { + "type": "doc", + "id": "kits/Demand and Capacity Management Kit/development-view/plugin-generated-capacity-group-api/post-week-based-capacity-group", + "label": "postWeekBasedCapacityGroup", + "className": "api-method post" + } + ] + } + ] + }, + "kits/Demand and Capacity Management Kit/development-view/api-IdBasedRequestForUpdate", + { + "type": "category", + "label": "API Specification", + "link": { + "type": "generated-index" + }, + "items": [ + { + "type": "doc", + "id": "kits/Demand and Capacity Management Kit/development-view/plugin-generated-rfu-api/catena-x-dcm-id-based-request-for-update" + }, + { + "type": "category", + "label": "IdBasedRequestForUpdate", + "link": { + "type": "generated-index", + "title": "IdBasedRequestForUpdate", + "slug": "/category/kits/Demand and Capacity Management Kit/development-view/plugin-generated-rfu-api/id-based-request-for-update" + }, + "items": [ + { + "type": "doc", + "id": "kits/Demand and Capacity Management Kit/development-view/plugin-generated-rfu-api/post-id-based-request-for-update", + "label": "postIdBasedRequestForUpdate", + "className": "api-method post" + } + ] + } + ] + }, + "kits/Demand and Capacity Management Kit/development-view/api-IdBasedComment", + { + "type": "category", + "label": "API Specification", + "link": { + "type": "generated-index" + }, + "items": [ + { + "type": "doc", + "id": "kits/Demand and Capacity Management Kit/development-view/plugin-generated-comment-api/catena-x-dcm-id-based-comment" + }, + { + "type": "category", + "label": "IdBasedComment", + "link": { + "type": "generated-index", + "title": "IdBasedComment", + "slug": "/category/kits/Demand and Capacity Management Kit/development-view/plugin-generated-comment-api/id-based-comment" + }, + "items": [ + { + "type": "doc", + "id": "kits/Demand and Capacity Management Kit/development-view/plugin-generated-comment-api/post-id-based-comment", + "label": "postIdBasedComment", + "className": "api-method post" + } + ] + } + ] + }, + "kits/Demand and Capacity Management Kit/development-view/api-aas", + "kits/Demand and Capacity Management Kit/development-view/test-customer", + "kits/Demand and Capacity Management Kit/development-view/test-supplier" + ] + }, + { + "type": "category", + "label": "Architecture View", + "link": { + "type": "doc", + "id": "kits/Demand and Capacity Management Kit/architecture-view/overview" + }, + "items": [ + "kits/Demand and Capacity Management Kit/architecture-view/dependencies" + ] + }, + "kits/Demand and Capacity Management Kit/operation-view" + ] + }, + { + "type": "category", + "label": "Data Governance Kit", + "link": { + "type": "generated-index" + }, + "collapsed": true, + "items": [ + "kits/Data Governance Kit/Data Governance Kit Changelog", + "kits/Data Governance Kit/Data Governance Kit Adoption View", + { + "type": "category", + "label": "Development View", + "link": { + "type": "doc", + "id": "kits/Data Governance Kit/Software Development View/Data Governance Kit Development View" + }, + "items": [ + { + "type": "autogenerated", + "dirName": "kits/Data Governance Kit/resources/MDX Files" + } + ] + } + ] + }, + { + "type": "category", + "label": "Digital Twin KIT", + "link": { + "type": "generated-index" + }, + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "kits/Digital Twin Kit" + } + ] + }, + { + "type": "category", + "label": "Eco Pass KIT", + "link": { + "type": "generated-index" + }, + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "kits/Eco_Pass_KIT" + } + ] + }, + { + "type": "category", + "label": "ESS KIT", + "link": { + "type": "generated-index" + }, + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "kits/ESS-Kit" + } + ] + }, + { + "type": "category", + "label": "Industry Core KIT", + "link": { + "type": "generated-index" + }, + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "kits/Industry Core Kit" + } + ] + }, + { + "type": "category", + "label": "Model Based Development and Data Processing (MDP) KIT", + "link": { + "type": "generated-index" + }, + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "kits/Behaviour Twin MDP Kit" + } + ] + }, + { + "type": "category", + "label": "Modular Production Kit", + "link": { + "type": "generated-index" + }, + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "kits/Modular Production Kit" + } + ] + }, + { + "type": "category", + "label": "Manufacturing as a Service KIT", + "link": { + "type": "generated-index" + }, + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "kits/Manufacturing as a Service Kit" + } + ] + }, + { + "type": "category", + "label": "OSim Kit", + "link": { + "type": "generated-index" + }, + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "kits/OSim Kit" + } + ] + }, + { + "type": "category", + "label": "PURIS Kit", + "link": { + "type": "generated-index" + }, + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "kits/PURIS Kit" + } + ] + }, + { + "type": "category", + "label": "Supply Chain Disruption Notifications KIT", + "link": { + "type": "generated-index" + }, + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "kits/Supply Chain Disruption Notifications KIT" + } + ] + }, + { + "type": "category", + "label": "PCF Exchange KIT", + "link": { + "type": "generated-index" + }, + "collapsed": true, + "items": [ + "kits/PCF Exchange Kit/PCF Exchange Kit Changelog", + "kits/PCF Exchange Kit/Adoption View", + "kits/PCF Exchange Kit/Operation View", + { + "type": "category", + "label": "Development View", + "link": { + "type": "generated-index" + }, + "items": [ + "kits/PCF Exchange Kit/Software Development View/Specification", + { + "type": "category", + "label": "PCF Exchange API", + "link": { + "type": "generated-index" + }, + "items": [] + } + ] + } + ] + }, + { + "type": "category", + "label": "Quality KIT", + "link": { + "type": "generated-index" + }, + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "kits/Quality-Kit" + } + ] + }, + { + "type": "category", + "label": "Traceability KIT", + "link": { + "type": "generated-index" + }, + "collapsed": true, + "items": [ + { + "type": "autogenerated", + "dirName": "kits/Traceability Kit" + } + ] + } + ] +} diff --git a/docs-kits_versions.json b/docs-kits_versions.json index 1dbdc029482..aa9f2ad636f 100644 --- a/docs-kits_versions.json +++ b/docs-kits_versions.json @@ -1,4 +1,4 @@ [ - "24.08", - "24.05" + "24.12", + "24.08" ] diff --git a/docs/release/trg-8/trg-8-03.md b/docs/release/trg-8/trg-8-03.md index cbba14fd480..1d50082bcc3 100644 --- a/docs/release/trg-8/trg-8-03.md +++ b/docs/release/trg-8/trg-8-03.md @@ -22,17 +22,36 @@ Configure your GitHub Actions to include: - `schedule`: Schedule the workflow to run at least once a week with `0 0 * * 0`. - `push` and `pull_request`: Activate the workflow on both push and pull request events targeting the branch that contains the code for the currently supported version, which may not necessarily be the main branch. This is the branch from which new releases will be made. -Note: `extra_args: --filter-entropy=4 --results=verified,unknown` +Note: `extra_args: --filter-entropy=4 --results=verified,unknown --only-verified` -Including `extra_args: --filter-entropy=4 --results=verified,unknown` in the GitHub Actions workflow ensures that TruffleHog focuses on detecting high-entropy strings, which are more likely to be sensitive information such as passwords or API keys. This setup also instructs TruffleHog to report both verified secrets and potential but unverified secrets, providing a comprehensive security scan that helps identify and address all possible vulnerabilities in the code. +Including `extra_args: --filter-entropy=4 --results=verified,unknown --only-verified` in the GitHub Actions workflow ensures that TruffleHog focuses on detecting high-entropy strings, which are more likely to be sensitive information such as passwords or API keys. This setup also instructs TruffleHog to report both verified secrets and potential but unverified secrets, providing a comprehensive security scan that helps identify and address all possible vulnerabilities in the code. The `--only-verified` flag reduces the appearance of false positives, because only the verified secrets will appear. Including `run: exit 1` in a step of a GitHub Actions workflow, as demonstrated below, commands the workflow to halt execution. This ensures that should TruffleHog uncover any secrets during its scan, the workflow promptly terminates in failure. GitHub Actions allows you to define workflows to automatically run TruffleHog scans on your code. You'll see the output that triggered the failure directly in the logs. -Here’s how you can set it up: +To comply with this TRG, simply create a file under the path: `.github/workflows/trufflehog.yaml` with the following content: ```yml +############################################################### +# Copyright (c) 2024 Contributors to the Eclipse Foundation +# +# See the NOTICE file(s) distributed with this work for additional +# information regarding copyright ownership. +# +# This program and the accompanying materials are made available under the +# terms of the Apache License, Version 2.0 which is available at +# https://www.apache.org/licenses/LICENSE-2.0. +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. +# +# SPDX-License-Identifier: Apache-2.0 +############################################################### + name: "TruffleHog" on: @@ -64,13 +83,13 @@ jobs: - name: TruffleHog OSS id: trufflehog - uses: trufflesecurity/trufflehog@main + uses: trufflesecurity/trufflehog@7e78ca385fb82c19568c7a4b341c97d57d9aa5e1 continue-on-error: true with: path: ./ # Scan the entire repository base: "${{ github.event.repository.default_branch }}" # Set base branch for comparison (pull requests) - extra_args: --filter-entropy=4 --results=verified,unknown --debug - + extra_args: --filter-entropy=4 --results=verified,unknown --debug --only-verified + - name: Scan Results Status if: steps.trufflehog.outcome == 'failure' run: exit 1 # Set workflow run to failure if TruffleHog finds secrets diff --git a/src/pages/CHANGELOG.md b/src/pages/CHANGELOG.md index f1716dbc9be..e72e8f52c35 100644 --- a/src/pages/CHANGELOG.md +++ b/src/pages/CHANGELOG.md @@ -8,6 +8,72 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). Tractus-X operates on YY.0M.MICRO [Calendar Versioning](https://calver.org/) for overarching, quarterly Releases. Semantic Versioning remains unchanged for all components. +## [24.12] - 2024-12-02 + +Implemented features can be found [here](https://github.com/orgs/eclipse-tractusx/projects/26/views/33?filterQuery=milestone%3A%2224.12%22+-label%3Ametadata+is%3Aclosed++status%3ADone) + +### Updated + +| Component | Helm Chart (s) | App-/KIT Version (s) | +| :-------- | :-------------: | :------------------: | +| [BPDM KIT](https://eclipse-tractusx.github.io/docs-kits/category/business-partner-kit) | n/a | [7.0.0](https://eclipse-tractusx.github.io/docs-kits/kits/Business%20Partner%20Kit/Changelog) | +| [Circularity KIT](https://eclipse-tractusx.github.io/docs-kits/kits/Circularity_KIT/page-adoption-view) | n/a | [1.3.0](https://eclipse-tractusx.github.io/docs-kits/kits/Data%20Chain%20Kit/data%20chain%20kit%20changelog) | +| [DCM Kit](https://eclipse-tractusx.github.io/docs-kits/kits/Demand%20and%20Capacity%20Management%20Kit/adoption-view/overview) | n/a | [1.2.0](https://eclipse-tractusx.github.io/docs-kits/kits/Demand%20and%20Capacity%20Management%20Kit/changelog) | +| [Digital Twin Registry](https://github.com/eclipse-tractusx/sldt-digital-twin-registry) | digital-twin-registry: [0.6.2](https://github.com/eclipse-tractusx/sldt-digital-twin-registry/releases/tag/digital-twin-registry-0.6.2) | [0.6.2](https://github.com/eclipse-tractusx/sldt-digital-twin-registry/releases/tag/v0.6.2) | +| [Discovery Finder](https://github.com/eclipse-tractusx/sldt-discovery-finder) | discoveryfinder: [0.4.2](https://github.com/eclipse-tractusx/sldt-discovery-finder/releases/tag/discoveryfinder-0.4.2) | [0.5.2](https://github.com/eclipse-tractusx/sldt-discovery-finder/releases/tag/v0.5.2) | +| [Discovery Service (BPN Finder)](https://github.com/eclipse-tractusx/sldt-bpn-discovery) | bpndiscovery: [0.4.2](https://github.com/eclipse-tractusx/sldt-bpn-discovery/releases/tag/bpndiscovery-0.4.2) | [0.5.2](https://github.com/eclipse-tractusx/sldt-bpn-discovery/releases/tag/v0.5.2) | +| [Eclipse Data Space Connector (Tractus-X EDC)](https://github.com/eclipse-tractusx/tractusx-edc) | [0.8.0](https://github.com/eclipse-tractusx/tractusx-edc/releases/tag/0.8.0) | [0.8.0](https://github.com/eclipse-tractusx/tractusx-edc/releases/tag/0.8.0) | +| [Golden Record Business Partner Number (BPN) Service](https://github.com/eclipse-tractusx/bpdm) | bpdm: [5.2.0](https://github.com/eclipse-tractusx/bpdm/releases/tag/bpdm-5.2.0) | [6.2.0](https://github.com/eclipse-tractusx/bpdm/releases/tag/v6.2.0) | +| [Identity and Access Management (IAM)](https://github.com/eclipse-tractusx/portal-iam) | centralidp: [4.0.0](https://github.com/eclipse-tractusx/portal-iam/releases/tag/centralidp-4.0.0)
          sharedidp: [4.0.0](https://github.com/eclipse-tractusx/portal-iam/releases/tag/sharedidp-4.0.0) | keycloak: [25.0.6](https://www.keycloak.org/docs/latest/release_notes/index.html#keycloak-25-0-0) | +| [Industry Core KIT](https://eclipse-tractusx.github.io/docs-kits/category/industry-core-kit) | n/a | [1.3.0](https://eclipse-tractusx.github.io/docs-kits/kits/Industry%20Core%20Kit/Industry%20Core%20Kit%20Changelog) | +| [Knowledge Agents](https://github.com/eclipse-tractusx/knowledge-agents) | remoting-agent: [1.14.24](https://github.com/eclipse-tractusx/knowledge-agents/releases/tag/remoting-agent-1.14.24)
          provisioning-agent: [1.14.24](https://github.com/eclipse-tractusx/knowledge-agents/releases/tag/provisioning-agent-1.14.24)
          conforming-agent: [1.14.24](https://github.com/eclipse-tractusx/knowledge-agents/releases/tag/conforming-agent-1.14.24)
          matchmaking-agent: [1.14.24](https://github.com/eclipse-tractusx/knowledge-agents/releases/tag/matchmaking-agent-1.14.24) | remoting-agent: [1.14.24](https://github.com/eclipse-tractusx/knowledge-agents/releases/tag/v1.14.24)
          provisioning-agent: [1.14.24](https://github.com/eclipse-tractusx/knowledge-agents/releases/tag/v1.14.24)
          conforming-agent: [1.14.24](https://github.com/eclipse-tractusx/knowledge-agents/releases/tag/v1.14.24)
          matchmaking-agent: [1.14.24](https://github.com/eclipse-tractusx/knowledge-agents/releases/tag/v1.14.24) | +| [(Knowledge) Agents KIT](https://eclipse-tractusx.github.io/docs-kits/category/agents-kit) | n/a | [1.2.0](https://eclipse-tractusx.github.io/docs-kits/kits/knowledge-agents/Knowledge%20Agent%20Changelog) | +| [Policy Hub](https://github.com/eclipse-tractusx/policy-hub) | policy-hub: [1.2.0](https://github.com/eclipse-tractusx/policy-hub/releases/tag/policy-hub-1.2.0) | [1.2.0](https://github.com/eclipse-tractusx/policy-hub/releases/tag/v1.2.0) | +| [Portal](https://github.com/eclipse-tractusx/portal) | portal: [2.3.0](https://github.com/eclipse-tractusx/portal/releases/tag/portal-2.3.0) | registration: [2.1.0](https://github.com/eclipse-tractusx/portal-frontend-registration/releases/tag/v2.1.0)
          frontend: [2.3.0](https://github.com/eclipse-tractusx/portal-frontend/releases/tag/v2.3.0)
          backend: [2.3.0](https://github.com/eclipse-tractusx/portal-backend/releases/tag/v2.3.0)
          assets: [2.3.0](https://github.com/eclipse-tractusx/portal-assets/releases/tag/v2.3.0) | +| [Self Description (SD) Factory](https://github.com/eclipse-tractusx/sd-factory) | sdfactory: [2.1.22](https://github.com/eclipse-tractusx/sd-factory/releases/tag/sdfactory-2.1.22) | [v2.1.14](https://github.com/eclipse-tractusx/sd-factory/releases/tag/v2.1.14) | +| [Semantic Hub](https://github.com/eclipse-tractusx/sldt-semantic-hub) | semantic-hub: [0.4.2](https://github.com/eclipse-tractusx/sldt-semantic-hub/releases/tag/semantic-hub-0.4.2) | [0.5.2](https://github.com/eclipse-tractusx/sldt-semantic-hub/releases/tag/v0.5.2) | +| [SSI Authority & Schema Registry](https://github.com/eclipse-tractusx/ssi-authority-schema-registry) | ssi-asr: [1.1.0](https://github.com/eclipse-tractusx/ssi-authority-schema-registry/releases/tag/ssi-asr-1.1.0) | [1.1.0](https://github.com/eclipse-tractusx/ssi-authority-schema-registry/releases/tag/v1.1.0) | +| [SSI Credential Issuer](https://github.com/eclipse-tractusx/ssi-credential-issuer) | ssi-credential-issuer: [1.2.0](https://github.com/eclipse-tractusx/ssi-credential-issuer/releases/tag/ssi-credential-issuer-1.2.0) | [1.2.0](https://github.com/eclipse-tractusx/ssi-credential-issuer/releases/tag/v1.2.0) | +| [Traceability KIT](https://eclipse-tractusx.github.io/docs-kits/category/traceability-kit) | n/a | [6.0.0](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Traceability%20Kit%20Changelog) | + +### Known Knowns + +- All not listed products and KITs have not been updated and are based on the release 24.08 + - These products were not part of the e2e testing phase + - And are not tested with the current EDC version 0.8.0 +- [BPN DID Resolution Service (BDRS)](https://github.com/eclipse-tractusx/bpn-did-resolution-service) is unchanged but was part of the testing phase +- [PURIS](https://github.com/eclipse-tractusx/puris) is unchanged but regression tests were executed +- [Knowledge Agents](https://github.com/eclipse-tractusx/knowledge-agents) was updated to version 0.8.0 but only tested with the EDC release candidate 0.8.0-RC4 +- This Tractus-X release does not include a Managed Identity Wallet (MIW). The development team decided on a temporary bridging solution, based on a commercial application, to test and ship Release 24.08. Without implementing this interim solution, participants will not be able to fully utilize this Tractus-X release in consequence. +- For E2E Testing, the [2.1.1](https://github.com/SAP/ssi-dim-middle-layer/releases/tag/v2.1.1) of the [SSI DIM Middle Layer](https://github.com/SAP/ssi-dim-middle-layer) was used - this component is FOSS but the currently used wallet (see previous item) is not. +- Security concern about exposed technical users when subscribing BPDM services over the Portal -> see [according issue](https://github.com/eclipse-tractusx/sig-release/issues/987) +- BPNL Group Validation for a Policy does not allow a Collection as a rightOperand -> see [Issue](https://github.com/eclipse-tractusx/tractusx-edc/issues/1674) +- EDR token refresh implementation is inconsistent and deviates from the documentation -> see [Issue](https://github.com/eclipse-tractusx/tractusx-edc/issues/1565) +- Consumer-Asset with the same ID as a Provider-Asset Cannot Be Deleted After Contract Negotiation -> see [Issue](https://github.com/eclipse-edc/Connector/issues/4583) +- Termination of pull transfer process from consumer side does not succeed -> see [Issue](https://github.com/eclipse-edc/Connector/issues/4592) +- Fatal error while resume PULL transfer process -> see [Issue](https://github.com/eclipse-edc/Connector/issues/4591) + +### Runtime + +The release has been tested + +- on [Kubernetes](https://en.wikipedia.org/wiki/Kubernetes) versions: `1.28.9` +- with [PostgreSQL](https://en.wikipedia.org/wiki/PostgreSQL) versions: `15.2.1.` + +Note: Tractus-X EDC has been tested on both Postgresql versions: 15.x and 16.x + +### Using helm with central helm registry + +You can search all released helm charts with the following commands: + +```shell +helm repo add tractusx-dev https://eclipse-tractusx.github.io/charts/dev +helm repo update tractusx-dev +helm search repo tractusx-dev --versions +``` + +For installation details, please see the referenced Repositories / Releases. + ## [24.08] - 2024-08-05 ### Added