The returned value from the calculation services is SAMM specified. The app can provide another representation.| +|Loading Data | A data source at the Data Provider that provides the loading data and other vehicle data that are needed for the RuL calculation.
It can be accessed by the knowledge agent via data bindings.| +|RuL Service| A RuL calculation service at the Service Provider. It accepts input data from the Data Provider, calculates the RuL value and returns it.| + +### Knowledge Agent components +|Subsystem|Description| +|---------|-----------| +|Matchmaking Agent|This component supports SparQL to traverse the federated data space as a large data structure. It interacts with the EDC.
- The provider's Matchmaking Agent will be activated by its EDC. Therefore, the EDC must offer a Graph Asset (variant of ordinary data assets in the Catena-X EDC standard).
- The consumer's Matchmaking Agent interacts with its EDC to negotiate and perform the transfer of Sub-Skills to other dataspace participants.
Implementation details: For data bindings, OnTop is used. For service bindings, RDF4J is used.| +|Ontology|The ontology is a formal representation of knowledge that captures concepts, relationships, and properties. It allows a shared understanding and reasoning about the respective domain.
It must be hosted in a way that all participants can access it. Currently, the ontology is hosted at GitHub.| +|Skill/Sub-Skill| The Skill describes, what to do (which data have to be connected, transferred and so on).| + +### Catena-X Core Services (except Knowledge Agent components) +|Subsystem|Description| +|---------|-----------| +|Eclipse Dataspace Components (EDC)|The Connector of the Eclipse Dataspace Components provides a framework for sovereign, inter-organizational data exchange. It implements the International Data Spaces standard (IDS) as well as relevant protocols associated with GAIA-X. The connector is designed in an extensible way in order to support alternative protocols and integrate in various ecosystems.| + + + +## Business Process +Two different cases need to be specified. + +### Service Consumer does not have input data for RuL Service available; RuL calculation based on vin. + +- Service Consumer provides Vin to OEM + +- OEM procures vin specific service inputs from vehicle + +- OEM forwards input to service providers + +- Service providers calculate RuL values + +- RuL results are provided to the Service consumer via the OEM + +### Service Consumer has input data for RuL Service available: + +- Service consumer needs to collect or generate load/input for RuL calculation, e.g. through driver questionnaire. +- Service provider uses the input to estimate RuL and send it back to Service Consumer + +### Access Policies +To decide which company has access to the data assets, access policy should be used. It is maybe possible to skip access policies, but this will made all data assets public available in the Catena-X network and is not recommended. Therefore, every asset should be protected and only be made available for specific companies, identified through their business partner number (BPN). In the near future, other access policies will be introduced like a company role and attribute based policy. Further details can be found in this page of the [EDC](https://github.com/eclipse-tractusx/tractusx-edc/tree/main/edc-extensions/business-partner-validation). + +### Usage policies +Use case specific credentials exist and will be mandatory. Their documentation will be available after SSI release. +A Behaviour Twin "Use Case Rahmenbedingung" which covers the business process of the app will be available after SSI release. +This Rahmenbedingung document can be referenced in the usage policies, and therefore limit Data & Service access to Behaviour Twin participants. + + +## Semantic Models & Standards + +Our relevant standards can be downloaded from the official [Catena-X Standard Library](https://catena-x.net/de/standard-library). + + +- [CX - 0056 Semantic Model: ClassifiedLoadSpectrum:](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Archiv/Update_Juli_23_R_3.2/CX-0056-SemanticModelClassifiedLoadSpectrum.pdf) + + _The data model “ClassifiedLoadSpectrum” represents the load data of a vehicle component. The load spectrum is a data set that represents the aggregated loading of a component. Any kind of loading is covered: loading can be force or torque or revolutions or temperature or event or similar. The load data is classified and counted with specific counting methods. This standard defines the format for the counted load data, so that the exchange of load data between different partners is possible._ + + +- [CX - 0057 Semantic Model: RemainingUsefulLife:](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Archiv/Update_Juli_23_R_3.2/CX-0057-SemanticModelRemainingUsefulLife.pdf) + + _The data model Remaining Useful Life contains the two relevant values to describe the expected remaining life of a vehicle, remaining running distance and remaining operating hours. The data model is used for vehicle parts and vehicle components which cannot be visually assessed but need the loading information combined with a damage model to estimate the health of the component._ + + +- [CX - 0058 API: Endurance Predictor:](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Archiv/Update_Juli_23_R_3.2/CX-0058-APIEndurancePredictor.pdf) + + _This documentation describes the technical specification to enable the request of standardized "Remaining Useful Life (RUL)" data at component level of a concrete vehicle instance ("as built") and its integration into the Eclipse Dataspace connector (EDC). It sets the standards for the API for the usage of services which calculate a so-called "remaining useful life value" (RUL-value, see CX-0057). This standard covers exclusively the definition of the specific API endpoint._ + +- [CX - 0059 Triangle Behavioral Twin Endurance Predictor:](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_September23/CX-0059-TriangleBehavioralTwinEndurancePredictorService-v.1.1.0.pdf) + + _This triangle document acts as a bracket for single standards required to request "Remaining Useful Life (RUL)" data as well as providing a service for its calculation at a component level.Included are APIs to be provided by the service provider and the service requestor, as well as aspect models for the respective payloads being exchanged in an asynchronous pattern leveraging those APIs._ + +- [CX - 0088 Aspect Model User Estimated Loading:](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_September23/CX-0088-AspectModel_UserEstimatedLoading_v1.0.0.pdf) + + _The semantic model for "User Estimated Loading" is the structured input for the Endurance Estimator Service. This Service should be used by normal customer without special knowledge of technical details of the car or access to ECU data. The input is basic data about the vehicle and information about the usage, previous usage as well as future usage._ + +- [CX - 0089 Triangle BehaviourTwin EnduranceEstimator:](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_September23/CX-0089-TriangleBehavioralTwinEnduranceEstimator_v.1.0.0.pdf) + + _This triangle document acts as a bracket for single standards required to request "Remaining Useful Life (RUL)" data as well as providing a service for its estimation. Included are APIs to be provided by the service provider and the service requestor, as well as aspect models for the respective payloads being exchanged in an asynchronous pattern leveraging those APIs._ + +- [CX - 0090 API EnduranceEstimator:](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_September23/CX-0090-APIEnduranceEstimator_v1.0.0.pdf) + + _This documentation describes the technical specification to enable the request of standardized "Remaining Useful Life (RUL)" data for "User Estimated Loading" and its integration into the Eclipse Dataspace connector (EDC). It sets the standards for the API for the usage of services which estimates a so-called "remaining useful life value" (RUL-value, see CX-0057) using estimated load data ("User Estimated Loading", see CX-0088). This standard covers exclusively the illustration of the specific API endpoints._ + + + diff --git a/docs-kits_versioned_docs/version-23.12/kits/Behaviour Twin RuL Kit/page_changelog.md b/docs-kits_versioned_docs/version-23.12/kits/Behaviour Twin RuL Kit/page_changelog.md new file mode 100644 index 00000000000..5cf5636a2df --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Behaviour Twin RuL Kit/page_changelog.md @@ -0,0 +1,41 @@ +--- +id: Changelog Remaining Useful Life Kit +title: Changelog +description: 'Remaining Useful Life Kit' +sidebar_position: 1 +--- + + + +### Remaining Useful Life Kit + +All notable changes to this Kit will be documented in this file. + + +## [0.1.1] - 2023-09-07 + +### Added + +- Adoption View: added license notice section. + +### Changed + +- Unified KIT name in menues/sidebars. + +### Removed + +- Removed unused page "Documentation". + +## [0.1.0] - 2023-09-07 + +### Added + +- Initial version of the KIT including adoption, operation and development view. + +### Changed + +- ./. + +### Removed + +- ./. diff --git a/docs-kits_versioned_docs/version-23.12/kits/Behaviour Twin RuL Kit/page_software-operation-view.md b/docs-kits_versioned_docs/version-23.12/kits/Behaviour Twin RuL Kit/page_software-operation-view.md new file mode 100644 index 00000000000..1c5fdd693a2 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Behaviour Twin RuL Kit/page_software-operation-view.md @@ -0,0 +1,165 @@ +--- +id: Operation View Remaining Useful Life Kit +title: Operation View +description: 'Remaining Useful Life Kit' +sidebar_position: 3 +--- + + + +### Remaining Useful Life Kit + + + +Based on the information provided in this KIT, it is possible to provide and/or consume services defined as Agent Skills based on the Behaviour Twin standards (ontology, SAMM models). + +Depending on the role within the RuL Use Case, different Knowledge Agent components are needed. +The needed information regarding Agent Kit components, their deployment and configuration, refer to the *Agent Kit Operation View Section*. + +# Deployment of Graph Assets + +## Data Provider Graph Asset +If you are engaged as a data provider within the RuL KIT, you can mount your data source to the federated knowledge graph as Graph Asset. +Beside the policy and contract definition, a Graph Asset registration is needed. It can like following example with a baseUrl set to the sparql endpoint of your provision agent: +```json +{ + "@context": { + "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#", + "rdfs": "http://www.w3.org/2000/01/rdf-schema#", + "cx-common": "https://w3id.org/catenax/ontology/common#", + "sh": "http://www.w3.org/ns/shacl#", + "edc": "https://w3id.org/edc/v0.0.1/ns/" + }, + "asset": { + "@type": "Asset", + "@id": "GraphAsset?oem=BehaviourTwinReliability", + "properties": { + "name": "OEM portion of the Behaviour Twin Reliablity Testdataset.", + "name@de": "OEM Anteil an den Verhaltenszwilling ReliabilityTestdaten.", + "description": "A graph asset/offering mounting Carena-X Testdata for Behaviour Twin.", + "description@de": "Ein Graph Angebot welches Catena-X Testdaten beinhaltet.", + "version": "CX_RuL_Testdata_v1.0.0", + "contenttype": "application/json, application/xml", + "cx-common:publishedUnderContract": "Contract?oem=Graph", + "rdf:type": "cx-common:GraphAsset", + "rdfs:isDefinedBy": "
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->>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 + Gate-->>SharingMember: Upserted Business Partner + + 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 + +``` + +## 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 + +## 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? +- ... + +### **Lack on Developer Resources** + +- Too less developer resources in contrast to the expectations that the BPDM Product and its Golden Record will be a foundation component within Catena-X. + +### **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" + +### **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. diff --git a/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/Software Development View/BPDM Bridge Dummy.postman_collection.json b/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/Software Development View/BPDM Bridge Dummy.postman_collection.json new file mode 100644 index 00000000000..cc3a88a65ab --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/Software Development View/BPDM Bridge Dummy.postman_collection.json @@ -0,0 +1,109 @@ +{ + "info": { + "_postman_id": "7b41c91f-d0b5-46c5-aeba-24dfec0c8d58", + "name": "BPDM Bridge Dummy", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "_exporter_id": "26818013" + }, + "item": [ + { + "name": "Bridge Sync", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "{{Bridge-Host}}/api/bridge/sync", + "host": [ + "{{Bridge-Host}}" + ], + "path": [ + "api", + "bridge", + "sync" + ] + } + }, + "response": [] + } + ], + "auth": { + "type": "oauth2", + "oauth2": [ + { + "key": "accessTokenUrl", + "value": "{{Keycloak-Host}}/auth/realms/CX-Central/protocol/openid-connect/token", + "type": "string" + }, + { + "key": "client_authentication", + "value": "body", + "type": "string" + }, + { + "key": "clientSecret", + "value": "{{Bridge-Client-Secret}}", + "type": "string" + }, + { + "key": "clientId", + "value": "{{Bridge-Client-ID}}", + "type": "string" + }, + { + "key": "tokenName", + "value": "BPDM Bridge Token {{Environment}}", + "type": "string" + }, + { + "key": "refreshRequestParams", + "value": [], + "type": "any" + }, + { + "key": "tokenRequestParams", + "value": [], + "type": "any" + }, + { + "key": "authRequestParams", + "value": [], + "type": "any" + }, + { + "key": "challengeAlgorithm", + "value": "S256", + "type": "string" + }, + { + "key": "grant_type", + "value": "client_credentials", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } + } + ] +} \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/Software Development View/BPDM Cleaning Service Dummy.postman_collection.json b/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/Software Development View/BPDM Cleaning Service Dummy.postman_collection.json new file mode 100644 index 00000000000..b40e67ce3f2 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/Software Development View/BPDM Cleaning Service Dummy.postman_collection.json @@ -0,0 +1,25 @@ +{ + "info": { + "_postman_id": "4f4f1804-c853-490d-b03c-80e2d545bb0c", + "name": "BPDM Cleaning Service Dummy", + "description": "Place holder for the cleaning service provider", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "_exporter_id": "26818013" + }, + "item": [ + { + "name": "New Request", + "request": { + "method": "GET", + "header": [] + }, + "response": [] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "http://localhost:8084" + } + ] +} \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/Software Development View/BPDM Gate.postman_collection.json b/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/Software Development View/BPDM Gate.postman_collection.json new file mode 100644 index 00000000000..a2bd400cddc --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/Software Development View/BPDM Gate.postman_collection.json @@ -0,0 +1,944 @@ +{ + "info": { + "_postman_id": "326ec7da-09af-411a-ae73-3612d9c592f7", + "name": "BPDM Gate", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "_exporter_id": "26818013" + }, + "item": [ + { + "name": "Sharing-state", + "item": [ + { + "name": "Sharing States", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json", + "type": "text" + } + ], + "url": { + "raw": "{{Gate-Host}}/api/catena/sharing-state?page=0&size=10&businessPartnerType=LEGAL_ENTITY", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "sharing-state" + ], + "query": [ + { + "key": "page", + "value": "0" + }, + { + "key": "size", + "value": "10" + }, + { + "key": "businessPartnerType", + "value": "LEGAL_ENTITY" + }, + { + "key": "externalIds", + "value": "12044444", + "disabled": true + } + ] + } + }, + "response": [] + }, + { + "name": "Sharing State", + "request": { + "method": "PUT", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"businessPartnerType\": \"LEGAL_ENTITY\",\n \"externalId\": \"string\",\n \"sharingStateType\": \"Pending\",\n \"sharingErrorCode\": \"SharingProcessError\",\n \"sharingErrorMessage\": \"string\",\n \"bpn\": \"string\",\n \"sharingProcessStarted\": \"2023-06-05T06:56:40.785Z\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Gate-Host}}/api/catena/sharing-state", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "sharing-state" + ] + } + }, + "response": [] + } + ] + }, + { + "name": "Input", + "item": [ + { + "name": "Legal Entity", + "item": [ + { + "name": "Legal Entities", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{Gate-Host}}/api/catena/input/legal-entities?limit=10", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "input", + "legal-entities" + ], + "query": [ + { + "key": "limit", + "value": "10" + } + ] + } + }, + "response": [] + }, + { + "name": "Legal Entity", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{Gate-Host}}/api/catena/input/legal-entities/99999", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "input", + "legal-entities", + "99999" + ] + } + }, + "response": [] + }, + { + "name": "Legal Entities", + "request": { + "method": "PUT", + "header": [], + "body": { + "mode": "raw", + "raw": "[\n {\n \"legalNameParts\": [\n \"Name of Company\"\n ],\n \"identifiers\": [\n {\n \"value\": \"123456789\",\n \"type\": \"CUSTOM_ID_TYPE\",\n \"issuingBody\": \"CUSTOM_ISSUE_BODY\"\n }\n ],\n \"legalShortName\": \"NoC\",\n \"legalForm\": \"CUSTOM_LEGAL_FORM\",\n \"states\": [\n {\n \"officialDenotation\": \"Active\",\n \"validFrom\": \"2020-12-16T05:54:48.942Z\",\n \"validTo\": \"2023-06-05T07:31:01.213Z\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"classifications\": [\n {\n \"value\": \"Farming of cattle, dairy farming\",\n \"code\": \"01.21\",\n \"type\": \"NACE\"\n }\n ],\n \"roles\": [\n \"SUPPLIER\"\n ],\n \"legalAddress\": {\n \"nameParts\": [\n \"WESTERN_LATIN_STANDARD\"\n ],\n \"states\": [\n {\n \"description\": \"WESTERN_LATIN_STANDARD\",\n \"validFrom\": \"2020-12-16T05:54:48.942Z\",\n \"validTo\": \"2023-06-05T07:31:01.213Z\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"identifiers\": [\n {\n \"value\": \"12345678910\",\n \"type\": \"CUSTOM_ID_ADD_TYPE\"\n }\n ],\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"DE\",\n \"postalCode\": \"70546\",\n \"city\": \"Stuttgart\",\n \"street\": {\n \"namePrefix\": \"test prefix\",\n \"additionalNamePrefix\": \"test1\",\n \"name\": \"Stuttgarter Strasse\",\n \"additionalNameSuffix\": \"test2\",\n \"houseNumber\": \"1\",\n \"milestone\": \"Stuttgarter Strasse 1\",\n \"direction\": \"Stuttgarter Str.\",\n \"nameSuffix\": \"test\"\n },\n \"administrativeAreaLevel1\": null,\n \"administrativeAreaLevel2\": \"test1\",\n \"administrativeAreaLevel3\": \"test2\",\n \"district\": \"Stuttgart\",\n \"companyPostalCode\": \"GM01\",\n \"industrialZone\": \"HEADQUARTER\",\n \"building\": \"Building A\",\n \"floor\": \"A\",\n \"door\": \"test\"\n },\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"DE\",\n \"postalCode\": \"1234\",\n \"city\": \"Stuttgart 1\",\n \"administrativeAreaLevel1\": null,\n \"deliveryServiceNumber\": \"1234\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"test\"\n },\n \"roles\": [\n \"SUPPLIER\"\n ]\n },\n \"externalId\": \"12044444\"\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Gate-Host}}/api/catena/input/legal-entities", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "input", + "legal-entities" + ] + } + }, + "response": [] + }, + { + "name": "Legal Entity Search", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "[\n 11111111\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Gate-Host}}/api/catena/input/legal-entities/search?page=0&size=10", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "input", + "legal-entities", + "search" + ], + "query": [ + { + "key": "page", + "value": "0" + }, + { + "key": "size", + "value": "10" + } + ] + } + }, + "response": [] + } + ] + }, + { + "name": "Site", + "item": [ + { + "name": "Sites", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{Gate-Host}}/api/catena/input/sites?limit=10", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "input", + "sites" + ], + "query": [ + { + "key": "limit", + "value": "10" + } + ] + } + }, + "response": [] + }, + { + "name": "Site", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{Gate-Host}}/api/catena/input/sites/12044444", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "input", + "sites", + "12044444" + ] + } + }, + "response": [] + }, + { + "name": "Sites", + "request": { + "method": "PUT", + "header": [], + "body": { + "mode": "raw", + "raw": "[\n {\n \"nameParts\": [\n \"Factory UT\"\n ],\n \"states\": [\n {\n \"description\": \"Baden-Wuerttemberg\",\n \"validFrom\": \"2023-06-05T08:29:20.015Z\",\n \"validTo\": \"2023-06-05T08:29:20.015Z\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"roles\": [\n \"SUPPLIER\"\n ],\n \"mainAddress\": {\n \"nameParts\": [\n \"WESTERN_LATIN_STANDARD\"\n ],\n \"states\": [\n {\n \"description\": \"Baden-Wuerttemberg\",\n \"validFrom\": \"2023-06-05T08:29:20.015Z\",\n \"validTo\": \"2023-06-05T08:29:20.015Z\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"identifiers\": [\n {\n \"value\": \"123456789\",\n \"type\": \"CUSTOM_SITE_ID\"\n }\n ],\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"DE\",\n \"postalCode\": \"70327\",\n \"city\": \"Stuttgart\",\n \"street\": {\n \"namePrefix\": \"test prefix\",\n \"additionalNamePrefix\": \"test\",\n \"name\": \"Untertuerckheim Strasse 1\",\n \"additionalNameSuffix\": \"test suffix\",\n \"houseNumber\": \"1234\",\n \"milestone\": \"Untertuerckheim Strasse 1\",\n \"direction\": \"Untertuerckheim Strasse 1\",\n \"nameSuffix\": \"test1 suffix\"\n },\n \"administrativeAreaLevel1\": \"Baden-Wuerttember\",\n \"district\": \"Stuttgart\",\n \"companyPostalCode\": \"71034\",\n \"industrialZone\": \"Sindelfinden\",\n \"building\": \"Building A\",\n \"floor\": \"A\",\n \"door\": \"1\"\n },\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"DE\",\n \"postalCode\": \"1234\",\n \"city\": \"Stuttgart\",\n \"administrativeAreaLevel1\": \"Stuttgart\",\n \"deliveryServiceNumber\": \"Untertuerckheim Strasse 1\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"test qualifier\"\n },\n \"roles\": [\n \"SUPPLIER\"\n ]\n },\n \"externalId\": \"12044444\",\n \"legalEntityExternalId\": \"12044444\"\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Gate-Host}}/api/catena/input/sites", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "input", + "sites" + ] + } + }, + "response": [] + }, + { + "name": "Site Search", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "[\n \"12044444\"\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Gate-Host}}/api/catena/input/sites/search", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "input", + "sites", + "search" + ] + } + }, + "response": [] + } + ] + }, + { + "name": "Address", + "item": [ + { + "name": "Addresses", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{Gate-Host}}/api/catena/input/addresses?limit=10", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "input", + "addresses" + ], + "query": [ + { + "key": "limit", + "value": "10" + } + ] + } + }, + "response": [] + }, + { + "name": "Address", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{Gate-Host}}/api/catena/input/addresses/12044444_site", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "input", + "addresses", + "12044444_site" + ] + } + }, + "response": [] + }, + { + "name": "Addresses", + "request": { + "method": "PUT", + "header": [], + "body": { + "mode": "raw", + "raw": "[\n {\n \"nameParts\": [\n \"WESTERN_LATIN_STANDARD\"\n ],\n \"states\": [\n {\n \"description\": \"Baden-Wuerttemberg\",\n \"validFrom\": \"2023-06-05T10:32:30.231Z\",\n \"validTo\": \"2023-06-05T10:32:30.231Z\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"identifiers\": [\n {\n \"value\": \"123456789\",\n \"type\": \"CUSTOM_ADDRESS_ID\"\n }\n ],\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"DE\",\n \"postalCode\": \"70327\",\n \"city\": \"Stuttgart\",\n \"street\": {\n \"namePrefix\": \"test prefix\",\n \"additionalNamePrefix\": \"test\",\n \"name\": \"Untertuerckheim Strasse 1\",\n \"additionalNameSuffix\": \"test suffix\",\n \"houseNumber\": \"1234\",\n \"milestone\": \"Untertuerckheim Strasse 1\",\n \"direction\": \"Untertuerckheim Strasse 1\",\n \"nameSuffix\": \"test1 suffix\"\n },\n \"administrativeAreaLevel1\": \"Baden-Wuerttember\",\n \"district\": \"Stuttgart\",\n \"companyPostalCode\": \"71034\",\n \"industrialZone\": \"Sindelfinden\",\n \"building\": \"Building A\",\n \"floor\": \"A\",\n \"door\": \"1\"\n },\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"DE\",\n \"postalCode\": \"1234\",\n \"city\": \"Stuttgart\",\n \"administrativeAreaLevel1\": \"Stuttgart\",\n \"deliveryServiceNumber\": \"Untertuerckheim Strasse 1\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"test qualifier\"\n },\n \"roles\": [\n \"SUPPLIER\"\n ],\n \"externalId\": \"12044444\",\n \"legalEntityExternalId\": \"12044444\",\n \"siteExternalId\": null\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Gate-Host}}/api/catena/input/addresses", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "input", + "addresses" + ] + } + }, + "response": [] + }, + { + "name": "Address Search", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "[\n \"12044444_legalAddress\"\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Gate-Host}}/api/catena/input/addresses/search", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "input", + "addresses", + "search" + ] + } + }, + "response": [] + } + ] + }, + { + "name": "Business Partner", + "item": [ + { + "name": "Business Patners", + "request": { + "method": "PUT", + "header": [], + "body": { + "mode": "raw", + "raw": "[\n {\n \"externalId\": \"1234\",\n \"nameParts\": [\n \"Name of Company\"\n ],\n \"shortName\": \"NoC\",\n \"identifiers\": [\n {\n \"type\": \"CUSTOM_ID_TYPE\",\n \"value\": \"123456789\",\n \"issuingBody\": \"CUSTOM_ISSUE_BODY\"\n }\n ],\n \"legalForm\": \"CUSTOM_LEGAL_FORM\",\n \"states\": [\n {\n \"type\": \"ACTIVE\",\n \"validFrom\": \"2020-12-16T05:54:48.942\",\n \"validTo\": \"2023-06-05T07:31:01.213\",\n \"description\": null\n }\n ],\n \"classifications\": [\n {\n \"type\": \"NACE\",\n \"code\": \"01.21\",\n \"value\": \"Farming of cattle, dairy farming\"\n }\n ],\n \"roles\": [\n \"SUPPLIER\"\n ],\n \"postalAddress\": {\n \"addressType\": \"SiteMainAddress\",\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0.0,\n \"latitude\": 0.0,\n \"altitude\": 0.0\n },\n \"country\": \"DE\",\n \"administrativeAreaLevel1\": null,\n \"administrativeAreaLevel2\": \"test2\",\n \"administrativeAreaLevel3\": \"test3\",\n \"postalCode\": \"12345\",\n \"city\": \"Stuttgart 1\",\n \"district\": \"Stuttgart\",\n \"street\": {\n \"namePrefix\": \"testNamePrefix\",\n \"additionalNamePrefix\": \"testAdditionalNamePrefix\",\n \"name\": \"testName\",\n \"nameSuffix\": \"testNameSuffix\",\n \"additionalNameSuffix\": \"testAdditionalNameSuffix\",\n \"houseNumber\": \"13\",\n \"milestone\": \"B\",\n \"direction\": \"F\"\n },\n \"companyPostalCode\": \"123456\",\n \"industrialZone\": \"zone1\",\n \"building\": \"b\",\n \"floor\": \"1\",\n \"door\": \"D\"\n },\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0.0,\n \"latitude\": 0.0,\n \"altitude\": 0.0\n },\n \"country\": \"DE\",\n \"administrativeAreaLevel1\": null,\n \"postalCode\": 123456,\n \"city\": \"test\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"test\",\n \"deliveryServiceNumber\": \"test\"\n }\n },\n \"bpnL\": \"BPNL000000000QHA\",\n \"bpnS\": \"BPNS0000000007UH\",\n \"bpnA\": \"BPNA0000000009T3\",\n \"isOwner\": true\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Gate-Host}}/api/catena/input/business-partners", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "input", + "business-partners" + ] + } + }, + "response": [] + }, + { + "name": "Business Patners Search", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "[\n \"1234\"\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Gate-Host}}/api/catena/input/business-partners/search?page=0&size=10", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "input", + "business-partners", + "search" + ], + "query": [ + { + "key": "page", + "value": "0" + }, + { + "key": "size", + "value": "10" + } + ] + } + }, + "response": [] + } + ] + } + ] + }, + { + "name": "Output", + "item": [ + { + "name": "Business Partner Search", + "item": [ + { + "name": "Business Patners Search", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "[\n \"1234\"\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Gate-Host}}/api/catena/output/business-partners/search?page=0&size=10", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "output", + "business-partners", + "search" + ], + "query": [ + { + "key": "page", + "value": "0" + }, + { + "key": "size", + "value": "10" + } + ] + } + }, + "response": [] + } + ] + }, + { + "name": "Legal Entity Search", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "[\n \"11111111\"\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Gate-Host}}/api/catena/output/legal-entities/search?limit=10", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "output", + "legal-entities", + "search" + ], + "query": [ + { + "key": "limit", + "value": "10" + } + ] + } + }, + "response": [] + }, + { + "name": "Site Search", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "[\n \"12044444\"\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Gate-Host}}/api/catena/output/sites/search?limit=10", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "output", + "sites", + "search" + ], + "query": [ + { + "key": "limit", + "value": "10" + } + ] + } + }, + "response": [] + }, + { + "name": "Address Search", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "[\n \"12044444_legalAddress\"\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Gate-Host}}/api/catena/output/addresses/search?limit=10", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "output", + "addresses", + "search" + ], + "query": [ + { + "key": "limit", + "value": "10" + } + ] + } + }, + "response": [] + }, + { + "name": "Legal Entity", + "request": { + "method": "PUT", + "header": [], + "body": { + "mode": "raw", + "raw": "[\n {\n \"legalNameParts\": [\n \"Name of Company\"\n ],\n \"identifiers\": [\n {\n \"value\": \"123456789\",\n \"type\": \"CUSTOM_ID_TYPE\",\n \"issuingBody\": \"CUSTOM_ISSUE_BODY\"\n }\n ],\n \"legalShortName\": \"NoC\",\n \"legalForm\": \"CUSTOM_LEGAL_FORM\",\n \"states\": [\n {\n \"officialDenotation\": \"Active\",\n \"validFrom\": \"2020-12-16T05:54:48.942Z\",\n \"validTo\": \"2023-06-05T07:31:01.213Z\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"classifications\": [\n {\n \"value\": \"Farming of cattle, dairy farming\",\n \"code\": \"01.21\",\n \"type\": \"NACE\"\n }\n ],\n \"roles\": [\n \"SUPPLIER\"\n ],\n \"legalAddress\": {\n \"nameParts\": [\n \"WESTERN_LATIN_STANDARD\"\n ],\n \"states\": [\n {\n \"description\": \"WESTERN_LATIN_STANDARD\",\n \"validFrom\": \"2020-12-16T05:54:48.942Z\",\n \"validTo\": \"2023-06-05T07:31:01.213Z\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"identifiers\": [\n {\n \"value\": \"12345678910\",\n \"type\": \"CUSTOM_ID_ADD_TYPE\"\n }\n ],\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"DE\",\n \"postalCode\": \"70546\",\n \"city\": \"Stuttgart\",\n \"street\": {\n \"namePrefix\": \"test prefix\",\n \"additionalNamePrefix\": \"test1\",\n \"name\": \"Stuttgarter Strasse\",\n \"additionalNameSuffix\": \"test2\",\n \"houseNumber\": \"1\",\n \"milestone\": \"Stuttgarter Strasse 1\",\n \"direction\": \"Stuttgarter Str.\",\n \"nameSuffix\": \"test\"\n },\n \"administrativeAreaLevel1\": \"Baden-Wuerttemberg\",\n \"administrativeAreaLevel2\": \"test1\",\n \"administrativeAreaLevel3\": \"test2\",\n \"district\": \"Stuttgart\",\n \"companyPostalCode\": \"GM01\",\n \"industrialZone\": \"HEADQUARTER\",\n \"building\": \"Building A\",\n \"floor\": \"A\",\n \"door\": \"test\"\n },\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"DE\",\n \"postalCode\": \"1234\",\n \"city\": \"Stuttgart 1\",\n \"administrativeAreaLevel1\": \"Baden-Wuerttemberg 1\",\n \"deliveryServiceNumber\": \"1234\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"test\"\n },\n \"roles\": [\n \"SUPPLIER\"\n ],\n \"bpn\": \"BPNL0000000001YN\"\n },\n \"externalId\": \"12044444\",\n \"bpn\": \"BPNL0000000001YN\"\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Gate-Host}}/api/catena/output/legal-entities", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "output", + "legal-entities" + ] + } + }, + "response": [] + }, + { + "name": "Site", + "request": { + "method": "PUT", + "header": [], + "body": { + "mode": "raw", + "raw": "[\n {\n \"nameParts\": [\n \"Factory UT\"\n ],\n \"states\": [\n {\n \"description\": \"Baden-Wuerttemberg\",\n \"validFrom\": \"2023-06-05T08:29:20.015Z\",\n \"validTo\": \"2023-06-05T08:29:20.015Z\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"roles\": [\n \"SUPPLIER\"\n ],\n \"mainAddress\": {\n \"nameParts\": [\n \"WESTERN_LATIN_STANDARD\"\n ],\n \"states\": [\n {\n \"description\": \"Baden-Wuerttemberg\",\n \"validFrom\": \"2023-06-05T08:29:20.015Z\",\n \"validTo\": \"2023-06-05T08:29:20.015Z\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"identifiers\": [\n {\n \"value\": \"123456789\",\n \"type\": \"CUSTOM_SITE_ID\"\n }\n ],\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"DE\",\n \"postalCode\": \"70327\",\n \"city\": \"Stuttgart\",\n \"street\": {\n \"namePrefix\": \"test prefix\",\n \"additionalNamePrefix\": \"test\",\n \"name\": \"Untertuerckheim Strasse 1\",\n \"additionalNameSuffix\": \"test suffix\",\n \"houseNumber\": \"1234\",\n \"milestone\": \"Untertuerckheim Strasse 1\",\n \"direction\": \"Untertuerckheim Strasse 1\",\n \"nameSuffix\": \"test1 suffix\"\n },\n \"administrativeAreaLevel1\": \"Baden-Wuerttember\",\n \"district\": \"Stuttgart\",\n \"companyPostalCode\": \"71034\",\n \"industrialZone\": \"Sindelfinden\",\n \"building\": \"Building A\",\n \"floor\": \"A\",\n \"door\": \"1\"\n },\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"DE\",\n \"postalCode\": \"1234\",\n \"city\": \"Stuttgart\",\n \"administrativeAreaLevel1\": \"Stuttgart\",\n \"deliveryServiceNumber\": \"Untertuerckheim Strasse 1\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"test qualifier\"\n },\n \"roles\": [\n \"SUPPLIER\"\n ],\n \"bpn\": \"BPNS000000000001\"\n },\n \"externalId\": \"12044444\",\n \"legalEntityExternalId\": \"12044444\",\n \"bpn\": \"BPNL0000000001YN\"\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Gate-Host}}/api/catena/output/sites", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "output", + "sites" + ] + } + }, + "response": [] + }, + { + "name": "Address", + "request": { + "method": "PUT", + "header": [], + "body": { + "mode": "raw", + "raw": "[\n {\n \"nameParts\": [\n \"WESTERN_LATIN_STANDARD\"\n ],\n \"states\": [\n {\n \"description\": \"Baden-Wuerttemberg\",\n \"validFrom\": \"2023-06-05T10:32:30.231Z\",\n \"validTo\": \"2023-06-05T10:32:30.231Z\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"identifiers\": [\n {\n \"value\": \"123456789\",\n \"type\": \"CUSTOM_ADDRESS_ID\"\n }\n ],\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"DE\",\n \"postalCode\": \"70327\",\n \"city\": \"Stuttgart\",\n \"street\": {\n \"namePrefix\": \"test prefix\",\n \"additionalNamePrefix\": \"test\",\n \"name\": \"Untertuerckheim Strasse 1\",\n \"additionalNameSuffix\": \"test suffix\",\n \"houseNumber\": \"1234\",\n \"milestone\": \"Untertuerckheim Strasse 1\",\n \"direction\": \"Untertuerckheim Strasse 1\",\n \"nameSuffix\": \"test1 suffix\"\n },\n \"administrativeAreaLevel1\": \"Baden-Wuerttember\",\n \"district\": \"Stuttgart\",\n \"companyPostalCode\": \"71034\",\n \"industrialZone\": \"Sindelfinden\",\n \"building\": \"Building A\",\n \"floor\": \"A\",\n \"door\": \"1\"\n },\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"DE\",\n \"postalCode\": \"1234\",\n \"city\": \"Stuttgart\",\n \"administrativeAreaLevel1\": \"Stuttgart\",\n \"deliveryServiceNumber\": \"Untertuerckheim Strasse 1\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"test qualifier\"\n },\n \"roles\": [\n \"SUPPLIER\"\n ],\n \"externalId\": \"12044444_legalAddress\",\n \"legalEntityExternalId\": \"12044444\",\n \"siteExternalId\": \"12044444_sites\",\n \"bpn\": \"BPNA000000000001\"\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Gate-Host}}/api/catena/output/addresses", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "output", + "addresses" + ] + } + }, + "response": [] + } + ] + }, + { + "name": "Changelog", + "item": [ + { + "name": "Output Changelog", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"timestampAfter\": \"2020-12-16T05:54:48.942Z\",\n \"externalIds\": [\n \"12044444\"\n ],\n \"lsaTypes\": [\n \"LEGAL_ENTITY\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Gate-Host}}/api/catena/output/changelog/search?page=0&size=10", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "output", + "changelog", + "search" + ], + "query": [ + { + "key": "page", + "value": "0" + }, + { + "key": "size", + "value": "10" + } + ] + } + }, + "response": [] + }, + { + "name": "Input Changelog", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"timestampAfter\": \"2020-12-16T05:54:48.942Z\",\n \"externalIds\": [\n \"12044444\"\n ],\n \"lsaTypes\": [\n \"LEGAL_ENTITY\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Gate-Host}}/api/catena/input/changelog/search?page=0&size=10", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "input", + "changelog", + "search" + ], + "query": [ + { + "key": "page", + "value": "0" + }, + { + "key": "size", + "value": "10" + } + ] + } + }, + "response": [] + } + ] + }, + { + "name": "Gate Documentation Controller", + "item": [ + { + "name": "mermaid", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{Gate-Host}}/api/catena/mermaid/", + "host": [ + "{{Gate-Host}}" + ], + "path": [ + "api", + "catena", + "mermaid", + "" + ] + } + }, + "response": [] + } + ] + } + ], + "auth": { + "type": "oauth2", + "oauth2": [ + { + "key": "accessTokenUrl", + "value": "{{Keycloak-Host}}/auth/realms/CX-Central/protocol/openid-connect/token", + "type": "string" + }, + { + "key": "tokenName", + "value": "BPDM Gate Token {{Environment}}", + "type": "string" + }, + { + "key": "client_authentication", + "value": "body", + "type": "string" + }, + { + "key": "clientSecret", + "value": "{{Gate-Client-Secret}}", + "type": "string" + }, + { + "key": "clientId", + "value": "{{Gate-Client-ID}}", + "type": "string" + }, + { + "key": "grant_type", + "value": "client_credentials", + "type": "string" + }, + { + "key": "refreshRequestParams", + "value": [], + "type": "any" + }, + { + "key": "tokenRequestParams", + "value": [], + "type": "any" + }, + { + "key": "authRequestParams", + "value": [], + "type": "any" + }, + { + "key": "challengeAlgorithm", + "value": "S256", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } + } + ] +} \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/Software Development View/BPDM Orchestrator.postman_collection.json b/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/Software Development View/BPDM Orchestrator.postman_collection.json new file mode 100644 index 00000000000..4db31fb86a4 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/Software Development View/BPDM Orchestrator.postman_collection.json @@ -0,0 +1,139 @@ +{ + "info": { + "_postman_id": "a3442157-1cd9-4dec-842d-a22a4482e83c", + "name": "BPDM Orchestrator", + "description": "Orchestrator component acts as a passive component and offers for each processing steps individual endpoints", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "_exporter_id": "26818013" + }, + "item": [ + { + "name": "Task Client", + "item": [ + { + "name": "Create golden record tasks", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"mode\": \"UpdateFromSharingMember\",\n \"businessPartners\": [\n {\n \"nameParts\": [\n \"string\"\n ],\n \"shortName\": \"string\",\n \"identifiers\": [\n {\n \"type\": \"string\",\n \"value\": \"string\",\n \"issuingBody\": \"string\"\n }\n ],\n \"legalForm\": \"string\",\n \"states\": [\n {\n \"validFrom\": \"2023-10-16T14:11:16.920Z\",\n \"validTo\": \"2023-10-16T14:11:16.920Z\",\n \"type\": \"ACTIVE\",\n \"description\": \"string\"\n }\n ],\n \"classifications\": [\n {\n \"type\": \"NACE\",\n \"code\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"roles\": [\n \"SUPPLIER\"\n ],\n \"postalAddress\": {\n \"addressType\": \"LegalAndSiteMainAddress\",\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"UNDEFINED\",\n \"administrativeAreaLevel1\": \"string\",\n \"administrativeAreaLevel2\": \"string\",\n \"administrativeAreaLevel3\": \"string\",\n \"postalCode\": \"string\",\n \"city\": \"string\",\n \"district\": \"string\",\n \"street\": {\n \"name\": \"string\",\n \"houseNumber\": \"string\",\n \"milestone\": \"string\",\n \"direction\": \"string\",\n \"namePrefix\": \"string\",\n \"additionalNamePrefix\": \"string\",\n \"nameSuffix\": \"string\",\n \"additionalNameSuffix\": \"string\"\n },\n \"companyPostalCode\": \"string\",\n \"industrialZone\": \"string\",\n \"building\": \"string\",\n \"floor\": \"string\",\n \"door\": \"string\"\n },\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"UNDEFINED\",\n \"administrativeAreaLevel1\": \"string\",\n \"postalCode\": \"string\",\n \"city\": \"string\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"string\",\n \"deliveryServiceNumber\": \"string\"\n }\n },\n \"bpnL\": \"string\",\n \"bpnS\": \"string\",\n \"bpnA\": \"string\",\n \"ownerBpnL\": \"string\"\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Orchestrator-Host}}/api/golden-record-tasks", + "host": [ + "{{Orchestrator-Host}}" + ], + "path": [ + "api", + "golden-record-tasks" + ] + } + }, + "response": [] + }, + { + "name": "Search GR state", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"taskIds\": [\n \"0\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Orchestrator-Host}}/api/golden-record-tasks/state/search", + "host": [ + "{{Orchestrator-Host}}" + ], + "path": [ + "api", + "golden-record-tasks", + "state", + "search" + ] + } + }, + "response": [] + } + ] + }, + { + "name": "Task Worker", + "item": [ + { + "name": "Step Results", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"results\": [\n {\n \"taskId\": \"string\",\n \"businessPartner\": {\n \"generic\": {\n \"nameParts\": [\n \"string\"\n ],\n \"shortName\": \"string\",\n \"identifiers\": [\n {\n \"type\": \"string\",\n \"value\": \"string\",\n \"issuingBody\": \"string\"\n }\n ],\n \"legalForm\": \"string\",\n \"states\": [\n {\n \"validFrom\": \"2023-10-16T14:15:47.919Z\",\n \"validTo\": \"2023-10-16T14:15:47.919Z\",\n \"type\": \"ACTIVE\",\n \"description\": \"string\"\n }\n ],\n \"classifications\": [\n {\n \"type\": \"NACE\",\n \"code\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"roles\": [\n \"SUPPLIER\"\n ],\n \"postalAddress\": {\n \"addressType\": \"LegalAndSiteMainAddress\",\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"UNDEFINED\",\n \"administrativeAreaLevel1\": \"string\",\n \"administrativeAreaLevel2\": \"string\",\n \"administrativeAreaLevel3\": \"string\",\n \"postalCode\": \"string\",\n \"city\": \"string\",\n \"district\": \"string\",\n \"street\": {\n \"name\": \"string\",\n \"houseNumber\": \"string\",\n \"milestone\": \"string\",\n \"direction\": \"string\",\n \"namePrefix\": \"string\",\n \"additionalNamePrefix\": \"string\",\n \"nameSuffix\": \"string\",\n \"additionalNameSuffix\": \"string\"\n },\n \"companyPostalCode\": \"string\",\n \"industrialZone\": \"string\",\n \"building\": \"string\",\n \"floor\": \"string\",\n \"door\": \"string\"\n },\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"UNDEFINED\",\n \"administrativeAreaLevel1\": \"string\",\n \"postalCode\": \"string\",\n \"city\": \"string\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"string\",\n \"deliveryServiceNumber\": \"string\"\n }\n },\n \"bpnL\": \"string\",\n \"bpnS\": \"string\",\n \"bpnA\": \"string\",\n \"ownerBpnL\": \"string\"\n },\n \"legalEntity\": {\n \"bpnLReference\": {\n \"referenceValue\": \"string\",\n \"referenceType\": \"Bpn\"\n },\n \"hasChanged\": true,\n \"legalName\": \"string\",\n \"legalShortName\": \"string\",\n \"identifiers\": [\n {\n \"value\": \"string\",\n \"type\": \"string\",\n \"issuingBody\": \"string\"\n }\n ],\n \"legalForm\": \"string\",\n \"states\": [\n {\n \"description\": \"string\",\n \"validFrom\": \"2023-10-16T14:15:47.919Z\",\n \"validTo\": \"2023-10-16T14:15:47.919Z\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"classifications\": [\n {\n \"type\": \"NACE\",\n \"code\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"legalAddress\": {\n \"bpnAReference\": {\n \"referenceValue\": \"string\",\n \"referenceType\": \"Bpn\"\n },\n \"hasChanged\": true,\n \"name\": \"string\",\n \"states\": [\n {\n \"description\": \"string\",\n \"validFrom\": \"2023-10-16T14:15:47.919Z\",\n \"validTo\": \"2023-10-16T14:15:47.919Z\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"identifiers\": [\n {\n \"value\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"UNDEFINED\",\n \"administrativeAreaLevel1\": \"string\",\n \"administrativeAreaLevel2\": \"string\",\n \"administrativeAreaLevel3\": \"string\",\n \"postalCode\": \"string\",\n \"city\": \"string\",\n \"district\": \"string\",\n \"street\": {\n \"name\": \"string\",\n \"houseNumber\": \"string\",\n \"milestone\": \"string\",\n \"direction\": \"string\",\n \"namePrefix\": \"string\",\n \"additionalNamePrefix\": \"string\",\n \"nameSuffix\": \"string\",\n \"additionalNameSuffix\": \"string\"\n },\n \"companyPostalCode\": \"string\",\n \"industrialZone\": \"string\",\n \"building\": \"string\",\n \"floor\": \"string\",\n \"door\": \"string\"\n },\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"UNDEFINED\",\n \"administrativeAreaLevel1\": \"string\",\n \"postalCode\": \"string\",\n \"city\": \"string\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"string\",\n \"deliveryServiceNumber\": \"string\"\n }\n }\n },\n \"site\": {\n \"bpnSReference\": {\n \"referenceValue\": \"string\",\n \"referenceType\": \"Bpn\"\n },\n \"hasChanged\": true,\n \"name\": \"string\",\n \"states\": [\n {\n \"description\": \"string\",\n \"validFrom\": \"2023-10-16T14:15:47.919Z\",\n \"validTo\": \"2023-10-16T14:15:47.919Z\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"mainAddress\": {\n \"bpnAReference\": {\n \"referenceValue\": \"string\",\n \"referenceType\": \"Bpn\"\n },\n \"hasChanged\": true,\n \"name\": \"string\",\n \"states\": [\n {\n \"description\": \"string\",\n \"validFrom\": \"2023-10-16T14:15:47.919Z\",\n \"validTo\": \"2023-10-16T14:15:47.919Z\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"identifiers\": [\n {\n \"value\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"UNDEFINED\",\n \"administrativeAreaLevel1\": \"string\",\n \"administrativeAreaLevel2\": \"string\",\n \"administrativeAreaLevel3\": \"string\",\n \"postalCode\": \"string\",\n \"city\": \"string\",\n \"district\": \"string\",\n \"street\": {\n \"name\": \"string\",\n \"houseNumber\": \"string\",\n \"milestone\": \"string\",\n \"direction\": \"string\",\n \"namePrefix\": \"string\",\n \"additionalNamePrefix\": \"string\",\n \"nameSuffix\": \"string\",\n \"additionalNameSuffix\": \"string\"\n },\n \"companyPostalCode\": \"string\",\n \"industrialZone\": \"string\",\n \"building\": \"string\",\n \"floor\": \"string\",\n \"door\": \"string\"\n },\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"UNDEFINED\",\n \"administrativeAreaLevel1\": \"string\",\n \"postalCode\": \"string\",\n \"city\": \"string\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"string\",\n \"deliveryServiceNumber\": \"string\"\n }\n }\n },\n \"address\": {\n \"bpnAReference\": {\n \"referenceValue\": \"string\",\n \"referenceType\": \"Bpn\"\n },\n \"hasChanged\": true,\n \"name\": \"string\",\n \"states\": [\n {\n \"description\": \"string\",\n \"validFrom\": \"2023-10-16T14:15:47.919Z\",\n \"validTo\": \"2023-10-16T14:15:47.919Z\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"identifiers\": [\n {\n \"value\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"UNDEFINED\",\n \"administrativeAreaLevel1\": \"string\",\n \"administrativeAreaLevel2\": \"string\",\n \"administrativeAreaLevel3\": \"string\",\n \"postalCode\": \"string\",\n \"city\": \"string\",\n \"district\": \"string\",\n \"street\": {\n \"name\": \"string\",\n \"houseNumber\": \"string\",\n \"milestone\": \"string\",\n \"direction\": \"string\",\n \"namePrefix\": \"string\",\n \"additionalNamePrefix\": \"string\",\n \"nameSuffix\": \"string\",\n \"additionalNameSuffix\": \"string\"\n },\n \"companyPostalCode\": \"string\",\n \"industrialZone\": \"string\",\n \"building\": \"string\",\n \"floor\": \"string\",\n \"door\": \"string\"\n },\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"UNDEFINED\",\n \"administrativeAreaLevel1\": \"string\",\n \"postalCode\": \"string\",\n \"city\": \"string\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"string\",\n \"deliveryServiceNumber\": \"string\"\n }\n }\n },\n \"errors\": [\n {\n \"type\": \"Timeout\",\n \"description\": \"string\"\n }\n ]\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Orchestrator-Host}}/api/golden-record-tasks/step-results", + "host": [ + "{{Orchestrator-Host}}" + ], + "path": [ + "api", + "golden-record-tasks", + "step-results" + ] + } + }, + "response": [] + }, + { + "name": "Step Reservation", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"amount\": 0,\n \"step\": \"CleanAndSync\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Orchestrator-Host}}/api/golden-record-tasks/step-reservations", + "host": [ + "{{Orchestrator-Host}}" + ], + "path": [ + "api", + "golden-record-tasks", + "step-reservations" + ] + } + }, + "response": [] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "http://localhost:8085" + } + ] +} \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/Software Development View/BPDM Pool.postman_collection.json b/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/Software Development View/BPDM Pool.postman_collection.json new file mode 100644 index 00000000000..ff89c7120bf --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/Software Development View/BPDM Pool.postman_collection.json @@ -0,0 +1,1098 @@ +{ + "info": { + "_postman_id": "7c864024-7b7c-4bb6-aab8-0be237fbb80f", + "name": "BPDM Pool", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "_exporter_id": "26818013" + }, + "item": [ + { + "name": "Metadata Controller", + "item": [ + { + "name": "Legal Forms", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{Pool-Host}}/api/catena/legal-forms?page=0&size=10", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "legal-forms" + ], + "query": [ + { + "key": "page", + "value": "0" + }, + { + "key": "size", + "value": "10" + } + ] + } + }, + "response": [] + }, + { + "name": "Regions", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{Pool-Host}}/api/catena/regions", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "regions" + ] + } + }, + "response": [] + }, + { + "name": "Create Legal Form", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"technicalKey\": \"CUSTOM_LEGAL_FORM\",\n \"name\": \"Custom Legal Form for Testing\",\n \"abbreviation\": null\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Pool-Host}}/api/catena/legal-forms", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "legal-forms" + ] + } + }, + "response": [] + }, + { + "name": "Identifier Types", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{Pool-Host}}/api/catena/identifier-types?page=0&size=10&businessPartnerType=LEGAL_ENTITY", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "identifier-types" + ], + "query": [ + { + "key": "page", + "value": "0" + }, + { + "key": "size", + "value": "10" + }, + { + "key": "businessPartnerType", + "value": "LEGAL_ENTITY" + } + ] + } + }, + "response": [] + }, + { + "name": "Create Identifier Type", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"technicalKey\": \"CUSTOM_ID_TYPE\",\n \"businessPartnerType\": \"LEGAL_ENTITY\",\n \"name\": \"CUSTOM_ID_TYPE\",\n \"details\": [\n {\n \"country\": \"DE\",\n \"mandatory\": false\n }\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Pool-Host}}/api/catena/identifier-types", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "identifier-types" + ] + } + }, + "response": [] + }, + { + "name": "Field Quality Rules", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{Pool-Host}}/api/catena/field-quality-rules/?country=CZ", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "field-quality-rules", + "" + ], + "query": [ + { + "key": "country", + "value": "CZ" + } + ] + } + }, + "response": [] + }, + { + "name": "Administrative areas level1", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{Pool-Host}}/api/catena/administrative-areas-level1?page=0&size=10", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "administrative-areas-level1" + ], + "query": [ + { + "key": "page", + "value": "0" + }, + { + "key": "size", + "value": "10" + } + ] + } + }, + "response": [] + } + ] + }, + { + "name": "Legal Entity Controller", + "item": [ + { + "name": "Legal Entities", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{Pool-Host}}/api/catena/legal-entities?legalName=Name of Company&page=0&size=10", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "legal-entities" + ], + "query": [ + { + "key": "legalName", + "value": "Name of Company" + }, + { + "key": "legalForm", + "value": "", + "disabled": true + }, + { + "key": "status", + "value": "", + "disabled": true + }, + { + "key": "classification", + "value": "", + "disabled": true + }, + { + "key": "administrativeArea", + "value": "", + "disabled": true + }, + { + "key": "postCode", + "value": "", + "disabled": true + }, + { + "key": "locality", + "value": "", + "disabled": true + }, + { + "key": "thoroughfare", + "value": "", + "disabled": true + }, + { + "key": "premise", + "value": "", + "disabled": true + }, + { + "key": "postalDeliveryPoint", + "value": "", + "disabled": true + }, + { + "key": "siteName", + "value": "", + "disabled": true + }, + { + "key": "page", + "value": "0" + }, + { + "key": "size", + "value": "10" + } + ] + } + }, + "response": [] + }, + { + "name": "Update Legal Entity", + "request": { + "method": "PUT", + "header": [], + "body": { + "mode": "raw", + "raw": "[\n {\n \"bpnl\": \"BPNL000000000001\",\n \"legalName\": \"Name of Company\",\n \"identifiers\": [\n {\n \"value\": \"123456789\",\n \"type\": \"CUSTOM_ID_TYPE\",\n \"issuingBody\": \"CUSTOM_ISSUE_BODY\"\n }\n ],\n \"legalShortName\": \"NoC\",\n \"legalForm\": \"CUSTOM_LEGAL_FORM\",\n \"states\": [\n {\n \"officialDenotation\": \"Active\",\n \"validFrom\": \"2020-12-16T05:54:48.942Z\",\n \"validTo\": \"2023-06-05T07:31:01.213Z\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"classifications\": [\n {\n \"value\": \"Farming of cattle, dairy farming\",\n \"code\": \"01.21\",\n \"type\": \"NACE\"\n }\n ],\n \"legalAddress\": {\n \"name\": \"WESTERN_LATIN_STANDARD\",\n \"states\": [\n {\n \"description\": \"WESTERN_LATIN_STANDARD\",\n \"validFrom\": \"2020-12-16T05:54:48.942Z\",\n \"validTo\": \"2023-06-05T07:31:01.213Z\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"identifiers\": [\n {\n \"value\": \"12345678910\",\n \"type\": \"CUSTOM_ID_ADD_TYPE\"\n }\n ],\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"DE\",\n \"postalCode\": \"70546\",\n \"city\": \"Stuttgart\",\n \"street\": {\n \"name\": \"Stuttgarter Strasse\",\n \"houseNumber\": \"1\",\n \"milestone\": \"Stuttgarter Strasse 1\",\n \"direction\": \"Stuttgarter Str.\"\n },\n \"administrativeAreaLevel1\": \"Baden-Wuerttemberg\",\n \"administrativeAreaLevel2\": \"test1\",\n \"administrativeAreaLevel3\": \"test2\",\n \"district\": \"Stuttgart\",\n \"companyPostalCode\": \"GM01\",\n \"industrialZone\": \"HEADQUARTER\",\n \"building\": \"Building A\",\n \"floor\": \"A\",\n \"door\": \"test\"\n },\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"DE\",\n \"postalCode\": \"1234\",\n \"city\": \"Stuttgart 1\",\n \"administrativeAreaLevel1\": \"Baden-Wuerttemberg 1\",\n \"deliveryServiceNumber\": \"1234\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"test\"\n }\n }\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Pool-Host}}/api/catena/legal-entities", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "legal-entities" + ] + } + }, + "response": [] + }, + { + "name": "Create Legal Entities", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "[\n {\n \"legalName\": \"Name of Company\",\n \"identifiers\": [\n {\n \"value\": \"123456789\",\n \"type\": \"CUSTOM_ID_TYPE\",\n \"issuingBody\": \"CUSTOM_ISSUE_BODY\"\n }\n ],\n \"legalShortName\": \"NoC\",\n \"legalForm\": \"CUSTOM_LEGAL_FORM\",\n \"states\": [\n {\n \"officialDenotation\": \"Active\",\n \"validFrom\": \"2020-12-16T05:54:48.942Z\",\n \"validTo\": \"2023-06-05T07:31:01.213Z\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"classifications\": [\n {\n \"value\": \"Farming of cattle, dairy farming\",\n \"code\": \"01.21\",\n \"type\": \"NACE\"\n }\n ],\n \"legalAddress\": {\n \"name\": \"WESTERN_LATIN_STANDARD\",\n \"states\": [\n {\n \"description\": \"WESTERN_LATIN_STANDARD\",\n \"validFrom\": \"2020-12-16T05:54:48.942Z\",\n \"validTo\": \"2023-06-05T07:31:01.213Z\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"identifiers\": [\n {\n \"value\": \"12345678910\",\n \"type\": \"CUSTOM_ID_ADD_TYPE\"\n }\n ],\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"DE\",\n \"postalCode\": \"70546\",\n \"city\": \"Stuttgart\",\n \"street\": {\n \"name\": \"Stuttgarter Strasse\",\n \"houseNumber\": \"1\",\n \"milestone\": \"Stuttgarter Strasse 1\",\n \"direction\": \"Stuttgarter Str.\"\n },\n \"administrativeAreaLevel1\": null,\n \"administrativeAreaLevel2\": \"test1\",\n \"administrativeAreaLevel3\": \"test2\",\n \"district\": \"Stuttgart\",\n \"companyPostalCode\": \"GM01\",\n \"industrialZone\": \"HEADQUARTER\",\n \"building\": \"Building A\",\n \"floor\": \"A\",\n \"door\": \"test\"\n },\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"DE\",\n \"postalCode\": \"1234\",\n \"city\": \"Stuttgart 1\",\n \"administrativeAreaLevel1\": null,\n \"deliveryServiceNumber\": \"1234\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"test\"\n }\n },\n \"index\": \"0\"\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Pool-Host}}/api/catena/legal-entities", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "legal-entities" + ] + } + }, + "response": [] + }, + { + "name": "Confirm up to date", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "{{Pool-Host}}/api/catena/legal-entities/BPNL000000000001/confirm-up-to-date", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "legal-entities", + "BPNL000000000001", + "confirm-up-to-date" + ] + } + }, + "response": [] + }, + { + "name": "Search Legal Entities", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "[\n \"BPNL000000000001\"\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Pool-Host}}/api/catena/legal-entities/search", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "legal-entities", + "search" + ] + } + }, + "response": [] + }, + { + "name": "Search Legal Addresses", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "[\n \"BPNL000000000001\"\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Pool-Host}}/api/catena/legal-entities/legal-addresses/search", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "legal-entities", + "legal-addresses", + "search" + ] + } + }, + "response": [] + }, + { + "name": "Legal Entity", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{Pool-Host}}/api/catena/legal-entities/123456789?idType=CUSTOM_ID_TYPE", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "legal-entities", + "123456789" + ], + "query": [ + { + "key": "idType", + "value": "CUSTOM_ID_TYPE" + } + ] + } + }, + "response": [] + }, + { + "name": "Legal Entity Sites", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{Pool-Host}}/api/catena/legal-entities/BPNL000000000001/sites?page=0&size=10", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "legal-entities", + "BPNL000000000001", + "sites" + ], + "query": [ + { + "key": "page", + "value": "0" + }, + { + "key": "size", + "value": "10" + } + ] + } + }, + "response": [] + }, + { + "name": "Legal Entity Addresses", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{Pool-Host}}/api/catena/legal-entities/BPNL000000000001/addresses?page=0&size=10", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "legal-entities", + "BPNL000000000001", + "addresses" + ], + "query": [ + { + "key": "page", + "value": "0" + }, + { + "key": "size", + "value": "10" + } + ] + } + }, + "response": [] + } + ] + }, + { + "name": "Site Controller", + "item": [ + { + "name": "Create Sites", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"Factory UT\",\n \"states\": [\n {\n \"description\": \"Baden-Wuerttemberg\",\n \"validFrom\": \"2023-06-06T08:18:05.777Z\",\n \"validTo\": \"2024-06-06T08:18:05.777Z\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"mainAddress\": {\n \"name\": \"WESTERN_LATIN_STANDARD\",\n \"states\": [\n {\n \"description\": \"Baden-Wuerttemberg\",\n \"validFrom\": \"2023-06-06T08:18:05.777Z\",\n \"validTo\": \"2024-06-06T08:18:05.777Z\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"identifiers\": [\n {\n \"value\": \"123456789\",\n \"type\": \"CUSTOM_SITE_ID\"\n }\n ],\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"DE\",\n \"postalCode\": \"70327\",\n \"city\": \"Stuttgart\",\n \"street\": {\n \"name\": \"Untertuerckheim Strasse 1\",\n \"houseNumber\": \"1234\",\n \"milestone\": \"Untertuerckheim Strasse 1\",\n \"direction\": \"Untertuerckheim Strasse 1\"\n },\n \"administrativeAreaLevel1\": \"Baden-Wuerttember\",\n \"district\": \"Stuttgart\",\n \"companyPostalCode\": \"71034\",\n \"industrialZone\": \"Sindelfinden\",\n \"building\": \"Building A\",\n \"floor\": \"A\",\n \"door\": \"1\"\n },\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"DE\",\n \"postalCode\": \"1234\",\n \"city\": \"Stuttgart\",\n \"administrativeAreaLevel1\": \"Stuttgart\",\n \"deliveryServiceNumber\": \"Untertuerckheim Strasse 1\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"test qualifier\"\n }\n },\n \"bpnlParent\": \"BPNL000000000001\",\n \"index\": \"1\"\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Pool-Host}}/api/catena/sites", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "sites" + ] + } + }, + "response": [] + }, + { + "name": "Update Sites", + "request": { + "method": "PUT", + "header": [], + "body": { + "mode": "raw", + "raw": "[\n {\n \"bpns\": \"BPNS000000000001\",\n \"name\": \"Factory UT\",\n \"states\": [\n {\n \"description\": \"Baden-Wuerttemberg\",\n \"validFrom\": \"2023-06-06T08:18:05.777Z\",\n \"validTo\": \"2024-06-06T08:18:05.777Z\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"mainAddress\": {\n \"name\": \"WESTERN_LATIN_STANDARD\",\n \"states\": [\n {\n \"description\": \"Baden-Wuerttemberg\",\n \"validFrom\": \"2023-06-06T08:18:05.777Z\",\n \"validTo\": \"2024-06-06T08:18:05.777Z\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"identifiers\": [\n {\n \"value\": \"123456789\",\n \"type\": \"CUSTOM_SITE_ID\"\n }\n ],\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"DE\",\n \"postalCode\": \"70327\",\n \"city\": \"Stuttgart\",\n \"street\": {\n \"name\": \"Untertuerckheim Strasse 1\",\n \"houseNumber\": \"1234\",\n \"milestone\": \"Untertuerckheim Strasse 1\",\n \"direction\": \"Untertuerckheim Strasse 1\"\n },\n \"administrativeAreaLevel1\": \"Baden-Wuerttember\",\n \"district\": \"Stuttgart\",\n \"companyPostalCode\": \"71034\",\n \"industrialZone\": \"Sindelfinden\",\n \"building\": \"Building A\",\n \"floor\": \"A\",\n \"door\": \"1\"\n },\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"DE\",\n \"postalCode\": \"1234\",\n \"city\": \"Stuttgart\",\n \"administrativeAreaLevel1\": \"Stuttgart\",\n \"deliveryServiceNumber\": \"Untertuerckheim Strasse 1\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"test qualifier\"\n }\n }\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Pool-Host}}/api/catena/sites", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "sites" + ] + } + }, + "response": [] + }, + { + "name": "Search Sites", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"legalEntities\": [\n \"BPNL000000000001\"\n ],\n \"sites\": [\n \"BPNS000000000001\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Pool-Host}}/api/catena/sites/search?page=0&size=10", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "sites", + "search" + ], + "query": [ + { + "key": "page", + "value": "0" + }, + { + "key": "size", + "value": "10" + } + ] + } + }, + "response": [] + }, + { + "name": "Search Main Addresses", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "[\n \"BPNS000000000001\"\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Pool-Host}}/api/catena/sites/main-addresses/search", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "sites", + "main-addresses", + "search" + ] + } + }, + "response": [] + }, + { + "name": "Site", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{Pool-Host}}/api/catena/sites/BPNS0000000007UH", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "sites", + "BPNS0000000007UH" + ] + } + }, + "response": [] + } + ] + }, + { + "name": "Address Controller", + "item": [ + { + "name": "Create Address Partners", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"WESTERN_LATIN_STANDARD\",\n \"states\": [\n {\n \"description\": \"WESTERN_LATIN_STANDARD\",\n \"validFrom\": \"2023-06-06T10:02:00.355Z\",\n \"validTo\": \"2024-06-06T10:02:00.355Z\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"identifiers\": [\n {\n \"value\": \"12345678910\",\n \"type\": \"CUSTOM_ID_ADD_TYPE\"\n }\n ],\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"DE\",\n \"postalCode\": \"70546\",\n \"city\": \"Stuttgart\",\n \"street\": {\n \"name\": \"Stuttgarter Strasse\",\n \"houseNumber\": \"1\",\n \"milestone\": \"Stuttgarter Strasse 1\",\n \"direction\": \"Stuttgarter Str.\"\n },\n \"administrativeAreaLevel1\": \"Baden-Wuerttemberg\",\n \"district\": \"Stuttgart\",\n \"companyPostalCode\": \"GM01\",\n \"industrialZone\": \"HEADQUARTER\",\n \"building\": \"Building A\",\n \"floor\": \"A\",\n \"door\": null\n },\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"DE\",\n \"postalCode\": \"1234\",\n \"city\": \"Stuttgart\",\n \"administrativeAreaLevel1\": \"Baden-Wuerttemberg test1\",\n \"deliveryServiceNumber\": \"test\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"test1\"\n },\n \"bpnParent\": \"BPNL000000000001\",\n \"index\": \"0\"\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Pool-Host}}/api/catena/addresses", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "addresses" + ] + } + }, + "response": [] + }, + { + "name": "Update Address Partner", + "request": { + "method": "PUT", + "header": [], + "body": { + "mode": "raw", + "raw": "[\n {\n \"bpna\": \"BPNA000000000001\",\n \"name\": \"WESTERN_LATIN_STANDARD\",\n \"states\": [\n {\n \"description\": \"WESTERN_LATIN_STANDARD\",\n \"validFrom\": \"2020-12-16T05:54:48.942\",\n \"validTo\": \"2023-06-05T07:31:01.213\",\n \"type\": \"ACTIVE\"\n }\n ],\n \"identifiers\": [\n {\n \"value\": \"12345678910\",\n \"type\": \"CUSTOM_ID_ADD_TYPE\"\n }\n ],\n \"physicalPostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"DE\",\n \"postalCode\": \"70546\",\n \"city\": \"Stuttgart\",\n \"street\": {\n \"name\": \"Stuttgarter Strasse\",\n \"houseNumber\": \"1\",\n \"milestone\": \"Stuttgarter Strasse 1\",\n \"direction\": \"Stuttgarter Str.\"\n },\n \"administrativeAreaLevel1\": null,\n \"administrativeAreaLevel2\": \"test1\",\n \"administrativeAreaLevel3\": \"test2\",\n \"district\": \"Stuttgart\",\n \"companyPostalCode\": \"GM01\",\n \"industrialZone\": \"HEADQUARTER\",\n \"building\": \"Building A\",\n \"floor\": \"A\",\n \"door\": \"test\"\n },\n \"alternativePostalAddress\": {\n \"geographicCoordinates\": {\n \"longitude\": 0,\n \"latitude\": 0,\n \"altitude\": 0\n },\n \"country\": \"DE\",\n \"postalCode\": \"Stuttgart 1\",\n \"city\": \"string\",\n \"administrativeAreaLevel1\": \"test1\",\n \"deliveryServiceNumber\": \"test2\",\n \"deliveryServiceType\": \"PO_BOX\",\n \"deliveryServiceQualifier\": \"test3\"\n }\n }\n]", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Pool-Host}}/api/catena/addresses", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "addresses" + ] + } + }, + "response": [] + }, + { + "name": "Address Partners", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{Pool-Host}}/api/catena/addresses?Name=ad&page=0&size=10", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "addresses" + ], + "query": [ + { + "key": "Name", + "value": "ad" + }, + { + "key": "postCode", + "value": "", + "disabled": true + }, + { + "key": "locality", + "value": "", + "disabled": true + }, + { + "key": "thoroughfare", + "value": "", + "disabled": true + }, + { + "key": "premise", + "value": "", + "disabled": true + }, + { + "key": "postalDeliveryPoint", + "value": "", + "disabled": true + }, + { + "key": "countryCode", + "value": "", + "disabled": true + }, + { + "key": "page", + "value": "0" + }, + { + "key": "size", + "value": "10" + } + ] + } + }, + "response": [] + }, + { + "name": "Search Address Partners", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"legalEntities\": [\n \"BPNL000000000001\"\n ],\n \"sites\": [\n \"BPNS000000000001\"\n ],\n \"addresses\": [\n \"BPNA000000000001\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Pool-Host}}/api/catena/addresses/search?page=0&size=10", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "addresses", + "search" + ], + "query": [ + { + "key": "page", + "value": "0" + }, + { + "key": "size", + "value": "10" + } + ] + } + }, + "response": [] + }, + { + "name": "Address Partner", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{Pool-Host}}/api/catena/addresses/BPNA000000000001", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "addresses", + "BPNA000000000001" + ] + } + }, + "response": [] + } + ] + }, + { + "name": "Opensearch Controller", + "item": [ + { + "name": "Check Opensearch Last Update Status", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{Pool-Host}}/api/opensearch/business-partner", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "opensearch", + "business-partner" + ] + } + }, + "response": [] + }, + { + "name": "Update Opensearch Index", + "request": { + "method": "POST", + "header": [], + "url": { + "raw": "{{Pool-Host}}/api/opensearch/business-partner", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "opensearch", + "business-partner" + ] + } + }, + "response": [] + }, + { + "name": "Empty Opensearch Index", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "{{Pool-Host}}/api/opensearch/business-partner", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "opensearch", + "business-partner" + ] + } + }, + "response": [] + } + ] + }, + { + "name": "BPN Controller", + "item": [ + { + "name": "Search BPNs", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"businessPartnerType\": \"LEGAL_ENTITY\",\n \"idType\": \"CUSTOM_ID_TYPE\",\n \"idValues\": [\n \"123456789\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Pool-Host}}/api/catena/bpn/search", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "bpn", + "search" + ] + } + }, + "response": [] + } + ] + }, + { + "name": "Changelog Controller", + "item": [ + { + "name": "Business Partner Changelog", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"timestampAfter\": \"2023-03-21T09:00:25.298594Z\",\n \"bpns\": [\n \"BPNL000000000001\"\n ],\n \"businessPartnerTypes\": [\n \"LEGAL_ENTITY\"\n ]\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{Pool-Host}}/api/catena/business-partners/changelog/search?page=0&size=10", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "business-partners", + "changelog", + "search" + ], + "query": [ + { + "key": "page", + "value": "0" + }, + { + "key": "size", + "value": "10" + } + ] + } + }, + "response": [] + } + ] + }, + { + "name": "Pool Documentation Controller", + "item": [ + { + "name": "mermaid", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{Pool-Host}}/api/catena/mermaid/", + "host": [ + "{{Pool-Host}}" + ], + "path": [ + "api", + "catena", + "mermaid", + "" + ] + } + }, + "response": [] + } + ] + } + ], + "auth": { + "type": "oauth2", + "oauth2": [ + { + "key": "accessTokenUrl", + "value": "{{Keycloak-Host}}/auth/realms/CX-Central/protocol/openid-connect/token", + "type": "string" + }, + { + "key": "client_authentication", + "value": "body", + "type": "string" + }, + { + "key": "clientSecret", + "value": "{{Pool-Client-Secret}}", + "type": "string" + }, + { + "key": "clientId", + "value": "{{Pool-Client-ID}}", + "type": "string" + }, + { + "key": "tokenName", + "value": "BPDM Pool Token {{Environment}}", + "type": "string" + }, + { + "key": "refreshRequestParams", + "value": [], + "type": "any" + }, + { + "key": "tokenRequestParams", + "value": [], + "type": "any" + }, + { + "key": "authRequestParams", + "value": [], + "type": "any" + }, + { + "key": "challengeAlgorithm", + "value": "S256", + "type": "string" + }, + { + "key": "grant_type", + "value": "client_credentials", + "type": "string" + }, + { + "key": "addTokenTo", + "value": "header", + "type": "string" + } + ] + }, + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } + } + ] +} \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/business-partner-data-management-bridge-dummy.info.mdx b/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/business-partner-data-management-bridge-dummy.info.mdx new file mode 100644 index 00000000000..9f966c14dad --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/business-partner-data-management-bridge-dummy.info.mdx @@ -0,0 +1,25 @@ +--- +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: 4.0.0-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-23.12/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/sidebar.js b/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/sidebar.js new file mode 100644 index 00000000000..26bad89f12c --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/sidebar.js @@ -0,0 +1 @@ +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-23.12/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/trigger-sync.api.mdx b/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/trigger-sync.api.mdx new file mode 100644 index 00000000000..3b9b10acbe7 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/Software Development View/Bridge Dummy Api/trigger-sync.api.mdx @@ -0,0 +1,34 @@ +--- +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":"4.0.0-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
+
+
Path Parameters
+
+Found address with external ID
+
+
Schema
states object[]
+
+The list of (temporary) states of the address.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
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.
+
+
+
+No address found under specified external ID
+
+
Query Parameters
Request Body array required
- string
+
+The requested page of addresses
+
+
Schema
content object[]
+
+Collection of results in the page
+
+
states object[]
+
+The list of (temporary) states of the address.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
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.
+
+
+
+On malformed pagination request
+
+
Query Parameters
Request Body array
- string
+
+The requested page of addresses
+
+
Schema
content object[]
+
+Collection of results in the page
+
+
states object[]
+
+The list of (temporary) states of the address.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
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.
+
+
+
+On malformed pagination request
+
+
Query Parameters
+
+The requested page of addresses
+
+
Schema
content object[]
+
+Collection of results in the page
+
+
states object[]
+
+The list of (temporary) states of the address.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
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.
+
+
+
+On malformed pagination request
+
+
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.
+
+
classifications object[]
+
+The list of classifications of the business partner, such as a specific industry. Sorted and duplicates removed by the service.
+
+
postalAddress object
+
+Postal address of a business partner
+
+
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.
+
+
+
+On malformed pagination request
+
+
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.
+
+
classifications object[]
+
+The list of classifications of the business partner, such as a specific industry. Sorted and duplicates removed by the service.
+
+
postalAddress object
+
+Postal address of a business partner
+
+
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.
+
+
+
+On malformed pagination request
+
+
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
+
+
Query Parameters
Request Body array required
- string
+
+The requested page of legal-entities
+
+
Schema
content object[]
+
+Collection of results in the page
+
+
identifiers object[]
+
+The list of identifiers of the legal entity.
+
+
states object[]
+
+The list of (temporary) states of the legal entity.
+
+
classifications object[]
+
+The list of classifications of the legal entity, such as a specific industry.
+
+
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.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
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.
+
+
+
+On malformed pagination request
+
+
Query Parameters
Request Body array
- string
+
+The requested page of legal entities
+
+
Schema
content object[]
+
+Collection of results in the page
+
+
identifiers object[]
+
+The list of identifiers of the legal entity.
+
+
states object[]
+
+The list of (temporary) states of the legal entity.
+
+
classifications object[]
+
+The list of classifications of the legal entity, such as a specific industry.
+
+
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.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
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.
+
+
+
+On malformed pagination request
+
+
Query Parameters
+
+The requested page of legal entities
+
+
Schema
content object[]
+
+Collection of results in the page
+
+
identifiers object[]
+
+The list of identifiers of the legal entity.
+
+
states object[]
+
+The list of (temporary) states of the legal entity.
+
+
classifications object[]
+
+The list of classifications of the legal entity, such as a specific industry.
+
+
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.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
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.
+
+
+
+On malformed pagination request
+
+
Path Parameters
+
+Found legal entity with external ID
+
+
Schema
identifiers object[]
+
+The list of identifiers of the legal entity.
+
+
states object[]
+
+The list of (temporary) states of the legal entity.
+
+
classifications object[]
+
+The list of classifications of the legal entity, such as a specific industry.
+
+
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.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
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.
+
+
+
+No legal entity found under specified external ID
+
+
+
+Entity model as mermaid diagramm
+
+
Schema
- string
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
+
+
Query Parameters
+
+Page of sharing states
+
+
Schema
content object[]
+
+Collection of results in the page
+
+
Path Parameters
+
+Found site with external ID
+
+
Schema
states object[]
+
+The list of the (temporary) states of the site.
+
+
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.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
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.
+
+
+
+No site found under specified external ID
+
+
Query Parameters
Request Body array required
- string
+
+The requested page of sites
+
+
Schema
content object[]
+
+Collection of results in the page
+
+
states object[]
+
+The list of the (temporary) states of the site.
+
+
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.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
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.
+
+
+
+On malformed pagination request
+
+
Query Parameters
Request Body array
- string
+
+The requested page of sites
+
+
Schema
content object[]
+
+Collection of results in the page
+
+
states object[]
+
+The list of the (temporary) states of the site.
+
+
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.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
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.
+
+
+
+On malformed pagination request
+
+
Query Parameters
+
+The requested page of sites
+
+
Schema
content object[]
+
+Collection of results in the page
+
+
states object[]
+
+The list of the (temporary) states of the site.
+
+
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.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
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.
+
+
+
+On malformed pagination request
+
+
Request Body array required
states object[]
+
+The list of (temporary) states of the address.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
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.
+
+
+
+Addresses were successfully updated or created
+
+
Schema
- object
+
+On malformed address request
+
+
Request Body array required
states object[]
+
+The list of (temporary) states of the address.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
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.
+
+
+
+Addresses were successfully updated or created
+
+
Schema
- object
+
+On malformed address request
+
+
Request Body array required
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.
+
+
classifications object[]
+
+The list of classifications of the business partner, such as a specific industry. Sorted and duplicates removed by the service.
+
+
postalAddress object
+
+Postal address of a business partner
+
+
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.
+
+
+
+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.
+
+
classifications object[]
+
+The list of classifications of the business partner, such as a specific industry. Sorted and duplicates removed by the service.
+
+
postalAddress object
+
+Postal address of a business partner
+
+
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.
+
+
+
+On malformed legal entity request
+
+
Request Body array required
identifiers object[]
+
+The list of identifiers of the legal entity.
+
+
states object[]
+
+The list of (temporary) states of the legal entity.
+
+
classifications object[]
+
+The list of classifications of the legal entity, such as a specific industry.
+
+
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.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
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.
+
+
+
+Legal entities were successfully updated or created
+
+
Schema
- object
+
+On malformed legal entity request
+
+
Request Body array required
identifiers object[]
+
+The list of identifiers of the legal entity.
+
+
states object[]
+
+The list of (temporary) states of the legal entity.
+
+
classifications object[]
+
+The list of classifications of the legal entity, such as a specific industry.
+
+
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.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
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.
+
+
+
+Legal entities were successfully updated or created
+
+
Schema
- object
+
+On malformed legal entity request
+
+
Request Body required
+
+Operation completed successfully
+
+
+
+Invalid data (e.g. external ID)
+
+
Request Body array required
states object[]
+
+The list of the (temporary) states of the site.
+
+
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.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
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.
+
+
+
+Sites were successfully updated or created
+
+
Schema
- object
+
+On malformed site request
+
+
Request Body array required
states object[]
+
+The list of the (temporary) states of the site.
+
+
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.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
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.
+
+
+
+Sites were successfully updated or created
+
+
Schema
- object
+
+On malformed site request
+
+
Request Body required
businessPartners object[]
+
+The list of business partner data to be processed
+
+
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.
+
+
classifications object[]
+
+The list of classifications of the business partner, such as a specific industry. Sorted and duplicates removed by the service.
+
+
postalAddress object
+
+Address of the official seat of this business partner.
+
+
physicalPostalAddress object
+
+The physical postal address of the address, such as an office, warehouse, gate, etc.
+
+
geographicCoordinates object
+
+The exact location of the physical postal address in latitude, longitude, and altitude.
+
+
street object
alternativePostalAddress object
+
+The alternative postal address of the address, 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.
+
+
+
+The states of successfully created tasks including the task identifier for tracking purposes.
+
+
Schema
createdTasks object[]
businessPartnerResult object
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.
+
+
classifications object[]
+
+The list of classifications of the business partner, such as a specific industry. Sorted and duplicates removed by the service.
+
+
postalAddress object
+
+Address of the official seat of this business partner.
+
+
physicalPostalAddress object
+
+The physical postal address of the address, such as an office, warehouse, gate, etc.
+
+
geographicCoordinates object
+
+The exact location of the physical postal address in latitude, longitude, and altitude.
+
+
street object
alternativePostalAddress object
+
+The alternative postal address of the address, 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.
+
+
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
+
+
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
+
+Business partner data in full representation, consisting of generic data as well as its L/S/A representation.
+
+
generic object
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.
+
+
classifications object[]
+
+The list of classifications of the business partner, such as a specific industry. Sorted and duplicates removed by the service.
+
+
postalAddress object
+
+Address of the official seat of this business partner.
+
+
physicalPostalAddress object
+
+The physical postal address of the address, such as an office, warehouse, gate, etc.
+
+
geographicCoordinates object
+
+The exact location of the physical postal address in latitude, longitude, and altitude.
+
+
street object
alternativePostalAddress object
+
+The alternative postal address of the address, 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.
+
+
legalEntity object
+
+The legal entity part of this business partner data
+
+
bpnLReference object
+
+A reference to the BPN of a business partner. Either by the BPN value itself or a BPN request identifier
+
+
identifiers object[]
+
+The list of identifiers of the legal entity.
+
+
states object[]
+
+The list of (temporary) states of the legal entity.
+
+
classifications object[]
+
+The list of classifications of the legal entity, such as a specific industry.
+
+
legalAddress object
+
+The address part of this business partner data
+
+
bpnAReference object
+
+A reference to the BPN of a business partner. Either by the BPN value itself or a BPN request identifier
+
+
states object[]
+
+The list of (temporary) states of the address.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
physicalPostalAddress object
+
+The physical postal address of the address, such as an office, warehouse, gate, etc.
+
+
geographicCoordinates object
+
+The exact location of the physical postal address in latitude, longitude, and altitude.
+
+
street object
alternativePostalAddress object
+
+The alternative postal address of the address, 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.
+
+
site object
+
+The site part of this business partner data
+
+
bpnSReference object
+
+A reference to the BPN of a business partner. Either by the BPN value itself or a BPN request identifier
+
+
states object[]
+
+The list of the (temporary) states of the site.
+
+
mainAddress object
+
+The address part of this business partner data
+
+
bpnAReference object
+
+A reference to the BPN of a business partner. Either by the BPN value itself or a BPN request identifier
+
+
states object[]
+
+The list of (temporary) states of the address.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
physicalPostalAddress object
+
+The physical postal address of the address, such as an office, warehouse, gate, etc.
+
+
geographicCoordinates object
+
+The exact location of the physical postal address in latitude, longitude, and altitude.
+
+
street object
alternativePostalAddress object
+
+The alternative postal address of the address, 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.
+
+
address object
+
+The address part of this business partner data
+
+
bpnAReference object
+
+A reference to the BPN of a business partner. Either by the BPN value itself or a BPN request identifier
+
+
states object[]
+
+The list of (temporary) states of the address.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
physicalPostalAddress object
+
+The physical postal address of the address, such as an office, warehouse, gate, etc.
+
+
geographicCoordinates object
+
+The exact location of the physical postal address in latitude, longitude, and altitude.
+
+
street object
alternativePostalAddress object
+
+The alternative postal address of the address, 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.
+
+
+
+On malformed task create requests or reaching upsert limit
+
+
Request Body required
results object[]
businessPartner object
+
+Business partner data in full representation, consisting of generic data as well as its L/S/A representation.
+
+
generic object required
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.
+
+
classifications object[]
+
+The list of classifications of the business partner, such as a specific industry. Sorted and duplicates removed by the service.
+
+
postalAddress object
+
+Address of the official seat of this business partner.
+
+
physicalPostalAddress object
+
+The physical postal address of the address, such as an office, warehouse, gate, etc.
+
+
geographicCoordinates object
+
+The exact location of the physical postal address in latitude, longitude, and altitude.
+
+
street object
alternativePostalAddress object
+
+The alternative postal address of the address, 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.
+
+
legalEntity object
+
+The legal entity part of this business partner data
+
+
bpnLReference object
+
+A reference to the BPN of a business partner. Either by the BPN value itself or a BPN request identifier
+
+
identifiers object[]
+
+The list of identifiers of the legal entity.
+
+
states object[]
+
+The list of (temporary) states of the legal entity.
+
+
classifications object[]
+
+The list of classifications of the legal entity, such as a specific industry.
+
+
legalAddress object
+
+The address part of this business partner data
+
+
bpnAReference object
+
+A reference to the BPN of a business partner. Either by the BPN value itself or a BPN request identifier
+
+
states object[]
+
+The list of (temporary) states of the address.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
physicalPostalAddress object
+
+The physical postal address of the address, such as an office, warehouse, gate, etc.
+
+
geographicCoordinates object
+
+The exact location of the physical postal address in latitude, longitude, and altitude.
+
+
street object
alternativePostalAddress object
+
+The alternative postal address of the address, 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.
+
+
site object
+
+The site part of this business partner data
+
+
bpnSReference object
+
+A reference to the BPN of a business partner. Either by the BPN value itself or a BPN request identifier
+
+
states object[]
+
+The list of the (temporary) states of the site.
+
+
mainAddress object
+
+The address part of this business partner data
+
+
bpnAReference object
+
+A reference to the BPN of a business partner. Either by the BPN value itself or a BPN request identifier
+
+
states object[]
+
+The list of (temporary) states of the address.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
physicalPostalAddress object
+
+The physical postal address of the address, such as an office, warehouse, gate, etc.
+
+
geographicCoordinates object
+
+The exact location of the physical postal address in latitude, longitude, and altitude.
+
+
street object
alternativePostalAddress object
+
+The alternative postal address of the address, 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.
+
+
address object
+
+The address part of this business partner data
+
+
bpnAReference object
+
+A reference to the BPN of a business partner. Either by the BPN value itself or a BPN request identifier
+
+
states object[]
+
+The list of (temporary) states of the address.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
physicalPostalAddress object
+
+The physical postal address of the address, such as an office, warehouse, gate, etc.
+
+
geographicCoordinates object
+
+The exact location of the physical postal address in latitude, longitude, and altitude.
+
+
street object
alternativePostalAddress object
+
+The alternative postal address of the address, 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.
+
+
errors object[]
+
+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
+
+
Request Body required
+
+The state of the tasks for the provided task identifiers.
+
+
Schema
tasks object[]
businessPartnerResult object
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.
+
+
classifications object[]
+
+The list of classifications of the business partner, such as a specific industry. Sorted and duplicates removed by the service.
+
+
postalAddress object
+
+Address of the official seat of this business partner.
+
+
physicalPostalAddress object
+
+The physical postal address of the address, such as an office, warehouse, gate, etc.
+
+
geographicCoordinates object
+
+The exact location of the physical postal address in latitude, longitude, and altitude.
+
+
street object
alternativePostalAddress object
+
+The alternative postal address of the address, 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.
+
+
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
+
+
+
+Index successfully cleared
+
+
+
+Clearing failed (no connection to OpenSearch or database)
+
+
Request Body array required
states object[]
+
+The list of (temporary) states of the address.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
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.
+
+
+
+New business partner record successfully created, possible errors are returned
+
+
Schema
entities object[]
states object[]
type object
+
+Named type uniquely identified by its technical key
+
+
identifiers object[]
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
+
+
errors object[]
+
+On malformed requests
+
+
Request Body array required
identifiers object[]
+
+The list of identifiers of the legal entity.
+
+
states object[]
+
+The list of (temporary) states of the legal entity.
+
+
classifications object[]
+
+The list of classifications of the legal entity, such as a specific industry.
+
+
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.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
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.
+
+
+
+New legal entities request was processed successfully, possible errors are returned
+
+
Schema
entities object[]
identifiers object[]
+
+The list of identifiers of the legal entity.
+
+
type object
+
+Named type uniquely identified by its technical key
+
+
legalForm object
+
+A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities.
+
+
states object[]
+
+The list of (temporary) states of the legal entity.
+
+
type object
+
+Named type uniquely identified by its technical key
+
+
classifications object[]
+
+The list of classifications of the legal entity, such as a specific industry.
+
+
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
+
+
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[]
type object
+
+Named type uniquely identified by its technical key
+
+
identifiers object[]
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
+
+
errors object[]
+
+On malformed requests
+
+
Request Body required
details object[]
+
+Validity details.
+
+
+
+New identifier type successfully created
+
+
Schema
details object[]
+
+Validity details.
+
+
+
+On malformed request parameters
+
+
+
+Identifier type with specified technical key already exists
+
+
Request Body required
+
+New legal form successfully created
+
+
Schema
+
+On malformed request parameters
+
+
+
+Legal form with specified technical key already exists
+
+
Request Body required
+
+New region successfully created
+
+
Schema
+
+On malformed request parameters
+
+
Request Body array required
states 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.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
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.
+
+
+
+New sites request was processed successfully, possible errors are returned
+
+
Schema
entities object[]
states object[]
type object
+
+Named type uniquely identified by its technical key
+
+
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[]
type object
+
+Named type uniquely identified by its technical key
+
+
identifiers object[]
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
+
+
errors object[]
+
+On malformed requests
+
+
+
+Export of records successfully
+
+
Schema
+
+Export failed (no connection to OpenSearch or database)
+
+
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
+
+
Path Parameters
+
+Found address with specified BPNA
+
+
Schema
states object[]
type object
+
+Named type uniquely identified by its technical key
+
+
identifiers object[]
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
+
+
+
+On malformed request parameters
+
+
+
+No address found under specified BPNA
+
+
Query Parameters
+
+Page of addresses matching the search criteria, may be empty
+
+
Schema
content object[]
+
+Collection of results in the page
+
+
address 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[]
type object
+
+Named type uniquely identified by its technical key
+
+
identifiers object[]
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
+
+
+
+On malformed search or pagination request
+
+
Path Parameters
Query Parameters
+
+The addresses for the specified BPNL
+
+
Schema
content object[]
+
+Collection of results in the page
+
+
states object[]
type object
+
+Named type uniquely identified by its technical key
+
+
identifiers object[]
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
+
+
+
+On malformed pagination request
+
+
+
+No business partner found for specified BPNL
+
+
Query Parameters
+
+Page of existing country subdivisions, may be empty
+
+
Schema
content object[]
+
+Collection of results in the page
+
+
+
+On malformed request parameters
+
+
+
+Export information found
+
+
Schema
+
+Fetching failed (no connection to database)
+
+
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
+
+
Query Parameters
+
+List of the existing rules for the given country
+
+
Schema array
+
+On malformed request parameters
+
+
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
+
+
Query Parameters
+
+Page of business partners matching the search criteria, may be empty
+
+
Schema
content object[]
+
+Collection of results in the page
+
+
identifiers object[]
+
+The list of identifiers of the legal entity.
+
+
type object
+
+Named type uniquely identified by its technical key
+
+
legalForm object
+
+A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities.
+
+
states object[]
+
+The list of (temporary) states of the legal entity.
+
+
type object
+
+Named type uniquely identified by its technical key
+
+
classifications object[]
+
+The list of classifications of the legal entity, such as a specific industry.
+
+
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
+
+
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[]
type object
+
+Named type uniquely identified by its technical key
+
+
identifiers object[]
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
+
+
+
+On malformed search or pagination request
+
+
Path Parameters
Query Parameters
+
+Found business partner with specified identifier
+
+
Schema
identifiers object[]
+
+The list of identifiers of the legal entity.
+
+
type object
+
+Named type uniquely identified by its technical key
+
+
legalForm object
+
+A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities.
+
+
states object[]
+
+The list of (temporary) states of the legal entity.
+
+
type object
+
+Named type uniquely identified by its technical key
+
+
classifications object[]
+
+The list of classifications of the legal entity, such as a specific industry.
+
+
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
+
+
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[]
type object
+
+Named type uniquely identified by its technical key
+
+
identifiers object[]
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
+
+
+
+On malformed request parameters
+
+
+
+No business partner found under specified identifier or specified identifier type not found
+
+
Query Parameters
+
+Page of existing legal forms, may be empty
+
+
Schema
content object[]
+
+Collection of results in the page
+
+
+
+On malformed request parameters
+
+
+
+Entity model as mermaid diagramm
+
+
Schema
- string
Query Parameters
+
+Page of existing regions, may be empty
+
+
Schema
content object[]
+
+Collection of results in the page
+
+
+
+On malformed request parameters
+
+
Path Parameters
+
+Found site with specified BPNS
+
+
Schema
states object[]
type object
+
+Named type uniquely identified by its technical key
+
+
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[]
type object
+
+Named type uniquely identified by its technical key
+
+
identifiers object[]
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
+
+
+
+On malformed request parameters
+
+
+
+No site found under specified BPNS
+
+
Query Parameters
+
+Page of business partners matching the search criteria, may be empty
+
+
Schema
content object[]
+
+Collection of results in the page
+
+
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[]
type object
+
+Named type uniquely identified by its technical key
+
+
identifiers object[]
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
+
+
site object
+
+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.
+
+
states object[]
type object
+
+Named type uniquely identified by its technical key
+
+
+
+On malformed pagination request
+
+
Path Parameters
Query Parameters
+
+The sites for the specified bpnl
+
+
Schema
content object[]
+
+Collection of results in the page
+
+
states object[]
type object
+
+Named type uniquely identified by its technical key
+
+
+
+On malformed pagination request
+
+
+
+No business partner found for specified bpnl
+
+
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[]
type object
+
+Named type uniquely identified by its technical key
+
+
identifiers object[]
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
+
+
+
+On malformed pagination request
+
+
Request Body array required
- string
+
+The found legal addresses
+
+
Schema array
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
+
+
+
+On malformed request parameters
+
+
Request Body array required
- string
+
+The found main addresses
+
+
Schema array
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
+
+
+
+On malformed request parameters
+
+
Request Body array required
- string
+
+Found legal entites
+
+
Schema array
identifiers object[]
+
+The list of identifiers of the legal entity.
+
+
type object
+
+Named type uniquely identified by its technical key
+
+
legalForm object
+
+A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities.
+
+
states object[]
+
+The list of (temporary) states of the legal entity.
+
+
type object
+
+Named type uniquely identified by its technical key
+
+
classifications object[]
+
+The list of classifications of the legal entity, such as a specific industry.
+
+
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
+
+
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[]
type object
+
+Named type uniquely identified by its technical key
+
+
identifiers object[]
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
+
+
+
+On malformed request parameters or if number of requested bpns exceeds limit
+
+
Query Parameters
Request Body required
+
+Found sites that belong to specified legal entites
+
+
Schema
content object[]
+
+Collection of results in the page
+
+
states object[]
type object
+
+Named type uniquely identified by its technical key
+
+
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[]
type object
+
+Named type uniquely identified by its technical key
+
+
identifiers object[]
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
+
+
+
+On malformed request parameters
+
+
Path Parameters
+
+Business partner's "currentness" successfully updated
+
+
+
+On malformed request parameters
+
+
+
+No business partner found for specified bpnl
+
+
Request Body array required
states object[]
+
+The list of (temporary) states of the address.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
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.
+
+
+
+The successfully updated records, possible errors are returned
+
+
Schema
entities object[]
states object[]
type object
+
+Named type uniquely identified by its technical key
+
+
identifiers object[]
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
+
+
errors object[]
+
+On malformed requests
+
+
Request Body array required
identifiers object[]
+
+The list of identifiers of the legal entity.
+
+
states object[]
+
+The list of (temporary) states of the legal entity.
+
+
classifications object[]
+
+The list of classifications of the legal entity, such as a specific industry.
+
+
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.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
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.
+
+
+
+Update legal entities request was processed successfully, possible errors are returned
+
+
Schema
entities object[]
identifiers object[]
+
+The list of identifiers of the legal entity.
+
+
type object
+
+Named type uniquely identified by its technical key
+
+
legalForm object
+
+A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities.
+
+
states object[]
+
+The list of (temporary) states of the legal entity.
+
+
type object
+
+Named type uniquely identified by its technical key
+
+
classifications object[]
+
+The list of classifications of the legal entity, such as a specific industry.
+
+
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
+
+
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[]
type object
+
+Named type uniquely identified by its technical key
+
+
identifiers object[]
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
+
+
errors object[]
+
+On malformed requests
+
+
Request Body array required
states 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.
+
+
identifiers object[]
+
+The list of identifiers of the address.
+
+
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.
+
+
+
+Update sites request was processed successfully, possible errors are returned
+
+
Schema
entities object[]
states object[]
type object
+
+Named type uniquely identified by its technical key
+
+
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[]
type object
+
+Named type uniquely identified by its technical key
+
+
identifiers object[]
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
+
+
errors object[]
+
+On malformed requests
+
+
+ + + +## Business Value + +** One open data model ** +Application and service providers reduce investments to integrate due to one data model / API specification and open interface. The pool API enables the integration and offering of value-added services and innovation based on high-quality master data. + +** Access to new market potentials ** +Potential to scale customer group and access new market potentials via Catena-X marketplace and shared service network. The BP Kit enables an interoperable foundation for value-added services. + +** The unique identifier ** +BPN is the unique number to identify and find partners in the Catena-X network. It will also provide high quality data sets from business partners, their legal unit, sites and addresses. + +** The industry’s largest golden record collection ** +as a shared and cost-optimized service (quality tested by the biggest players). + +--- +
+ +## Use Case +** Status Quo ** +**Todays challenge for automotive companies** + +Most of today’s automotive companies have to invest a significant amount of resources to keep their individual partner master data updated and correct, since outdated or incorrect data records result in federal fines and wrong claims / billing processes. The industry spends a vast amount into an area that is non differentiating, regulated and executed redundantly across the partners. + +For this, cutting individual company costs by offering the golden master data record as a shared service is the mission. And proactively reduce Business Partner risk via collaborative value-add services. +More insights to the business partner data management use case here: [Catena-X | Business Partner Use Case](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/5_PC_BPDM_v.2.1/BPM_-_001_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v2.1.pdf) + +This will become the industry’s largest golden record collection as a shared and cost-optimized service (quality tested by the biggest players). + +OEMs and small-medium enterprises: + +- Reduce today’s individual investments in master data management +- Re-allocate freed-up resources to differentiating / critical tasks +- Time to value within 6 months, due to standard interfaces and mapping tools (e.g. SAP) +- Increase data quality and use industry collective wisdom to act pro-actively (e.g. fraud alerts) + +Solution Provider: + +- Reduce investments to integrate due to one Data Model and open interface. +- The Kit enables the offering of value-add services and innovation based on golden record and collective wisdom. +- Potential to scale customer group and access new market potentials via marketplace and shared service network. + +## Standards +The standards for release 3.2 will be published soon. +Our relevant standards can be downloaded from the official [Catena-X Standard Library](https://catena-x.net/de/standard-library): + +- Business Partner Number (Version 2.0.0) + +- Business Partner Pool API (Version 2.0.0) + +- Business Partner Gate API (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,2023 ZF Friedrichshafen AG +- SPDX-FileCopyrightText: 2023,2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG) +- SPDX-FileCopyrightText: 2023,2023 SAP SE +- SPDX-FileCopyrightText: 2023,2023 Volkswagen AG +- SPDX-FileCopyrightText: 2023,2023 Robert Bosch GmbH +- SPDX-FileCopyrightText: 2023,2023 Mercedes Benz Group +- SPDX-FileCopyrightText: 2023,2023 BASF SE +- SPDX-FileCopyrightText: 2023,2023 Schaeffler AG +- SPDX-FileCopyrightText: 2023,2023 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/bpdm diff --git a/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/page_changelog.md b/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/page_changelog.md new file mode 100644 index 00000000000..25431bd8a98 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/page_changelog.md @@ -0,0 +1,61 @@ +--- +id: Changelog +title: Changelog +description: 'Business Partner Kit' +sidebar_position: 1 +--- + + + +### Business Partner KIT + +All notable changes to this Kit will be documented in this file. + +## [3.0.0] -2023-11-02 + +### Added + +- documentation for orchestrator and cleaning dummy service in software development view +- documentation of new services with installation steps in operation view +- documentation of bpdm architecture (arc42) + +### Changed + +- documentation of gate service with new endpoints for creating and querying generic business partners +- documentation of operation view for local deployment + +### Removed + +- documentation of old endpoints in software development view for gate and pool servicce + +## [2.0.0] - 2023-08-25 + +### Added + +- documentation of the software development view including the business partner data management for Gate and Bridge-Dummy API +- documentation of bpdm architecture (arc42) +- documentation versions based on Catena-X release + +### Changed + +- documentation of the operations view with an installation guide for all services + +### Removed + +- documentation of api references, troubleshooting and best practices + +## [1.0.0] - 2023-03-01 + +### Added + +- documentation of the software development view including the business partner data management POOL API +- documentation of adoption view +- documentation of the operations view with an installation guide for the POOL API + +### Changed + +- ./. + +### Removed + +- ./. diff --git a/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/page_software-operation-view.md b/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/page_software-operation-view.md new file mode 100644 index 00000000000..f484041184c --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Business Partner Kit/page_software-operation-view.md @@ -0,0 +1,584 @@ +--- +id: Operation View +title: Operation View +description: 'Business Partner Kit' +sidebar_position: 3 +--- + + + +### 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 | +|----------------------------------------------------------------------------------|-------------------------------------|-------------------------------------------------------------------------| +|| **[Install the prerequisites](#step-1-prerequisites)**| Install all necessary tools for this setup | +| | **[Check out the Code](#step-2-check-out-the-code)** | Get all necessary code to deploy the service and dependencies to the kuberneetes cluster| +| | **[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**: + + + +#### 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 +
Linked to [Traceability KIT](https://eclipse-tractusx.github.io/docs-kits/kits/Traceability%20Kit/Adoption%20View%20Traceability%20Kit/) | **Explanation** | Concept in Catena-X developed | Data Models that need to be filled (link to the relevant data models here) | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | ----------------------------------------------------------------------------- | +| a. Supplier Inquiry/As Designed | This is the initial phase of the process where the supplier is inquired about the design of the product. The data exchanged in this phase is an initial estimation of secondary material content. | Concept currently not developed | N/A | +| b. Supplier Selection/ As Planend | In this phase, the supplier is selected, and the data exchanged is based on the planned production and concretized to the previous phase. | Concept developed | 1. Part as Planned (Component)
2. SMC | +| c. SOP/ Industrialisation/ As Ordered | This phase involves the ordering and the start of the production process. The data exchanged is based on the actual production process. | Concept currently not developed | N/A | +| d. Post-SOP/ Serie/ As Built | This is the final phase of the process where the product is built, and the data exchanged is based on actual product specifications. The data exchange during this phase is regular and allows for the most precise calculation of SMC of all the stages. | Concept developed | 1a. Serial Part (Component)
**or**
1b. Batch
**and**
2. SMC | + +In addition to filling out the data model for Secondary Material Content, other data models must also be completed to ensure adequate information and compatibility within Catena-X. During the As-Planned phase, the Part as Planned (Component) data model must be filled in addition to the SMC data model. Once the as-built phase is reached, the serial part (Component) data model must be filled to provide information as manufacturer partID, and customer partID. As such, these values are not included in the SMC data model. + +#### 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, followed by the actual weight (unitOfMeasureValue). + +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 and mass-balancing can be found under 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). For Post-Consumer material, the differentiation whether the material originates from recycled end-of-life vehicles (isPreviousIndustryAutomotive) can be selected. 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: + +“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.” + +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.” + +#### Optional Information, such as Reutilization + +Optional information can be included to enhance the quality of the provided data, such as the percentage of material weight of reutilization material content (additionalInformation). + +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 the cycle.” + +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). + +**Figure 5** + + + +The schematic depiction above provides a visual representation of the connection between various material characteristics, facilitating an understanding of how different data points relate to each other and contribute to the calculation of SMC. + +#### 2. Order data + +To clearly identify the order and relevant material, the order number (orderNumber) can be provided on an optional basis. + +#### B. Accounting for chain of Custody Models + +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 6** +[^1] + +[^1]: Original image taken from [Mass Balance EMF White Paper](https://emf.thirdlight.com/link/f1phopemqs36-8xgjzx/@/preview/1?o), visually adapted for this purpose. + +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. 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 + +In implementing chain-of-custody methods, including the mass balance one, the following set of guiding principles shall be fulfilled: + +1. The use of chain-of-custody approaches shall achieve significant changes and an effective transition towards a more circular, more bio-based and lower GHG emissions production in complex value chains. +2. The choice and implementation of chain-of-custody approaches and models shall be transparent, clear, and credible – abiding by relevant standards such as ISO and CEN. Such credibility can also be achieved but is not limited to accepted third-party certification schemes, e.g. ISCC PLUS, REDCert2 and RSB. + Note: Certification Schemes are not yet available in all sectors. +3. Labels and claims referring to chain-of-custody controlled specified characteristics and used on products shall fulfill the following requirements: + + - description of the chain-of-custody approaches and models + - accurate and appropriate implementation of the chain-of-custody model + - compliant with existing standards and regulations + - non-misleading + + In case the “specified characteristic” content in products cannot be measured and verified, labels and claims products may reflect this in ways that clearly differentiate and specify the actual content. + +4. No double counting: A reliable bookkeeping system shall be installed at each operating site to avoid the sales of a greater amount of alternative attributed products than physically available in the company. + Additional requirements for mass balance chain of custody approach: +5. The operating sites in the spatial boundaries for mass balancing are under the operational control of the same company/corporate group/joint venture. +6. It shall be technically possible according to standard industry practice to produce a mass balanced product from an alternative feedstock. The share of mass-balanced material can be technically lower than the attributed share. + +Applied emissions factors for the mass balance system boundaries shall be material and process specific. + +For the SMC data model, information whether a mass-balanced approach has been applied or not can be provided in the data model. + +#### C. Calculation logic for SMC + +The secondary material quota (SMQ) is a KPI measuring the usage of secondary materials within a vehicle. A vehicle can be defined as the sum of its individual components. Therefore, the secondary material content (SMC) is defined as the ratio between secondary material used and total material used on component level. To enable steering for secondary material content on the component level, it is important to establish a common understanding of the SMC of a single material. Based on the data model and information provided earlier, the SMC of a material can be calculated. The SMC can be divided into different pillars: Pre-consumer material and Post-consumer material and, optional: Reutilization material content + +All secondary material usage types are being expressed as percentages of the relationship between secondary materials and total materials used. + +##### 1. Pre-consumer material content: + + + +**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.” + +##### 2. Post-consumer material content: + + + +**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.” + +##### 3. Optional: Reutilization content + + + +**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.” + +#### SMC and SMQ Calculation + +The SMC calculates as the sum of the above defined secondary material usage types: + + + +In the above-described manner, the secondary material content is to be calculated for every component of the vehicle. + +The SMQ as a KPI defined on vehicle level which is calculated based on the individual SMC’s of the respective components: + + + +It is important to note that data quality may vary during different stages of the process, and this should be taken into consideration to ensure the highest level of data accuracy. + +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 7** + + + +#### D. 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.secondary_material_content/1.0.0](https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.secondary_material_content/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 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 8** + + +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 Decomnissioning" + +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 9** + + + +##### 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 Relation Ship, 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 + +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 10** + + + +#### 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 11** + + + +## 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 | +| 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 +Ressource (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. | Translated from BMW Proposal +Resource Protection | Economical use of natural resources with the aim of preserving their quantity and function. | Translated from BMW Proposal +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 raw materials are recycled materials that can be used in manufacturing processes instead of or alongside virgin raw materials. | European Parliament +Secondary Raw Material Content | The secondary raw material content is calculated in proportion of secondary material and product weight. | +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 kit. | 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 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 diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/page-documentation.md b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/page-documentation.md new file mode 100644 index 00000000000..fc8b3778abf --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/page-documentation.md @@ -0,0 +1,17 @@ +--- +title: Documentation +--- + +## 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 diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/page-software-development-view.md b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/page-software-development-view.md new file mode 100644 index 00000000000..342adfa1e5e --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/page-software-development-view.md @@ -0,0 +1,17 @@ +--- +title: Development View +--- + +## 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 diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/page-software-operation-view.md b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/page-software-operation-view.md new file mode 100644 index 00000000000..0d118a86937 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/page-software-operation-view.md @@ -0,0 +1,17 @@ +--- +title: Software Operation View +--- + +## 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 diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/page_changelog.md b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/page_changelog.md new file mode 100644 index 00000000000..80dace7433a --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/page_changelog.md @@ -0,0 +1,16 @@ +--- +id: Changelog Circularity KIT +title: Changelog +description: 'Circularity KIT' +sidebar_position: 1 +--- + +## [0.1.0] - 2023-12-08 + +### Added + +- add Circularity KIT to Tractus-X Repository + +### Changed + +### Removed \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/Relationship_between_Material_Characteristics.svg b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/Relationship_between_Material_Characteristics.svg new file mode 100644 index 00000000000..713d1b6224c --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/Relationship_between_Material_Characteristics.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/circularity_kit_wheel.svg b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/circularity_kit_wheel.svg new file mode 100644 index 00000000000..fd70f4a359c --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/circularity_kit_wheel.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/circularity_kit_wheel.svg.license b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/circularity_kit_wheel.svg.license new file mode 100644 index 00000000000..9ffcef3ef98 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/circularity_kit_wheel.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 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 diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/custody_models.svg b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/custody_models.svg new file mode 100644 index 00000000000..dda1316d865 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/custody_models.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/custody_models.svg.license b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/custody_models.svg.license new file mode 100644 index 00000000000..9ffcef3ef98 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/custody_models.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 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 diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/datapoints_along_valuechain.svg b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/datapoints_along_valuechain.svg new file mode 100644 index 00000000000..17fb5a9a5a5 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/datapoints_along_valuechain.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/datapoints_along_valuechain.svg.license b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/datapoints_along_valuechain.svg.license new file mode 100644 index 00000000000..9ffcef3ef98 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/datapoints_along_valuechain.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 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 diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/eq_post_consumer_material_content.svg b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/eq_post_consumer_material_content.svg new file mode 100644 index 00000000000..fdde1843de1 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/eq_post_consumer_material_content.svg @@ -0,0 +1,120 @@ + + + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/eq_pre_consumer_material_content.svg b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/eq_pre_consumer_material_content.svg new file mode 100644 index 00000000000..a4a7e10ac50 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/eq_pre_consumer_material_content.svg @@ -0,0 +1,117 @@ + + + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/equation_Reutilization_content.svg b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/equation_Reutilization_content.svg new file mode 100644 index 00000000000..ec6acddff74 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/equation_Reutilization_content.svg @@ -0,0 +1,90 @@ + + + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/equation_SMC.svg b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/equation_SMC.svg new file mode 100644 index 00000000000..dc6e483e2fa --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/equation_SMC.svg @@ -0,0 +1,125 @@ + + + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/equation_SMQ.svg b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/equation_SMQ.svg new file mode 100644 index 00000000000..47e467f0a69 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/equation_SMQ.svg @@ -0,0 +1,120 @@ + + + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/figure11.svg b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/figure11.svg new file mode 100644 index 00000000000..fa1369d3daf --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/figure11.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/figure7.svg b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/figure7.svg new file mode 100644 index 00000000000..12f7541730d --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/figure7.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF.svg b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF.svg new file mode 100644 index 00000000000..d9141023833 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF.svg.license b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF.svg.license new file mode 100644 index 00000000000..9ffcef3ef98 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/figure_dataJourney_EOF.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 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 diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/figure_user_journey_codm.svg b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/figure_user_journey_codm.svg new file mode 100644 index 00000000000..be0629a7112 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/figure_user_journey_codm.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/figure_user_journey_codm.svg.license b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/figure_user_journey_codm.svg.license new file mode 100644 index 00000000000..9ffcef3ef98 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/figure_user_journey_codm.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 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 diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/figure_userstory_ce_assistant.svg b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/figure_userstory_ce_assistant.svg new file mode 100644 index 00000000000..83d7697e113 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/figure_userstory_ce_assistant.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/figure_userstory_ce_assistant.svg.license b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/figure_userstory_ce_assistant.svg.license new file mode 100644 index 00000000000..9ffcef3ef98 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/figure_userstory_ce_assistant.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 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 diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/material_charactersitics.svg b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/material_charactersitics.svg new file mode 100644 index 00000000000..c74039e5531 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/material_charactersitics.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/material_charactersitics.svg.license b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/material_charactersitics.svg.license new file mode 100644 index 00000000000..9ffcef3ef98 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/material_charactersitics.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 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 diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/overview_material_flow.svg b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/overview_material_flow.svg new file mode 100644 index 00000000000..30f68afbb37 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/overview_material_flow.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/overview_material_flow.svg.license b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/overview_material_flow.svg.license new file mode 100644 index 00000000000..9ffcef3ef98 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/overview_material_flow.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 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 diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/userJourney_smc.svg b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/userJourney_smc.svg new file mode 100644 index 00000000000..bc9d8c03cbe --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/userJourney_smc.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/userJourney_smc.svg.license b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/userJourney_smc.svg.license new file mode 100644 index 00000000000..9ffcef3ef98 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Circularity_KIT/resources/adoption-view/userJourney_smc.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 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 diff --git a/docs-kits_versioned_docs/version-23.12/kits/Data Chain Kit/Documentation/admin_guide.md b/docs-kits_versioned_docs/version-23.12/kits/Data Chain Kit/Documentation/admin_guide.md new file mode 100644 index 00000000000..870c52e0cf2 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Data Chain Kit/Documentation/admin_guide.md @@ -0,0 +1,721 @@ +--- +id: irs_admin_guide +title: Administration Guide +description: 'Administration Guide' +sidebar_position: 3 +--- + + + +### Data Chain KIT + +## System Overview + +The deployment contains the components required to connect the IRS to an existing Catena-X network. This includes: + +* IRS with Minio - part of the "irs-helm" Helm chart +* EDC Consumer (controlplane & dataplane) - part of the "irs-edc-consumer" Helm chart + +Everything else needs to be provided externally. + + + +## Installation + +The IRS Helm repository can be found here: +
Path Parameters
+
+Cancel a batch order for a given orderId.
+
+
Schema
batches object[]
+
+**Possible values:** `<= 2147483647`
+
+
+
+Array of batches.
+
+
jobs object[]
+
+**Possible values:** `<= 2147483647`
+
+
+
+Array of jobs.
+
+
+
+Return Batch Order failed.
+
+
Schema
+
+No valid authentication credentials.
+
+
Schema
+
+Authorization refused by server.
+
+
Schema
+
+Batch Order with the requested orderId not found.
+
+
Schema
Path Parameters
+
+Job with requested jobId canceled.
+
+
Schema
exception object
+
+Job error details.
+
+
parameter object
+
+Job parameter of job processing.
+
+
summary object
+
+Summary of the job with statistics of the job processing.
+
+
asyncFetchedItems object
+
+Statistics of job execution.
+
+
bpnLookups object
+
+Statistics of job execution.
+
+
+
+Cancel job failed.
+
+
Schema
+
+No valid authentication credentials.
+
+
Schema
+
+Authorization refused by server.
+
+
Schema
+
+Job for requested jobId not found.
+
+
Schema
+
+Returns all available aspect models.
+
+
Schema
models object[]
+
+No valid authentication credentials.
+
+
Schema
+
+Authorization refused by server.
+
+
Schema
Path Parameters
+
+Get a batch order for a given orderId.
+
+
Schema
batches object[]
+
+**Possible values:** `<= 2147483647`
+
+
+
+Array of batches.
+
+
jobs object[]
+
+**Possible values:** `<= 2147483647`
+
+
+
+Array of jobs.
+
+
+
+Return Batch Order failed.
+
+
Schema
+
+No valid authentication credentials.
+
+
Schema
+
+Authorization refused by server.
+
+
Schema
+
+Batch Order with the requested orderId not found.
+
+
Schema
Path Parameters
+
+Get a batch with a given batchId for a given orderId.
+
+
Schema
jobs object[]
+
+**Possible values:** `<= 2147483647`
+
+
+
+Array of jobs.
+
+
+
+Return batch failed.
+
+
Schema
+
+No valid authentication credentials.
+
+
Schema
+
+Authorization refused by server.
+
+
Schema
+
+Batch with the requested orderId and batchId not found.
+
+
Schema
Path Parameters
+
+Return job with item graph for the requested id.
+
+
Schema
property name*object
bpns object[]
+
+**Possible values:** `<= 2147483647`
+
+
+
+Collection of bpn mappings
+
+
job object
+
+Executable unit with meta information and item graph result.
+
+
exception object
+
+Job error details.
+
+
parameter object
+
+Job parameter of job processing.
+
+
summary object
+
+Summary of the job with statistics of the job processing.
+
+
asyncFetchedItems object
+
+Statistics of job execution.
+
+
bpnLookups object
+
+Statistics of job execution.
+
+
relationships object[]
+
+**Possible values:** `<= 2147483647`
+
+
+
+Relationships between parent and child items.
+
+
linkedItem object
+
+Set of child parts the parent object is assembled by (one structural level down).
+
+
quantity object
+
+Quantity component.
+
+
measurementUnit object
shells object[]
+
+**Possible values:** `<= 2147483647`
+
+
+
+AAS shells.
+
+
administration object
description object[]
+
+**Possible values:** `<= 2147483647`
+
+
globalAssetId object
specificAssetIds object[]
+
+**Possible values:** `<= 2147483647`
+
+
semanticId object
subjectId object
submodelDescriptors object[]
+
+**Possible values:** `<= 2147483647`
+
+
administration object
description object[]
+
+**Possible values:** `<= 2147483647`
+
+
endpoints object[]
+
+**Possible values:** `<= 2147483647`
+
+
protocolInformation object
semanticId object
submodels object[]
+
+**Possible values:** `<= 2147483647`
+
+
+
+Collection of requested Submodels
+
+
payload object
tombstones object[]
+
+**Possible values:** `<= 2147483647`
+
+
+
+Collection of not resolvable endpoints as tombstones. Including cause of error and endpoint URL.
+
+
processingError object
+
+Return job failed.
+
+
Schema
+
+No valid authentication credentials.
+
+
Schema
+
+Authorization refused by server.
+
+
Schema
+
+Job with the requested jobId not found.
+
+
Schema
Path Parameters
Query Parameters
+
+Return job with item graph for the requested id.
+
+
Schema
property name*object
bpns object[]
+
+**Possible values:** `<= 2147483647`
+
+
+
+Collection of bpn mappings
+
+
job object
+
+Executable unit with meta information and item graph result.
+
+
exception object
+
+Job error details.
+
+
parameter object
+
+Job parameter of job processing.
+
+
summary object
+
+Summary of the job with statistics of the job processing.
+
+
asyncFetchedItems object
+
+Statistics of job execution.
+
+
bpnLookups object
+
+Statistics of job execution.
+
+
relationships object[]
+
+**Possible values:** `<= 2147483647`
+
+
+
+Relationships between parent and child items.
+
+
linkedItem object
+
+Set of child parts the parent object is assembled by (one structural level down).
+
+
quantity object
+
+Quantity component.
+
+
measurementUnit object
shells object[]
+
+**Possible values:** `<= 2147483647`
+
+
+
+AAS shells.
+
+
administration object
description object[]
+
+**Possible values:** `<= 2147483647`
+
+
globalAssetId object
specificAssetIds object[]
+
+**Possible values:** `<= 2147483647`
+
+
semanticId object
subjectId object
submodelDescriptors object[]
+
+**Possible values:** `<= 2147483647`
+
+
administration object
description object[]
+
+**Possible values:** `<= 2147483647`
+
+
endpoints object[]
+
+**Possible values:** `<= 2147483647`
+
+
protocolInformation object
semanticId object
submodels object[]
+
+**Possible values:** `<= 2147483647`
+
+
+
+Collection of requested Submodels
+
+
payload object
tombstones object[]
+
+**Possible values:** `<= 2147483647`
+
+
+
+Collection of not resolvable endpoints as tombstones. Including cause of error and endpoint URL.
+
+
processingError object
+
+Return job with current processed item graph for the requested id.
+
+
Schema
property name*object
bpns object[]
+
+**Possible values:** `<= 2147483647`
+
+
+
+Collection of bpn mappings
+
+
job object
+
+Executable unit with meta information and item graph result.
+
+
exception object
+
+Job error details.
+
+
parameter object
+
+Job parameter of job processing.
+
+
summary object
+
+Summary of the job with statistics of the job processing.
+
+
asyncFetchedItems object
+
+Statistics of job execution.
+
+
bpnLookups object
+
+Statistics of job execution.
+
+
relationships object[]
+
+**Possible values:** `<= 2147483647`
+
+
+
+Relationships between parent and child items.
+
+
linkedItem object
+
+Set of child parts the parent object is assembled by (one structural level down).
+
+
quantity object
+
+Quantity component.
+
+
measurementUnit object
shells object[]
+
+**Possible values:** `<= 2147483647`
+
+
+
+AAS shells.
+
+
administration object
description object[]
+
+**Possible values:** `<= 2147483647`
+
+
globalAssetId object
specificAssetIds object[]
+
+**Possible values:** `<= 2147483647`
+
+
semanticId object
subjectId object
submodelDescriptors object[]
+
+**Possible values:** `<= 2147483647`
+
+
administration object
description object[]
+
+**Possible values:** `<= 2147483647`
+
+
endpoints object[]
+
+**Possible values:** `<= 2147483647`
+
+
protocolInformation object
semanticId object
submodels object[]
+
+**Possible values:** `<= 2147483647`
+
+
+
+Collection of requested Submodels
+
+
payload object
tombstones object[]
+
+**Possible values:** `<= 2147483647`
+
+
+
+Collection of not resolvable endpoints as tombstones. Including cause of error and endpoint URL.
+
+
processingError object
+
+Return job failed.
+
+
Schema
+
+No valid authentication credentials.
+
+
Schema
+
+Authorization refused by server.
+
+
Schema
+
+Job with the requested jobId not found.
+
+
Schema
Query Parameters
+
+Paginated list of jobs with state and execution times for requested job states.
+
+
Schema
content object[]
+
+Return jobs for requested job states failed.
+
+
Schema
+
+No valid authentication credentials.
+
+
Schema
+
+Authorization refused by server.
+
+
Schema
Authentication
| Security Scheme Type: | oauth2 |
|---|---|
| clientCredentials OAuth Flow: | Token URL: https://localhost Scopes:
|
Request Body required
property name*object
content object required
header object required
+
+EDC notification header information
+
+
+
+Notification received successfully.
+
+
+
+Notification malformed.
+
+
Schema
Request Body required
+
+Returns id of registered job.
+
+
Schema
+
+Job registration failed.
+
+
Schema
+
+No valid authentication credentials.
+
+
Schema
+
+Authorization refused by server.
+
+
Schema
Request Body required
+
+Returns id of registered job.
+
+
Schema
+
+Job registration failed.
+
+
Schema
+
+No valid authentication credentials.
+
+
Schema
+
+Authorization refused by server.
+
+
Schema
Request Body required
+
+Returns orderId of registered Batch order.
+
+
Schema
+
+Batch Order registration failed.
+
+
Schema
+
+No valid authentication credentials.
+
+
Schema
+
+Authorization refused by server.
+
+
Schema
+
Trace-X
++
Trace-X empowers all companies from SMEs to large OEMs to participate in parts traceability with an Open-Source solution.
+ + + +The Open-Source Traceability application is developed within the Catena-X project and enables all companies to participate in Parts Traceability. +Trace-X offers capabilities to ingest data for serialized parts and batches as well as their child components. Within CX, we strive to establish a standardized, data-sovereign and interoperable exchange of traceability data along the value creation chain. + +The application gives an overview of the supplier network and the supply chain. A high level of transparency across the supplier network enables faster intervention based on recorded events in the supply chain. Additionally, automated massages regarding Quality related incidents. +All this saves' costs by seamlessly tracking parts as well as creates trust through clearly defined and secure data access by the companies and persons involved in the process. + + + +Applying and using the Item Relationship Service had the following benefits: + +* With the decision using the IRS we could speed our development of Trace-X through out the scope of their helm charts including a running service with test data. That alone was very benefitial to have a stable environment with data +* The IRS fulfills a high level of quality in code which provides a reliable service +* The deployment via helm charts has been built so that it can fit in existing architecture components through out configuration like the Digital Twin Registry, the EDC, Semantic Hub, Keycloack and others. This enabled Trace-X to configure the Service smoothly into the architecture of the application +* The IRS abstracts the communication with partners along the supply chain, that makes it easy to build business processes on that. It abstracts a technical level to a logical level to enhance the speed of implementation of a Software Provider +* The IRS with the standardized API provides a data interoperability level on data chains +* The Team behind the IRS is fast in implementing and adapting new features ++
+ + + + + + diff --git a/docs-kits_versioned_docs/version-23.12/kits/Data Chain Kit/Success Stories/success_stories.mdx b/docs-kits_versioned_docs/version-23.12/kits/Data Chain Kit/Success Stories/success_stories.mdx new file mode 100644 index 00000000000..5ddcd49d879 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Data Chain Kit/Success Stories/success_stories.mdx @@ -0,0 +1,10 @@ +--- +id: IRS Success Stories index +title: IRS Success Stories index +description: 'asdf' +sidebar_position: 3 +slug: /sidebar +--- + + +asdfasd \ No newline at end of file diff --git a/docs-kits_versioned_docs/version-23.12/kits/Data Chain Kit/arc/page_documentation.md b/docs-kits_versioned_docs/version-23.12/kits/Data Chain Kit/arc/page_documentation.md new file mode 100644 index 00000000000..3502407f2fd --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Data Chain Kit/arc/page_documentation.md @@ -0,0 +1,14 @@ +--- +id: documentation +title: Documentation +description: 'Data Chain Kit' +sidebar_position: 3 +--- + + + +## INCLUDE + +* [https://eclipse-tractusx.github.io/item-relationship-service/docs/](https://eclipse-tractusx.github.io/item-relationship-service/docs) + +Under the following you will find the documentation from the IRS diff --git a/docs-kits_versioned_docs/version-23.12/kits/Data Chain Kit/page_adoption-view.md b/docs-kits_versioned_docs/version-23.12/kits/Data Chain Kit/page_adoption-view.md new file mode 100644 index 00000000000..bb141f2bfe2 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Data Chain Kit/page_adoption-view.md @@ -0,0 +1,293 @@ +--- +id: Adoption View Data Chain Kit +title: Adoption View +description: 'Data Chain Kit' +sidebar_position: 1 +--- + + + +### Data Chain Kit + +## Vision & Mission + +### Vision + +DataChainKit brings valuable data chain information to your use-cases and services through connected data that can help Business Owner and Catena-X participants to be up-to-date and prepared. It's easy to use the DataChainKit with an Open Source Software package, which can easily deployed via HELM or docker-compose. The DataChainKit enables to apply business logic along a distributed data chains, for example aggregation of certificates along the value chain. Also, ad-hoc provisioning of continuous data chains across company boundaries for empowerment of use cases Circular Economy, Traceability, Quality and the European supply chain act. + +(#GreenIT#DataSovereignty#Interoperability#ConnectedData) + +### Mission + +The Data Chain KIT provides a reference implementation as functional federated component to handle ad-hoc data chains across n-tiers within the Catena-X network. To realize these data chains, the Data Chain Kit relies on data models of the Traceability use case and provides the federated data chains to customers or applications. Furthermore, the target picture of the IRS includes the enablement of new business areas by means of data chains along the value chain in the automotive industry. + +All described specifications in the KIT are based on Catena-X standards and refer to other Catena-X KITs like the Connector KIT (EDC) and Digital Twin Registry to ensure interoperability and data sovereignty according to IDSA and Gaia-X principles. + +### Customer Journey + +With the Data Chain KIT, we support the Catena-X customer journey for our adopters and solutions providers. + +There are few steps for your Customer Journey: +* Step 1: Inform yourself & take the decision to become part +* Step 2: Connect your company & teams to Catena-X. +* Step 3: Boost data readiness and governance +* Step 4: Adopt a data driven business process and create instant value +* Step 5: Utilize the full power of collaboration in your business team + + +## Business Value + +### IRS Iterative + +* Application and Service provider can reduce integrate or migrate due to one API specification +* The IRS Iterative API enables an easy interface for complex network tasks +* Potential to scale and optimize network traffic +* The IRS Iterative API is providing one Endpoint to access and collect widely distributed data +* The Data Chain Kit enables interoperability for Data Chains along the value chain to extend + +### IRS Recursive +* Application and Service provider can reduce integrate or migrate due to one API specification +* The IRS Recursive API enables an easy interface for complex network tasks +* The IRS Recursive API enables different use cases which collect insights over distributed data by not disclosing the supply chain +* The solution enables interoperability with other solutions along the value chain to extend + + +## Use Case + +### Environmental Social Responsibility (ESR) + +_Use Case for achieving compliance for Environmental Social Responsibility (ESR) for a component in the supply chain (multi-tier)_ + +In the use case, it was assumed that a company in the supply chain is considered "compliant" if that company can show the ISO 14001 certificate. Presenting means that either the company itself provides it as a data provider or deposits it in a certificate repository with a service provider. + +The benefit of the solution is to obtain an automated overview of the supply chain's compliance and to be able to check it again and again on a cyclical basis. The companies in the supply chain are not disclosed, which follows the Catena-X specifications. + +The decentralized implementation at Catena-X "traverses" from the OEM to the direct supplier and from the direct supplier to its next supplier and thus through the supply chain for a specific component. Each partner determines its direct supplier automatically via the parts list stored by it in Catena-X's Item Relationship Service (IRS). + +Aggregated information on the compliance of the upstream suppliers is returned to the OEM via each stage of the supply chain. From this, the OEM can finally read how many companies are compliant and how many are non-compliant in its supply chain for the component. + +The names of the suppliers further down the supply chain are not disclosed to follow the Catena-X data sovereignty principle one-up-one-down, but each intermediate level sees which of the direct suppliers are non-compliant and can act, so that perspectively the whole supply chain is assessed as compliant. + +### Environmental and Social Standards (ESS) Top-Down + +With the entry into force of the German Supply Chain Due Diligence Act as from January 1st, 2023, German companies are +obliged to implement the corresponding requirements of this law. In addition, the following European directives on this +subject have also been adopted: EU regulation 2018/858. This regulation is legally binding to all EU member states. + +This use-case facilitates the [IRS Recursive](#irs-recursive-1) approach and enables data providers to provide the BoM +as planned aspect models via the Catena-X defined solution +stack (i.e. EDC). The BoM as planned aspect models consists of three aspect models: + +- SingleLevelBomAsPlanned - The single-level bill of material (BoM) represents one sub-level of an assembly and does not + include any lower-level subassemblies. In the As-Planned lifecycle state all variants are covered ("120% BoM"). If multiple versions of child parts exist that can be assembled into the same parent part, all versions of the child part are included in the BoM. If there are multiple suppliers for the same child part, each supplier has an entry for their child part in the BoM. +- PartAsPlanned - representation of an item in the Catena-X Bill of Material (BOM) in As-Planned lifecycle status in a specific version. This also includes information about the validityPeriod - the period of time during which the Part is offered by the manufacturer and can be purchased by customers. +- PartSiteInformationAsPlanned - Site related information for a given as planned item. A site is a delimited geographical area where a legal entity does business. In the "as planned" lifecycle context all potentially related sites are listed including all sites where e.g. production of this part (type) is planned. + +#### Step 0: Process initiation + +The process is initiated by an ESS incident, that is received by (or created within) the inquiring company. This ESS incident acts as the root incident for the overall process. The incident contains a company name (incl. address) and a valid BPN exists for that company. The BPN (a BPNL or BPNS) can be looked up in BPDM. + +#### Step 1: Check direct suppliers + +The inquiring company checks, if the company of the incident is a direct supplier of them. In order to perform this check, the following data must be available in the inquiring company: + +- Full list of direct suppliers +- Full list of parts supplied by those direct suppliers + +In case the company of the incident is a direct supplier of the inquiring company, the process ends. In case the company of the incident is not a direct supplier of the inquiring company, Step 2 is executed. + +#### Step 2: Forward Incident + +The incident is forwarded to all direct suppliers. Each direct supplier is sent a "personalized" request to evaluate, if the inquiring company is impacted by the incident. The incident is enhanced with additional data by the inquiring company: + +- List of parts, that are supplied to the inquiring company by their direct supplier. + +Each direct supplier executes Step 1. + +#### Step 3: Gather Responses + +The inquiring company collects the (asynchronous) responses. The response of each direct supplier may contain the following results: + +- YES → The company of the incident was found in the supply chain of the given list of parts. In this case, the result also contains the BPN of the direct supplier where the incident occurred alongside the number of hops (i.e. how many levels down the chain) to where the incident occurred +- NO → The company of the incident was not found in the supply chain of the given list of parts +- UNKNOWN → The query timed out or some other error occurred + +In case at least one "YES" is received, the process step 3 ends + +### Environmental and Social Standards (ESS) Bottom-Up + +The occasion related traceability helps stakeholders to identify if a company that is detected for social or environmental misbehavior is part of its own supply chain. In case of a hit, the inquiring company and the originator company will be informed by the response, and therefore if the specific company has to start investigations. + +Similar to the ESS use-case Top-Down, ESS Bottom-Up focuses on notifying customers about incidents in the supply chain. The difference to Top-Down is that the Bottom-Up approach only investigates on one level and does not send any notifications. To achieve this goal, IRS uses these aspect models: + +- SingleLevelUsageAsPlanned - The aspect provides the information in which parent part(s)/product(s) the given item is assembled in. This could be a 1:1 relationship in terms of e.g. a brake component or 1:n for e.g. coatings. The given item as well as the parent item must refer to an object from as-planned lifecycle phase. If multiple versions of parent parts exist that the child part can be assembled into, all versions of the parent part are included in the usage list. +- PartAsPlanned - representation of an item in the Catena-X Bill of Material (BOM) in As-Planned lifecycle status in a specific version. This also includes information about the validityPeriod - the period of time during which the Part is offered by the manufacturer and can be purchased by customers. +- PartSiteInformationAsPlanned - Site related information for a given "as planned" item. A site is a delimited geographical area where a legal entity does business. In the "as planned" lifecycle context all potentially related sites are listed including all sites where e.g. production of this part (type) is planned. + +For the originator company, IRS validates whether the requested BPNS is part of their PartSiteInformationAsPlanned and whether the provided validityTimestamp is within the validityPeriod of PartAsPlanned. If this is the case, IRS will then collect all the BPNLs of the direct customer and return the affected parts in the following structure for an incident company to handle further incident management: + +```json +{ + "customers": [ + { + "businessPartnerNumberLegalEntity": "
Fixed
+ +- Update documentation: Local deployment currently requires IRS version 2.4.0. See https://github.com/eclipse-tractusx/item-relationship-service/issues/247. + + +## [1.1.0] - 2023-08-25 + +Added
+ +- Adoption View: added NOTICE section according to TRG 7.0.7 Legal notice for non-code (e.g. documentation) +- Adoption View: added Vision & Mission +- Adoption View: added Customer Journey +- Adoption View: added Business Value +- Adoption View: added IRS Components and Catena-X Core Services +- Adoption View: added Business Process +- Adoption View: added Standards +- Adoption View: added irs building block for decentral architecture + + +Changed
+- Adoption View: adaption to new structure of Adoption View + +## [1.0.0] - 2023-03-01 + +Added
+ +- documentation of the IRS API +- documentation of adoption view +- documentation of software development view +- documentation of the IRS reference implementation +- two success stories how this Kit is used + +Changed
+ +- ./. + +Removed
+ +- ./. diff --git a/docs-kits_versioned_docs/version-23.12/kits/Data Chain Kit/page_software-operation-view.md b/docs-kits_versioned_docs/version-23.12/kits/Data Chain Kit/page_software-operation-view.md new file mode 100644 index 00000000000..8b5dfec06ab --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Data Chain Kit/page_software-operation-view.md @@ -0,0 +1,269 @@ +--- +id: Operation View +title: Operation View +description: 'Data Chain Kit' +sidebar_position: 2 +--- + + + +### Data Chain KIT + +## Local Deployment + +> **Please note that this demo is currently based on IRS version 2.4.0.** + +Run a working demo scenario of the Item Relationship Service with a mocked Catena-X network to retrieve data chains with the following components: + +* Item Relationship Service +* Eclipse Dataspace Connector for accessing data +* Eclipse Dataspace Connector for data provisioning +* a submodel server and testdata for provisioning test digital twins +* an OIDC authentication provider mock +* Registry Service to register test digital twins +* Item Relationship Service Debugging View to visualize the results of the Item Relationship Service + +This emulates the communication over EDC, retrieving assets via a registry and building one continuous data chain with data from different companies. + +This local deployment is an easy installation with helm. This setup is built to run on a kubernetes cluster. + +| Step | Action | Description | +|----------------------------------------------------------------------------------|-------------------------------------|-------------------------------------------------------------------------| +|| **[Install the prerequisites](#step-1-prerequisites)**| Install all necessary tools for this setup | +| | **[Check out the Code](#step-2-check-out-the-code)** | Get all necessary code to deploy the service and dependencies to the kuberneetes cluster| +| | **[Installing the Service](#step-3-installing-the-services)**|Start cluster and interact with the Item Relationship Service| + +### 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. [Python3](https://www.python.org/downloads/) is installed +6. [Ruby](https://www.ruby-lang.org/de/documentation/installation/) is installed +7. [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 [Item Relationship Service](https://github.com/eclipse-tractusx/item-relationship-service) or download a [released version](https://github.com/eclipse-tractusx/item-relationship-service/releases) of the Item Relationship Service + +> 👉 **Please use [tag 2.6.0](https://github.com/eclipse-tractusx/item-relationship-service/releases/tag/2.6.0) instead +of the latest version currently (this is the version compatible with IRS 2.4.0).** +> +> ```git clone -b 2.6.0 https://github.com/catenax-ng/tx-item-relationship-service``` + + +### Step 3: Installing the services + +#### 1. Start the cluster + +To deploy the services on kubernetes, run + +```bash +cd local/deployment/full-irs +./start.sh true true +``` + +The script takes 2 parameters as input: + +* INSTALL_EDC: default is set to true. If this is passed as true, will delete all helm charts related to EDC (vault, DAPS, EDC consumer and EDC provider) and install them again. +* INSTALL_IRS: default is set to true. If this is passed as true, will delete all helm charts related to IRS (dependencies, IRS backend and IRS frontend) and install them again. + +This can take up to **20 minutes**. + +When the deployment is finished you can expect that 13 deployments can be seen in the minikube dashboard: + +* irs-frontend +* irs +* irs-minio +* keycloak (mocked Service) +* digital-twin-registry +* semantic-hub (mocked Service) +* irs-provider-backend +* edc-provider-control-plane +* edc-provider-data-plane +* edc-consumer-control-plane +* edc-consumer-data-plane +* edc-vault-agent-injector + +Also in total 17 Pods are up and running. + +**INFO**: sometimes you will get the following message during deployment, which can be ignored. This is caused when a service takes longer than 90 seconds to be available. + +```bash +-e Waiting for the deployments to be available +error: timed out waiting for the condition on deployments/irs-frontend +``` + +##### 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 **irs**: + + + +#### 2. Forward ports + +When the deployment has been finished, please use the script to forward the ports: + +```bash +./forwardingPorts.sh +``` + +After that you can access the: + +* **Digital Twin Registry:** [http://localhost:10200](http://localhost:10200) +* **IRS Frontend:** [http://localhost:3000](http://localhost:3000) + +#### 3. Prepare test data + +> Only if Step 2 has been applied and the ports are forwarded. + +To provision testdata to the provider EDC and register the testdata with the Digital Twin Registry, use the following script: + +```bash +./upload-testdata.sh +``` + +If you like, you can remove the test data with: + +```bash +./deleteIRSTestData.sh +``` + +### Step 4: Access the Debugging View + +Open [http://localhost:3000/](http://localhost:3000/) and you should see the Item Relationship Service login screen. **Just press Login.** + + + +## Testing the Item Relationship Service + +You can use several approaches to interact with the IRS. One is through the **IRS API** and another way is through the **IRS API Frontend**. + +### Valid Global Asset IDs for testing + +Use these globalAssetId's for testing: + +| globalAssetId | type | +|---------------|------| +| urn:uuid:d3c0bf85-d44f-47c5-990d-fec8a36065c6 | vehicle combustion engine | +| urn:uuid:61a22b1c-5725-41fb-8e1e-dccaaba83838 | vehicle combustion engine | +| urn:uuid:513d7be8-e7e4-49f4-a22b-8cd31317e454 | vehicle combustion engine | + +### Valid test requests for testing + +Use these snippets for testing purposes. + +```json +{ + "aspects": [ + "AssemblyPartRelationship", + "SerialPartTypization" + ], + "bomLifecycle": "asBuilt", + "collectAspects": true, + "direction": "downward", + "depth": 10, + "globalAssetId": "urn:uuid:d387fa8e-603c-42bd-98c3-4d87fef8d2bb" +} +```` + +```json +{ + "aspects": [ + "SerialPartTypization" + ], + "depth": 1, + "globalAssetId": "urn:uuid:d387fa8e-603c-42bd-98c3-4d87fef8d2bb" +} +``` + + + +### Testing the IRS API endpoints + +#### Precondition + +* Visual Studio extension: [REST Client by Huachao Mao](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) +* All installation steps have been conducted successfully +* A valid Global Asset ID + +#### Test-steps + +1. To interact with the API Endpoints, you need a valid token. You can generate an access token by using the ``` ./test/keycloack-service.rest ```. +2. **copy & paste** the valid token into line 8 of ``` ./test/irs-backend-service.rest ``` +3. **copy & paste** a valid globalAssetId into the request body +4. **execute the request** ```./test/irs-backend-service.rest``` + +### Testing with the IRS frontend + +#### Precondition + +* All installation steps have been conducted successfully + +#### Test-steps + +1. **open** [http://localhost:3000](http://localhost:3000) and click 'Login' +2. **copy & paste** a valid globalAssetId into the request body +  +3. **click** 'Build Data Chain' to start a new IRS job +4. **click** 'Visualization' to see the result of the job +  + +### Step 2: Verify Results + +The following example shows a visual overview of all retrieved data assets and digital twins of a data chain. + +_Item Relationship Service visualization overview_ + +With the following snippet, all clickable objects will be explained: + +* **Digital Twin:** the box itself is clickable and will open an overlay to show more information on this object. +* **Aspect:** the green button is clickable and represents an Aspect or Submodel of the twin. +* **Relationship Aspect:** the line between Digital Twins is clickable and will give detailed Information about the relationship between the twins. + + +_Item Relationship Service clickable objects_ + +## 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 IRS, as it is based on Spring Boot and Java, 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 IRS deployment to your host machine and connect your IDE to that port. diff --git a/docs-kits_versioned_docs/version-23.12/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-23.12/kits/Digital Twin Kit/Software Development View/API AAS Discovery/dotaas-part-2-http-rest-discovery-service-specification.info.mdx new file mode 100644 index 00000000000..08dea9e47f6 --- /dev/null +++ b/docs-kits_versioned_docs/version-23.12/kits/Digital Twin Kit/Software Development View/API AAS Discovery/dotaas-part-2-http-rest-discovery-service-specification.info.mdx @@ -0,0 +1,25 @@ +--- +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.orgLicense
CC BY 4.0Query Parameters
+
+Requested Asset Administration Shell ids
+
+
Schema array
- string
+
+Default error handling for unmentioned status codes
+
+
Schema
messages object[]
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[]
+
+Requested Description
+
+
Schema
+
+Default error handling for unmentioned status codes
+
+
Schema
messages object[]
Contact
Industrial Digital Twin Association (IDTA): info@idtwin.orgLicense
CC BY 4.0Query 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[]
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[]
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[]
+
+Requested Description
+
+
Schema
+
+Forbidden
+
+
Schema
messages object[]
+
+Default error handling for unmentioned status codes
+
+
Schema
messages object[]
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[]
Authentication
Contact
SLDT Team:Path Parameters
+
+BPN Identifier Key-Value deleted successfully
+
+
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[]
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
property name*object
details object
+
+An object with key/value pairs containing additional information exception.
+
+
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
Path Parameters
+
+Discovery Endpoint deleted successfully
+
+
Authentication
Contact
SLDT Team: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`
+
+
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
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
+
+
Contact
Industrial Digital Twin Association (IDTA): info@idtwin.orgLicense
CC BY 4.0
+
+Requested Description
+
+
Schema
+
+Unauthorized, e.g. the server refused the authorization attempt.
+
+
Schema
messages object[]
+
+Forbidden
+
+
Schema
messages object[]
Query Parameters
+
+ValueOnly representation of the Submodel
+
+
Schema
+
+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
+
+